diff --git a/en/_assets/billing/billing-cycle-business-credit.svg b/en/_assets/billing/billing-cycle-business-credit.svg new file mode 100644 index 00000000000..f9aefad9cdc --- /dev/null +++ b/en/_assets/billing/billing-cycle-business-credit.svg @@ -0,0 +1,94 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/en/_assets/compute/connect-sa.png b/en/_assets/compute/connect-sa.png deleted file mode 100755 index ba4d94b2c8c..00000000000 Binary files a/en/_assets/compute/connect-sa.png and /dev/null differ diff --git a/en/_assets/console-icons/chevrons-expand-up-right.svg b/en/_assets/console-icons/chevrons-expand-up-right.svg new file mode 100644 index 00000000000..585a2a66b80 --- /dev/null +++ b/en/_assets/console-icons/chevrons-expand-up-right.svg @@ -0,0 +1,3 @@ + + + diff --git a/en/_assets/console-icons/circle-plus-fill.svg b/en/_assets/console-icons/circle-plus-fill.svg new file mode 100644 index 00000000000..d2d7324003e --- /dev/null +++ b/en/_assets/console-icons/circle-plus-fill.svg @@ -0,0 +1,3 @@ + + + diff --git a/en/_assets/console-icons/cubes-3.svg b/en/_assets/console-icons/cubes-3.svg new file mode 100644 index 00000000000..6e87337149c --- /dev/null +++ b/en/_assets/console-icons/cubes-3.svg @@ -0,0 +1,3 @@ + + + diff --git a/en/_assets/console-icons/handset-arrow-in.svg b/en/_assets/console-icons/handset-arrow-in.svg new file mode 100644 index 00000000000..9b4187111ab --- /dev/null +++ b/en/_assets/console-icons/handset-arrow-in.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/en/_assets/console-icons/stop.svg b/en/_assets/console-icons/stop.svg new file mode 100644 index 00000000000..68bf4502909 --- /dev/null +++ b/en/_assets/console-icons/stop.svg @@ -0,0 +1,3 @@ + + + diff --git a/en/_assets/console-icons/triangle-right.svg b/en/_assets/console-icons/triangle-right.svg new file mode 100644 index 00000000000..d0d9f448f24 --- /dev/null +++ b/en/_assets/console-icons/triangle-right.svg @@ -0,0 +1,3 @@ + + + diff --git a/en/_assets/datalens/concepts/widget.png b/en/_assets/datalens/concepts/widget.png index 0edf3cc3037..e781724a3cc 100644 Binary files a/en/_assets/datalens/concepts/widget.png and b/en/_assets/datalens/concepts/widget.png differ diff --git a/en/_assets/datalens/solution-03/01-metrica-list.png b/en/_assets/datalens/solution-03/01-metrica-list.png index f0825b4e69f..ea6a4a587a2 100644 Binary files a/en/_assets/datalens/solution-03/01-metrica-list.png and b/en/_assets/datalens/solution-03/01-metrica-list.png differ diff --git a/en/_assets/datalens/solution-03/10-delete-charts1.png b/en/_assets/datalens/solution-03/10-delete-charts1.png index 2428498fb0e..f5cedeba507 100644 Binary files a/en/_assets/datalens/solution-03/10-delete-charts1.png and b/en/_assets/datalens/solution-03/10-delete-charts1.png differ diff --git a/en/_assets/datalens/solution-03/11-replace-charts.png b/en/_assets/datalens/solution-03/11-replace-charts.png index 65d9e1b8100..abbe115cdb7 100644 Binary files a/en/_assets/datalens/solution-03/11-replace-charts.png and b/en/_assets/datalens/solution-03/11-replace-charts.png differ diff --git a/en/_assets/datalens/solution-03/12-delete-charts2.png b/en/_assets/datalens/solution-03/12-delete-charts2.png index 9b9fa6b5575..4497dec8687 100644 Binary files a/en/_assets/datalens/solution-03/12-delete-charts2.png and b/en/_assets/datalens/solution-03/12-delete-charts2.png differ diff --git a/en/_assets/datalens/solution-03/14-edit-chart.png b/en/_assets/datalens/solution-03/14-edit-chart.png index cacfbdb4e3e..9e9b24a1544 100644 Binary files a/en/_assets/datalens/solution-03/14-edit-chart.png and b/en/_assets/datalens/solution-03/14-edit-chart.png differ diff --git a/en/_assets/datalens/solution-03/15-choose-pie.png b/en/_assets/datalens/solution-03/15-choose-pie.png index 22e00c192f1..e5391fd7cb9 100644 Binary files a/en/_assets/datalens/solution-03/15-choose-pie.png and b/en/_assets/datalens/solution-03/15-choose-pie.png differ diff --git a/en/_assets/datalens/solution-03/16-save-chart.png b/en/_assets/datalens/solution-03/16-save-chart.png index d4b01133b65..27333dbc6fa 100644 Binary files a/en/_assets/datalens/solution-03/16-save-chart.png and b/en/_assets/datalens/solution-03/16-save-chart.png differ diff --git a/en/_assets/datalens/solution-03/17-refresh-dashboard.png b/en/_assets/datalens/solution-03/17-refresh-dashboard.png index 964fcbc21fe..a097ed3b28a 100644 Binary files a/en/_assets/datalens/solution-03/17-refresh-dashboard.png and b/en/_assets/datalens/solution-03/17-refresh-dashboard.png differ diff --git a/en/_assets/overview/legal-entity-trial-period.svg b/en/_assets/overview/legal-entity-trial-period.svg new file mode 100644 index 00000000000..0e83ac62e68 --- /dev/null +++ b/en/_assets/overview/legal-entity-trial-period.svg @@ -0,0 +1,86 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/en/_assets/storage/bucket.svg b/en/_assets/storage/bucket.svg new file mode 100644 index 00000000000..bb05f952e17 --- /dev/null +++ b/en/_assets/storage/bucket.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/en/_assets/storage/link.svg b/en/_assets/storage/link.svg new file mode 100644 index 00000000000..eed56977ade --- /dev/null +++ b/en/_assets/storage/link.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/en/_assets/storage/upload.svg b/en/_assets/storage/upload.svg new file mode 100644 index 00000000000..ce1ebb1fcf5 --- /dev/null +++ b/en/_assets/storage/upload.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/en/_cli-ref/cli-ref/managed-services/lockbox/secret/add-version.md b/en/_cli-ref/cli-ref/managed-services/lockbox/secret/add-version.md index c676c185012..ca00af11111 100644 --- a/en/_cli-ref/cli-ref/managed-services/lockbox/secret/add-version.md +++ b/en/_cli-ref/cli-ref/managed-services/lockbox/secret/add-version.md @@ -20,7 +20,7 @@ Syntax: |`--name`|`string`
Secret name.| |`--async`|Display information about the operation in progress, without waiting for the operation to complete.| |`--description`|`string`
Version description.| -|`--payload`|`string`
YAML or JSON array defining how to change payload from the base version.
Each item of the array must match the format: https://yandex.cloud/ru/docs/lockbox/api-ref/grpc/secret_service#PayloadEntryChange
For instance, to modify the value of "password" entry from the base version payload:
[{"key": "username", "text_value": "alice"}, {"key": "password", "text_value": "p@$$w0rd"}]
the following JSON can be passed:
[{"key": "password", "text_value": "another-p@$$w0rd"}]
so the resulting payload of the newly added version will be:
[{"key": "username", "text_value": "alice"}, {"key": "password", "text_value": "another-p@$$w0rd"}]
To remove the entry pass an item containing only the "key" field, e.g.:
[..., {"key": "the-key-of-the-entry-to-remove"}, ...]
Use - value to pass payload string via stdin.| +|`--payload`|`string`
YAML or JSON array defining how to change payload from the base version.
Each item of the array must match the format: https://yandex.cloud/ru/docs/lockbox/api-ref/grpc/Secret/create#yandex.cloud.lockbox.v1.PayloadEntryChange
For instance, to modify the value of "password" entry from the base version payload:
[{"key": "username", "text_value": "alice"}, {"key": "password", "text_value": "p@$$w0rd"}]
the following JSON can be passed:
[{"key": "password", "text_value": "another-p@$$w0rd"}]
so the resulting payload of the newly added version will be:
[{"key": "username", "text_value": "alice"}, {"key": "password", "text_value": "another-p@$$w0rd"}]
To remove the entry pass an item containing only the "key" field, e.g.:
[..., {"key": "the-key-of-the-entry-to-remove"}, ...]
Use - value to pass payload string via stdin.| |`--base-version-id`|`string`
Base version id. By default, the current one is used.| #### Global Flags diff --git a/en/_cli-ref/cli-ref/managed-services/lockbox/secret/create.md b/en/_cli-ref/cli-ref/managed-services/lockbox/secret/create.md index 604543e9870..4491b67405a 100644 --- a/en/_cli-ref/cli-ref/managed-services/lockbox/secret/create.md +++ b/en/_cli-ref/cli-ref/managed-services/lockbox/secret/create.md @@ -21,7 +21,7 @@ Syntax: |`--labels`|`key=value[,key=value...]`
A list of label KEY=VALUE pairs to add. For example, to add two labels named 'foo' and 'bar', both with the value 'baz', use '--labels foo=baz,bar=baz'.| |`--kms-key-id`|`string`
KMS key ID will be used to encrypt the secret payload.| |`--version-description`|`string`
Description of the first version.| -|`--payload`|`string`
YAML or JSON array defining the entries of the secret payload.
Each item of the array must match the format: https://yandex.cloud/ru/docs/lockbox/api-ref/grpc/secret_service#PayloadEntryChange
For instance, the following payload JSON defines a payload containing two text value entries:
[{"key": "username", "text_value": "alice"}, {"key": "password", "text_value": "p@$$w0rd"}]
Use - value to pass payload string via stdin.| +|`--payload`|`string`
YAML or JSON array defining the entries of the secret payload.
Each item of the array must match the format: https://yandex.cloud/ru/docs/lockbox/api-ref/grpc/Secret/create#yandex.cloud.lockbox.v1.PayloadEntryChange
For instance, the following payload JSON defines a payload containing two text value entries:
[{"key": "username", "text_value": "alice"}, {"key": "password", "text_value": "p@$$w0rd"}]
Use - value to pass payload string via stdin.| |`--deletion-protection`|Enable deletion protection for the secret.| |`--async`|Display information about the operation in progress, without waiting for the operation to complete.| diff --git a/en/_includes/application-load-balancer/create-web-server.md b/en/_includes/application-load-balancer/create-web-server.md index 78048959403..62ffd716ede 100644 --- a/en/_includes/application-load-balancer/create-web-server.md +++ b/en/_includes/application-load-balancer/create-web-server.md @@ -18,5 +18,5 @@ 1. Make sure the web server returns a list of folders in the `test-server` folder. Open the terminal on your computer and run this command: ```bash - curl -v :8080 + curl --verbose :8080 ``` \ No newline at end of file diff --git a/en/_includes/backup/baremetal-note.md b/en/_includes/backup/baremetal-note.md new file mode 100644 index 00000000000..b26cd84a0a7 --- /dev/null +++ b/en/_includes/backup/baremetal-note.md @@ -0,0 +1,7 @@ +{% note info %} + +{{ backup-name }} also supports [{{ baremetal-full-name }} server](../../baremetal/concepts/servers.md) backups. For details, see [Connecting a {{ baremetal-name }} server to {{ backup-name }}](../../backup/tutorials/backup-baremetal.md). + +_{{ baremetal-name }} will be released at the [Preview stage](../../overview/concepts/launch-stages.md) in Q4 2024._ + +{% endnote %} \ No newline at end of file diff --git a/en/_includes/backup/operations/full-config.md b/en/_includes/backup/operations/full-config.md index 3a9172af305..a3ce1c85a65 100644 --- a/en/_includes/backup/operations/full-config.md +++ b/en/_includes/backup/operations/full-config.md @@ -191,10 +191,10 @@ Attribute sections with multiple nested values. | `scheduling.backupSets.sinceLastExecTime.delay.type` | Units of time used to set the interval between backups. | | | `scheduling.backupSets.sinceLastExecTime.delay.count` | Duration of the interval between backups in time units set by the `delay.type` attribute. | Integer | | `scheduling.enabled` | Making scheduled backups. | | - | `scheduling.maxParallelBackups` | Maximum number of parallel backups allowed. Unlimited if no value is specified. | Integer | + | `scheduling.maxParallelBackups` | Maximum permissible number of parallel backups. Unlimited if no value is specified. | Integer | | `scheduling.randMaxDelay.type` | Units of time used to set the maximum delay before running parallel jobs. | | | `scheduling.randMaxDelay.count` | Maximum delay before running parallel jobs in time units set by the `randMaxDelay.type` attribute. The delay is determined randomly but it may not exceed the value set here. | Integer | | `scheduling.scheme` | Backup schedule scheme. | | - | `scheduling.weeklyBackupDay` | Day of the week to make weekly backups on. | Integer from 1 to 7 | + | `scheduling.weeklyBackupDay` | Day of the week for the weekly backup. | Integer from 1 to 7 | {% endlist %} \ No newline at end of file diff --git a/en/_includes/billing/billing-account-create-individual.md b/en/_includes/billing/billing-account-create-individual.md index eb6831df4b9..0d77bededcb 100644 --- a/en/_includes/billing/billing-account-create-individual.md +++ b/en/_includes/billing/billing-account-create-individual.md @@ -14,7 +14,7 @@ To create a billing account: 1. If you see a list of available payers in the **{{ ui-key.yacloud_billing_account.create-account-wizard.field_person-id }}** section, you can select one of them or add a new one. To add a payer: - * Select the **{{ ui-key.startrek.ui_components_page-admin_BillingAccountInfo.person-type-invididual }}** payer type and click **{{ ui-key.yacloud_billing_account.cloud-billing-account.label_wizard-next }}**. + * Select the **Individual** payer type and click **{{ ui-key.yacloud_billing_account.cloud-billing-account.label_wizard-next }}**. * Enter your first and last name. * (Optional) Enter your middle name and mailing address. * Click **{{ ui-key.yacloud_billing_account.cloud-billing-account.label_wizard-next }}**. diff --git a/en/_includes/billing/billing-account-create-legal-entities.md b/en/_includes/billing/billing-account-create-legal-entities.md index 56e1c515733..cb58df3e9f7 100644 --- a/en/_includes/billing/billing-account-create-legal-entities.md +++ b/en/_includes/billing/billing-account-create-legal-entities.md @@ -2,7 +2,7 @@ To create a billing account: 1. {% include [move-to-billing-step](../../billing/_includes/move-to-billing-step.md) %} -1. Log in to your Yandex ID or Yandex 360 account. If you do not have an account yet, [sign up](https://yandex.ru/support/id/authorization/registration.html) and create an [organization](../../organization/quickstart.md) to work in [{{org-full-name}}]({{link-org-main}}). If you use a social network profile to log in to Yandex, [create a username and password](https://passport.yandex.com/passport?mode=postregistration&create_login=1). +1. Log in to your Yandex ID or Yandex 360 account. If you do not have an account yet, [sign up](https://yandex.ru/support/id/authorization/registration.html) and create an [organization](../../organization/quickstart.md) in [{{ org-full-name }}]({{ link-org-main }}) for you to work in. If using your social network profile to log in to Yandex, [create a username and password](https://passport.yandex.com/passport?mode=postregistration&create_login=1). 1. On the **{{ ui-key.yacloud_billing.billing.title_accounts }}** page, click **Create billing account**. Fill in your information: @@ -10,27 +10,49 @@ To create a billing account: * {% include [choose-org-step](../../billing/_includes/choose-org-step.md) %} * {% include [choose-country-step](../../billing/_includes/choose-country-step.md) %} - {% include [billing-account-payers](../../billing/_includes/billing-account-payers.md) %} + {% include [billing-account-payers](../../billing/_includes/billing-account-payers.md) %} 1. If you see a list of available payers in the **{{ ui-key.yacloud_billing_account.create-account-wizard.field_person-id }}** section, you can select one of them or add a new one. -1. Select the **{{ ui-key.startrek.ui_components_page-admin_BillingAccountInfo.person-type-company }}** payer type. +1. Select the **Legal entity or individual entrepreneur** payer type. -1. Select the **{{ ui-key.yacloud_billing.billing.account.create-new.payment-type_label_invoice }}** payment method. +1. Select the **{{ ui-key.yacloud_billing.billing.account.create-new.payment-type_label_card }}** or **{{ ui-key.yacloud_billing.billing.account.create-new.payment-type_label_invoice }}** payment method. You can [change the payment method](../../billing/operations/change-payment-method.md) any time after creating a billing account. 1. Click **{{ ui-key.yacloud_billing_account.cloud-billing-account.label_wizard-next }}**. +1. If you selected **{{ ui-key.yacloud_billing.billing.account.create-new.payment-type_label_card }}** as a payment method: -1. Enter the legal information of your organization and your contact details. + 1. Enter the legal information of your organization and your contact details. -1. Enter your current email address and phone number. Contact details are required not only to reach you, but also to issue payment invoices and send financial documents. If you have already signed up for {{ yandex-cloud }}, check that your contact details are correct. + {% include [contacts-note](contacts-note.md) %} + 1. Link your corporate bank card: + + {% include [pin-card-data](pin-card-data.md) %} + + * Confirm that the card is a corporate one and you are authorized to use it. + + * Click **{{ ui-key.yacloud_billing_account.cloud-billing-account.label_wizard-next }}**. + + {% include [payment-card-types](payment-card-types-business.md) %} + + {% include [yandex-account](payment-card-validation.md) %} + + 1. Enter your current email address and phone number. Contact details are required not only to reach you, but also to issue payment invoices and send financial documents. If you have already signed up for {{ yandex-cloud }}, check that your contact details are correct. + +1. If you selected **{{ ui-key.yacloud_billing.billing.account.create-new.payment-type_label_invoice }}** as a payment method: + + 1. Enter the legal information of your organization and your contact details. + + 1. Enter your current email address and phone number. Contact details are required not only to reach you, but also to issue payment invoices and send financial documents. If you have already signed up for {{ yandex-cloud }}, check that your contact details are correct. 1. If this is your first {{ yandex-cloud }} billing account, you are eligible for a [trial period](../../billing/concepts/trial-period.md). After it expires, the access to your resources will be suspended. To resume operation, you will need to switch to the [paid version](../../billing/operations/activate-commercial.md). 1. Click **{{ ui-key.yacloud.common.create }}**. + If you select the **{{ ui-key.yacloud_billing.billing.account.create-new.payment-type_label_invoice }}** payment method or if the payer is a non-resident of Russia and Kazakhstan, further instructions will be emailed to you at the address specified in your Yandex or Yandex 360 account. It may take up to three business days to activate your billing account. - Further instructions will be emailed to you at the address specified in your Yandex or Yandex 360 account. It may take up to three business days to activate your billing account. - + Email the following documents to [{{ billing-docs-email }}](mailto:{{ billing-docs-email }}): + * Copy of the minutes or resolution on the appointment of the general director + * [Billing account](../../billing/concepts/billing-account.md#billing-account-id) ID diff --git a/en/_includes/billing/card-business-nonresidents.md b/en/_includes/billing/card-business-nonresidents.md deleted file mode 100644 index 1c51d2c0f7e..00000000000 --- a/en/_includes/billing/card-business-nonresidents.md +++ /dev/null @@ -1,5 +0,0 @@ -{% note info %} - -Payment by credit/debit card is not available for non-residents of Russia and Kazakhstan. - -{% endnote %} diff --git a/en/_includes/billing/contract.md b/en/_includes/billing/contract.md index 2be9f4deae1..cbfea898f73 100644 --- a/en/_includes/billing/contract.md +++ b/en/_includes/billing/contract.md @@ -1 +1 @@ -In {{ yandex-cloud }}, all services are provided under an agreement you enter into by accepting an [offer]({{ billing-oferta-url }}?lang=en) when creating your [billing account](../../billing/concepts/billing-account.md). The agreement does not need to be signed by both parties. +In {{ yandex-cloud }}, all services are provided under an agreement you enter into by accepting an offer when creating your [billing account](../../billing/concepts/billing-account.md). The agreement does not need to be signed by both parties. diff --git a/en/_includes/billing/legal-entity-nonresidents.md b/en/_includes/billing/legal-entity-nonresidents.md new file mode 100644 index 00000000000..e323e1d951f --- /dev/null +++ b/en/_includes/billing/legal-entity-nonresidents.md @@ -0,0 +1,5 @@ +{% note info %} + +If you are a non-resident of Russia or Kazakhstan, specify the bank details of the legal entity you signed the [agreement](../../billing/concepts/contract.md) with when [creating your billing account](../../billing/operations/create-new-account.md). + +{% endnote %} diff --git a/en/_includes/billing/non-residents-functional-access.md b/en/_includes/billing/non-residents-functional-access.md new file mode 100644 index 00000000000..ba0ed7b229b --- /dev/null +++ b/en/_includes/billing/non-residents-functional-access.md @@ -0,0 +1,5 @@ +{% note info %} + +This feature is not available for non-residents of Russia and Kazakhstan. + +{% endnote %} \ No newline at end of file diff --git a/en/_includes/billing/payment-card-types-business.md b/en/_includes/billing/payment-card-types-business.md new file mode 100644 index 00000000000..9a989964efc --- /dev/null +++ b/en/_includes/billing/payment-card-types-business.md @@ -0,0 +1,5 @@ +We accept Mir, Visa, and MasterCard. + +* Residents of Russia make payments in RUB and can only use bank cards issued by Russian banks. Customers with tax residency in the Republic of Belarus pay for {{ yandex-cloud }} services in RUB with their Belcard cards issued in the Republic of Belarus or Mir cards issued in the Russian Federation. +* Residents of Kazakhstan make payments in KZT and can only use bank cards issued by non-Russian banks. +* Non-residents of Russia and Kazakhstan make payments in USD and can only use credit or debit cards issued by non-Russian banks. diff --git a/en/_includes/billing/payment-card-types.md b/en/_includes/billing/payment-card-types.md index 895f2ae9149..12326b9500d 100644 --- a/en/_includes/billing/payment-card-types.md +++ b/en/_includes/billing/payment-card-types.md @@ -1,4 +1,5 @@ We accept Mir, Visa, and MasterCard. * Residents of Russia make payments in RUB and can only use bank cards issued by Russian banks. -* Residents of Kazakhstan make payments in KZT and can only use bank cards issued by non-Russian banks. \ No newline at end of file +* Residents of Kazakhstan make payments in KZT and can only use bank cards issued by non-Russian banks. +* Non-residents of Russia and Kazakhstan make payments in USD and can only use credit or debit cards issued by non-Russian banks. \ No newline at end of file diff --git a/en/_includes/cloud-desktop/access-options.md b/en/_includes/cloud-desktop/access-options.md new file mode 100644 index 00000000000..973cd582105 --- /dev/null +++ b/en/_includes/cloud-desktop/access-options.md @@ -0,0 +1 @@ +{{ cloud-desktop-name }} leverages [{{ iam-full-name }} roles](../../cloud-desktop/security/index.md) and [access control lists (ACL)](../../cloud-desktop/concepts/acl.md) to manage access. [This example](../../cloud-desktop/concepts/acl.md#example) shows how access control works in {{ cloud-desktop-name }}. \ No newline at end of file diff --git a/en/_includes/cloud-desktop/limits.md b/en/_includes/cloud-desktop/limits.md index 252509dc0dc..3e6d12a61f7 100644 --- a/en/_includes/cloud-desktop/limits.md +++ b/en/_includes/cloud-desktop/limits.md @@ -1,9 +1,9 @@ #### Quotas {#quotas} -| Type of limit | Value | +Type of limit | Value ----- | ----- -| Maximum number of desktops per cloud | 5 | -| Maximum total number of vCPUs per cloud | 10 | -| Maximum total amount of RAM per cloud | 20 GB | -| Maximum total HDD storage capacity per cloud | 500 GB | -| Maximum total SSD storage capacity per cloud | 500 GB | +Maximum number of desktops per cloud | 5 +Maximum total number of vCPUs per cloud | 10 +Maximum total amount of RAM per cloud | 20 GB +Maximum total HDD space per cloud | 500 GB +Maximum total SSD space per cloud | 500 GB \ No newline at end of file diff --git a/en/_includes/cns-limits.md b/en/_includes/cns-limits.md new file mode 100644 index 00000000000..04fba5d51ea --- /dev/null +++ b/en/_includes/cns-limits.md @@ -0,0 +1,27 @@ +#### Quotas {#quotas} + +**Type of limit** | **Value** +----- | ----- +Maximum message size per [push notification](../notifications/concepts/push.md) | 4 KB + +#### Limits {#limits} + +**Type of limit** | **Value** +----- | ----- +Maximum number of [push notification channels](../notifications/concepts/push.md#mobile-channel) per cloud | 20 +Maximum number of [SMS notification](../notifications/concepts/sms.md) channels per cloud | 10 +Maximum number of SMS notification channels with a [shared sender ](../notifications/concepts/sms.md) per cloud | 1 +Maximum number of SMS notification channels with an [individual sender](../notifications/concepts/sms.md#individual-sender) per cloud | 10 +Maximum number of [test phone numbers](../notifications/concepts/sms.md#sandbox) per SMS notification channel | 10 +Maximum number of SMS messages per cloud^1^ | 100 per month +Maximum message size per push notification | 200 KB +Maximum SMS message length | 1,600 characters (10 segments) +Maximum name length for a push notification channel | 40 characters +Maximum length for user data (`CustomUserData`) per mobile endpoint | 256 characters +Maximum length for a device ID per mobile endpoint | 256 characters +Maximum rate of requests to create or update notification channel attributes per cloud | 30 requests per second +Maximum rate of requests to send an SMS message per cloud | 20 requests per second +Maximum number of SMS messages to verify one test number | 5 per day for one number +Maximum number of SMS messages to verify test numbers per cloud | 20 per day + +^1^ Moving forward, the limit on the maximum number of SMS messages per cloud will become a [quota](#quotas). You will be able to increase it by contacting support. \ No newline at end of file diff --git a/en/_includes/code-assistant/auto-manual-modes.md b/en/_includes/code-assistant/auto-manual-modes.md index 516e19191f5..45a8393c55b 100644 --- a/en/_includes/code-assistant/auto-manual-modes.md +++ b/en/_includes/code-assistant/auto-manual-modes.md @@ -1,3 +1,3 @@ {{ ca-name }} analyzes your code context and provides the following types of suggestions: * Automatic. -* Upon user request (use **Ctrl** + **Space** or **Ctrl** + **Enter**). \ No newline at end of file +* User-triggered (**Ctrl** + **Space**). In Visual Studio Code, you can also use **Ctrl** + **Enter**. \ No newline at end of file diff --git a/en/_includes/code-assistant/unable-to-download.md b/en/_includes/code-assistant/unable-to-download.md new file mode 100644 index 00000000000..cab1edf75bc --- /dev/null +++ b/en/_includes/code-assistant/unable-to-download.md @@ -0,0 +1 @@ +If you cannot download it for any reason, contact your system administrator so that they open network access to {{ yandex-cloud }} resources. \ No newline at end of file diff --git a/en/_includes/compute/backup-info.md b/en/_includes/compute/backup-info.md deleted file mode 100644 index 72771ae2cb7..00000000000 --- a/en/_includes/compute/backup-info.md +++ /dev/null @@ -1,3 +0,0 @@ -(Optional) To back up your VMs automatically using [{{ backup-name }}](../../backup/), under **{{ ui-key.yacloud.compute.instances.create.section_additional }}**, select how your VM should connect to the service. - -For more information, see [{#T}](../../backup/concepts/vm-connection.md). diff --git a/en/_includes/compute/create-from-snapshot.md b/en/_includes/compute/create-from-snapshot.md index c8f3c93ebb7..d1a46c691d2 100644 --- a/en/_includes/compute/create-from-snapshot.md +++ b/en/_includes/compute/create-from-snapshot.md @@ -3,109 +3,69 @@ - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the folder to create the virtual machine in. - 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. - 1. At the top right, click **{{ ui-key.yacloud.compute.instances.button_create }}**. - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**: - - * Enter a name and description for the VM. The naming requirements are as follows: - - {% include [name-format](../name-format.md) %} - - {% include [name-fqdn](../compute/name-fqdn.md) %} - - * Select an [availability zone](../../overview/concepts/geo-scope.md) to put your virtual machine in. - - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, choose a snapshot: - - * Go to the **{{ ui-key.yacloud.compute.instances.create.image_value_custom_new }}** tab and click **{{ ui-key.yacloud.common.select }}**. - * In the window that opens, go to the **{{ ui-key.yacloud.compute.instances.create-disk.value_source-snapshot }}** tab. - * Select a disk snapshot from the list and click **{{ ui-key.yacloud.common.apply }}**. - - - 1. {% include [encryption-section-boot](encryption-section-boot.md) %} - - - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}**, [add a disk](../../compute/operations/vm-create/create-from-disks.md): - - * Click **{{ ui-key.yacloud.compute.component.instance-storage-dialog.button_add-disk }}**. - * Enter the disk name. + 1. In the [management console]({{ link-console-main }}), select the [folder](../../resource-manager/concepts/resources-hierarchy.md#folder) to create your VM in. + 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. + 1. In the left-hand panel, select ![image](../../_assets/console-icons/server.svg) **{{ ui-key.yacloud.compute.switch_instances }}**. + 1. Click **{{ ui-key.yacloud.compute.instances.button_create }}**. + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**: + + * Go to the **{{ ui-key.yacloud.compute.instances.create.image_value_custom_new }}** tab. + * Click ![image](../../_assets/console-icons/pencil.svg), and, in the window that opens, select **{{ ui-key.yacloud.common.create-new }}**. + * In the **{{ ui-key.yacloud.compute.instances.create-disk.field_source }}** field, select `{{ ui-key.yacloud.compute.instances.create-disk.value_source-snapshot }}` and then select the disk snapshot you need from the list below. Use filters if you need to. + * Enter a name for the new boot disk. * Select the [disk type](../../compute/concepts/disk.md#disks_types). - * Specify the required block size. - * Specify the required disk size. - - - * {% include [encryption-section-secondary](encryption-section-secondary.md) %} - - - * (Optional) Enable the **{{ ui-key.yacloud.compute.field_disk-autodelete }}** option if you need to automatically delete the disk when deleting the VM it will be attached to. - * Select `{{ ui-key.yacloud.compute.instances.create-disk.value_source-snapshot }}` as content. - * Click **{{ ui-key.yacloud.compute.instances.create-disk.button_create }}**. - - - 1. (Optional) Under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}**, select the **{{ ui-key.yacloud.compute.nfs.label_filesystems }}** tab and attach the [file storage](../../compute/concepts/filesystem.md): - - * Click **{{ ui-key.yacloud.compute.nfs.button_attach-filesystem-to-the-instance }}**. - * In the window that opens, select the file storage. - * Enter the device name. - * Click **{{ ui-key.yacloud.compute.nfs.button_attach-filesystem-to-the-instance }}**. - - - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_platform }}**: - - * Choose a [platform](../../compute/concepts/vm-platforms.md). - * Specify the [guaranteed share](../../compute/concepts/performance-levels.md) and the required number of vCPUs, as well as the amount of RAM. - * If required, make your VM [preemptible](../../compute/concepts/preemptible-vm.md). - * (Optional) Enable a [software-accelerated network](../../compute/concepts/software-accelerated-network.md). - - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_network }}**: - - {% include [network-settings](network-settings.md) %} - - - 1. {% include [backup-info](backup-info.md) %} - - - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_access }}**, specify the information required to access the instance: + * Specify the required disk and block size. + * (Optional) Enable the **{{ ui-key.yacloud.compute.field_disk-autodelete }}** option in the **{{ ui-key.yacloud.compute.field_additional }}** field if you need to automatically delete this disk when deleting the VM. + * Click **{{ ui-key.yacloud.compute.component.instance-storage-dialog.button_add-disk }}**. - * (Optional) Select or create a [service account](../../iam/concepts/users/service-accounts.md). With a service account, you can flexibly configure access rights for your resources. - * Enter the username in the **{{ ui-key.yacloud.compute.instances.create.field_user }}** field. + 1. Under **{{ ui-key.yacloud.k8s.node-groups.create.section_allocation-policy }}**, select an [availability zone](../../overview/concepts/geo-scope.md) to place your VM in. + 1. Add a secondary [disk](../../compute/concepts/disk.md): - {% note alert %} + * Under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}**, click **{{ ui-key.yacloud.compute.instances.create-disk.button_create }}** + * In the window that opens, select **{{ ui-key.yacloud.compute.instances.create-disk.value_source-disk }}** → `Create new`. + * In the **{{ ui-key.yacloud.compute.instances.create-disk.field_source }}** field, select `{{ ui-key.yacloud.compute.instances.create-disk.value_source-snapshot }}`. + * Enter a name for the new disk. + * Select the [disk type](../../compute/concepts/disk.md#disks_types). + * Specify the required disk and block size. + * (Optional) Enable the **{{ ui-key.yacloud.compute.field_disk-autodelete }}** option in the **{{ ui-key.yacloud.compute.field_additional }}** field if you need to automatically delete this disk when deleting the VM. + * Click **{{ ui-key.yacloud.compute.component.instance-storage-dialog.button_add-disk }}**. - Do not use the `root` username or other names reserved by the operating system. To perform operations that require superuser permissions, use the `sudo` command. + 1. {% include [encryption-section-secondary](encryption-section-secondary.md) %} + 1. {% include [section-storages-filesystem](create/section-storages-filesystem.md) %} + 1. {% include [section-platform](create/section-platform.md) %} + 1. {% include [network-settings](create/section-network.md) %} + 1. {% include [section-access](create/section-access.md) %} - {% endnote %} + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**, specify the VM name: - * In the **{{ ui-key.yacloud.compute.instances.create.field_key }}** field, paste the contents of the [public key](../../compute/operations/vm-connect/ssh.md#creating-ssh-keys) file. - * If required, grant access to the [serial console](../../compute/operations/serial-console/index.md). + {% include [name-format](../name-format.md) %} - {% include [vm-connect-linux](../vm-connect-linux.md) %} + {% include [name-fqdn](../compute/name-fqdn.md) %} - 1. (Optional) Under **{{ ui-key.yacloud.compute.instances.create.section_placement }}**, select a VM [placement group](../../compute/concepts/placement-groups.md). - 1. Click **{{ ui-key.yacloud.compute.instances.create.button_create }}**. + 1. {% include [section-additional](../../_includes/compute/create/section-additional.md) %} + 1. Click **{{ ui-key.yacloud.compute.instances.create.button_create }}**. - The virtual machine will appear in the list. When a VM is created, it is assigned an [IP address](../../vpc/concepts/address.md) and [host name](../../vpc/concepts/address.md#fqdn) (FQDN). + You will see the new VM in the list. Every new VM gets an [IP address](../../vpc/concepts/address.md) and [host name](../../vpc/concepts/address.md#fqdn) (FQDN). - CLI {#cli} - {% include [cli-install](../cli-install.md) %} + {% include [cli-install](../cli-install.md) %} - {% include [default-catalogue](../default-catalogue.md) %} + {% include [default-catalogue](../default-catalogue.md) %} - 1. View the description of the CLI command for creating a VM: + 1. View the description of the CLI command for creating a VM: ``` yc compute instance create --help ``` - 1. Prepare snapshots of the required disks, see [{#T}](../../compute/operations/disk-control/create-snapshot.md). - 1. Get a list of snapshots in the default folder: + 1. Prepare the snapshots of the disks, see [{#T}](../../compute/operations/disk-control/create-snapshot.md). + 1. Get a list of snapshots in the default folder: {% include [compute-snapshot-list](../../compute/_includes_service/compute-snapshot-list.md) %} - 1. Select the `ID`s or `NAME`s of the snapshots you need. - 1. Create a VM in the default folder: + 1. Select the IDs (`ID`) or names (`NAME`) of the snapshots you need. + 1. Create a VM in the default folder: ``` yc compute instance create \ @@ -117,7 +77,7 @@ --ssh-key ~/.ssh/id_ed25519.pub ``` - This command creates a VM named `first-instance` in the `{{ region-id }}-a` availability zone, with a public IP and the disks from the snapshots. + This command creates a VM named `first-instance` in the `{{ region-id }}-a` availability zone, with a public IP and disks from the snapshots. {% include [name-fqdn](name-fqdn.md) %} @@ -128,6 +88,6 @@ - API {#api} - Use the [create](../../compute/api-ref/Instance/create.md) REST API method for the [Instance](../../compute/api-ref/Instance/) resource or the [InstanceService/Create](../../compute/api-ref/grpc/Instance/create.md) gRPC API call. + Use the [create](../../compute/api-ref/Instance/create.md) REST API method for the [Instance](../../compute/api-ref/Instance/) resource or the [InstanceService/Create](../../compute/api-ref/grpc/Instance/create.md) gRPC API call. {% endlist %} diff --git a/en/_includes/compute/create/access-ssh-key.md b/en/_includes/compute/create/access-ssh-key.md new file mode 100644 index 00000000000..3a4f071ad3b --- /dev/null +++ b/en/_includes/compute/create/access-ssh-key.md @@ -0,0 +1,4 @@ +In the **{{ ui-key.yacloud.compute.instances.create.field_key }}** field, paste the contents of the [public key](../../../compute/operations/vm-connect/ssh.md#creating-ssh-keys) file. + +You need to create a key pair for the SSH connection yourself. To learn how, see [Connecting to a VM via SSH](../../../compute/operations/vm-connect/ssh.md). + diff --git a/en/_includes/compute/create/change-custom-disk-settings-image.md b/en/_includes/compute/create/change-custom-disk-settings-image.md new file mode 100644 index 00000000000..68100fa8c55 --- /dev/null +++ b/en/_includes/compute/create/change-custom-disk-settings-image.md @@ -0,0 +1 @@ +To create a VM instance from an existing boot disk, go to the **{{ ui-key.yacloud.compute.instances.create.image_value_custom_new }}** tab and select the boot disk you need. To update its settings, click ![image](../../../_assets/console-icons/pencil.svg) next to the disk name. \ No newline at end of file diff --git a/en/_includes/compute/create/change-custom-disk-settings-storages.md b/en/_includes/compute/create/change-custom-disk-settings-storages.md new file mode 100644 index 00000000000..26c2e2d54fd --- /dev/null +++ b/en/_includes/compute/create/change-custom-disk-settings-storages.md @@ -0,0 +1 @@ +If you are creating a VM instance from an existing boot disk, update the settings of that disk in the **{{ ui-key.yacloud.compute.instances.create.image_value_custom_new }}** tab under **{{ ui-key.yacloud.compute.instances.create.section_image }}** at the top of the form. \ No newline at end of file diff --git a/en/_includes/compute/create/create-vm-with-gpu-console.md b/en/_includes/compute/create/create-vm-with-gpu-console.md index a8e0607d18a..60decc0f0f3 100644 --- a/en/_includes/compute/create/create-vm-with-gpu-console.md +++ b/en/_includes/compute/create/create-vm-with-gpu-console.md @@ -1,79 +1,44 @@ -1. In the [management console]({{ link-console-main }}), select the folder to create the virtual machine in. +1. In the [management console]({{ link-console-main }}), select the folder to create your VM in. 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. -1. At the top right, click **{{ ui-key.yacloud.compute.instances.button_create }}**. -1. Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**: - * Enter a name and description for the VM. The naming requirements are as follows: - - {% include [name-format](../../name-format.md) %} - - {% include [name-fqdn](../name-fqdn.md) %} - - * Select an [availability zone](../../../overview/concepts/geo-scope.md) to place your virtual machine in. - - - {% include [gpu-zones](../gpu-zones.md) %} - - - +1. In the left-hand panel, select ![image](../../../_assets/console-icons/server.svg) **{{ ui-key.yacloud.compute.switch_instances }}**. +1. Click **{{ ui-key.yacloud.compute.instances.button_create }}**. 1. Select one of the [GPU-oriented images](/marketplace?search=gpu) and OS version under **{{ ui-key.yacloud.compute.instances.create.section_image }}** in the **{{ ui-key.yacloud.compute.instances.create.image_value_marketplace }}** tab. - {% include [gpu-os](../gpu-os.md) %} - -1. (Optional) Configure the boot disk under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}**: - * Select the [disk type](../../../compute/concepts/disk.md#disks_types). - * Specify the required disk size. - + {% include [gpu-os](../gpu-os.md) %} - * {% include [encryption-section-boot](../../../_includes/compute/encryption-section-boot.md) %} +1. Under **{{ ui-key.yacloud.k8s.node-groups.create.section_allocation-policy }}**, select an [availability zone](../../../overview/concepts/geo-scope.md) to place your VM in. +1. (Optional) Configure the boot [disk](../../../compute/concepts/disk.md) under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}**: + * Select the [disk type](../../../compute/concepts/disk.md#disks_types). + * Specify the required disk size. + * {% include [encryption-section-secondary](../encryption-section-secondary.md) %} + If you are creating a VM from an existing boot disk, update the settings of that disk in the **{{ ui-key.yacloud.compute.instances.create.image_value_custom_new }}** tab under **{{ ui-key.yacloud.compute.instances.create.section_image }}** at the top of the form. -1. (Optional) Under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}**, select the **{{ ui-key.yacloud.compute.nfs.label_filesystems }}** tab and attach the [file storage](../../../compute/concepts/filesystem.md): - - * Click **{{ ui-key.yacloud.compute.nfs.button_attach-filesystem-to-the-instance }}**. - * In the window that opens, select the file storage. - * Enter the device name. - * Click **{{ ui-key.yacloud.compute.nfs.button_attach-filesystem-to-the-instance }}**. - - +1. {% include [section-storages-secondary-disk](section-storages-secondary-disk.md) %} +1. {% include [section-storages-filesystem](section-storages-filesystem.md) %} 1. Under **{{ ui-key.yacloud.compute.instances.create.section_platform }}**: - * Choose a [platform](../../../compute/concepts/vm-platforms.md#gpu-platforms): - - - * {{ v100-broadwell }} - * {{ v100-cascade-lake }} - * {{ a100-epyc }} - * {{ t4-ice-lake }} - - - - * Select a VM [configuration](../../../compute/concepts/gpus.md#config) specifying the required number of GPUs. - * Make your VM [preemptible](../../../compute/concepts/preemptible-vm.md), if required. - - -1. Under **{{ ui-key.yacloud.compute.instances.create.section_network }}**: - - {% include [network-settings](../../../_includes/compute/network-settings.md) %} - -1. Under **{{ ui-key.yacloud.compute.instances.create.section_access }}**, specify the data required to access the VM: - * (Optional) Select or create a [service account](../../../iam/concepts/index.md#sa). With a service account, you can flexibly configure access rights for your resources. - For VMs with a Linux-based operating system: - * Enter the username in the **{{ ui-key.yacloud.compute.instances.create.field_user }}** field. + * Go to the **{{ ui-key.yacloud.component.compute.resources.label_tab-gpu }}** tab. + * Choose a [platform](../../../compute/concepts/vm-platforms.md#gpu-platforms): - {% note alert %} + * {{ v100-broadwell }} + * {{ v100-cascade-lake }} + * {{ a100-epyc }} + * {{ t4-ice-lake }} - Do not use the `root` username or other names reserved by the operating system. To perform operations that require superuser permissions, use the `sudo` command. + * Select one of the available configurations with the required GPUs, vCPUs, and amount of RAM. - {% endnote %} +1. {% include [network-settings](section-network.md) %} +1. {% include [section-access](section-access.md) %} - * In the **{{ ui-key.yacloud.compute.instances.create.field_key }}** field, paste the contents of the [public key](../../../compute/operations/vm-connect/ssh.md#creating-ssh-keys) file. +1. Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**, specify the VM name: - * (Optional) Enable access to the [serial console](../../../compute/operations/index.md#serial-console), if required. + {% include [name-format](../../name-format.md) %} - {% include [vm-connect-linux](../../../_includes/vm-connect-linux.md) %} + {% include [name-fqdn](../../compute/name-fqdn.md) %} -1. (Optional) Under **{{ ui-key.yacloud.compute.instances.create.section_placement }}**, select a VM [placement group](../../../compute/concepts/placement-groups.md). +1. {% include [section-additional](section-additional.md) %} 1. Click **{{ ui-key.yacloud.compute.instances.create.button_create }}**. -The virtual machine will appear in the list. +The virtual machine will appear in the list. \ No newline at end of file diff --git a/en/_includes/compute/create/section-access.md b/en/_includes/compute/create/section-access.md new file mode 100644 index 00000000000..ad3f6e46cd7 --- /dev/null +++ b/en/_includes/compute/create/section-access.md @@ -0,0 +1,17 @@ +Under **{{ ui-key.yacloud.compute.instances.create.section_access }}**, specify the data for access to the VM: + +* (Optional) [Enable VM access via OS Login](../../../compute/operations/vm-connect/os-login.md). The option is available for Linux images from [{{ marketplace-name }}](/marketplace) with `OS Login` in their names. +* Enter the username into the **{{ ui-key.yacloud.compute.instances.create.field_user }}** field. + + {% note alert %} + + Do not use `root` or other usernames reserved by the OS. To perform operations requiring superuser permissions, use the `sudo` command. + + {% endnote %} + +* In the **{{ ui-key.yacloud.compute.instances.create.field_key }}** field, paste the contents of the [public key](../../../compute/operations/vm-connect/ssh.md#creating-ssh-keys) file. You need to create a key pair for the SSH connection yourself. To learn how, see [Connecting to a VM via SSH](../../../compute/operations/vm-connect/ssh.md). + +If you want to add several users with SSH keys to the VM at the same time, [specify](../../../compute/concepts/vm-metadata.md#how-to-send-metadata) these users' data under **{{ ui-key.yacloud.common.metadata }}**. You can also use metadata to [install additional software](../../../compute/operations/vm-create/create-with-cloud-init-scripts.md) on a VM when creating it. + +{% include [vm-connect-linux](../../vm-connect-linux.md) %} + diff --git a/en/_includes/compute/create/section-additional.md b/en/_includes/compute/create/section-additional.md new file mode 100644 index 00000000000..8d7d95fbcfc --- /dev/null +++ b/en/_includes/compute/create/section-additional.md @@ -0,0 +1,9 @@ +Under **{{ ui-key.yacloud.compute.instances.create.section_additional }}**: + +* (Optional) Select or create a [service account](../../../iam/concepts/users/service-accounts.md). With a service account, you can flexibly configure access rights for your resources. +* (Optional) Grant access to the [serial console](../../../compute/operations/serial-console/index.md). +* (Optional) Under **Backup**, enable **{{ ui-key.yacloud.compute.instances.create.action_activate-backup }}** and select or create a [backup policy](../../../backup/concepts/policy.md) to back up your VMs automatically using [{{ backup-name }}](../../../backup/index.yaml). + + For more information, see [{#T}](../../../backup/concepts/vm-connection.md). +* (Optional) Under **{{ ui-key.yacloud.compute.instances.create.section_monitoring }}**, enable the **{{ ui-key.yacloud.compute.instances.create.unified-agent }}** option to configuire delivery of [metrics](../../../compute/metrics.md) to [{{ monitoring-full-name }}](../../../compute/monitoring/). +* (Optional) Under **{{ ui-key.yacloud.compute.instances.create.section_placement }}**, select a VM [placement group](../../../compute/concepts/placement-groups.md). \ No newline at end of file diff --git a/en/_includes/compute/create/section-network.md b/en/_includes/compute/create/section-network.md new file mode 100644 index 00000000000..4d948baa325 --- /dev/null +++ b/en/_includes/compute/create/section-network.md @@ -0,0 +1,33 @@ +Under **{{ ui-key.yacloud.compute.instances.create.section_network }}**: + +* In the **{{ ui-key.yacloud.component.compute.network-select.field_subnetwork }}** field, enter the ID of a subnet in the new VM’s availability zone. Alternatively, you can select a [cloud network](../../../vpc/concepts/network.md#network) from the list. + + * Each network must have at least one [subnet](../../../vpc/concepts/network.md#subnet). If there is no subnet, create one by selecting **{{ ui-key.yacloud.component.vpc.network-select.button_create-subnetwork }}**. + * If you do not have a network, click **{{ ui-key.yacloud.component.vpc.network-select.button_create-network }}** to create one: + + * In the window that opens, enter the network name and select the folder to host the network. + * (Optional) Select the **{{ ui-key.yacloud.vpc.networks.create.field_is-default }}** option to automatically create subnets in all availability zones. + * Click **{{ ui-key.yacloud.vpc.networks.create.button_create }}**. + +* In the **{{ ui-key.yacloud.component.compute.network-select.field_external }}** field, choose a method for assigning an IP address: + + * `{{ ui-key.yacloud.component.compute.network-select.switch_auto }}`: Assign a random IP address from the {{ yandex-cloud }} IP address pool. In this case, you can enable [DDoS protection](../../../vpc/ddos-protection/index.md) using the option below. + * `{{ ui-key.yacloud.component.compute.network-select.switch_list }}`: Select a public IP address from the list of previously reserved static addresses. For more information, see [{#T}](../../../vpc/operations/set-static-ip.md). + * `{{ ui-key.yacloud.component.compute.network-select.switch_none }}`: Do not assign a public IP address. + +* Select the [appropriate security groups](../../../vpc/concepts/security-groups.md). If you leave this field empty, the default security group will be assigned to the VM. + +* Expand the **{{ ui-key.yacloud.component.compute.network-select.section_additional }}** section and select a method for internal IP address assignment in the **{{ ui-key.yacloud.component.internal-v4-address-field.field_internal-ipv4-address }}** field: + + * `{{ ui-key.yacloud.common.label_auto }}`: Assign a random IP address from the pool of IP addresses available in the selected subnet. + * `{{ ui-key.yacloud.common.label_list }}`: Select a private IP address from the list of previously reserved IP addresses. Click **{{ ui-key.yacloud.component.internal-v4-address-field.button_internal-address-reserve }}** to reserve a private IP address in the selected subnet if needed. + * Enable the **{{ ui-key.yacloud.common.field_ddos-protection-provider }}** option, if needed. The option is available if you previously selected the automatic IP assignment method in the public address settings. + +* (Optional) Create records for the VM in the [DNS zone](../../../dns/concepts/dns-zone.md): + + * Expand the **{{ ui-key.yacloud.dns.label_dns-internal-settings }}** section and click **{{ ui-key.yacloud.dns.button_add-record }}**. + * Specify the zone, FQDN, and TTL for the record. When setting the FQDN, you can select `{{ ui-key.yacloud.dns.label_auto-select-zone }}` for the zone. + You can add multiple records to [internal DNS zones](../../../dns/concepts/dns-zone.md). For more information, see [Cloud DNS integration with Compute Cloud](../../../dns/concepts/compute-integration.md). + * To create another record, click **{{ ui-key.yacloud.dns.button_add-record }}**. + +If you want to attach an additional [network interface](../../../compute/concepts/network.md) to your VM, click **{{ ui-key.yacloud.compute.instances.create.label_add-network-interface }}** and repeat the settings from this step for the new interface. You can add up to eight network interfaces to a single VM. \ No newline at end of file diff --git a/en/_includes/compute/create/section-platform.md b/en/_includes/compute/create/section-platform.md new file mode 100644 index 00000000000..b76474f9753 --- /dev/null +++ b/en/_includes/compute/create/section-platform.md @@ -0,0 +1,7 @@ +Under **{{ ui-key.yacloud.compute.instances.create.section_platform }}**, select a preset configuration or create a new one. To create a configuration: + +* Go to the **{{ ui-key.yacloud.component.compute.resources.label_tab-custom }}** tab. +* Choose a [platform](../../../compute/concepts/vm-platforms.md). +* Specify the [guaranteed share](../../../compute/concepts/performance-levels.md) and required number of vCPUs, as well as RAM size. +* Enable a [software-accelerated network](../../../compute/concepts/software-accelerated-network.md) if needed. +* If required, make your VM [preemptible](../../../compute/concepts/preemptible-vm.md). \ No newline at end of file diff --git a/en/_includes/compute/create/section-storages-filesystem.md b/en/_includes/compute/create/section-storages-filesystem.md new file mode 100644 index 00000000000..f431515b0df --- /dev/null +++ b/en/_includes/compute/create/section-storages-filesystem.md @@ -0,0 +1,9 @@ +(Optional) Connect a [file storage](../../../compute/concepts/filesystem.md): + +* Under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}**, click **{{ ui-key.yacloud.compute.instances.create-disk.button_create }}**. + + * In the window that opens, select **File storage** and select the storage you want to connect from the list. + + If you do not have any file storages, click **{{ ui-key.yacloud.compute.nfs.button_create-filesystem }}** to create a new one. + + * Click **Add file storage**. \ No newline at end of file diff --git a/en/_includes/compute/create/section-storages-secondary-disk.md b/en/_includes/compute/create/section-storages-secondary-disk.md new file mode 100644 index 00000000000..b856fec677d --- /dev/null +++ b/en/_includes/compute/create/section-storages-secondary-disk.md @@ -0,0 +1,14 @@ +(Optional) Add a secondary [disk](../../../compute/concepts/disk.md): + +* Under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}**, click **{{ ui-key.yacloud.compute.instances.create-disk.button_create }}** +* In the window that opens, select **{{ ui-key.yacloud.compute.instances.create-disk.value_source-disk }}**. You can select an existing disk or create a new one, either empty or from a snapshot / image. + + For example, to create a new empty disk: + + * Select `Create new`. + * In the **{{ ui-key.yacloud.compute.instances.create-disk.field_source }}** field, select `{{ ui-key.yacloud.compute.instances.create-disk.value_source-none }}`. + * Specify the disk name. + * Select the [disk type](../../../compute/concepts/disk.md#disks_types). + * Specify the required disk size and block size. + * (Optional) Enable the **{{ ui-key.yacloud.compute.field_additional }}** option in the **{{ ui-key.yacloud.compute.field_disk-autodelete }}** field if you need to automatically delete this disk when deleting the VM. + * Click **{{ ui-key.yacloud.compute.component.instance-storage-dialog.button_add-disk }}**. \ No newline at end of file diff --git a/en/_includes/compute/encryption-section-boot.md b/en/_includes/compute/encryption-section-boot.md deleted file mode 100644 index 59e0eb7d520..00000000000 --- a/en/_includes/compute/encryption-section-boot.md +++ /dev/null @@ -1,9 +0,0 @@ -(Optional) To [encrypt](../../compute/concepts/encryption.md) a boot disk, under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}**, configure encryption parameters for the disk: - -* Select the **Encrypted disk** option. -* In the **{{ kms-short-name }} Key** field, select the [key](../../kms/concepts/key.md) with which you want to encrypt the disk. To [create](../../kms/operations/key.md#create) a new key, click **Create**. -* In the **Service account** field, select the [service account](../../iam/concepts/users/service-accounts.md) with the `kms.keys.encrypterDecrypter` [role](../../kms/security/index.md#kms-keys-encrypterDecrypter) for the specified key. To [create](../../iam/operations/sa/create.md) a service account, click **Create**. - -{% include [encryption-preview-note](encryption-preview-note.md) %} - -{% include [encryption-keys-note](encryption-keys-note.md) %} diff --git a/en/_includes/compute/encryption-section-secondary.md b/en/_includes/compute/encryption-section-secondary.md index 8ef8a8565e5..be56726843b 100644 --- a/en/_includes/compute/encryption-section-secondary.md +++ b/en/_includes/compute/encryption-section-secondary.md @@ -1 +1,9 @@ -(Optional) To encrypt a disk, configure encryption parameters. +(Optional) To [encrypt](../../compute/concepts/encryption.md) a boot disk or a secondary disk, under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}**, click ![image](../../_assets/console-icons/pencil.svg) to the right of the disk name and set encryption parameters for the disk: + +* Select **{{ ui-key.yacloud.compute.disk-form.label_disk-encryption }}**. +* In the **{{ ui-key.yacloud.compute.disk-form.label_disk-kms-key }}** field, select the [key](../../kms/concepts/key.md) to encrypt the disk with. To [create](../../kms/operations/key.md#create) a new key, click **{{ ui-key.yacloud.component.symmetric-key-select.button_create-key-new }}**. +* In the **{{ ui-key.yacloud.compute.disk-form.label_service-account }}** field, select a [service account](../../iam/concepts/users/service-accounts.md) with the `kms.keys.encrypterDecrypter` [role](../../kms/security/index.md#kms-keys-encrypterDecrypter) for the specified key. To [create](../../iam/operations/sa/create.md) a service account, click **{{ ui-key.yacloud.component.service-account-select.button_create-account-new }}**. + +{% include [encryption-preview-note](encryption-preview-note.md) %} + +{% include [encryption-keys-note](encryption-keys-note.md) %} diff --git a/en/_includes/compute/gpu-os.md b/en/_includes/compute/gpu-os.md index 83895e8ce21..e2c9fc2b688 100644 --- a/en/_includes/compute/gpu-os.md +++ b/en/_includes/compute/gpu-os.md @@ -1,4 +1,3 @@ - For VMs with GPUs, you can use the following special images of operating systems with NVIDIA drivers: {{ v100-broadwell }} and {{ v100-cascade-lake }} @@ -15,5 +14,4 @@ For VMs with GPUs, you can use the following special images of operating systems : * [Ubuntu 20.04 LTS GPU A100](/marketplace/products/yc/ubuntu-20-04-lts-gpu-a100) (`ubuntu-2004-lts-a100`) * [Ubuntu 18.04 LTS GPU A100](/marketplace/products/yc/ubuntu-18-04-lts-gpu-a100) (`ubuntu-1804-lts-a100`) -We recommend using a standard image from {{ yandex-cloud }}. You can also [install the drivers](../../compute/operations/vm-operate/install-nvidia-drivers.md) on another standard image yourself or [create a custom image](../../compute/operations/image-create/custom-image.md) with pre-installed drivers. - +We recommend using a standard image from {{ yandex-cloud }}. You can also [install the drivers](../../compute/operations/vm-operate/install-nvidia-drivers.md) on another standard image yourself or [create a custom image](../../compute/operations/image-create/custom-image.md) with pre-installed drivers. \ No newline at end of file diff --git a/en/_includes/compute/network-settings.md b/en/_includes/compute/network-settings.md deleted file mode 100644 index d6d73a9e10c..00000000000 --- a/en/_includes/compute/network-settings.md +++ /dev/null @@ -1,29 +0,0 @@ -* Enter a subnet ID or select a [cloud network](../../vpc/concepts/network.md#network) from the list. - If you do not have a network, click ![image](../../_assets/console-icons/plus.svg) **{{ ui-key.yacloud.component.vpc.network-select.button_create-network }}** to create one: - - * In the window that opens, enter the network name and specify the folder to host the network. - * (Optional) To automatically create subnets, select the **{{ ui-key.yacloud.vpc.networks.create.field_is-default }}** option. - * Click **{{ ui-key.yacloud.vpc.networks.create.button_create }}**. - Each network must have at least one [subnet](../../vpc/concepts/network.md#subnet). If there is no subnet, create one by selecting ![image](../../_assets/console-icons/plus.svg) **{{ ui-key.yacloud.component.vpc.network-select.button_create-subnetwork }}**. - -* In the **{{ ui-key.yacloud.component.compute.network-select.field_external }}** field, choose a method for assigning an IP address: - - * `{{ ui-key.yacloud.component.compute.network-select.switch_auto }}`: Assign a random IP address from the {{ yandex-cloud }} IP pool. With this, you can enable [DDoS protection](../../vpc/ddos-protection/index.md) using the option below. - * `{{ ui-key.yacloud.component.compute.network-select.switch_list }}`: Select a public IP address from the list of previously reserved static addresses. For more information, see [{#T}](../../vpc/operations/set-static-ip.md). - * `{{ ui-key.yacloud.component.compute.network-select.switch_none }}`: Do not assign a public IP address. - -* Select the [appropriate security groups](../../vpc/concepts/security-groups.md). - -* Expand the **{{ ui-key.yacloud.component.compute.network-select.section_additional }}** section and select a method for internal IP address assignment in the **{{ ui-key.yacloud.component.internal-v4-address-field.field_internal-ipv4-address }}** field: - * `{{ ui-key.yacloud.common.label_auto }}`: Assign a random IP address from the pool of IP addresses available in the selected subnet. - * `{{ ui-key.yacloud.common.label_list }}`: Select an internal IP address from the list of previously reserved IP addresses. Click **{{ ui-key.yacloud.component.internal-v4-address-field.button_internal-address-reserve }}** to reserve an internal IP address in the selected subnet if needed. - * Enable the **{{ ui-key.yacloud.common.field_ddos-protection-provider }}** option, if needed. The option is available if you previously selected the automatic IP assignment method in the public address settings. - -* (Optional) Create records for the VM in the [DNS zone](../../dns/concepts/dns-zone.md): - - * Expand the **{{ ui-key.yacloud.dns.label_dns-internal-settings }}** section and click **{{ ui-key.yacloud.dns.button_add-record }}**. - * Specify the zone, FQDN, and TTL for the record. When setting the FQDN, you can select `{{ ui-key.yacloud.dns.label_auto-select-zone }}` for the zone. - You can add multiple records to [internal DNS zones](../../dns/concepts/dns-zone.md). For more information, see [Cloud DNS integration with Compute Cloud](../../dns/concepts/compute-integration.md). - * To create another record, click **{{ ui-key.yacloud.dns.button_add-record }}**. - -If you want to attach an additional [network interface](../../compute/concepts/network.md) to your VM, click **{{ ui-key.yacloud.compute.instances.create.label_add-network-interface }}** and repeat the settings from this step for the new interface. You can add up to eight network interfaces to a single VM. \ No newline at end of file diff --git a/en/_includes/compute/os-login-certificate-short-lived.md b/en/_includes/compute/os-login-certificate-short-lived.md new file mode 100644 index 00000000000..3c56b4035c8 --- /dev/null +++ b/en/_includes/compute/os-login-certificate-short-lived.md @@ -0,0 +1,5 @@ +{% note info %} + +The certificate is valid for one hour. After this time has elapsed, you will need to [export](../../compute/operations/vm-connect/os-login-export-certificate.md) a new certificate to connect to the VM. + +{% endnote %} \ No newline at end of file diff --git a/en/_includes/compute/oslogin-connect-cert-enable-in-org.md b/en/_includes/compute/oslogin-connect-cert-enable-in-org.md new file mode 100644 index 00000000000..7b574f8b23f --- /dev/null +++ b/en/_includes/compute/oslogin-connect-cert-enable-in-org.md @@ -0,0 +1,3 @@ +[Enable](../../organization/operations/os-login-access.md) access via OS Login at the organization level. + +To connect to a VM via OS Login using an SSH certificate, enable **{{ ui-key.yacloud_org.form.oslogin-settings.title_ssh-certificate-settings }}**. \ No newline at end of file diff --git a/en/_includes/compute/oslogin-connect-instr-create-ssh-key.md b/en/_includes/compute/oslogin-connect-instr-create-ssh-key.md new file mode 100644 index 00000000000..e15ac7fd797 --- /dev/null +++ b/en/_includes/compute/oslogin-connect-instr-create-ssh-key.md @@ -0,0 +1 @@ +[Create](../../compute/operations/vm-connect/ssh.md#creating-ssh-keys) an SSH key pair and [add](../../organization/operations/add-ssh.md) the public key to the OS Login profile of a user or [service account](../../iam/concepts/users/service-accounts.md). Remember where your private key is stored, as you will need it to connect to a VM. \ No newline at end of file diff --git a/en/_includes/compute/oslogin-connect-instr-list-vms.md b/en/_includes/compute/oslogin-connect-instr-list-vms.md new file mode 100644 index 00000000000..edc12914668 --- /dev/null +++ b/en/_includes/compute/oslogin-connect-instr-list-vms.md @@ -0,0 +1,16 @@ +Get a list of all VMs in the default folder: + +```bash +yc compute instance list +``` + +Result: + +```text ++----------------------+-----------------+---------------+---------+---------------+--------------+ +| ID | NAME | ZONE ID | STATUS | EXTERNAL IP | INTERNAL IP | ++----------------------+-----------------+---------------+---------+---------------+--------------+ +| fhm0b28lgf********** | first-instance | {{ region-id }}-a | RUNNING | 158.160.**.** | 192.168.0.8 | +| fhm9gk85nj********** | second-instance | {{ region-id }}-a | RUNNING | 51.250.**.*** | 192.168.0.12 | ++----------------------+-----------------+---------------+---------+---------------+--------------+ +``` \ No newline at end of file diff --git a/en/_includes/compute/oslogin-connect-key-enable-in-org.md b/en/_includes/compute/oslogin-connect-key-enable-in-org.md new file mode 100644 index 00000000000..7a4d1239e05 --- /dev/null +++ b/en/_includes/compute/oslogin-connect-key-enable-in-org.md @@ -0,0 +1,5 @@ +[Enable](../../organization/operations/os-login-access.md) access via OS Login at the organization level. + +To connect to a VM via OS Login using an SSH certificate, enable **{{ ui-key.yacloud_org.form.oslogin-settings.title_user-ssh-key-settings }}**. + +To add an SSH key to an organization user profile, enable **{{ ui-key.yacloud_org.form.oslogin-settings.title_allow-edit-own-keys }}**. \ No newline at end of file diff --git a/en/_includes/compute/oslogin-connect-with-cli.md b/en/_includes/compute/oslogin-connect-with-cli.md index 41be9a2a6d0..d416b01dd7e 100644 --- a/en/_includes/compute/oslogin-connect-with-cli.md +++ b/en/_includes/compute/oslogin-connect-with-cli.md @@ -1,52 +1,26 @@ To connect to a VM via OS Login with an SSH certificate using the YC CLI: -1. [Enable](../../organization/operations/os-login-access.md) access via OS Login at the organization level. - - To connect to a VM via OS Login with an SSH certificate using the YC CLI, enable **{{ ui-key.yacloud_org.form.oslogin-settings.title_ssh-certificate-settings }}**. - +1. {% include [oslogin-connect-cert-enable-in-org](../../_includes/compute/oslogin-connect-cert-enable-in-org.md) %} 1. View the description of the CLI command to connect to a VM: ```bash yc compute ssh --help ``` - -1. Get a list of all VMs in the default folder: +1. {% include [os-login-cli-organization-list](../../_includes/organization/os-login-cli-organization-list.md) %} +1. {% include [os-login-cli-profile-list](../../_includes/organization/os-login-cli-profile-list.md) %} +1. {% include [oslogin-connect-instr-list-vms](../../_includes/compute/oslogin-connect-instr-list-vms.md) %} +1. Connect to the VM: ```bash - yc compute instance list - ``` - - Result: - - ```text - +----------------------+-----------------+---------------+---------+----------------------+ - | ID | NAME | ZONE ID | STATUS | DESCRIPTION | - +----------------------+-----------------+---------------+---------+----------------------+ - | fhm0b28lgf********** | first-instance | {{ region-id }}-a | RUNNING | my first vm via CLI | - | fhm9gk85nj********** | second-instance | {{ region-id }}-a | RUNNING | my second vm via CLI | - +----------------------+-----------------+---------------+---------+----------------------+ + yc compute ssh \ + --name + --login + --internal-address ``` -1. Connect to the VM: - - To connect via OS login, use the VM name: - - ```bash - yc compute ssh \ - --name - ``` - - When connecting via OS Login, you can specify the VM ID instead of its name: - - ```bash - yc compute ssh \ - --id - ``` + Where: + * `--name`: Previously obtained VM name. You can specify the VM ID instead of its name by using the `--id` parameter. + * `--login`: Previously obtained user or service account login, as set in the OS Login profile. This is an optional parameter. If this parameter is not specified, the connection will use the SSH certificate of the user or service account currently authorized in the YC CLI profile. + * (Optional) `--internal-address`: To connect using an internal IP address. - To connect via OS login by an internal IP address, use the `--internal-address` parameter: - - ```bash - yc compute ssh \ - --name \ - --internal-address - ``` \ No newline at end of file + You can also see the command for VM connection in the [management console]({{ link-console-main }}). On the **{{ ui-key.yacloud.compute.instance.overview.label_title }}** page of the VM you need, under **Connect to VM**, expand the **Connect via the {{ yandex-cloud }} CLI interface** section and select the **Certificate** tab. \ No newline at end of file diff --git a/en/_includes/compute/oslogin-connect-with-exported-cert.md b/en/_includes/compute/oslogin-connect-with-exported-cert.md index 7a5147c7a90..46d02660966 100644 --- a/en/_includes/compute/oslogin-connect-with-exported-cert.md +++ b/en/_includes/compute/oslogin-connect-with-exported-cert.md @@ -1,91 +1,26 @@ -You can use a standard SSH client or exported OS Login certificate to connect to a VM with OS Login access enabled. To do this, [assign](../../iam/operations/roles/grant.md) the `compute.osLogin` or `compute.osAdminLogin` role to the user or service account holding the certificate. +To connect to a VM via OS Login with an SSH certificate using a standard SSH client: -To connect to a VM via OS Login using a standard SSH client, [export](../../compute/operations/vm-connect/os-login-export-certificate.md) the OS Login certificate to your local computer and specify this certificate when connecting to a VM: - -1. [Enable](../../organization/operations/os-login-access.md) access via OS Login at the organization level. - - To connect to a VM via OS Login using an SSH certificate over a standard SSH client, enable **{{ ui-key.yacloud_org.form.oslogin-settings.title_ssh-certificate-settings }}**. - -1. Get a list of all VMs in the default folder: - - ```bash - yc compute instance list - ``` - - Result: - - ```text - +----------------------+-----------------+---------------+---------+---------------+--------------+ - | ID | NAME | ZONE ID | STATUS | EXTERNAL IP | INTERNAL IP | - +----------------------+-----------------+---------------+---------+---------------+--------------+ - | fhm0b28lgf********** | first-instance | {{ region-id }}-a | RUNNING | 158.160.**.** | 192.168.0.8 | - | fhm9gk85nj********** | second-instance | {{ region-id }}-a | RUNNING | 51.250.**.*** | 192.168.0.12 | - +----------------------+-----------------+---------------+---------+---------------+--------------+ - ``` - -1. Get a [public address](../../vpc/concepts/address.md#public-addresses) of the VM by specifying its ID: - - ```bash - yc compute instance get \ - --id - ``` - - {% cut "Result:" %} - - ```yaml - id: fhm0b28lgf********** - folder_id: b1gt6g8ht345******** - created_at: "2023-12-09T06:23:04Z" - name: first-instance - zone_id: {{ region-id }}-a - platform_id: standard-v3 - resources: - memory: "2147483648" - cores: "2" - core_fraction: "100" - status: RUNNING - metadata_options: - gce_http_endpoint: ENABLED - aws_v1_http_endpoint: ENABLED - gce_http_token: ENABLED - aws_v1_http_token: DISABLED - boot_disk: - mode: READ_WRITE - device_name: epd9m2csd95p******** - auto_delete: true - disk_id: epd9m2csd95p******** - network_interfaces: - - index: "0" - mac_address: d0:0d:87:75:**:** - subnet_id: e2li9tcgi7ii******** - primary_v4_address: - address: 192.168.0.8 - one_to_one_nat: - address: 158.160.**.** - ip_version: IPV4 - gpu_settings: {} - fqdn: first-instance.{{ region-id }}.internal - scheduling_policy: {} - network_settings: - type: STANDARD - placement_policy: {} - ``` - - You can find the VM public address in the `network_interfaces.primary_v4_address.one_to_one_nat.address` field. - - {% endcut %} +1. {% include [oslogin-connect-cert-enable-in-org](../../_includes/compute/oslogin-connect-cert-enable-in-org.md) %} +1. [Export](../../compute/operations/vm-connect/os-login-export-certificate.md) the SSH certificate to your local computer. +1. {% include [os-login-cli-organization-list](../../_includes/organization/os-login-cli-organization-list.md) %} +1. {% include [os-login-cli-profile-list](../../_includes/organization/os-login-cli-profile-list.md) %} +1. {% include [oslogin-connect-instr-list-vms](../../_includes/compute/oslogin-connect-instr-list-vms.md) %} + Save the public IP address (the `EXTERNAL IP` value) of the VM you want to connect to. 1. Connect to the VM: ```bash - ssh -i @ + ssh -i \ + -l ``` Where: - * ``: Path to the previously saved `Identity` file of the certificate. e.g., `/home/user1/.ssh/yc-cloud-id-b1gia87mbaom********-orgusername`. - * ``: Organization user's name. You can see the username at the end of the exported OS Login certificate. In the example above, it is `orgusername`. - * ``: VM public IP address obtained earlier. + * ``: Path to the certificate’s `Identity` file you exported previously, e.g., `/home/user1/.ssh/yc-cloud-id-b1gia87mbaom********-orgusername`. + * ``: Previously obtained user or [service account](../../iam/concepts/users/service-accounts.md) login, as set in the OS Login profile. + * ``: VM public IP address you saved earlier. + + You can also see the command for VM connection in the [management console]({{ link-console-main }}). On the **{{ ui-key.yacloud.compute.instance.overview.label_title }}** page of the VM you need, under **Connect to VM**, expand the **Connect via SSH client** section and select the **Certificate** tab. If this is your first time connecting to the VM, you will see an unknown host warning: diff --git a/en/_includes/compute/oslogin-connect-with-key.md b/en/_includes/compute/oslogin-connect-with-key.md index 540ee1c4310..4f68767af0c 100644 --- a/en/_includes/compute/oslogin-connect-with-key.md +++ b/en/_includes/compute/oslogin-connect-with-key.md @@ -1,41 +1,29 @@ -You can use a custom SSH key to connect to VMs with OS Login access enabled. To do this, [create](../../compute/operations/vm-connect/ssh.md#creating-ssh-keys) an SSH key, [add](../../organization/operations/add-ssh.md) it to the organization user or service account profile in {{ org-full-name }}, and specify the following when connecting: +To connect to a VM instance via OS Login with an SSH key using the YC CLI: -1. [Enable](../../organization/operations/os-login-access.md) access via OS Login at the organization level. - - To connect to a VM via OS Login using an SSH key over the YC CLI, enable **{{ ui-key.yacloud_org.form.oslogin-settings.title_user-ssh-key-settings }}**. - -1. Get a list of all VMs in the default folder: +1. {% include [oslogin-connect-key-enable-in-org](../../_includes/compute/oslogin-connect-key-enable-in-org.md) %} +1. {% include [oslogin-connect-instr-create-ssh-key](../../_includes/compute/oslogin-connect-instr-create-ssh-key.md) %} +1. View the description of the CLI command to connect to a VM: ```bash - yc compute instance list + yc compute ssh --help ``` - - Result: - - ```text - +----------------------+-----------------+---------------+---------+---------------+--------------+ - | ID | NAME | ZONE ID | STATUS | EXTERNAL IP | INTERNAL IP | - +----------------------+-----------------+---------------+---------+---------------+--------------+ - | fhm0b28lgf********** | first-instance | {{ region-id }}-a | RUNNING | 158.160.**.** | 192.168.0.8 | - | fhm9gk85nj********** | second-instance | {{ region-id }}-a | RUNNING | 51.250.**.*** | 192.168.0.12 | - +----------------------+-----------------+---------------+---------+---------------+--------------+ - ``` - +1. {% include [os-login-cli-organization-list](../../_includes/organization/os-login-cli-organization-list.md) %} +1. {% include [os-login-cli-profile-list](../../_includes/organization/os-login-cli-profile-list.md) %} +1. {% include [oslogin-connect-instr-list-vms](../../_includes/compute/oslogin-connect-instr-list-vms.md) %} 1. Connect to the VM: ```bash yc compute ssh \ --name \ --identity-file \ - --login \ + --login \ --internal-address ``` Where: - * `--name`: Previously obtained VM name. You can specify the VM ID instead of its name by using the `--id` parameter. - * `--identity-file`: Path to the previously saved private SSH key file, e.g., `/home/user1/.ssh/id_ed25519`. - * `--login`: OS Login username. + * `--identity-file`: Path to a private SSH key file, e.g., `/home/user1/.ssh/id_ed25519`. + * `--login`: Previously obtained user or service account login, as set in the OS Login profile. This is an optional parameter. If this parameter is not specified, the connection will use the SSH certificate of the user or service account currently authorized in the YC CLI profile. * (Optional) `--internal-address`: To connect using an internal IP address. -You will connect to the specified virtual machine using your SSH key. If this is your first time connecting to this VM, a new user profile will be created in the VM's operating system. \ No newline at end of file + You can also see the command for VM connection in the [management console]({{ link-console-main }}). On the **{{ ui-key.yacloud.compute.instance.overview.label_title }}** page of the VM you need, under **Connect to VM**, expand the **Connect via the {{ yandex-cloud }} CLI interface** section and select the **SSH key** tab. \ No newline at end of file diff --git a/en/_includes/compute/oslogin-export-certificate.md b/en/_includes/compute/oslogin-export-certificate.md index d0d63bfb8ae..470275c456a 100644 --- a/en/_includes/compute/oslogin-export-certificate.md +++ b/en/_includes/compute/oslogin-export-certificate.md @@ -1,48 +1,34 @@ -To export an OS Login user certificate from an organization to your local computer: +To export the SSH certificate of a {{ org-name }} organization user or [service account](../../iam/concepts/users/service-accounts.md) to a local computer: {% list tabs group=instructions %} + - CLI {#cli} {% include [cli-install](../cli-install.md) %} {% include [default-catalogue](../default-catalogue.md) %} - 1. See the description of the CLI command for exporting an OS Login certificate to a local directory: + 1. See the description of the CLI command for exporting an SSH certificate to a local directory: ```bash yc compute ssh certificate export --help ``` - - 1. If you have multiple organizations, get the ID of the organization you want to export the certificate from. If you have a single organization, skip this step. - - ```bash - yc organization-manager organization list - ``` - - Result: - - ```text - +----------------------+-------------------------+-------------------------+ - | ID | NAME | TITLE | - +----------------------+-------------------------+-------------------------+ - | bpf1smsil5q0******** | sample-organization1 | Organization 1 | - | bpf2c65rqcl8******** | sample-organization2 | Organization 2 | - | bpf6dne49ue8******** | sample-organization3 | Organization 3 | - +----------------------+-------------------------+-------------------------+ - ``` - + 1. {% include [os-login-cli-organization-list](../../_includes/organization/os-login-cli-organization-list.md) %} + 1. {% include [os-login-cli-profile-list](../../_includes/organization/os-login-cli-profile-list.md) %} 1. Export the certificate: ```bash yc compute ssh certificate export \ + --login --organization-id \ --directory ``` Where: - * `--organization-id`: Previously obtained ID of the organization to export the OS Login certificate from. This is an optional parameter. If omitted, the certificate will be exported from the organization the default folder belongs to. - * `--directory`: Path to the local directory to save the exported OS Login certificate to. This is an optional parameter. If not specified, the certificate will be saved by default to the `.ssh` home directory of the current PC user (`~/.ssh/`). + * `--login`: Previously obtained user or service account login, as set in the OS Login profile. This is an optional parameter. If you do not set this parameter, you will export the SSH certificate of the user or service account currently authorized in the YC CLI profile. + * `--organization-id`: Previously obtained ID of the organization to export the SSH certificate from. This is an optional parameter. If omitted, the certificate will be exported from the organization the default folder belongs to. + * `--directory`: Path to the local directory to save the exported SSH certificate to. This is an optional parameter. If not specified, the certificate will be saved by default to the `.ssh` home directory of the current PC user (`~/.ssh/`). Result: diff --git a/en/_includes/compute/oslogin-ssh-connect-with-ssh-key.md b/en/_includes/compute/oslogin-ssh-connect-with-ssh-key.md new file mode 100644 index 00000000000..f9df306ffcf --- /dev/null +++ b/en/_includes/compute/oslogin-ssh-connect-with-ssh-key.md @@ -0,0 +1,33 @@ +To connect to a VM instance via OS Login with an SSH key using a standard SSH client: + +1. {% include [oslogin-connect-key-enable-in-org](../../_includes/compute/oslogin-connect-key-enable-in-org.md) %} +1. {% include [oslogin-connect-instr-create-ssh-key](../../_includes/compute/oslogin-connect-instr-create-ssh-key.md) %} +1. {% include [os-login-cli-organization-list](../../_includes/organization/os-login-cli-organization-list.md) %} +1. {% include [os-login-cli-profile-list](../../_includes/organization/os-login-cli-profile-list.md) %} +1. {% include [oslogin-connect-instr-list-vms](../../_includes/compute/oslogin-connect-instr-list-vms.md) %} + + Save the public IP address (the `EXTERNAL IP` value) of the VM you want to connect to. +1. Connect to the VM: + + ```bash + ssh -i \ + -l + ``` + + Where: + + * ``: Path to the file containing the private SSH key, e.g., `/home/user1/.ssh/id_ed25519`. + * ``: Previously obtained user or service account login, as set in the OS Login profile. + * ``: VM public IP address you saved earlier. + + You can also see the command for VM connection in the [management console]({{ link-console-main }}). On the **{{ ui-key.yacloud.compute.instance.overview.label_title }}** page of the VM you need, under **Connect to VM**, expand the **Connect via SSH client** section and select the **SSH key** tab. + + If this is your first time connecting to the VM, you will see an unknown host warning: + + ```text + The authenticity of host '158.160.**.** (158.160.**.**)' can't be established. + ECDSA key fingerprint is SHA256:PoaSwqxRc8g6iOXtiH7ayGHpSN0MXwUfWHk********. + Are you sure you want to continue connecting (yes/no)? + ``` + + Type `yes` in the terminal and press **Enter**. \ No newline at end of file diff --git a/en/_includes/compute/software-accelerated-network.md b/en/_includes/compute/software-accelerated-network.md index 5d575d99769..b8882ffc3a2 100644 --- a/en/_includes/compute/software-accelerated-network.md +++ b/en/_includes/compute/software-accelerated-network.md @@ -3,6 +3,7 @@ In the {{ yandex-cloud }} infrastructure, all VMs run in the [QEMU-KVM](https://en.wikipedia.org/wiki/QEMU) virtualization environment. A *hypervisor* proportionally distributes the computing load across all processor cores allocated to a VM. The computing load can be logically divided into three parts: + * User load: OS processes and user processes run in the OS of a user VM. * Processes maintaining the operation of [network disks](../../compute/concepts/disk.md). * Processes for handling the VM's network traffic. @@ -44,9 +45,9 @@ The [cost](../../compute/pricing.md#software-accelerated-network) of additional To enable a software-accelerated network: -* Select the **{{ ui-key.yacloud.component.compute.resources.label_sw-accelerated-net }}** option when [creating a new VM](../../compute/operations/vm-create/create-linux-vm.md) or [reconfigure](../../compute/operations/vm-control/vm-update-resources.md#enable-software-accelerated-network) an existing VM. +* Select the **{{ ui-key.yacloud.component.compute.resources.field_sw-accelerated-net }}** option when [creating a new VM](../../compute/operations/vm-create/create-linux-vm.md) or [reconfigure](../../compute/operations/vm-control/vm-update-resources.md#enable-software-accelerated-network) an existing VM. -* Enable the **{{ ui-key.yacloud.component.compute.resources.label_sw-accelerated-net }}** option in the basic VM configuration when [creating an instance group](../../compute/operations/instance-groups/create-fixed-group.md) or set the `network_settings.type` key to `SOFTWARE_ACCELERATED` in the [YAML specification](../../compute/concepts/instance-groups/specification.md). +* Enable the **{{ ui-key.yacloud.component.compute.resources.field_sw-accelerated-net }}** option in the basic VM configuration when [creating an instance group](../../compute/operations/instance-groups/create-fixed-group.md) or set the `network_settings.type` key to `SOFTWARE_ACCELERATED` in the [YAML specification](../../compute/concepts/instance-groups/specification.md). ## Recommendations for using a software-accelerated network {#use-cases} diff --git a/en/_includes/data-transfer/fields/postgresql/ui/connection-manager.md b/en/_includes/data-transfer/fields/postgresql/ui/connection-manager.md index 074bf8d8415..409b9fb465a 100644 --- a/en/_includes/data-transfer/fields/postgresql/ui/connection-manager.md +++ b/en/_includes/data-transfer/fields/postgresql/ui/connection-manager.md @@ -1,6 +1,6 @@ **{{ ui-key.yc-data-transfer.data-transfer.console.form.common.console.form.common.Connection.authorization_connman.title }}**: Enables using a database conection via [{{ connection-manager-full-name }}](../../../../../metadata-hub/quickstart/connection-manager.md): -* **{{ ui-key.yc-data-transfer.data-transfer.console.form.postgres.console.form.postgres.ConnmanConnection.connection_id.title }}**: Specify a connection ID from {{ connection-manager-name }}. +* **{{ ui-key.yc-data-transfer.data-transfer.console.form.common.console.form.common.ConnmanConnection.connection_id.title }}**: Specify a connection ID from {{ connection-manager-name }}. * {% include [database](../../../fields/postgresql/ui/database.md) %} diff --git a/en/_includes/datasphere/dag-load-job-results.md b/en/_includes/datasphere/dag-load-job-results.md new file mode 100644 index 00000000000..e8576259288 --- /dev/null +++ b/en/_includes/datasphere/dag-load-job-results.md @@ -0,0 +1,29 @@ +You can use a DAG operator to load the output file of one job (`result.txt`) and provide it as an input file (`INPUT_DATA`) for another: + +{% list tabs group=programming_language %} + +- Python {#bash} + + ```python + from typing import Dict + + from airflow.decorators import dag, task + import pendulum + + from datasphere import SDK + + now = pendulum.now() + + @dag(dag_id='output_files_for_other_job', start_date=now, schedule="@daily", catchup=False) + def run(): + @task(task_id='fork_job') + def fork_job(files_job_id: str, fork_source_job_id: str): + sdk = SDK() + sdk.download_job_files(files_job_id) + job = sdk.fork_job(fork_source_job_id, vars={'INPUT_DATA': 'result.txt'}) + job.wait() + + fork_job('', '') + ``` + +{% endlist %} \ No newline at end of file diff --git a/en/_includes/instance-groups/create-autoscaled-group-via-concole.md b/en/_includes/instance-groups/create-autoscaled-group-via-concole.md index cba26796cbc..94908319339 100644 --- a/en/_includes/instance-groups/create-autoscaled-group-via-concole.md +++ b/en/_includes/instance-groups/create-autoscaled-group-via-concole.md @@ -5,13 +5,13 @@ 1. Under **{{ ui-key.yacloud.compute.groups.create.section_base }}**: * Enter a name and description of the instance group. The naming requirements are as follows: - {% include [name-format](../name-format.md) %} + {% include [name-format](../name-format.md) %} - {% include [name-fqdn](../compute/name-fqdn.md) %} + {% include [name-fqdn](../compute/name-fqdn.md) %} - * Select a [service account](../../iam/concepts/users/service-accounts.md) from the list or create a new one. To be able to create, update, and delete instances in the instance group, assign the `editor` role to the service account. By default, all operations in {{ ig-name }} are performed on behalf of a service account. + * Select a [service account](../../iam/concepts/users/service-accounts.md) from the list or create a new one. To be able to create, update, and delete VM instances in the instance group, assign the `editor` role to the service account. By default, all operations in {{ ig-name }} are performed on behalf of a service account. - {% include [sa-dependence-brief](../../_includes/instance-groups/sa-dependence-brief.md) %} + {% include [sa-dependence-brief](../../_includes/instance-groups/sa-dependence-brief.md) %} * Enable **{{ ui-key.yacloud.compute.groups.create.field_deletion-protection }}** if needed. You cannot delete a group with this option enabled. 1. Under **{{ ui-key.yacloud.compute.groups.create.section_allocation }}**, select the required ones in the **{{ ui-key.yacloud.compute.groups.create.field_zone }}** field. Instances of a group may reside in [different availability zones](../../overview/concepts/geo-scope.md). @@ -20,48 +20,50 @@ * Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, select a system to be deployed on the VM instance's boot [disk](../../compute/concepts/disk.md). * Under **{{ ui-key.yacloud.compute.instances.create.section_disk }}**: - * Select the [disk type](../../compute/concepts/disk.md#disks_types). - * Specify the disk size. - * To add more disks, click **{{ ui-key.yacloud.compute.component.instance-storage-dialog.button_add-disk }}**. + * Select the [disk type](../../compute/concepts/disk.md#disks_types). + * Specify the disk size. + * To add more disks, click **{{ ui-key.yacloud.compute.component.instance-storage-dialog.button_add-disk }}**. * Under **{{ ui-key.yacloud.compute.instances.create.section_platform }}**: - * Choose a [platform](../../compute/concepts/vm-platforms.md). - * Enter the required number of vCPUs, [guaranteed vCPU performance](../../compute/concepts/performance-levels.md), and the amount of RAM. + * Choose a [platform](../../compute/concepts/vm-platforms.md). + * Enter the required number of vCPUs, [guaranteed vCPU performance](../../compute/concepts/performance-levels.md), and the amount of RAM. - * {% include [include](specify-preemptible-vm.md) %} + * {% include [include](specify-preemptible-vm.md) %} - * (Optional) Enable a [software-accelerated network](../../compute/concepts/software-accelerated-network.md). + * (Optional) Enable a [software-accelerated network](../../compute/concepts/software-accelerated-network.md). * Under **{{ ui-key.yacloud.compute.instances.create.section_network }}**: - {% include [network-settings-group](../../_includes/compute/network-settings-group.md) %} + {% include [network-settings-group](../../_includes/compute/network-settings-group.md) %} - * Under **{{ ui-key.yacloud.compute.instances.create.section_access }}**, specify the information required to access the instance: - * Select a service account to link to the instance. - * If you selected a Linux [image](../../compute/concepts/image.md), fill out the fields **{{ ui-key.yacloud.compute.instances.create.field_user }}** and **{{ ui-key.yacloud.compute.instances.create.field_key }}**. For a key, use the contents of the [public key](../../compute/operations/vm-connect/ssh.md#creating-ssh-keys) file. - * Select `{{ ui-key.yacloud.compute.instances.create.field_serial-port-enable }}`, if needed. + * Under **{{ ui-key.yacloud.compute.instances.create.section_access }}**, specify the data for access to the VM: + * Select a service account to link to the instance. + * If you selected a Linux [image](../../compute/concepts/image.md), fill out the fields **{{ ui-key.yacloud.compute.instances.create.field_user }}** and **{{ ui-key.yacloud.compute.instances.create.field_key }}**. For a key, use the contents of the [public key](../../compute/operations/vm-connect/ssh.md#creating-ssh-keys) file. + * Select `{{ ui-key.yacloud.compute.instances.create.field_serial-port-enable }}`, if needed. * Click **{{ ui-key.yacloud.compute.groups.create.button_edit }}**. 1. Under **{{ ui-key.yacloud.compute.groups.create.section_deploy }}**: * In the **{{ ui-key.yacloud.compute.groups.create.field_deploy-max-expansion }}** field, specify the number of instances you can exceed the group size by. + + {% include [max-expansion-notice](./max-expansion-notice.md) %} * In the field **{{ ui-key.yacloud.compute.groups.create.field_deploy-max-unavailable }}**, specify the number of instances you can decrease the group size by. * In the **{{ ui-key.yacloud.compute.groups.create.field_deploy-max-creating }}** field, specify how many instances can be created at the same time. * In **{{ ui-key.yacloud.compute.groups.create.field_deploy-startup-duration }}**, specify the period after which the VM instance will start receiving the load. * In the **{{ ui-key.yacloud.compute.groups.create.field_deploy-max-deleting }}** field, specify how many instances can be stopped at the same time. * In the **{{ ui-key.yacloud.compute.groups.create.field_deploy-strategy }}** field, specify one of the [strategies](../../compute/concepts/instance-groups/policies/deploy-policy.md#strategy): - * `{{ ui-key.yacloud.compute.groups.create.value_strategy-proactive }}`: {{ ig-name }} itself chooses which instances to stop when updating or scaling down the group. - * `{{ ui-key.yacloud.compute.groups.create.value_strategy-opportunistic }}`: {{ ig-name }} waits for the instances to stop on their own or be stopped by the user. + * `{{ ui-key.yacloud.compute.groups.create.value_strategy-proactive }}`: {{ ig-name }} itself chooses which instances to stop when updating or scaling down the group. + * `{{ ui-key.yacloud.compute.groups.create.value_strategy-opportunistic }}`: {{ ig-name }} waits for the instances to stop on their own or be stopped by the user. 1. Under **{{ ui-key.yacloud.compute.groups.create.section_scale }}**: * Select the `{{ ui-key.yacloud.compute.groups.create.value_scale-auto }}` [scaling type](../../compute/concepts/instance-groups/scale.md). * Specify the following: - * **{{ ui-key.yacloud.compute.groups.create.field_auto-scale-type }}**: `{{ ui-key.yacloud.compute.groups.create.value_scale-zonal }}` autoscaling adjusts the number of VM instances separately for each availability zone specified in the group settings. `{{ ui-key.yacloud.compute.groups.create.value_scale-regional }}` is applied to the entire instance group. - * **{{ ui-key.yacloud.compute.groups.create.field_min-zone-size }}**. - * **{{ ui-key.yacloud.compute.groups.create.field_max-size }}**. - * **{{ ui-key.yacloud.compute.groups.create.field_measurement-duration }}** to average the utilization measurements for each instance in the group. - * **{{ ui-key.yacloud.compute.groups.create.field_warmup-duration }}**: Startup duration of an instance in the group. - * **{{ ui-key.yacloud.compute.groups.create.field_cooldown-duration }}**: Interval during which the required number of instances in the group cannot be reduced. - * **{{ ui-key.yacloud.compute.groups.create.field_initial-size }}**. + * **{{ ui-key.yacloud.compute.groups.create.field_auto-scale-type }}**: `{{ ui-key.yacloud.compute.groups.create.value_scale-zonal }}` autoscaling adjusts the number of VM instances separately for each availability zone specified in the group settings. `{{ ui-key.yacloud.compute.groups.create.value_scale-regional }}` does the same for the entire instance group. + * **{{ ui-key.yacloud.compute.groups.create.field_min-zone-size }}**. + * **{{ ui-key.yacloud.compute.groups.create.field_max-size }}**. + * **{{ ui-key.yacloud.compute.groups.create.field_measurement-duration }}** to average the utilization measurements for each instance in the group. + * **{{ ui-key.yacloud.compute.groups.create.field_warmup-duration }}**: Startup duration of an instance in the group. + * **{{ ui-key.yacloud.compute.groups.create.field_cooldown-duration }}**: Interval during which the required number of instances in the group cannot be reduced. + * **{{ ui-key.yacloud.compute.groups.create.field_initial-size }}**. 1. Under **{{ ui-key.yacloud.compute.groups.create.label_custom-metrics }}**, specify: * In the **{{ ui-key.yacloud.compute.groups.create.field_metric }}** field: - * [{{ ui-key.yacloud.compute.groups.create.metric-type-cpu }}](../../compute/concepts/instance-groups/scale.md#cpu-utilization): Specify the average CPU utilization level that {{ ig-name }} must support. - * [{{ ui-key.yacloud.compute.groups.create.metric-type-custom }}](../../compute/concepts/instance-groups/scale.md#custom-metrics): Specify the name of the custom metric and target value that {{ ig-name }} must support. + * [{{ ui-key.yacloud.compute.groups.create.metric-type-cpu }}](../../compute/concepts/instance-groups/scale.md#cpu-utilization): Specify the average CPU utilization level that {{ ig-name }} must support. + * [{{ ui-key.yacloud.compute.groups.create.metric-type-custom }}](../../compute/concepts/instance-groups/scale.md#custom-metrics): Specify the name of the custom metric and target value that {{ ig-name }} must support. 1. If needed, enable the **{{ ui-key.yacloud.compute.groups.create.section_health-check }}** to get information about the state of instances and their automatic recovery on failure. * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-protocol }}** field, select the protocol for the health checks: `{{ ui-key.yacloud.common.label_http }}` or `{{ ui-key.yacloud.common.label_tcp }}`. * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-path }}** field (for the HTTP type), specify the URL path for the HTTP check requests sent from {{ ig-name }}. diff --git a/en/_includes/instance-groups/create-fixed-group-via-concole.md b/en/_includes/instance-groups/create-fixed-group-via-concole.md index 6ccda0d66ba..7d8bf3a0501 100644 --- a/en/_includes/instance-groups/create-fixed-group-via-concole.md +++ b/en/_includes/instance-groups/create-fixed-group-via-concole.md @@ -1,53 +1,55 @@ -1. In the [management console]({{ link-console-main }}), select a folder to create your instance group in. +1. In the [management console]({{ link-console-main }}), select a folder to create your VM group in. 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. 1. In the left-hand panel, select ![image](../../_assets/console-icons/layers-3-diagonal.svg) **{{ ui-key.yacloud.compute.switch_groups }}**. 1. Click **{{ ui-key.yacloud.compute.groups.button_create }}**. 1. Under **{{ ui-key.yacloud.compute.groups.create.section_base }}**: * Enter a name and description of the instance group. The naming requirements are as follows: - {% include [name-format](../name-format.md) %} + {% include [name-format](../name-format.md) %} - {% include [name-fqdn](../compute/name-fqdn.md) %} + {% include [name-fqdn](../compute/name-fqdn.md) %} - * Select a [service account](../../iam/concepts/users/service-accounts.md) from the list or create a new one. To be able to create, update, and delete instances in the instance group, assign the `editor` role to the service account. By default, all operations in {{ ig-name }} are performed on behalf of a service account. + * Select a [service account](../../iam/concepts/users/service-accounts.md) from the list or create a new one. To be able to create, update, and delete VM instances in the instance group, assign the `editor` role to the service account. By default, all operations in {{ ig-name }} are performed on behalf of a service account. {% include [sa-dependence-brief](../../_includes/instance-groups/sa-dependence-brief.md) %} * Enable the **{{ ui-key.yacloud.compute.groups.create.field_deletion-protection }}** option, if needed. You cannot delete a group with this option enabled. -1. Under **{{ ui-key.yacloud.compute.groups.create.section_allocation }}**, select the required ones in the **{{ ui-key.yacloud.compute.groups.create.field_zone }}** field. Instances of a group may reside in [different availability zones](../../overview/concepts/geo-scope.md). +1. Under **{{ ui-key.yacloud.compute.groups.create.section_allocation }}**, select the required ones in the **{{ ui-key.yacloud.compute.groups.create.field_zone }}** field. VM groups may reside in [different availability zones](../../overview/concepts/geo-scope.md). 1. Under **{{ ui-key.yacloud.compute.groups.create.section_instance }}**, click **{{ ui-key.yacloud.compute.groups.create.button_instance_empty-create }}** to configure a basic instance: * Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**, enter a description for the [template](../../compute/concepts/instance-groups/instance-template.md). * Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, select a system to be deployed on the VM instance's boot [disk](../../compute/concepts/disk.md). * Under **{{ ui-key.yacloud.compute.instances.create.section_disk }}**: - * Select the [disk type](../../compute/concepts/disk.md#disks_types). - * Specify the disk size. - * To add more disks, click **{{ ui-key.yacloud.compute.component.instance-storage-dialog.button_add-disk }}**. + * Select the [disk type](../../compute/concepts/disk.md#disks_types). + * Specify the disk size. + * To add more disks, click **{{ ui-key.yacloud.compute.component.instance-storage-dialog.button_add-disk }}**. * Under **{{ ui-key.yacloud.compute.instances.create.section_platform }}**: - * Choose a [platform](../../compute/concepts/vm-platforms.md). - * Enter the required number of vCPUs, [guaranteed vCPU performance](../../compute/concepts/performance-levels.md), and the amount of RAM. + * Choose a [platform](../../compute/concepts/vm-platforms.md). + * Enter the required number of vCPUs, [guaranteed vCPU performance](../../compute/concepts/performance-levels.md), and the amount of RAM. - * {% include [include](specify-preemptible-vm.md) %} - - * (Optional) Enable a [software-accelerated network](../../compute/concepts/software-accelerated-network.md). + * {% include [include](specify-preemptible-vm.md) %} + + * (Optional) Enable a [software-accelerated network](../../compute/concepts/software-accelerated-network.md). * Under **{{ ui-key.yacloud.compute.instances.create.section_network }}**: - {% include [network-settings-group](../../_includes/compute/network-settings-group.md) %} + {% include [network-settings-group](../../_includes/compute/network-settings-group.md) %} - * Under **{{ ui-key.yacloud.compute.instances.create.section_access }}**, specify the information required to access the instance: - * Select a service account to link to the instance. - * If you selected a Linux [image](../../compute/concepts/image.md), fill out the fields **{{ ui-key.yacloud.compute.instances.create.field_user }}** and **{{ ui-key.yacloud.compute.instances.create.field_key }}**. For a key, use the contents of the [public key](../../compute/operations/vm-connect/ssh.md#creating-ssh-keys) file. - * Select `{{ ui-key.yacloud.compute.instances.create.field_serial-port-enable }}`, if needed. + * Under **{{ ui-key.yacloud.compute.instances.create.section_access }}**, specify the data for access to the VM: + * Select a service account to link to the instance. + * If you selected a Linux [image](../../compute/concepts/image.md), fill out the fields **{{ ui-key.yacloud.compute.instances.create.field_user }}** and **{{ ui-key.yacloud.compute.instances.create.field_key }}**. For a key, use the contents of the [public key](../../compute/operations/vm-connect/ssh.md#creating-ssh-keys) file. + * Select `{{ ui-key.yacloud.compute.instances.create.field_serial-port-enable }}`, if needed. * Click **{{ ui-key.yacloud.compute.groups.create.button_edit }}**. 1. Under **{{ ui-key.yacloud.compute.groups.create.section_deploy }}**: * In the **{{ ui-key.yacloud.compute.groups.create.field_deploy-max-expansion }}** field, specify the number of instances you can exceed the group size by. + + {% include [max-expansion-notice](./max-expansion-notice.md) %} * In the field **{{ ui-key.yacloud.compute.groups.create.field_deploy-max-unavailable }}**, specify the number of instances you can decrease the group size by. * In the **{{ ui-key.yacloud.compute.groups.create.field_deploy-max-creating }}** field, specify how many instances can be created at the same time. * In **{{ ui-key.yacloud.compute.groups.create.field_deploy-startup-duration }}**, specify the period after which the VM instance will start receiving the load. * In the **{{ ui-key.yacloud.compute.groups.create.field_deploy-max-deleting }}** field, specify how many instances can be stopped at the same time. * In the **{{ ui-key.yacloud.compute.groups.create.field_deploy-strategy }}** field, specify one of the [strategies](../../compute/concepts/instance-groups/policies/deploy-policy.md#strategy): - * `{{ ui-key.yacloud.compute.groups.create.value_strategy-proactive }}`: {{ ig-name }} itself chooses which instances to stop when updating or scaling down the group. - * `{{ ui-key.yacloud.compute.groups.create.value_strategy-opportunistic }}`: {{ ig-name }} waits for the instances to stop on their own or be stopped by the user. + * `{{ ui-key.yacloud.compute.groups.create.value_strategy-proactive }}`: {{ ig-name }} itself chooses which instances to stop when updating or scaling down the group. + * `{{ ui-key.yacloud.compute.groups.create.value_strategy-opportunistic }}`: {{ ig-name }} waits for the instances to stop on their own or be stopped by the user. 1. Under **{{ ui-key.yacloud.compute.groups.create.section_scale }}**: * Select the `{{ ui-key.yacloud.compute.groups.create.value_scale-fixed }}` [scaling type](../../compute/concepts/instance-groups/scale.md). * Specify the instance group size. diff --git a/en/_includes/instance-groups/max-expansion-notice.md b/en/_includes/instance-groups/max-expansion-notice.md new file mode 100644 index 00000000000..639cb92fad6 --- /dev/null +++ b/en/_includes/instance-groups/max-expansion-notice.md @@ -0,0 +1 @@ +When bringing the number of VMs in the group to the target value, VMs created in excess of the target under the `max_expansion` quota can remain in the group, while those that existed in the group before may be deleted. \ No newline at end of file diff --git a/en/_includes/managed-gitlab/instance-create-console.md b/en/_includes/managed-gitlab/instance-create-console.md index aa954b015ac..d09ba943cbd 100644 --- a/en/_includes/managed-gitlab/instance-create-console.md +++ b/en/_includes/managed-gitlab/instance-create-console.md @@ -18,12 +18,12 @@ Once an instance is created, you cannot change its resource configuration, i.e., 1. Under **{{ ui-key.yacloud.gitlab.label_configuration-section }}**: 1. Select the instance type. - 1. Specify the [subnet](../../vpc/concepts/network.md#subnet) where the instance will be hosted. Currently, {{ yandex-cloud }} technical restrictions do not allow selecting a subnet with an address range of `192.168.0.0/24`. + 1. Specify the [subnet](../../vpc/concepts/network.md#subnet) where the instance will be hosted. Currently, you cannot select a subnet with the `192.168.0.0/24` address range due to {{ yandex-cloud }} technical restrictions. The [default security group](../../vpc/concepts/security-groups.md#default-security-group) for the selected [network](../../vpc/concepts/network.md#network) will be used for the instance. If you cannot open the {{ GL }} web interface after creating the instance, create a separate security group and [configure it](../../managed-gitlab/operations/configure-security-group.md) so that the rules allow incoming traffic from the required ports and IP addresses. 1. Select the [disk](../../compute/concepts/disk.md) size. - 1. Specify the [instance domain name](../../compute/concepts/network.md#hostname): relevant DNS records will be created for it in the `.gitlab.yandexcloud.net` domain. + 1. Specify the [instance domain name](../../compute/concepts/network.md#hostname): the required DNS records for this domain name will be automatically created in `.gitlab.yandexcloud.net`. The domain name must be unique throughout {{ yandex-cloud }}. @@ -32,6 +32,9 @@ Once an instance is created, you cannot change its resource configuration, i.e., * It must not start or end with a dash character. 1. Set up the retention period for automatic backups (in days). + 1. (Optional) Enable [code approval rules](../../managed-gitlab/concepts/approval-rules.md). To do this, select the appropriate configuration for approval rules. + + {% include [note-approval-rules-pricing](note-approval-rules-pricing.md) %} 1. Under **{{ ui-key.yacloud.gitlab.label_admin-section }}**, specify: * **{{ ui-key.yacloud.gitlab.field_admin-email }}**: Email address of the {{ GL }} instance administrator. This mailbox will receive an email with a link for creating a password. diff --git a/en/_includes/managed-kubernetes/alb-ref/http-backend-group.md b/en/_includes/managed-kubernetes/alb-ref/http-backend-group.md index bc3e305b48b..aa8209412d2 100644 --- a/en/_includes/managed-kubernetes/alb-ref/http-backend-group.md +++ b/en/_includes/managed-kubernetes/alb-ref/http-backend-group.md @@ -108,7 +108,7 @@ Where: * `tls` (`BackendTLS`) - TLC connection settings for the load balancer nodes and backend endpoints. + TLS connection settings for the load balancer nodes and backend endpoints. If the field is specified, the load balancer established TLS connections with the backend and compares the certificates received to the certificate specified in the `trustedCa` field. If the field is not specified, the load balancer will make unencrypted connections to the backend. diff --git a/en/_includes/mdb/list-operations-about.md b/en/_includes/mdb/list-operations-about.md deleted file mode 100644 index dfcced058b3..00000000000 --- a/en/_includes/mdb/list-operations-about.md +++ /dev/null @@ -1,2 +0,0 @@ -The operation list shows the operations performed with clusters and related resources (databases, shards, users, and backup copies). - diff --git a/en/_includes/mdb/mgp/cluster-sg-rules.md b/en/_includes/mdb/mgp/cluster-sg-rules.md index b6ac2e66720..549271e19e3 100644 --- a/en/_includes/mdb/mgp/cluster-sg-rules.md +++ b/en/_includes/mdb/mgp/cluster-sg-rules.md @@ -1,9 +1,18 @@ -Set up the cluster security groups to allow any incoming and outgoing traffic over any protocol. To do this, [create rules](../../../vpc/operations/security-group-add-rule.md) for incoming and outgoing traffic: +1. For incoming traffic: -* **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-port-range }}**: `{{ port-any }}` -* **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-protocol }}**: `{{ ui-key.yacloud.vpc.network.security-groups.forms.value_any }}` (`Any`) -* **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-source }}**: `{{ ui-key.yacloud.vpc.network.security-groups.forms.value_sg-rule-destination-cidr }}` -* **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-cidr-blocks }}**: `0.0.0.0/0` + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-port-range }}**: `{{ port-mgp }}`. + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-protocol }}**: `{{ ui-key.yacloud.common.label_tcp }}`. + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-source }}**: `{{ ui-key.yacloud.vpc.network.security-groups.forms.value_sg-rule-destination-cidr }}`. + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-cidr-blocks }}**: Range of addresses to connect from. + +1. For outgoing traffic: + + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-port-range }}**: `{{ port-any }}`. + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-protocol }}**: `{{ ui-key.yacloud.vpc.network.security-groups.forms.value_any }}` (`Any`). + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-source }}**: `{{ ui-key.yacloud.vpc.network.security-groups.forms.value_sg-rule-destination-cidr }}`. + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-cidr-blocks }}**: `0.0.0.0/0`. + + This rule enables {{ mgp-name }} to use external data sources, e.g., PXF or GPFDIST. diff --git a/en/_includes/mdb/mgp/dbms-settings.md b/en/_includes/mdb/mgp/dbms-settings.md index 20b5ed163b2..3667e74ea63 100644 --- a/en/_includes/mdb/mgp/dbms-settings.md +++ b/en/_includes/mdb/mgp/dbms-settings.md @@ -1,90 +1,200 @@ +* **Gp add column inherits table setting** {{ tag-con }} {{ tag-api }} {#setting-gp-add-column-inherits-table-setting} + + This setting controls whether to apply the data compression parameters (`compresstype`, `compresslevel`, and `blocksize`) specified for the [AOCO table](../../../managed-greenplum/concepts/tables.md) when adding a column. + + By default, the setting is disabled, i.e., the table’s data compression parameters are ignored. + + For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_add_column_inherits_table_setting). + * **Gp workfile compression**{#setting-gp-workfile-compression} {{ tag-con }} {{ tag-api }} - This setting determines whether temporary files created on the disk during a hash connection or hash aggregation will be compressed. + This setting determines whether temporary files created on the disk during a hash connection or hash aggregation will be compressed. - By default, it is disabled, i.e., temporary files are not compressed. + By default, it is disabled, i.e., temporary files are not compressed. - For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_compression). + For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_compression). * **Gp workfile limits per query**{#setting-gp-workfile-limits} {{ tag-con }} {{ tag-api }} - The maximum amount of disk space (in bytes) the temporary files of an active query can occupy in every segment. + The maximum amount of disk space (in bytes) the temporary files of an active query can occupy in every segment. - The maximum value is `1099511627776` (1 TB), the minimum one is `0` (unlimited amount), and the default one is also `0`. + The maximum value is `1099511627776` (1 TB), the minimum value is `0` (unlimited amount), and the default value is `0`. - For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_query). + For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_query). * **Gp workfile limit files per query**{#setting-gp-workfile-limit-files} {{ tag-con }} {{ tag-api }} - The maximum number of temporary files the service creates in a segment to process a single query. If the limit is exceeded, the query will be canceled. + The maximum number of temporary files the service creates in a segment to process a single query. If the limit is exceeded, the query will be canceled. - The maximum value is `100000`, the minimum one is `0` (unlimited number of temporary files), and the default one is `10000`. + The maximum value is `100000`, the minimum value is `0` (unlimited number of temporary files), and the default value is `10000`. - For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_files_per_query). + For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_files_per_query). * **Gp workfile limit per segment**{#setting-gp-workfile-limit-per-segment} {{ tag-con }} {{ tag-api }} - The maximum amount of disk space (in bytes) the temporary files of all active queries can occupy in every segment. + The maximum amount of disk space (in bytes) the temporary files of all active queries can occupy in every segment. + + The maximum value is `1099511627776` (1 TB), the minimum value is `0` (unlimited amount). The default value [depends on the segment host storage size](#settings-instance-dependent) and is calculated by the formula: + + ```text + 0.1 × / + ``` + + For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_segment). + +* **Log connections** {{ tag-con }} {#setting-log-connections} + + This setting controls whether to log a string detailing each successful connection to the {{ GP }} server. + + The setting is disabled by default (no logging). + + For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#log_connections). + +* **Log disconnections** {{ tag-con }} {#setting-log-disconnections} + + This setting controls whether to log session completion. If the setting is enabled, after each completed client session, a string with the session duration is output to the log. + + The setting is disabled by default (no logging). + + For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#log_disconnections). + +* **Log error verbosity** {{ tag-con }} {#setting-log-error-verbosity} + + This setting controls the amount of detail written to the {{ GP }} log for each message. Log detail levels in ascending order of verbosity: + + * `terse`. + * `default` (default value). + * `verbose`. + + For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#log_error_verbosity). + +* **Log hostname** {{ tag-con }} {#setting-log-hostname} + + This setting controls whether to output the host name of the {{ GP }} database master server to the connection log. If the setting is enabled, the IP address and host name are logged. If the setting is disabled, only the IP address is logged. + + This setting is disabled by default. + + For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#log_hostname). + +* **Log min duration statement** {{ tag-con }} {#setting-log-min-duration-statement} + + This setting specifies the minimum command duration required to log the command (in milliseconds). + + If the value is `0`, the runtime of all commands is logged. - The maximum value is `1099511627776` (1 TB), the minimum one is `0` (unlimited amount). The default value [depends on the segment host storage size](#settings-instance-dependent) and is calculated by the formula: + The minimum value is `-1` (disables runtime logging), the maximum value is `2147483647`. The default value is `-1`. - ```text - 0.1 × / - ``` + For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#log_min_duration_statement). - For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_segment). +* **Log min messages** {{ tag-con }} {#setting-log-min-messages} + + This setting defines the logging level in {{ GP }}. All messages of the selected severity level (or higher) are logged. Possible values (in ascending order of severity): `DEBUG5`, `DEBUG4`, `DEBUG3`, `DEBUG2`, `DEBUG1`, `INFO`, `NOTICE`, `WARNING`, `ERROR`, `LOG`, `FATAL`, and `PANIC`. + + The default value is `WARNING`. This means all the messages with the following severity levels will be logged: `WARNING`, `ERROR`, `LOG`, `FATAL`, and `PANIC`. + + To disable logging of most messages, select `PANIC`. + + For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#log_min_messages). * **Log statement**{#setting-log-statement} {{ tag-con }} {{ tag-api }} - Filter for SQL statements that will be written to the {{ GP }} log: + Filter for SQL commands that will be written to the {{ GP }} log: + + * `NONE`: Filter is disabled, no SQL commands are logged. + * `DDL`: Logs SQL commands used to change data structure definitions (such as `CREATE`, `ALTER`, `DROP` etc.). + * `MOD`: Logs the `DDL` commands and commands allowing you to modify data (`INSERT`, `UPDATE`, `DELETE`, `TRUNCATE`, and `COPY FROM`). + * `ALL`: Logs all SQL commands. + + The default value is `ALL`. + + The `PREPARE` and `EXPLAIN ANALYZE` expressions are also logged if they contain the relevant types of commands. + + For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#log_statement). + +* **Log statement stats** {{ tag-con }} {#setting-log-statement-stat} + + This setting controls whether to log query statistics (parsing, scheduling, execution). + + The setting is disabled by default (no logging). + + For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#log_statement_stats). + +* **Master shared buffers** {{ tag-con }} {#setting-master-shared-buffers} - * `NONE`: The filter is disabled and SQL statements are not logged. - * `DDL`: SQL statements that change data definitions are logged (such as `CREATE`, `ALTER`, and `DROP`). - * `MOD`: SQL statements that fall under the `DDL` filter and statements that allow you to change data (`INSERT`, `UPDATE`, `DELETE`, `TRUNCATE`, and `COPY FROM`) are logged. - * `ALL`: All SQL statements are logged. + The amount of memory the {{ GP }} master host uses for shared memory buffers (in bytes). - The default value is `ALL`. + The minimum value is `1048576` (1 MB). The default value is `134217728` (128 MB). - The `PREPARE` and `EXPLAIN ANALYZE` expressions are also logged if they contain the relevant types of commands. + The maximum value is calculated using the following formula: - For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#log_statement). + ```text + min( / 4, 8 * ) + ``` + + For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#shared_buffers). + + {% note warning %} + + Changing this setting will restart the cluster. + + {% endnote %} * **Max connections**{#setting-max-connections} {{ tag-con }} {{ tag-api }} - The maximum number of simultaneous connections to a master host. + The maximum number of concurrent connections to the master host. - The maximum value is `1000`, the minimum one is `250`, and the default one is `350`. For segment hosts, this value is automatically multiplied by five. + The maximum value is `1000`, the minimum value is `250`, and the default value is `350`. For segment hosts, this value is automatically multiplied by five. - If you increase this value, we recommend increasing [Max prepared transactions](#setting-max-prepared-transactions) as well. + If you increase this value, we recommend increasing [Max prepared transactions](#setting-max-prepared-transactions) as well. - For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#max_connections). + For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#max_connections). * **Max prepared transactions**{#setting-max-prepared-transactions} {{ tag-con }} {{ tag-api }} - Maximum number of concurrent [prepared]({{ pg.docs.org }}/current/sql-prepare-transaction.html) transactions. + The maximum number of transactions that can be in the [prepared state]({{ pg.docs.org }}/current/sql-prepare-transaction.html) at the same time. - The maximum value is `10000`, the minimum one is `350`, and the default one is `350`. The values for master hosts and segment hosts are the same. + The maximum value is `10000`, the minimum value is `350`, and the default value is `350`. The values for master hosts and segment hosts are the same. - We recommend choosing a value higher than [Max connections](#setting-max-connections). + We recommend choosing a value higher than [Max connections](#setting-max-connections). - For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#max_prepared_transactions). + For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#max_prepared_transactions). * **Max slot wal keep size**{#setting-max-slot-wal-keep-size} {{ tag-con }} {{ tag-api }} - The maximum [Write-Ahead Log (WAL)](https://www.postgresql.org/docs/current/wal-intro.html) file size in bytes allowed for replication. + The maximum [write-ahead log (WAL)](https://www.postgresql.org/docs/current/wal-intro.html) file size in bytes allowed for replication. - The minimum value is `0` (no logging), the maximum one is `214748364800` (200 GB). The default value [depends on the segment host storage size](#settings-instance-dependent) and is calculated by the formula: + The minimum value is `0` (no logging), and the maximum value is `214748364800` (200 GB). The default value [depends on the segment host storage size](#settings-instance-dependent) and is calculated by the formula: - ```text - 0.1 × / - ``` + ```text + 0.1 × / + ``` - For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#max_slot_wal_keep_size). + For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#max_slot_wal_keep_size). * **Max statement mem**{#setting-max-statement-mem} {{ tag-con }} {{ tag-api }} - The maximum amount of memory (in bytes) allocated for query processing. + The maximum amount of memory (in bytes) allocated for query processing. + + The minimum value is `134217728` (128 MB), the maximum value is `1099511627776` (1 TB), and the default value is `2097152000` (2,000 MB). + + For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#max_statement_mem). + +* **Segment shared buffers** {{ tag-con }} {#setting-segment-shared-buffers} + + The amount of memory the {{ GP }} segment hosts use for shared memory buffers (in bytes). + + The minimum value is `1048576` (1 MB). The default value is `134217728` (128 MB). + + The maximum value is calculated using the following formula: + + ```text + min( / 4 / , 8 * ) + ``` + + For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#shared_buffers). + + {% note warning %} - The minimum value is `134217728` (128 MB), the maximum one is `1099511627776` (1 TB), and the default one is `2097152000` (2000 MB). + Changing this setting will restart the cluster. - For more information, see the [{{ GP }} documentation]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#max_statement_mem). + {% endnote %} diff --git a/en/_includes/mdb/mgp/limits.md b/en/_includes/mdb/mgp/limits.md index c1babe72cc3..21c53779537 100644 --- a/en/_includes/mdb/mgp/limits.md +++ b/en/_includes/mdb/mgp/limits.md @@ -1,23 +1,23 @@ #### Quotas {#quotas} -| Type of limit | Value | +| Type of limit | Value | |--------------------------------------------------------------------------------|----------| -| Number of clusters per cloud | 16 | -| Total number of processor cores for all database hosts per cloud | 96 | -| Total virtual memory for all database hosts per cloud | 640 GB | -| Total storage capacity for all clusters per cloud | 4096 GB | +| Number of clusters per cloud | 16 | +| Total number of processor cores for all database hosts per cloud | 96 | +| Total virtual memory for all database hosts per cloud | 640 GB | +| Total storage capacity for all clusters per cloud | 4096 GB | #### Limits {#limits} -| Type of limit | Minimum value | Maximum value | +| Type of limit | Minimum value | Maximum value | |:--------------------------------------------------------------------------------------------------------------|:-------------------------------------------------|:-------------------------------------------------| -| Host class | s2.medium (8 vCPU Intel Cascade Lake, 32 GB RAM) | i3-c40-m320 (40 vCPU Intel Ice Lake, 320 GB RAM) | -| Number of master hosts in the cluster | 2 | 2 | -| Number of segment hosts in the cluster | 2 | 32 | -| Number of segments per host | 1 | 16 | -| Amount of data on the host when using HDD network storage | 10 GB | 2048 GB | -| Amount of data on the host when using network SSD storage | 10 GB | 8192 GB | -| Amount of host data when using non-replicated SSD storage (for segment hosts only) | 93 GB | 8184 GB | -| Amount of data on the host when using local SSD storage (for Intel Cascade Lake) | 100 GB | 1500 GB | -| Amount of data on the host when using local SSD storage (for Intel Ice Lake) | {{ local-ssd-v3-step }} | {{ local-ssd-v3-max }} | +| Host class | s2.medium (8 vCPU Intel Cascade Lake, 32 GB RAM) | i3-c40-m320 (40 vCPU Intel Ice Lake, 320 GB RAM) | +| Number of master hosts in the cluster | 2 | 2 | +| Number of segment hosts in the cluster | 2 | 32 | +| Number of segments per host | 1 | 16 | +| Amount of data on the host when using HDD network storage | 10 GB | 2048 GB | +| Amount of data per host when using network SSD storage | 10 GB | 8,192 GB | +| Amount of data per host when using non-replicated SSD storage | 93 GB | 8184 GB | +| Amount of data on the host when using local SSD storage (for Intel Cascade Lake) | 100 GB | 1500 GB | +| Amount of data per host when using local SSD storage (for Intel Ice Lake) | {{ local-ssd-v3-step }} | {{ local-ssd-v3-max }} | \ No newline at end of file diff --git a/en/_includes/mdb/mkf-list-operations-about.md b/en/_includes/mdb/mkf-list-operations-about.md deleted file mode 100644 index 67b45df7df0..00000000000 --- a/en/_includes/mdb/mkf-list-operations-about.md +++ /dev/null @@ -1,2 +0,0 @@ -The operation list shows the operations performed with clusters and related resources (topics and users). - diff --git a/en/_includes/mdb/mmg-readonly-safeguard.md b/en/_includes/mdb/mmg-readonly-safeguard.md index 2b01928be21..bd81fb7cd8f 100644 --- a/en/_includes/mdb/mmg-readonly-safeguard.md +++ b/en/_includes/mdb/mmg-readonly-safeguard.md @@ -1,6 +1,6 @@ -If at least one host in a {{ mmg-name }} cluster runs out of allocated disk space, the {{ MG }} instance on this host will crash and the host will be disabled. If the host was a [`PRIMARY` replica](../../managed-mongodb/concepts/replication.md), this role will be assigned to one of the `SECONDARY` replicas. As a result of migrating the `PRIMARY` role from one host to another, you may run out of disk space on all hosts in the cluster, which will result in a complete cluster failure. +If at least one host in a {{ mmg-name }} cluster runs out of its allocated disk space, the {{ MG }} instance on this host will crash and the host will be disabled. If this host was a [`PRIMARY` replica](../../managed-mongodb/concepts/replication.md), this role will be assigned to one of the `SECONDARY` replicas. As a result of migrating the `PRIMARY` role from one host to another, you may run out of disk space on all hosts in the cluster, which will result in a complete cluster failure. -To avoid this, {{ mmg-name }} monitors disk space in use and automatically enables read-only mode (using the [`db.fsyncLock` method](https://docs.mongodb.com/manual/reference/method/db.fsyncLock/)) for those hosts in the cluster that have: +To avoid this, {{ mmg-name }} monitors disk space in use and automatically enables _read-only_ mode (using the [`db.fsyncLock` method](https://docs.mongodb.com/manual/reference/method/db.fsyncLock/)) for those hosts in the cluster that have: * Less than 500 MB of free disk space left (if the host storage size is less than 600 GB). * Less than 5 GB of free disk space left (if the host storage size is 600 GB or more). diff --git a/en/_includes/mdb/mmg/note-info-db-name-limits.md b/en/_includes/mdb/mmg/note-info-db-name-limits.md index 4f20550927b..064960df7ec 100644 --- a/en/_includes/mdb/mmg/note-info-db-name-limits.md +++ b/en/_includes/mdb/mmg/note-info-db-name-limits.md @@ -1 +1 @@ -A database name may contain Latin letters, numbers, underscores, and hyphens. The name may be up to 63 characters long. Such names as `config`, `local`, `admin`, and `mdb_internal` are reserved for {{ mmg-name }}. You cannot create DBs with these names. \ No newline at end of file +A database name may contain Latin letters, numbers, underscores, and hyphens. The name may be up to 63 characters long. Such names as `config`, `local`, `admin`, and `mdb_internal` are reserved for {{ mmg-name }}. You cannot create DBs with these names. diff --git a/en/_includes/mdb/mmg/settings-host-class.md b/en/_includes/mdb/mmg/settings-host-class.md index 2d512e5a200..4159949d135 100644 --- a/en/_includes/mdb/mmg/settings-host-class.md +++ b/en/_includes/mdb/mmg/settings-host-class.md @@ -1,7 +1,7 @@ Under **{{ ui-key.yacloud.mdb.forms.section_resource }}**, select: -* One of the available [platforms](../../../compute/concepts/vm-platforms.md) -* Configuration type: **memory-optimized**, **standard**, or **burstable**. -* [Host class](../../../managed-mongodb/concepts/instance-types.md): Defines the technical specifications of the VMs where the DB hosts will be deployed. When you change the host class for the cluster, the characteristics of all existing hosts change, too. + * One of the available [platforms](../../../compute/concepts/vm-platforms.md). + * Configuration type: **memory-optimized**, **cpu-optimized**, **standard**, or **burstable**. + * [Host class](../../../managed-mongodb/concepts/instance-types.md): Defines the technical specifications of the VMs where the DB hosts will be deployed. When you change the host class for the cluster, the characteristics of all existing hosts change, too. diff --git a/en/_includes/mdb/mmy-limits.md b/en/_includes/mdb/mmy-limits.md index 2877e698602..9755565460e 100644 --- a/en/_includes/mdb/mmy-limits.md +++ b/en/_includes/mdb/mmy-limits.md @@ -1,22 +1,22 @@ #### Quotas {#mmy-quotas} -| Type of limit | Value | +| Type of limit | Value | |:-------------------------------------------------------------------------------|:---------| -| Number of clusters per cloud | 16 | -| Total number of processor cores for all database hosts per cloud | 96 | -| Total virtual memory for all database hosts per cloud | 640 GB | -| Total storage capacity for all clusters per cloud | 4096 GB | +| Number of clusters per cloud | 16 | +| Total number of processor cores for all database hosts per cloud | 96 | +| Total virtual memory for all database hosts per cloud | 640 GB | +| Total storage capacity for all clusters per cloud | 4,096 GB | #### Limits {#mmy-limits} -| Type of limit | Minimum value | Maximum value | -|:------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------| -| Host class | b1.medium (2 × [50%](../../compute/concepts/performance-levels.md) vCPU Intel Broadwell, 4 GB RAM) | m3-c80-m640 (80 vCPU Intel Cascade Lake, 640 GB RAM) | -| Number of hosts per cluster when using HDD or SSD network storage | 1 | 7 | -| Number of hosts per cluster when using non-replicated SSD or local SSD storage | 3 | 7 | -| Amount of data per host when using network SSD storage | 10 GB | 6144 GB | -| Amount of data per host when using network HDD storage | 10 GB | 2048 GB | -| Amount of data per host when using non-replicated SSD storage | 93 GB | 8184 GB | -| Amount of data per host when using local SSD storage (for Intel Broadwell and Intel Cascade Lake) | 100 GB | 1500 GB | -| Amount of data per host when using local SSD storage (for Intel Ice Lake) | {{ local-ssd-v3-step }} | {{ local-ssd-v3-max }} | -| Number of databases per cluster | 1 | {{ all-mdb.max-databases }} | +| Type of limit | Minimum value | Maximum value | +|:------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------|:-----------------------------------------------------| +| Host class | b1.medium (2 × [50%](../../compute/concepts/performance-levels.md) vCPU Intel Broadwell, 4 GB RAM) | m3-c80-m640 (80 vCPU Intel Cascade Lake, 640 GB RAM) | +| Number of hosts per cluster when using HDD or SSD network storage | 1 | 7 | +| Number of hosts per cluster when using non-replicated SSD or local SSD storage | 3 | 7 | +| Amount of data per host when using network SSD storage | 10 GB | 6,144 GB | +| Amount of data per host when using network HDD storage | 10 GB | 2,048 GB | +| Amount of data per host when using non-replicated SSD storage | 93 GB | 8,184 GB | +| Amount of data per host when using local SSD storage (for Intel Broadwell and Intel Cascade Lake) | 100 GB | 1,500 GB | +| Amount of data per host when using local SSD storage (for Intel Ice Lake) | {{ local-ssd-v3-step }} | {{ local-ssd-v3-max }} | +| Number of databases per cluster | 1 | {{ all-mdb.max-databases }} | \ No newline at end of file diff --git a/en/_includes/mdb/monitoring-cluster-health.md b/en/_includes/mdb/monitoring-cluster-health.md index 42d904ea342..23061a98101 100644 --- a/en/_includes/mdb/monitoring-cluster-health.md +++ b/en/_includes/mdb/monitoring-cluster-health.md @@ -1,6 +1,6 @@ -| State | Description | Suggested actions | -| :--- | :--- | :--- | -| **ALIVE** | Cluster is operating normally. | No action is required. | -| **DEGRADED** | Cluster is not running at its full capacity: the state of at least one of the hosts is other than `ALIVE`. | Run the diagnostics:
  • Go to the **{{ ui-key.yacloud.mdb.cluster.hosts.label_title }}** tab and see which hosts are not alive.
  • Go to the **{{ ui-key.yacloud.common.operations-key-value }}** tab and make sure all of them are completed.
  • Check that the cluster is not under maintenance.
If you cannot find the cause yourself, [contact support]({{ link-console-support }}). | -| **DEAD** | Cluster is out of order: all of its hosts are down. | [Prepare an application to support]({{ link-console-support }}) stating the following:
  • Cluster ID.
  • IDs of the last operations performed on it.
  • Time the cluster entered the `DEAD` state according to the [availability charts](#monitoring-cluster).
| -| **UNKNOWN** | Cluster state is unknown. | [Prepare an application to support]({{ link-console-support }}) stating the following:
  • Cluster ID.
  • IDs of the last operations performed on it.
  • Time the cluster entered the `UNKNOWN` state according to the [availability charts](#monitoring-cluster).
| \ No newline at end of file +State | Description | Suggested actions +:--- | :--- | :--- +**ALIVE** | Cluster is operating normally. | No action is required. +**DEGRADED** | Cluster is not running at its full capacity: the state of at least one of the hosts is other than `ALIVE`. | Run the diagnostics:
  • Go to the **{{ ui-key.yacloud.mdb.cluster.hosts.label_title }}** tab and see which hosts are not working.
  • Go to the **{{ ui-key.yacloud.common.operations-key-value }}** tab and make sure all operations are completed.
  • Make sure the cluster is not under maintenance.
If you cannot find the cause yourself, [contact support]({{ link-console-support }}). +**DEAD** | The cluster is down: none of its hosts are running. | [Make a support request]({{ link-console-support }}) stating the following:
  • Cluster ID.
  • IDs of the last operations performed on it.
  • Time the cluster entered the `DEAD` state according to the [availability charts](#monitoring-cluster).
+**UNKNOWN** | Cluster state is unknown. | [Make a support request]({{ link-console-support }}) stating the following:
  • Cluster ID.
  • IDs of the last operations performed on it.
  • Time the cluster entered the `UNKNOWN` state according to the [availability charts](#monitoring-cluster).
\ No newline at end of file diff --git a/en/_includes/mdb/monitoring-cluster-status.md b/en/_includes/mdb/monitoring-cluster-status.md index 0b623d7d251..aa45daedf77 100644 --- a/en/_includes/mdb/monitoring-cluster-status.md +++ b/en/_includes/mdb/monitoring-cluster-status.md @@ -1,10 +1,10 @@ -| Status | Description | Suggested actions | +Status | Description | Suggested actions :--- | :--- | :--- -| **CREATING** | Preparing for the first launch | Wait a while and get started. The time it takes to create a cluster depends on the host class. | -| **RUNNING** | Cluster is operating normally | No action is required. | -| **STOPPING** | Stopping | After a while, the cluster's status will change to `STOPPED` and it will be disabled. No action is required. | -| **STOPPED** | Stopped | For instructions on how to restart it, see **Stopping and restarting a cluster**. | -| **STARTING** | Starting the cluster that was stopped earlier | After a while, the cluster's status will change to `RUNNING`. Wait a while and get started. | -| **UPDATING** | Updating the cluster status | After the update is completed, the cluster's status will change to `RUNNING`. Wait a while and get started. | -| **ERROR** | An error occurred that does not allow the cluster to continue working | Run the initial diagnostics:
  • Analyze the cluster's [monitoring charts](#monitoring-cluster) and view operations that were performed in it.
  • Prepare a list of IDs of problem resources.
If you cannot find the cause of the error yourself, [contact support]({{ link-console-support }}). | -| **STATUS_UNKNOWN** | Cluster is unable to determine its own status | Run the initial diagnostics:
  • Analyze the cluster's [monitoring charts](#monitoring-cluster) and view operations that were performed in it.
  • Prepare a list of IDs of problem resources.
If you cannot find the cause of the error yourself, [contact support]({{ link-console-support }}). | +**CREATING** | Preparing for the first launch | Wait a while and get started. The time it takes to create a cluster depends on the host class. +**RUNNING** | Cluster is operating normally | No action is required. +**STOPPING** | Stopping cluster | After a while, the cluster status will change to `STOPPED` and the cluster will be disabled. No action is required. +**STOPPED** | Cluster stopped | Start the cluster to get it running again. +**STARTING** | Starting the cluster that was stopped earlier | After a while, the cluster status will change to `RUNNING`. Wait a while and get started. +**UPDATING** | Updating the cluster status | After the update is completed, the cluster status will change to `RUNNING`. Wait a while and get started. +**ERROR** | An error occurred that does not allow the cluster to continue working | Run the initial diagnostics:
  • Analyze the cluster [monitoring charts](#monitoring-cluster) and view the operations performed.
  • Prepare a list of IDs of problem resources.
If you cannot find the cause of the error yourself, [contact support]({{ link-console-support }}). +**STATUS_UNKNOWN** | Cluster is unable to determine its own status | Run the initial diagnostics:
  • Analyze the cluster [monitoring charts](#monitoring-cluster) and view the operations performed.
  • Prepare a list of IDs of problem resources.
If you cannot find the cause of the error yourself, [contact support]({{ link-console-support }}). diff --git a/en/_includes/mdb/mpg/performance-diagnostics-api.md b/en/_includes/mdb/mpg/performance-diagnostics-api.md deleted file mode 100644 index 54bdb27d1f5..00000000000 --- a/en/_includes/mdb/mpg/performance-diagnostics-api.md +++ /dev/null @@ -1,8 +0,0 @@ -1. Pass the `true` value in the `config.performanceDiagnostics.enabled` parameter. -1. Pass the sessions sampling interval in the `config.performanceDiagnostics.sessionsSamplingInterval` parameter. -1. Pass the statements sampling interval in the `config.performanceDiagnostics.statementsSamplingInterval` parameter. - -Acceptable parameter values: - -- `config.performanceDiagnostics.sessionsSamplingInterval`: From `1` to `86400` seconds. -- `config.performanceDiagnostics.statementsSamplingInterval`: From `60` to `86400` seconds. diff --git a/en/_includes/mdb/mrd-limits.md b/en/_includes/mdb/mrd-limits.md index dbe9545478d..1cf7a2b014e 100644 --- a/en/_includes/mdb/mrd-limits.md +++ b/en/_includes/mdb/mrd-limits.md @@ -1,28 +1,28 @@ #### Quotas {#mrd-quotas} -| Type of limit | Value | +| Type of limit | Value | |:-------------------------------------------------------------------------------|:---------| -| Number of clusters per cloud | 16 | -| Total number of processor cores for all database hosts per cloud | 64 | -| Total virtual memory for all database hosts per cloud | 512 GB | -| Total storage capacity for all clusters per cloud | 4,096 GB | +| Number of clusters per cloud | 16 | +| Total number of processor cores for all database hosts per cloud | 64 | +| Total virtual memory for all database hosts per cloud | 512 GB | +| Total storage capacity for all clusters per cloud | 4,096 GB | #### Limits {#mrd-limits} -| Type of limit | Minimum value | Maximum value | +| Type of limit | Minimum value | Maximum value | |:----------------------------------------------------------------------------------------------------------|:--------------------------------------|:--------------------------------------------------| -| Host class | b2.medium (`burstable`, 4 GB RAM) | hm3-c32-m512 (32 vCPU Intel Ice Lake, 512 GB RAM) | -| Number of hosts in an unsharded cluster | 1 or 3 depending on the [disk type](../../managed-redis/concepts/storage.md#storage-type-selection) | 7 | -| Number of shards in a sharded cluster | 1 | 10 | -| Number of hosts per shard when using network SSD storage | 1 | 7 | -| Number of hosts per shard when using local SSD storage^*^ | 2 | 7 | -| Number of hosts per shard when using non-replicated SSD storage^*^ | 3 | 7 | -| Number of hosts in a sharded cluster | 1, 2, or 3 hosts depending on the [disk type](../../managed-redis/concepts/storage.md#storage-type-selection) | 70 (10 shards, 7 hosts) | -| Amount of data per host when using network SSD storage | Twice the amount of selected RAM | 4096 GB | -| Amount of data per host when using non-replicated SSD storage^*^ | Twice the amount of selected RAM, at least 93 GB | 8184 GB | -| Amount of data per host when using local SSD storage (for Intel Broadwell and Intel Cascade Lake)^*^ | Twice the amount of selected RAM, at least 100 GB | 1500 GB | -| Amount of data per host when using local SSD storage (for Intel Ice Lake)^*^ | Twice the amount of selected RAM, at least {{ local-ssd-v3-step }} | {{ local-ssd-v3-max }} | +| Host class | b2.medium (`burstable`, 4 GB RAM) | hm3-c32-m512 (32 vCPU Intel Ice Lake, 512 GB RAM) | +| Number of hosts in an unsharded cluster | 1 or 3 depending on the [disk type](../../managed-redis/concepts/storage.md#storage-type-selection) | 7 | +| Number of shards in a sharded cluster | 1 | 10 | +| Number of hosts per shard when using network SSD storage | 1 | 7 | +| Number of hosts per shard when using local SSD storage^*^ | 2 | 7 | +| Number of hosts per shard when using non-replicated SSD storage^*^ | 3 | 7 | +| Number of hosts in a sharded cluster | 1, 2, or 3 hosts depending on the [disk type](../../managed-redis/concepts/storage.md#storage-type-selection) | 70 (10 shards, 7 hosts) | +| Amount of data per host when using network SSD storage | Twice the amount of selected RAM | 4,096 GB | +| Amount of data per host when using non-replicated SSD storage^*^ | Twice the amount of selected RAM, at least 93 GB | 8,184 GB | +| Amount of data per host when using local SSD storage (for Intel Broadwell and Intel Cascade Lake)^*^ | Twice the amount of selected RAM, at least 100 GB | 1,500 GB | +| Amount of data per host when using local SSD storage (for Intel Ice Lake)^*^ | Twice the amount of selected RAM, at least {{ local-ssd-v3-step }} | {{ local-ssd-v3-max }} | | Number of cluster connections | — | 65,000 | {% include [storage-limitations-mrd](./mrd/storage-limitations-note.md) %} diff --git a/en/_includes/mdb/mrd/conn-strings-non-sharded.md b/en/_includes/mdb/mrd/conn-strings-non-sharded.md index 798cc6d702e..6762cf7de5c 100644 --- a/en/_includes/mdb/mrd/conn-strings-non-sharded.md +++ b/en/_includes/mdb/mrd/conn-strings-non-sharded.md @@ -166,7 +166,7 @@ Password: "", ReadOnly: false, TLSConfig: &tls.Config{ - RootCAs: rootCertPool, + RootCAs: rootCertPool, }, }, ) @@ -284,7 +284,7 @@ String redisPass = ""; System.setProperty("javax.net.ssl.trustStore", "/home//.redis/YATrustStore"); - System.setProperty("javax.net.ssl.trustStorePassword", ""); + System.setProperty("javax.net.ssl.trustStorePassword", ""); SSLParameters sslParameters = new SSLParameters(); DefaultJedisClientConfig jedisClientConfig = DefaultJedisClientConfig.builder(). diff --git a/en/_includes/mdb/sg-rules-limits.md b/en/_includes/mdb/sg-rules-limits.md index 9c206bc934d..539c592bfbd 100644 --- a/en/_includes/mdb/sg-rules-limits.md +++ b/en/_includes/mdb/sg-rules-limits.md @@ -1,3 +1,4 @@ -[Security groups](../../vpc/concepts/security-groups.md) follow the _All traffic that is not allowed is prohibited_ principle. To connect to a cluster, security groups must include rules allowing traffic from certain ports, IP addresses, or other security groups. +[Security groups](../../vpc/concepts/security-groups.md) follow the _All traffic that is not allowed is prohibited_ principle. To connect to a cluster, configure security group rules. These rules allow traffic from certain ports, IP addresses, or other security groups. For example, a VM will not be able to connect to a cluster in the following cases: -For example, let's assume a VM in {{ yandex-cloud }} is used to access the cluster. In this case, if only the 10.133.0.0/24 subnet is specified in the incoming traffic rules for the security group, while the VM is in the 10.128.0.0/16 subnet, the VM will not be able to connect to the cluster. A VM from the 10.133.0.0/24 subnet will not be able to connect either, in case it tries to access a port that is not specified in the security group rules. +* The VM is in subnet 10.128.0.0/16, whereas the incoming traffic rules only specify subnet 10.133.0.0/24. +* The VM is in subnet 10.133.0.0/24 but attempts to access a port not specified in the security group rules. diff --git a/en/_includes/notifications/about-service.md b/en/_includes/notifications/about-service.md new file mode 100644 index 00000000000..1e37d22aad1 --- /dev/null +++ b/en/_includes/notifications/about-service.md @@ -0,0 +1 @@ +{{ cns-name }} ({{ cns-short-name }}) is a service for multichannel notifications of users. The service's HTTP API is compatible with the [Amazon SNS API](https://docs.aws.amazon.com/sns/latest/api/welcome.html). diff --git a/en/_includes/notifications/ask-for-turning-on.md b/en/_includes/notifications/ask-for-turning-on.md new file mode 100644 index 00000000000..798b219ed40 --- /dev/null +++ b/en/_includes/notifications/ask-for-turning-on.md @@ -0,0 +1 @@ +To enable {{ cns-name }}, request access to the service from your account manager or [technical support]({{ link-console-support }}). diff --git a/en/_includes/notifications/auth-apns.md b/en/_includes/notifications/auth-apns.md new file mode 100644 index 00000000000..a9c5b4ee0df --- /dev/null +++ b/en/_includes/notifications/auth-apns.md @@ -0,0 +1,13 @@ +You can authenticate with APNs using either a _token_ or a _certificate_: +* To authenticate using a token, you will need the following data: + * **Token**: To get a token in `.p8` format, create an authentication key in your Apple developer account: **Certificates, Identifiers & Profiles** → **Keys** → ![image](../../_assets/console-icons/circle-plus-fill.svg). You can download the token file only once. + * **Token ID**: Get the ID in your Apple developer account: **Certificates, Identifiers & Profiles** → **Keys**. Make sure the ID matches the token you want to use. It must be 10 characters long. + * **Team ID**: You can find it in the top-right corner of your Apple developer account. It must be 10 characters long and contain only numbers and Latin letters. + * **Bundle ID**: Get the [bundle ID](https://developer.apple.com/documentation/appstoreconnectapi/list_bundle_ids) in your Apple developer account: **Certificates, Identifiers & Profiles** → **Identifiers** or in the Xcode app: **Target** → **General** → **Identity**. It may contain only numbers, Latin letters, hyphens, and periods. +* To authenticate using a certificate, you will need the following data: + * **Certificate**: SSL certificate file in `.p12` format. + * **Certificate private key**. + + For more information about the certificate, see the [Apple documentation](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/establishing_a_certificate-based_connection_to_apns#2947597). + +Token-based authentication is preferred as it is more progressive. \ No newline at end of file diff --git a/en/_includes/notifications/auth-fcm.md b/en/_includes/notifications/auth-fcm.md new file mode 100644 index 00000000000..c49d7673cec --- /dev/null +++ b/en/_includes/notifications/auth-fcm.md @@ -0,0 +1,11 @@ +You can authenticate with FCM using either the _HTTP v1 API_ or _Legacy API_: +* To authenticate using the HTTP v1 API, you will need a **Google Cloud service account key in JSON format**. The key is used to generate OAuth 2.0 temporary tokens for authenticating requests in the FCM HTTP v1 API. You can get it in the Google Cloud management console. +* To authenticate using the Legacy API, you will need an **API key** (server key). You can get it in the Firebase management console. + +{% note info %} + +The HTTP v1 API is preferred as [FCM will no longer support](https://firebase.google.com/docs/cloud-messaging/migrate-v1) the Legacy API starting from June 2024. + +{% endnote %} + +See more in the [Firebase documentation](https://firebase.google.com/docs/cloud-messaging/android/client). \ No newline at end of file diff --git a/en/_includes/notifications/auth-hms.md b/en/_includes/notifications/auth-hms.md new file mode 100644 index 00000000000..ec4b1edeca9 --- /dev/null +++ b/en/_includes/notifications/auth-hms.md @@ -0,0 +1,5 @@ +You can authenticate with HMS using the following parameters: +* **Key ID** +* **API key** + +See more in the [HMS documentation](https://developer.huawei.com/consumer/en/doc/hmscore-common-Guides/get-started-hmscore-0000001212585589). \ No newline at end of file diff --git a/en/_includes/notifications/channels-push-preview.md b/en/_includes/notifications/channels-push-preview.md new file mode 100644 index 00000000000..3b09afd3a1f --- /dev/null +++ b/en/_includes/notifications/channels-push-preview.md @@ -0,0 +1,3 @@ +At the preview stage, you can send personalized [push notifications](../../notifications/concepts/push.md) to iOS and Android devices as well as [text messages (SMS)](../../notifications/concepts/sms.md). + +Moving forward, we will add notifications to messengers and browsers. \ No newline at end of file diff --git a/en/_includes/notifications/common-sender-description.md b/en/_includes/notifications/common-sender-description.md new file mode 100644 index 00000000000..793370f25eb --- /dev/null +++ b/en/_includes/notifications/common-sender-description.md @@ -0,0 +1,9 @@ +An SMS notification channel with a _shared sender_ is a good option for testing the service's features and has the following advantages: +* You do not have to register the sender's name with the telecom operator. +* No monthly subscription fee is charged. + +There are restrictions in place for this type of sender: +* All SMS messages are signed with a shared service name. +* Promotional SMS messages are not allowed. +* A [cloud](../../resource-manager/concepts/resources-hierarchy.md#cloud) can contain only one SMS notification channel with a shared sender. +* A channel can only operate in a [sandbox](../../notifications/concepts/sms.md#sandbox) with a limited number of test phone numbers. \ No newline at end of file diff --git a/en/_includes/notifications/individual-in-sandbox.md b/en/_includes/notifications/individual-in-sandbox.md new file mode 100644 index 00000000000..8ec095ec99d --- /dev/null +++ b/en/_includes/notifications/individual-in-sandbox.md @@ -0,0 +1 @@ +The SMS notification channel with an individual sender is originally created in the sandbox. \ No newline at end of file diff --git a/en/_includes/notifications/individual-sender-description.md b/en/_includes/notifications/individual-sender-description.md new file mode 100644 index 00000000000..34c04556c8b --- /dev/null +++ b/en/_includes/notifications/individual-sender-description.md @@ -0,0 +1,8 @@ +An SMS notification channel with an _individual sender_ is suitable for the product environment and has the following advantages: +* All SMS messages are signed with the sender's unique text name. +* After leaving the [sandbox](#sandbox) you can send SMS to any Russian phone numbers in [E.164](https://en.wikipedia.org/wiki/E.164) format. + +There are restrictions and rules in place for this type of sender: +* The sender's text name will be registered with the service provider. +* You will be charged a monthly subscription fee for using the sender's text name. +* In the [cloud](../../resource-manager/concepts/resources-hierarchy.md#cloud), one sender's text name can correspond to one SMS notification channel. \ No newline at end of file diff --git a/en/_includes/notifications/limits-warning.md b/en/_includes/notifications/limits-warning.md new file mode 100644 index 00000000000..8d820a1bac9 --- /dev/null +++ b/en/_includes/notifications/limits-warning.md @@ -0,0 +1,5 @@ +{% note info %} + +The service is subject to limitations. For more information, see [{#T}](../../notifications/concepts/limits.md). + +{% endnote %} \ No newline at end of file diff --git a/en/_includes/notifications/preview-stage.md b/en/_includes/notifications/preview-stage.md new file mode 100644 index 00000000000..c33a90ea522 --- /dev/null +++ b/en/_includes/notifications/preview-stage.md @@ -0,0 +1,5 @@ +{% note info %} + +The service is at the [preview stage](../../overview/concepts/launch-stages.md). + +{% endnote %} diff --git a/en/_includes/notifications/registration-duration-warning.md b/en/_includes/notifications/registration-duration-warning.md new file mode 100644 index 00000000000..f860046a482 --- /dev/null +++ b/en/_includes/notifications/registration-duration-warning.md @@ -0,0 +1,5 @@ +{% note info %} + +Registering a sender's text name may take from 2 to 4 weeks. + +{% endnote %} \ No newline at end of file diff --git a/en/_includes/notifications/sa-role-static-key.md b/en/_includes/notifications/sa-role-static-key.md new file mode 100644 index 00000000000..05890c07482 --- /dev/null +++ b/en/_includes/notifications/sa-role-static-key.md @@ -0,0 +1,8 @@ +For authentication in {{ cns-name }}, use a [static access key](../../iam/concepts/authorization/access-key.md). The key is issued for the [service account](../../iam/concepts/users/service-accounts.md), and all actions are performed on behalf of that service account. + +To get a static access key: +1. [Create](../../iam/operations/sa/create.md) a service account. +1. [Assign](../../iam/operations/sa/assign-role-for-sa.md) the service account the `editor` [role](../../iam/roles-reference.md#editor) for the folder. +1. [Create](../../iam/operations/sa/create-access-key.md) a static access key for the service account. + + Save the ID and private key. diff --git a/en/_includes/notifications/sandbox-test-numbers.md b/en/_includes/notifications/sandbox-test-numbers.md new file mode 100644 index 00000000000..9844d33acbe --- /dev/null +++ b/en/_includes/notifications/sandbox-test-numbers.md @@ -0,0 +1,3 @@ +A _sandbox_ is a test environment, in which you can send SMS messages only to _test phone numbers_. + +Each test phone number is registered in a channel using a confirmation code from an SMS. By adding a number, you agree to receive messages to it. \ No newline at end of file diff --git a/en/_includes/notifications/sms-quota-increase.md b/en/_includes/notifications/sms-quota-increase.md new file mode 100644 index 00000000000..6941c9a3caa --- /dev/null +++ b/en/_includes/notifications/sms-quota-increase.md @@ -0,0 +1 @@ +You can also request an increase in the service quotas together with your request to exit the sandbox mode. \ No newline at end of file diff --git a/en/_includes/notifications/sms-short-description.md b/en/_includes/notifications/sms-short-description.md new file mode 100644 index 00000000000..0667cf967be --- /dev/null +++ b/en/_includes/notifications/sms-short-description.md @@ -0,0 +1 @@ +With {{ cns-name }}, you can send [text messages (SMS)](https://en.wikipedia.org/wiki/SMS) using _SMS notification channels_. Russian phone numbers in [E.164](https://en.wikipedia.org/wiki/E.164) format are supported, e.g., `+79991112233`. SMS messages are signed with sender text names. The maximum length of one SMS is 160 Latin characters or 70 Cyrillic characters. Longer texts are sent using multiple SMS messages. \ No newline at end of file diff --git a/en/_includes/organization/os-login-cli-organization-list.md b/en/_includes/organization/os-login-cli-organization-list.md new file mode 100644 index 00000000000..9919fe1d82c --- /dev/null +++ b/en/_includes/organization/os-login-cli-organization-list.md @@ -0,0 +1,17 @@ +Get the ID of the organization which contains the required OS Login profile of a user or [service account](../../iam/concepts/users/service-accounts.md): + +```bash +yc organization-manager organization list +``` + +Result: + +```text ++----------------------+-------------------------+-------------------------+ +| ID | NAME | TITLE | ++----------------------+-------------------------+-------------------------+ +| bpf1smsil5q0******** | sample-organization1 | Organization 1 | +| bpf2c65rqcl8******** | sample-organization2 | Organization 2 | +| bpf6dne49ue8******** | sample-organization3 | Organization 3 | ++----------------------+-------------------------+-------------------------+ +``` \ No newline at end of file diff --git a/en/_includes/organization/os-login-cli-profile-list.md b/en/_includes/organization/os-login-cli-profile-list.md new file mode 100644 index 00000000000..288cc99d2ad --- /dev/null +++ b/en/_includes/organization/os-login-cli-profile-list.md @@ -0,0 +1,20 @@ +Get a list of logins in the OS Login profiles of an organization's users and service accounts by specifying its ID: + +```bash +yc organization-manager os-login profile list \ + --organization-id +``` + +Result: + +```text ++----------------------+----------------------+-----------+----------------------+----------------------+------------+ +| ID | LOGIN | UID | ORGANIZATION ID | SUBJECT ID | IS DEFAULT | ++----------------------+----------------------+-----------+----------------------+----------------------+------------+ +| aje1eb5qm7jb******** | yc-sa-my-service-acc | 487816044 | bpfaidqca8vd******** | ajevnu4u2q3m******** | true | +| ajegs81t2k9s******** | user1 | 760684761 | bpfaidqca8vd******** | aje7b4u65nb6******** | true | +| ajej57b2kf0t******** | user2 | 1011 | bpfaidqca8vd******** | ajei280a73vc******** | true | ++----------------------+----------------------+-----------+----------------------+----------------------+------------+ +``` + +Save the `LOGIN` field value for the required user or service account: you will need it later. \ No newline at end of file diff --git a/en/_includes/organization/os-login-roles-needed-for-vm-access.md b/en/_includes/organization/os-login-roles-needed-for-vm-access.md new file mode 100644 index 00000000000..7a8306b0d1a --- /dev/null +++ b/en/_includes/organization/os-login-roles-needed-for-vm-access.md @@ -0,0 +1,11 @@ +{% list tabs %} + +- Connecting via the YC CLI + + To connect to a virtual machine or {{ k8s }} node with OS Login access enabled via the [YC CLI](../../cli/quickstart.md), the user or [service account](../../iam/concepts/users/service-accounts.md) under which you will run the YC CLI command needs the `compute.osLogin` or `compute.osAdminLogin` role, as well as the `compute.operator` role. + +- Connecting via a standard SSH client + + To connect to a virtual machine or {{ k8s }} node with OS Login access enabled via a standard SSH client, the user or [service account](../../iam/concepts/users/service-accounts.md) used for connection needs the `compute.osLogin` or `compute.osAdminLogin` role. + +{% endlist %} \ No newline at end of file diff --git a/en/_includes/organization/os-login-yc-cli-roles-needed.md b/en/_includes/organization/os-login-yc-cli-roles-needed.md deleted file mode 100644 index ee77f947c10..00000000000 --- a/en/_includes/organization/os-login-yc-cli-roles-needed.md +++ /dev/null @@ -1 +0,0 @@ -To access a VM using OS Login via the YC CLI, [assign](../../iam/operations/roles/grant.md) the `compute.osLogin` or `compute.osAdminLogin` role, as well as the `compute.operator` role to the user or service account under which you are running the YC CLI command. \ No newline at end of file diff --git a/en/_includes/pricing/currency-choice.md b/en/_includes/pricing/currency-choice.md index 4d52d152318..63162ea5527 100644 --- a/en/_includes/pricing/currency-choice.md +++ b/en/_includes/pricing/currency-choice.md @@ -1,7 +1,7 @@ {% note info %} Currency of Service rates (prices) depends on the company you made a contract with: -* Prices in US dollars are applicable to customers of Iron Hive doo Beograd (Serbia). +* Prices in US dollars are applicable to customers of Iron Hive doo Beograd (Serbia) or Direct Cursus Technology L.L.C. (Dubai). * Prices in Russian roubles are applicable to customers of Yandex.Cloud LLC. {% endnote %} diff --git a/en/_includes/pricing/use-calculator.md b/en/_includes/pricing/use-calculator.md index 9dae9f30c9e..768673a86a4 100644 --- a/en/_includes/pricing/use-calculator.md +++ b/en/_includes/pricing/use-calculator.md @@ -1 +1 @@ -To calculate the cost of using the service, use the [calculator]({{ link-cloud-calculator }}) on the {{ yandex-cloud }} website or see the prices in this section. +To calculate the cost of using the service, use the [calculator]({{ link-cloud-calculator }}) on the {{ yandex-cloud }} website or see the pricing in this section. diff --git a/en/_includes/quickstart-all-no-billing.md b/en/_includes/quickstart-all-no-billing.md index c54ab37d6d1..9e7a5d6a986 100644 --- a/en/_includes/quickstart-all-no-billing.md +++ b/en/_includes/quickstart-all-no-billing.md @@ -30,10 +30,8 @@ * [Manage data streams in {{ yds-name }}](../data-streams/quickstart/index.md). * [Use {{ iot-name }} as your framework for smart home development](../iot-core/quickstart.md). * Databases and clusters: - * [{{ CH }}](../managed-clickhouse/quickstart.md). - * [{{ MG }}](../managed-mongodb/quickstart.md). - * [{{ MY }}](../managed-mysql/quickstart.md). - * [{{ RD }}](../managed-redis/quickstart.md). + * [{{ CH }}](../managed-clickhouse/quickstart.md). + * [{{ MY }}](../managed-mysql/quickstart.md). * [{{ PG }}](../managed-postgresql/quickstart.md). * [{{ OS }}](../managed-opensearch/quickstart.md). diff --git a/en/_includes/security-deck/sd-limits.md b/en/_includes/security-deck/sd-limits.md index 95968661f92..1dc91721533 100644 --- a/en/_includes/security-deck/sd-limits.md +++ b/en/_includes/security-deck/sd-limits.md @@ -4,7 +4,7 @@ Type of limit | Value --- | --- Number of scanning sessions per folder | 10,000 Number of data sources per folder | 1,000 -Number of files per bucket to scan | 1,000 +Number of files per bucket to scan | 500 Number of results per scanning session | 1,000 Number of results per file | 1,000 -Number of results for a particular data type per file | 500 \ No newline at end of file +Number of results for a particular data type per file | 500 diff --git a/en/_includes/smartcaptcha/captcha-validation.md b/en/_includes/smartcaptcha/captcha-validation.md index eab7a89106d..3d14fea0950 100644 --- a/en/_includes/smartcaptcha/captcha-validation.md +++ b/en/_includes/smartcaptcha/captcha-validation.md @@ -1,6 +1,6 @@ After validating a request, {{ captcha-name }} assigns it an ID: a one-time token. You can use the token to retrieve the result of a user request validation from the service. The token is valid for five minutes. After this time expires, it becomes invalid and the user has to go through the validation process again. -After validation, the token is loaded into the `` element on the user's page. For example: +After validation, the token is loaded into the `` element on the user page. Here is an example: ```HTML
@@ -14,17 +14,10 @@ Where: * `
`: `div` element with a widget. * `value`: Token value. -To find out the result of the validation, send a POST request to `https://smartcaptcha.yandexcloud.net/validate`: +To find out the result of the validation, send a POST request to `https://smartcaptcha.yandexcloud.net/validate` providing parameters in `x-www-form-urlencoded` format: -```HTML -response = requests.post( -"https://smartcaptcha.yandexcloud.net/validate", - { - "secret": SMARTCAPTCHA_SERVER_KEY, - "token": token, - "ip": "" - } -) +``` +secret=&token=&ip= ``` Where: @@ -85,7 +78,7 @@ In its response, the service will return a JSON object containing the `status` a ## Request errors {#errors} -If your request to `https://smartcaptcha.yandexcloud.net/validate` is incorrect, the service will return an error. For example: +If your request to `https://smartcaptcha.yandexcloud.net/validate` is incorrect, the service will return an error. Here is an example: 1. Request missing the server key: diff --git a/en/_includes/smartwebsecurity/sum-cloud-account.md b/en/_includes/smartwebsecurity/sum-cloud-account.md index 56a02ea64cc..cef384921af 100644 --- a/en/_includes/smartwebsecurity/sum-cloud-account.md +++ b/en/_includes/smartwebsecurity/sum-cloud-account.md @@ -1,6 +1,6 @@ Billing is based on the number of requests across all [clouds](../../resource-manager/concepts/resources-hierarchy.md#cloud) linked to a single [billing account](../../billing/concepts/billing-account.md). -You pay for the actual number of legitimate requests. For each request you are charged for: +You pay for the actual number of legitimate requests. For each request, you are charged for: * Processing with security profile rules, both [basic](../../smartwebsecurity/concepts/rules.md#base-rules) and [Smart Protection](../../smartwebsecurity/concepts/rules.md#smart-protection-rules) ones. diff --git a/en/_includes/speechkit/transcribe-result-example.md b/en/_includes/speechkit/transcribe-result-example.md new file mode 100644 index 00000000000..150fb7a7aeb --- /dev/null +++ b/en/_includes/speechkit/transcribe-result-example.md @@ -0,0 +1,200 @@ +{% cut "Result example" %} + +```bash +[session_uuid { + uuid: "df49eaa2-25a55218-ae967fa1-********" + user_request_id: "f8dkup42nmhk********" +} +audio_cursors { + received_data_ms: 6600 + partial_time_ms: 6600 + final_time_ms: 6600 +} +response_wall_time_ms: 204 +final { + alternatives { + words { + text: "I" + start_time_ms: 380 + end_time_ms: 420 + } + words { + "text": "Yandex" + start_time_ms: 539 + end_time_ms: 919 + } + words { + "text": "SpeechKit" + start_time_ms: 960 + end_time_ms: 1719 + } + words { + text: "I" + start_time_ms: 2159 + end_time_ms: 2200 + } + words { + "text": "can" + start_time_ms: 2260 + end_time_ms: 2440 + } + words { + text: "turn" + start_time_ms: 2520 + end_time_ms: 3000 + } + words { + "text": "any" + start_time_ms: 3060 + end_time_ms: 3320 + } + words { + "text": "text" + start_time_ms: 3419 + end_time_ms: 3740 + } + words { + "text": "into" + start_time_ms: 3780 + end_time_ms: 3800 + } + words { + "text": "speech" + start_time_ms: 3860 + end_time_ms: 4279 + } + words { + "text": "now" + start_time_ms: 4680 + end_time_ms: 5240 + } + words { + "text": "you" + start_time_ms: 5339 + end_time_ms: 5380 + } + words { + "text": "can" + start_time_ms: 5460 + end_time_ms: 5766 + } + words { + text: "too" + start_time_ms: 5920 + end_time_ms: 6393 + } + text: "I'm Yandex SpeechKit I can turn any text into speech now you can too" + end_time_ms: 6600 + } + channel_tag: "0" +} +channel_tag: "0" +, session_uuid { + uuid: "df49eaa2-25a55218-ae967fa1-********" + user_request_id: "f8dkup42nmhk********" +} +audio_cursors { + received_data_ms: 6600 + partial_time_ms: 6600 + final_time_ms: 6600 +} +response_wall_time_ms: 204 +final_refinement { + normalized_text { + alternatives { + words { + text: "I" + start_time_ms: 380 + end_time_ms: 420 + } + words { + "text": "Yandex" + start_time_ms: 539 + end_time_ms: 919 + } + words { + "text": "SpeechKit" + start_time_ms: 960 + end_time_ms: 1719 + } + words { + text: "I" + start_time_ms: 2159 + end_time_ms: 2200 + } + words { + "text": "can" + start_time_ms: 2260 + end_time_ms: 2440 + } + words { + text: "turn" + start_time_ms: 2520 + end_time_ms: 3000 + } + words { + "text": "any" + start_time_ms: 3060 + end_time_ms: 3320 + } + words { + "text": "text" + start_time_ms: 3419 + end_time_ms: 3740 + } + words { + "text": "into" + start_time_ms: 3780 + end_time_ms: 3800 + } + words { + "text": "speech" + start_time_ms: 3860 + end_time_ms: 4279 + } + words { + "text": "now" + start_time_ms: 4680 + end_time_ms: 5240 + } + words { + "text": "you" + start_time_ms: 5339 + end_time_ms: 5380 + } + words { + "text": "can" + start_time_ms: 5460 + end_time_ms: 5766 + } + words { + text: "too" + start_time_ms: 5920 + end_time_ms: 6393 + } + text: "I'm Yandex SpeechKit I can turn any text into speech now you can too" + end_time_ms: 6600 + } + channel_tag: "0" + } +} +channel_tag: "0" +, session_uuid { + uuid: "df49eaa2-25a55218-ae967fa1-********" + user_request_id: "f8dkup42nmhk********" +} +audio_cursors { + received_data_ms: 6600 + partial_time_ms: 6600 + final_time_ms: 6600 + eou_time_ms: 6600 +} +response_wall_time_ms: 204 +eou_update { + time_ms: 6600 +} +channel_tag: "0" +] +``` + +{% endcut %} \ No newline at end of file diff --git a/en/_includes/speechsense/reports/filters.md b/en/_includes/speechsense/reports/filters.md index 497e0bc35e6..1153198ea71 100644 --- a/en/_includes/speechsense/reports/filters.md +++ b/en/_includes/speechsense/reports/filters.md @@ -1,10 +1,10 @@ -# Report filtering +# Filtering in the report You can use filtering to select the dialogs to include in your report. To do this, use the following settings: -* Period: Period of time for which the report is generated. -* Filters: Use the same fields as for the parameters. -* Grouping: Choose how to group data in your report. You can only group by metadata fields, e.g.: +* **Period**: Time period of the report. +* **Filters**: Use the same fields as for the parameters. You can also use [neuroparameters](../../../speechsense/concepts/reports/neuro-parameters.md) in filters. +* **Grouping**: Choose how to group data in your report. You can only group by metadata fields, for example: * By agent, to analyze the performance of each one. * By product, to learn which products agents make fewer mistakes presenting in dialogs. diff --git a/en/_includes/speechsense/reports/parameters.md b/en/_includes/speechsense/reports/parameters.md index 28fa6b6fd35..56f0a940648 100644 --- a/en/_includes/speechsense/reports/parameters.md +++ b/en/_includes/speechsense/reports/parameters.md @@ -3,8 +3,8 @@ * **Bot** (only for chats): Bot data. * **Speech statistics** (only for audio): Agent and customer speech quality criteria, e.g., speech rate, mutual interruptions, etc. * **General metadata**: Data about the conversation audio (collected via PBX) or text chat. Metadata is uploaded to {{ speechsense-name }} together with the conversation audio or text chat and contains its key characteristics, e.g., date, topic, and dialog language. -* **Customer tags** and **Agent tags**: Classifiers applied to conversation audio recognition results or text chat messages. {{ speechsense-name }} scans the dialog for specific keywords, phrases, or intonations, classifies the dialog, and adds a tag to it. +* **Customer tags** and **Agent tags**: Classifiers applied to conversation audio recognition results or text chat messages. {{ speechsense-name }} detects specific keywords, phrases, or intonations in the dialog, classifies and tags the dialog. - {{ speechsense-name }} has preconfigured tags. These can give you a clue as to whether there was an informal greeting or goodbye, whether the agent thanked the customer for waiting, whether it was the customer's repeat call to support, etc. You can learn more about tags [here](../../../speechsense/concepts/tags.md). + {{ speechsense-name }} has preconfigured tags. These can give you a clue as to whether there was an informal greeting or goodbye, whether the agent thanked the customer for waiting, whether it was the customer's repeat call to support, etc. You can learn more about tags [here](../../../speechsense/concepts/tags.md). -* **YandexGPT analysis**: Agent's performance criteria and customer's behavioral characteristics during the dialog, such as whether the agent was polite, whether the customer was on the rude side, etc. +* **Analysis by {{ yagpt-name }}**: Agent's performance criteria and customer's behavioral characteristics during the dialog, such as whether the agent was polite, whether the customer was on the rude side, etc. diff --git a/en/_includes/speechsense/tag/tag-settings.md b/en/_includes/speechsense/tag/tag-settings.md index 150d96398a3..f2688d0d2e6 100644 --- a/en/_includes/speechsense/tag/tag-settings.md +++ b/en/_includes/speechsense/tag/tag-settings.md @@ -16,7 +16,7 @@ A tag is assigned the _poor service_ key phrase. The search for this phrase will be performed differently depending on the **{{ ui-key.yc-ui-talkanalytics.tags.words-between-key-value }}** field value: - | Phrase example | Distance: `0` | Distance: `1` | Distance: `2` | + | Example in a dialog | Distance: `0` | Distance: `1` | Distance: `2` | | ----------- | ----------- | ----------- | ----------- | | _poor service_ | found | found | found | | _poor customer service_ | not found | found | found | diff --git a/en/_includes/storage/create-bucket.md b/en/_includes/storage/create-bucket.md index c094788bfb5..c34cf4579e7 100644 --- a/en/_includes/storage/create-bucket.md +++ b/en/_includes/storage/create-bucket.md @@ -6,7 +6,7 @@ To create a [bucket](../../storage/concepts/bucket.md), you need the _minimum_ ` - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the folder where you want to create your bucket. + 1. In the [management console]({{ link-console-main }}), select the folder you want to create a bucket in. 1. Select **{{ objstorage-name }}**. 1. Click **{{ ui-key.yacloud.storage.buckets.button_empty-create }}**. 1. On the bucket creation page: @@ -31,7 +31,7 @@ To create a [bucket](../../storage/concepts/bucket.md), you need the _minimum_ ` * `{{ ui-key.yacloud.storage.bucket.settings.class_value_cold }}`. * `{{ ui-key.yacloud.storage.bucket.settings.class_value_ice }}`. - The "colder" classes are for long-term storage of objects you intend to use less frequently. The "colder" the storage, the less you pay for it, but also the more expensive it is to read and write data. + "Cold" classes are designed to store objects that you plan to use less frequently for longer periods of time. The "colder" your storage is, the less you pay for storing data; however, the costs of reading and writing data increase. 1. Add [labels](../../storage/concepts/tags.md), if required: 1. Click **{{ ui-key.yacloud.component.label-set.button_add-label }}**. @@ -86,7 +86,7 @@ To create a [bucket](../../storage/concepts/bucket.md), you need the _minimum_ ` * `cold`: Cold storage. * `ice`: Ice storage. - The "colder" classes are for long-term storage of [objects](../../storage/concepts/object.md) you intend to use less frequently. The "colder" the storage, the less you pay for it, but also the more expensive it is to read and write data. + "Cold" classes are designed to store [objects](../../storage/concepts/object.md) that you plan to use less frequently for longer periods of time. The "colder" your storage is, the less you pay for storing data; however, the costs of reading and writing data increase. * `--max-size`: Maximum bucket size, in bytes. Default value: `0` (unlimited). * Parameters for enabling [public access](../../storage/security/public-access.md) to a bucket: @@ -101,11 +101,11 @@ To create a [bucket](../../storage/concepts/bucket.md), you need the _minimum_ ` * Parameters to configure the bucket [ACL](../../storage/concepts/acl.md): * `--acl`: Predefined ACL. For a list of possible values, see [Predefined ACLs](../../storage/concepts/acl.md#predefined-acls). You cannot use this parameter together with the `--grants` parameter. * `--grants`: Configures permissions for individual users, [service accounts](../../iam/concepts/users/service-accounts.md), [user groups](../../organization/concepts/groups.md), and [public groups](../../storage/concepts/acl.md#public-groups) (a group of all internet users or a group of all authenticated {{ yandex-cloud }} users). You cannot use this parameter together with the `--acl` parameter. The parameter value is specified in the following format: `grant-type=,grantee-id=,permission=`, where: - * `grant-type`: Type of the permission grantee. The possible values are: + * `grant-type`: Permission grantee type. The possible values are: * `grant-type-account`: User, [service account](../../iam/concepts/users/service-accounts.md), or [user group](../../organization/concepts/groups.md). * `grant-type-all-authenticated-users`: [Public group](../../storage/concepts/acl.md#public-groups) that includes all authenticated {{ yandex-cloud }} users. * `grant-type-all-users`: Public group that includes all internet users. - * `grantee-id`: ID of the user, service account, or user group to which you need to grant permission. It is only specified if `grant-type=grant-type-account`. + * `grantee-id`: ID of the user, service account, or user group you need to grant a permission to. Specified only if `grant-type=grant-type-account`. * `permission`: ACL permission type. Possible values: `permission-full-control`, `permission-write`, `permission-read`. For more information about permissions, see [Permission types](../../storage/concepts/acl.md#permissions-types). To configure multiple permissions, specify the `--grants` parameter multiple times. @@ -188,13 +188,13 @@ To create a [bucket](../../storage/concepts/bucket.md), you need the _minimum_ ` Where: * Possible types of ACL permissions: - * `--grant-read`: Permission to access the list of objects in the bucket, read various bucket settings (e.g., lifecycle, CORS, or static hosting), and read all objects in the bucket. + * `--grant-read`: Permission to access the list of objects in the bucket, read various bucket settings (lifecycle, CORS, or static hosting), and read all objects in the bucket. * `--grant-write`: Permission to write, overwrite, and delete objects in the bucket. Can only be used together with `--grant-read`. * `--grant-full-control`: Full access to the bucket and the objects in it. You can set multiple permissions within the same command. * The possible permission grantees are: - * `id=`: ID of the user, service account, or user group to which you need to grant permission. + * `id=`: ID of the user, service account, or user group you need to grant a permission to. * `uri=http://acs.amazonaws.com/groups/global/AuthenticatedUsers`: [Public group](../../storage/concepts/acl.md#public-groups) that includes all authenticated {{ yandex-cloud }} users. * `uri=http://acs.amazonaws.com/groups/global/AllUsers`: Public group that includes all internet users. @@ -202,7 +202,7 @@ To create a [bucket](../../storage/concepts/bucket.md), you need the _minimum_ ` {% endcut %} - You can learn more about the `aws s3api create-bucket` command in the [AWS documentation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/create-bucket.html). + For more information about the `aws s3api create-bucket` command, see the [AWS documentation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/create-bucket.html). - {{ TF }} {#tf} @@ -276,8 +276,8 @@ To create a [bucket](../../storage/concepts/bucket.md), you need the _minimum_ ` Where: * `yandex_iam_service_account`: Description of the [service account](../../iam/concepts/users/service-accounts.md) to create and use the [bucket](../../storage/concepts/bucket.md): - * `name`: Service account name. - * `bucket`: Bucket name. + * `name`: Service account name + * `bucket`: Bucket name By default, a bucket with a dot in the name is only available over HTTP. To provide HTTPS support for your bucket, [upload your own security certificate](../../storage/operations/hosting/certificate.md) to {{ objstorage-name }}. @@ -290,7 +290,7 @@ To create a [bucket](../../storage/concepts/bucket.md), you need the _minimum_ ` * `cold`: Cold storage. * `ice`: Ice storage. - The "colder" classes are for long-term storage of objects you intend to use less frequently. The "colder" the storage, the less you pay for it, but also the more expensive it is to read and write data. + "Cold" classes are designed to store objects that you plan to use less frequently for longer periods of time. The "colder" your storage is, the less you pay for storing data; however, the costs of reading and writing data increase. * `anonymous_access_flags`: [Access](../../storage/concepts/bucket.md#bucket-access) settings: @@ -300,9 +300,9 @@ To create a [bucket](../../storage/concepts/bucket.md), you need the _minimum_ ` * `tags`: Bucket [labels](../../storage/concepts/tags.md) in `key = "value"` format. - `name`: Required parameter Other parameters are optional. By default, the `max-size` value is `0`, public access to the bucket is disabled, and the storage class is set to `standard`. + `name`: Required parameter. Other parameters are optional. By default, the `max-size` value is `0`, public access to the bucket is disabled, and the storage class is set to `standard`. - For more information about the `yandex_storage_bucket` parameters in {{ TF }}, see the [provider documentation]({{ tf-provider-resources-link }}/storage_bucket). + For more information about the `yandex_storage_bucket` resource parameters in {{ TF }}, see the [relevant provider documentation]({{ tf-provider-resources-link }}/storage_bucket). 1. Create resources: diff --git a/en/_includes/storage/generate-signing-key.md b/en/_includes/storage/generate-signing-key.md index 19300cf33cb..a131ceb779b 100644 --- a/en/_includes/storage/generate-signing-key.md +++ b/en/_includes/storage/generate-signing-key.md @@ -1,27 +1,25 @@ -To generate a signing key, you need static access keys for {{ objstorage-name }}. To learn how to get them, see [Before you start](../../storage/s3/index.md#before-you-begin). - -Generate a signing key +To generate a signing key: 1. Use the secret key to encode the date: - ``` - DateKey = sign("AWS4" + "SecretKey", "yyyymmdd") - ``` + ``` + DateKey = sign("AWS4" + "SecretKey", "yyyymmdd") + ``` -1. Encode the region using the `DateKey` obtained in the previous step: +1. Encode the region using the `DateKey` you got in the previous step: - ``` - RegionKey = sign(DateKey, "{{ region-id }}") - ``` + ``` + RegionKey = sign(DateKey, "{{ region-id }}") + ``` -1. Encode the service using the `RegionKey` obtained in the previous step: +1. Encode the service using the `RegionKey` you got in the previous step: - ``` - ServiceKey = sign(RegionKey, "s3") - ``` + ``` + ServiceKey = sign(RegionKey, "s3") + ``` -1. Get a signing key: +1. Get the signing key: - ``` - SigningKey = sign(ServiceKey, "aws4_request") - ``` + ``` + SigningKey = sign(ServiceKey, "aws4_request") + ``` diff --git a/en/_includes/support/notify.md b/en/_includes/support/notify.md index f594b0ae975..a92c8b8d405 100644 --- a/en/_includes/support/notify.md +++ b/en/_includes/support/notify.md @@ -48,7 +48,9 @@ Some {{ yandex-cloud }} maintenance operations may affect the performance or ava ### Infrastructure failure {#infra} -If there is a {{ yandex-cloud }} failure that can potentially affect the security or availability of your data, technical support will notify you by email as soon as the scope and impact of the problem are identified. Failure notifications will be sent to the subscribers of the folder hosting the affected resource. +If there is a {{ yandex-cloud }} failure that can potentially affect the security or availability of your data, our support team will notify you by email as soon as the scope and impact of the problem are identified. Failure notifications will be sent to the subscribers of the folder hosting the affected resource. + +Our support team does not send notifications about platform incidents. You can check the availability of services on the platform component status [page](https://status.cloud.yandex.ru/dashboard) or follow the announcements in our [Telegram channel](https://t.me/yandexcloudalerts). ### Information security incident {#security} @@ -65,4 +67,4 @@ To configure notification methods: 1. Under **{{ ui-key.yacloud_components.settings.section_settings }}**, select the types of notifications to send and channels for receiving them: * ![image](../../_assets/console-icons/at.svg): Email * ![image](../../_assets/console-icons/smartphone.svg): Text message - * ![image](../../_assets/console-icons/logo-telegram.svg): Telegram bot message \ No newline at end of file + * ![image](../../_assets/console-icons/logo-telegram.svg): Telegram bot message diff --git a/en/_includes/tracker/color-issue.md b/en/_includes/tracker/color-issue.md index 9c713286941..ac4e9c4a011 100644 --- a/en/_includes/tracker/color-issue.md +++ b/en/_includes/tracker/color-issue.md @@ -4,7 +4,7 @@ By default, issue bars on the chart are colored according to the issue status ty To select a different color scheme: -1. Above the timeline on the right, click ![](../../_assets/tracker/svg/gantt-settings-button.svg) **{{ ui-key.startrek.ui_components_Gantt.timeline-config }}**. +1. Above the timeline on the right, click ![](../../_assets/tracker/svg/gantt-settings-button.svg) **Chart settings**. 1. Under **{{ ui-key.startrek-backend.fields.issue.paletteColor }}**, you can choose an appropriate color scheme: {% list tabs %} @@ -13,10 +13,10 @@ To select a different color scheme: This option allows you to set issue colors right on the chart. - 1. Select **{{ ui-key.startrek.ui_components_Gantt.color-type-by-manual }}**. + 1. Select **manual**. 1. Click **Apply**. - Select an issue from the list to the left of the chart and click ![](../../_assets/horizontal-ellipsis.svg) **{{ ui-key.startrek.ui_components_Gantt_IssueActionsCell.issue-action-menu-title }}**. This will open a palette where you can set the issue color. + Select an issue from the list to the left of the chart and click ![](../../_assets/horizontal-ellipsis.svg) **Issue actions menu**. This will open a palette where you can set the issue color. ![](../../_assets/tracker/three-dots-menu.png) @@ -25,7 +25,7 @@ To select a different color scheme: This option will be of use if you need to differentiate issues by a certain parameter, such as a queue or tag. - 1. Select **{{ ui-key.startrek.ui_components_Gantt.color-type-by-parameter }}**. + 1. Select **by task parameters**. 1. Specify the parameter whose values you want to set colors for. 1. Click **Apply**. @@ -33,7 +33,7 @@ To select a different color scheme: All issue bars on the chart will be blue. - 1. Select **{{ ui-key.startrek.ui_components_Gantt.color-type-monochrome }}**. + 1. Select **monochrome**. 1. Click **Apply**. {% endlist %} diff --git a/en/_includes/tracker/external-blockers.md b/en/_includes/tracker/external-blockers.md index 4c3601444c4..7a9dda8339a 100644 --- a/en/_includes/tracker/external-blockers.md +++ b/en/_includes/tracker/external-blockers.md @@ -1 +1 @@ -* To enable displaying external blockers in the issue list, select **{{ ui-key.startrek.ui_components_Gantt.show-external-blockers }}**. +* To enable displaying external blockers in the issue list, select **Show external blockers**. diff --git a/en/_includes/tracker/gantt-assigned.md b/en/_includes/tracker/gantt-assigned.md index 7e2f7427639..2b6c8b3aa94 100644 --- a/en/_includes/tracker/gantt-assigned.md +++ b/en/_includes/tracker/gantt-assigned.md @@ -6,6 +6,6 @@ On the Gantt chart, you can appoint or change the issue's assignee: {% note info %} -If you do not see the ![](../../_assets/tracker/svg/pick-user.svg) button on the issue bar, go to ![](../../_assets/tracker/svg/gantt-settings-button.svg) **{{ ui-key.startrek.ui_components_Gantt.timeline-config }}** and select the **assignee** item under **Issue bar**. +If you do not see the ![](../../_assets/tracker/svg/pick-user.svg) button on the issue bar, go to ![](../../_assets/tracker/svg/gantt-settings-button.svg) **Chart settings** and select the **assignee** item under **Issue bar**. {% endnote %} diff --git a/en/_includes/tracker/gantt-time-scale.md b/en/_includes/tracker/gantt-time-scale.md index 9e9d0cb9801..049d2f5c5f5 100644 --- a/en/_includes/tracker/gantt-time-scale.md +++ b/en/_includes/tracker/gantt-time-scale.md @@ -1 +1 @@ -To set up the time scale, select **{{ ui-key.startrek.ui_components_Gantt.scale-days }}**, **{{ ui-key.startrek.ui_components_Gantt.scale-month }}**, or **{{ ui-key.startrek.ui_components_Gantt.scale-quarters }}** in the bottom-right corner of the chart. The scale settings persist after refreshing the page or opening the chart again. \ No newline at end of file +To set up the time scale, select **Week**, **Month**, or **Quarter** in the bottom-right corner of the chart. The scale settings persist after refreshing the page or opening the chart again. \ No newline at end of file diff --git a/en/_includes/tracker/gantt-timing-prolongate.md b/en/_includes/tracker/gantt-timing-prolongate.md index b907e0f9ef7..52aca84d448 100644 --- a/en/_includes/tracker/gantt-timing-prolongate.md +++ b/en/_includes/tracker/gantt-timing-prolongate.md @@ -1 +1 @@ -* To set up automatic updates of start dates and deadlines for dependent issues, go to ![](../../_assets/tracker/svg/gantt-settings-button.svg) **{{ ui-key.startrek.ui_components_Gantt.timeline-config }}** and select **{{ ui-key.startrek.ui_components_Gantt.shift-blocked-with-blocker }}**. If the deadline of the blocking issue is later than the start date of the dependent issue, this start date is shifted based on the blocking issue's new deadline. +* To set up automatic updates of start dates and deadlines for dependent issues, go to ![](../../_assets/tracker/svg/gantt-settings-button.svg) **Chart settings** and select **Automatically move the deadline of the dependent issue when the blocking issue's deadline changes**. If the deadline of the blocking issue is later than the start date of the dependent issue, this start date is shifted based on the blocking issue's new deadline. diff --git a/en/_includes/tracker/issue-bar.md b/en/_includes/tracker/issue-bar.md index 5effeb91dbe..cde95d41236 100644 --- a/en/_includes/tracker/issue-bar.md +++ b/en/_includes/tracker/issue-bar.md @@ -1,7 +1,7 @@ -Above the timeline on the right, click ![](../../_assets/tracker/svg/gantt-settings-button.svg) **{{ ui-key.startrek.ui_components_Gantt.timeline-config }}** and select a setting in **Issue bar**: +Above the timeline on the right, click ![](../../_assets/tracker/svg/gantt-settings-button.svg) **Chart settings** and select a setting in **Issue bar**: -* To show the issue name on the issue bar, select the **{{ ui-key.startrek.ui_components_Gantt.show-issue-title }}** item. +* To show the issue name on the issue bar, select the **name** item. -* To show the assignee icon on the issue bar, select the **{{ ui-key.startrek.ui_components_Gantt.show-issue-assignee }}** item. +* To show the assignee icon on the issue bar, select the **assignee** item. * To have the missed deadline property (the difference between the deadline and the current date) highlighted in red on the chart, select **missed deadline**. diff --git a/en/_includes/tracker/issues-table-project.md b/en/_includes/tracker/issues-table-project.md index 7c26b31601b..9e6ccea41fe 100644 --- a/en/_includes/tracker/issues-table-project.md +++ b/en/_includes/tracker/issues-table-project.md @@ -1,8 +1,8 @@ * To select the fields you want to see in the issue list table to the left of the chart, click ![](../../_assets/tracker/svg/settings-old.svg). Select the relevant items and click **Apply**. -* To find issues in the list, start typing in the **{{ ui-key.startrek.ui_components_filter-pane.search-placeholder }}** field. +* To find issues in the list, start typing in the **{{ ui-key.startrek.ui_Common_smart-components_filter-pane.search-placeholder }}** field. -* To set up their display order in the list, click ![](../../_assets/tracker/svg/sorting.svg) **{{ ui-key.startrek.ui_components_SortButton.default-title }}**, specify the parameter, and click ![](../../_assets/tracker/svg/new-first.svg). In this case, you will not be able to move issues manually. +* To set up their display order in the list, click ![](../../_assets/tracker/svg/sorting.svg) **{{ ui-key.startrek.ui_Common_smart-components_SortButton.default-title }}**, specify the parameter, and click ![](../../_assets/tracker/svg/new-first.svg). In this case, you will not be able to move issues manually. * To group issues by their status, assignee, or other parameters, click ![](../../_assets/tracker/svg/group.svg) **Not grouped** and select the appropriate option from the list. @@ -14,7 +14,7 @@ * To hide the issue list section, click ![](../../_assets/tracker/svg/close-block.svg). -* To change the layout of the issue list, select ![](../../_assets/tracker/svg/flat-list.svg) **{{ ui-key.startrek.ui_components_filter-pane.list-mode-flat }}** or ![](../../_assets/tracker/svg/tree-list.svg) **{{ ui-key.startrek.ui_components_filter-pane.list-mode-tree }}**.{#trees} +* To change the layout of the issue list, select ![](../../_assets/tracker/svg/flat-list.svg) **{{ ui-key.startrek.ui_Common_smart-components_filter-pane.list-mode-flat }}** or ![](../../_assets/tracker/svg/tree-list.svg) **{{ ui-key.startrek.ui_Common_smart-components_filter-pane.list-mode-tree }}**.{#trees} {% note info %} @@ -26,7 +26,7 @@ In the tree list, you can create new sub-issues or change links for sub-issues: - * To create a sub-issue, click ![](../../_assets/tracker/svg/icon-add.svg) **{{ ui-key.startrek.ui_components_projects_Table.add-sub-issue }}** next to the issue: + * To create a sub-issue, click ![](../../_assets/tracker/svg/icon-add.svg) **Add sub-issue** next to the issue: * To create an issue, go to the **New issue** tab. Give your issue a name and press **Enter**. * If the issue already exists, go to the **Existing issue** tab, specify the issue key or name, and select the issue from the list. You can find the key on the issue page, under the title (for example, `TEST-1234`). @@ -37,6 +37,6 @@ {% note info %} - You can move issues manually if no sorting parameter is selected in the **{{ ui-key.startrek.ui_components_SortButton.default-title }}** field. By default, manual sorting mode is selected for the list of issues: you can drag issues in the list. + You can move issues manually if no sorting parameter is selected in the **{{ ui-key.startrek.ui_Common_smart-components_SortButton.default-title }}** field. By default, manual sorting mode is selected for the list of issues: you can drag issues in the list. {% endnote %} \ No newline at end of file diff --git a/en/_includes/tracker/issues-table-queue-filter-project.md b/en/_includes/tracker/issues-table-queue-filter-project.md index cdc5e9f17a7..b1ad5e5c9d3 100644 --- a/en/_includes/tracker/issues-table-queue-filter-project.md +++ b/en/_includes/tracker/issues-table-queue-filter-project.md @@ -1,12 +1,12 @@ * To select the fields you want to see in the issue list table to the left of the chart, click ![](../../_assets/tracker/svg/settings-old.svg). Select the relevant items and click **Apply**. -* To find issues in the list, start typing in the **{{ ui-key.startrek.ui_components_filter-pane.search-placeholder }}** field. +* To find issues in the list, start typing in the **{{ ui-key.startrek.ui_Common_smart-components_filter-pane.search-placeholder }}** field. -* To set up their display order in the list, click ![](../../_assets/tracker/svg/sorting.svg) **{{ ui-key.startrek.ui_components_SortButton.default-title }}**, specify the parameter, and click ![](../../_assets/tracker/svg/new-first.svg). In this case, you will not be able to move issues manually. +* To set up their display order in the list, click ![](../../_assets/tracker/svg/sorting.svg) **{{ ui-key.startrek.ui_Common_smart-components_SortButton.default-title }}**, specify the parameter, and click ![](../../_assets/tracker/svg/new-first.svg). In this case, you will not be able to move issues manually. * To group issues by their status, assignee, or other parameters, click ![](../../_assets/tracker/svg/group.svg) **Not grouped** and select the appropriate option from the list. -* To filter the issue list, use the filter builder. For this, on the ![](../../_assets/tracker/svg/filter.svg) **{{ ui-key.startrek.ui_components_IssueTabs.fields-tab }}** panel, select the parameters and specify the values to use for generating an issue list. +* To filter the issue list, use the filter builder. For this, on the ![](../../_assets/tracker/svg/filter.svg) **Parameters** panel, select the parameters and specify the values to use for generating an issue list. * To swap the list columns, click ![](../../_assets/tracker/svg/settings-old.svg) above the list. Next, in the **Added** section, click the parameter, hold and drag it within the section. Click **Apply**. diff --git a/en/_includes/tracker/on-premise-server.md b/en/_includes/tracker/on-premise-server.md index 9a73627db9e..9420645654a 100644 --- a/en/_includes/tracker/on-premise-server.md +++ b/en/_includes/tracker/on-premise-server.md @@ -6,11 +6,11 @@ To connect your own server to {{ tracker-name }}: 1. In the **Platform** field, select the platform your server is connected to. -1. In the **{{ ui-key.startrek.ui_components_admin-repositories_ConnectRepositoryDialog_fields_UrlField.server-url-label }}** field, specify your server address to any repository that can be accessed using a token. +1. In the **Link to repository** field, specify your server address to any repository that can be accessed using a token. 1. Get an OAuth token for your repository on GitLab. For details on how to get a token, see the [GitLab documentation](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#create-a-personal-access-token). For the proper operation of {{ tracker-name }}, enable the **read_repository** and **read_api** options when setting up permissions. -1. In the **{{ ui-key.startrek.ui_components_admin-repositories_ConnectRepositoryDialog.token-label }}** field, enter the token for connecting to your server. +1. In the **{{ ui-key.startrek.ui_Common_smart-components_admin-repositories_ConnectRepositoryDialog.token-label }}** field, enter the token for connecting to your server. 1. Click **Connect**. diff --git a/en/_includes/tracker/open-personal-settings.md b/en/_includes/tracker/open-personal-settings.md index 2f1fbe16ba1..9f760413bf1 100644 --- a/en/_includes/tracker/open-personal-settings.md +++ b/en/_includes/tracker/open-personal-settings.md @@ -1 +1 @@ -In the left-hand panel, click ![](../../_assets/tracker/svg/settings.svg) **{{ ui-key.startrek.ui_components_PageAgileBoard_PageAgileBoardHeader.settings }}**. +In the left-hand panel, click ![](../../_assets/tracker/svg/settings.svg) **{{ ui-key.startrek.ui_Boards_pages_PageAgileBoard_PageAgileBoardHeader.settings }}**. diff --git a/en/_includes/tracker/repository-path.md b/en/_includes/tracker/repository-path.md index ef12938af2b..9ecaf0334a5 100644 --- a/en/_includes/tracker/repository-path.md +++ b/en/_includes/tracker/repository-path.md @@ -1 +1 @@ -In the left-hand panel, click ![](../../_assets/tracker/svg/still.svg) and select **Admin settings** → ![](../../_assets/tracker/svg/repositories.svg) **{{ ui-key.startrek.ui_components_page-admin_PageAdmin.menu-item-repositories }}** → **{{ ui-key.startrek.ui_components_admin-repositories_ConnectRepositoryDialog.connect }}**. \ No newline at end of file +In the left-hand panel, click ![](../../_assets/tracker/svg/still.svg) and select **Admin settings** → ![](../../_assets/tracker/svg/repositories.svg) **{{ ui-key.startrek.ui_Common_smart-components_page-admin_PageAdmin.menu-item-repositories }}** → **{{ ui-key.startrek.ui_Common_smart-components_admin-repositories_ConnectRepositoryDialog.connect }}**. \ No newline at end of file diff --git a/en/_includes/tracker/task-by-mail.md b/en/_includes/tracker/task-by-mail.md index 073bfbb221f..981b16e4ee9 100644 --- a/en/_includes/tracker/task-by-mail.md +++ b/en/_includes/tracker/task-by-mail.md @@ -6,16 +6,16 @@ 1. {% include [go to settings](transition-page.md) %} - 1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. + 1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. - 1. Select **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-aliases }}**. + 1. Select **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-aliases }}**. 1. Click **Configure mail**. 1. Set up the mailbox for receiving messages: - 1. Under **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.mail-settings-title }}**, in the **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.mail-address }}** field, specify the email address you created in Step 1, including the domain, e.g., `{{ example-account }}`. The **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.mail-login }}** field will be populated automatically. - 1. In the **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.mail-password }}** field, provide the password for your email address. If the selected email server allows you to control access to the mailbox by an application password, enter the application's password for email clients in this field. + 1. Under **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.mail-settings-title }}**, in the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.mail-address }}** field, specify the email address you created in Step 1, including the domain, e.g., `{{ example-account }}`. The **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.mail-login }}** field will be populated automatically. + 1. In the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.mail-password }}** field, provide the password for your email address. If the selected email server allows you to control access to the mailbox by an application password, enter the application's password for email clients in this field. {% note info "If the setup failed with a 404 error" %} @@ -26,15 +26,15 @@ [Learn more about application passwords in the Yandex ID documentation]({{ link-yandex }}/support/id/authorization/app-passwords.html). - 1. Enter the **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.mail-imap }}** and the email server **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.mail-port }}**: you need them to collect emails. You can find this data in your email account settings. - 1. To enable SSL encryption, select **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.mail-ssl }}**. - 1. If you need to process emails not only from the organization's employees but from external users as well, enable the **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.mail-allow-external }}** setting. + 1. Enter the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.mail-imap }}** and the email server **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.mail-port }}**: you need them to collect emails. You can find this data in your email account settings. + 1. To enable SSL encryption, select **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.mail-ssl }}**. + 1. If you need to process emails not only from the organization's employees but from external users as well, enable the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.mail-allow-external }}** setting. {% cut "Additional parameters" %} - * **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.mail-incoming-folder }}**: Create a folder for emails from {{ tracker-name }} and specify its name. Any emails sent to this folder will automatically be converted to queue issues. - * **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.mail-archive-folder }}**: Create a folder for archiving emails from {{ tracker-name }} and specify its name. - * **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.mail-process-messages-from }}**: Set the date. Emails received prior to this date are not processed and are automatically moved to the **Archive** folder. + * **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.mail-incoming-folder }}**: Create a folder for emails from {{ tracker-name }} and specify its name. Any emails sent to this folder will automatically be converted to queue issues. + * **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.mail-archive-folder }}**: Create a folder for archiving emails from {{ tracker-name }} and specify its name. + * **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.mail-process-messages-from }}**: Set the date. Emails received prior to this date are not processed and are automatically moved to the **Archive** folder. {% note alert %} @@ -49,15 +49,15 @@ 1. Specify the parameters to create issues from your email with: the issue type and [components](../../tracker/manager/components.md). 1. If you want the issue comments to be also sent as emails, set up a mailbox for sending messages: - 1. Under **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesFormSendPanel.send-settings-title }}**, click ![](../../_assets/tracker/svg/add-address.svg) **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesStateList.action-add-mail }}**. - 1. In the **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesFormSendPanel.send-mail-login }}** field, specify the email address to send emails as issue comments from, e.g., `{{ example-account }}`. - 1. In the **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesFormSendPanel.send-mail-password }}** field, provide the password for your email address. - 1. Specify the **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesFormSendPanel.send-mail-smtp }}** and **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesFormSendPanel.send-mail-port }}** to enable sending emails. You can find this data in your email account settings. - 1. To enable SSL encryption, select **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesFormSendPanel.send-mail-ssl }}**. - 1. Set up **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesFormSendPanel.signature-settings-title }}** for emails to send. Make sure to specify the **{{ ui-key.startrek.ui_components_page-queue-admin_Signature.alias-title }}**, as you will need it to distinguish signatures in the common list. Your email recipients will see the nickname instead of the sender name. - 1. Test that everything is up and running: click ![](../../_assets/tracker/svg/send-email.svg) **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesFormSendPanel.test-mail-button }}**. + 1. Under **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesFormSendPanel.send-settings-title }}**, click ![](../../_assets/tracker/svg/add-address.svg) **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesStateList.action-add-mail }}**. + 1. In the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesFormSendPanel.send-mail-login }}** field, specify the email address to send emails as issue comments from, e.g., `{{ example-account }}`. + 1. In the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesFormSendPanel.send-mail-password }}** field, provide the password for your email address. + 1. Specify the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesFormSendPanel.send-mail-smtp }}** and **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesFormSendPanel.send-mail-port }}** to enable sending emails. You can find this data in your email account settings. + 1. To enable SSL encryption, select **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesFormSendPanel.send-mail-ssl }}**. + 1. Set up **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesFormSendPanel.signature-settings-title }}** for emails to send. Make sure to specify the **Alias**, as you will need it to distinguish signatures in the common list. Your email recipients will see the nickname instead of the sender name. + 1. Test that everything is up and running: click ![](../../_assets/tracker/svg/send-email.svg) **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesFormSendPanel.test-mail-button }}**. - 1. Click **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.save-button }}**. The queue's email address will get running within an hour after creation. + 1. Click **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.save-button }}**. The queue's email address will get running within an hour after creation. 1. Enable sending issue comments as emails: 1. In the queue settings, select **Basic settings**. @@ -73,21 +73,21 @@ 1. {% include [go to settings](transition-page.md) %} - 1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. + 1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. - 1. Select **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-aliases }}**. + 1. Select **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-aliases }}**. - 1. Check whether your organization has an [email domain]({{ support-business-domain }}) in {{ ya-360 }}. Otherwise, click **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesStateList.action-domain }}** to open {{ ya-360 }} and create a domain. If you already have a email domain set up in another service, you can create a subdomain for it and [connect it to {{ ya-360 }}]({{ support-business-domain }}). + 1. Check whether your organization has an [email domain]({{ support-business-domain }}) in {{ ya-360 }}. Otherwise, click **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesStateList.action-domain }}** to open {{ ya-360 }} and create a domain. If you already have a email domain set up in another service, you can create a subdomain for it and [connect it to {{ ya-360 }}]({{ support-business-domain }}). 1. Click **Configure mail**. 1. Set up a mailbox for receiving and sending messages. - 1. In the **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.mail-address }}** field, specify a new email address to be used only for the queue. - 1. If you need to process emails not only from the organization's employees but from external users as well, enable the **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.mail-allow-external }}** setting. + 1. In the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.mail-address }}** field, specify a new email address to be used only for the queue. + 1. If you need to process emails not only from the organization's employees but from external users as well, enable the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.mail-allow-external }}** setting. 1. Specify the parameters with which the issues should be created in the queue: the [issue type](../../tracker/manager/add-ticket-type.md) and [components](../../tracker/manager/components.md). - 1. Set up signatures for the sent emails. Make sure to specify the **{{ ui-key.startrek.ui_components_page-queue-admin_Signature.alias-title }}**, as you will need it to distinguish signatures in the common list. Your email recipients will see the nickname instead of the sender name. Check that everything is up and running by sending a test email. + 1. Set up signatures for the sent emails. Make sure to specify the **Alias**, as you will need it to distinguish signatures in the common list. Your email recipients will see the nickname instead of the sender name. Check that everything is up and running by sending a test email. 1. Click **Create**. The queue's email address will get running within an hour after creation. diff --git a/en/_includes/tracker/timeline-area.md b/en/_includes/tracker/timeline-area.md index fe4e60f9a57..81918c46d04 100644 --- a/en/_includes/tracker/timeline-area.md +++ b/en/_includes/tracker/timeline-area.md @@ -1,8 +1,8 @@ On a chart, you can configure the shift logic for dependent and parent issues, as well as issue link display. -Above the timeline on the right, click ![](../../_assets/tracker/svg/gantt-settings-button.svg) **{{ ui-key.startrek.ui_components_Gantt.timeline-config }}** and select a setting in **Issue bar**: +Above the timeline on the right, click ![](../../_assets/tracker/svg/gantt-settings-button.svg) **Chart settings** and select a setting in **Issue bar**: -* To have issues with the _Depends on — Blocks_ link joined with an arrow on the chart, select **{{ ui-key.startrek.ui_components_Gantt.show-links }}**. +* To have issues with the _Depends on — Blocks_ link joined with an arrow on the chart, select **Show blocking links**. * To automatically move the deadline of the dependent issue when the blocking issue's deadline changes, select the appropriate option. diff --git a/en/_includes/video/add-subtitles-optional.md b/en/_includes/video/add-subtitles-optional.md new file mode 100644 index 00000000000..0f4bd92d29a --- /dev/null +++ b/en/_includes/video/add-subtitles-optional.md @@ -0,0 +1,7 @@ +(Optional) To add [subtitles](../../video/concepts/videos.md#subtitles) to a video, in the **{{ ui-key.yacloud_video.videos.label_subtitles }}** field, click **{{ ui-key.yacloud_video.common.action_add }}**: + +1. In the window that opens, select the subtitle language. +1. Click **Select file** and select the file with subtitles. +1. Click **{{ ui-key.yacloud_video.common.action_create }}**. + + Wait for the file to upload. \ No newline at end of file diff --git a/en/_includes/video/get-key.md b/en/_includes/video/get-key.md index 98882474758..9a9cb9a2f33 100644 --- a/en/_includes/video/get-key.md +++ b/en/_includes/video/get-key.md @@ -2,18 +2,18 @@ - {{ video-name }} interface {#console} - 1. Open the {{ video-name }} [home page]({{ link-video-main }}). - 1. Select a channel. - 1. In the ![image](../../_assets/console-icons/antenna-signal.svg) **{{ ui-key.yacloud_video.streams.title_streams }}** tab, select a stream. - 1. In the stream settings window that opens, copy the following field values: + 1. Open the {{ video-name }} [home page]({{ link-video-main }}). + 1. Select a channel. + 1. In the ![image](../../_assets/console-icons/antenna-signal.svg) **{{ ui-key.yacloud_video.streams.title_streams }}** tab, select the broadcast you need. + 1. In the stream settings window that opens, copy the following field values: - * **{{ ui-key.yacloud_video.stream-lines.label_stream-key }}**. - * **{{ ui-key.yacloud_video.stream-lines.label_server-address }}**. + * **{{ ui-key.yacloud_video.stream-lines.label_stream-key }}** + * **{{ ui-key.yacloud_video.stream-lines.label_server-address }}** - API {#api} - To get the server address, use the [StreamLineService/Get](../../video/api-ref/grpc/StreamLine/get.md) gRPC API call. + Use the [get](../../video/api-ref/StreamLine/get.md) REST API method for the [StreamLine](../../video/api-ref/StreamLine/index.md) resource or the [StreamLineService/Get](../../video/api-ref/grpc/StreamLine/get.md) gRPC API call. - To get the stream key, use the [StreamLineService/GetStreamKey](../../video/api-ref/grpc/StreamLine/getStreamKey.md) gRPC API call. + Use the [getStreamKey](../../video/api-ref/StreamLine/getStreamKey.md) REST API method for the [StreamLine](../../video/api-ref/StreamLine/index.md) resource or the [StreamLineService/GetStreamKey](../../video/api-ref/grpc/StreamLine/getStreamKey.md) gRPC API call. {% endlist %} diff --git a/en/_includes/vision/ai-before-beginning.md b/en/_includes/vision/ai-before-beginning.md index f248f5308f7..235b3d0383b 100644 --- a/en/_includes/vision/ai-before-beginning.md +++ b/en/_includes/vision/ai-before-beginning.md @@ -52,6 +52,6 @@ Get your account data for authentication: Authorization: Api-Key ``` - Do not specify the folder ID in your requests, as {{ yagpt-name }} uses the folder in which the service account was created. + Do not specify the folder ID in your requests, as the service uses the folder the service account was created in. {% endlist %} \ No newline at end of file diff --git a/en/_pricing/compute/usd-instance-resources.md b/en/_pricing/compute/usd-instance-resources.md index 3a1ebda6b45..997d4ac9bac 100644 --- a/en/_pricing/compute/usd-instance-resources.md +++ b/en/_pricing/compute/usd-instance-resources.md @@ -19,6 +19,10 @@ | 100% vCPU | {{ sku|USD|compute.vm.cpu.c100.v3|string }} | {{ sku|USD|compute.vm.cpu.c100.preemptible.v3|string }} | {{ sku|USD|v1.commitment.selfcheckout.m6.compute.vm.cpu.c100.standard.v3|string }} | {{ sku|USD|v1.commitment.selfcheckout.y1.compute.vm.cpu.c100.standard.v3|string }} | | 1 NVIDIA T4 GPU | {{ sku|USD|compute.vm.gpu.standard.v3-t4|string }} | {{ sku|USD|compute.vm.gpu.standard.v3-t4.preemptible|string }} | − | − | | RAM (for 1 GB) | {{ sku|USD|compute.vm.ram.v3|string }} | {{ sku|USD|compute.vm.ram.preemptible.v3|string }} | {{ sku|USD|v1.commitment.selfcheckout.m6.compute.vm.ram.standard.v3|string }} | {{ sku|USD|v1.commitment.selfcheckout.y1.compute.vm.ram.standard.v3|string }} | +| **Intel Ice Lake with T4i** | Regular VM | Preemptible VM | | | +| 100% vCPU | $0.008400 | $0.008400 | - | - | +| 1 GPU | $1.152000 | $1.152000 | - | - | +| RAM (for 1 GB) | $0.002240 | $0.002240 | - | - | | **Intel Ice Lake (Compute Optimized)** | Regular VM | Preemptible VM | | | | 100% vCPU | {{ sku|USD|compute.vm.cpu.c100.highfreq-v3|string }} | - | − | − | | RAM (for 1 GB) | {{ sku|USD|compute.vm.ram.highfreq-v3|string }} | - | − | − | @@ -31,4 +35,4 @@ | 1 GPU | $13.338400 | $13.338400 | - | - | | RAM (for 1 GB) | $0.002240 | $0.002240 | - | - | -^*^ Feature is available on request, subject to technical availability. \ No newline at end of file +^*^ Feature is available on request, subject to technical availability. diff --git a/en/_pricing_examples/managed-kafka/usd-hour.md b/en/_pricing_examples/managed-kafka/usd-hour.md index a5381274aaa..c6c4ad3acd9 100644 --- a/en/_pricing_examples/managed-kafka/usd-hour.md +++ b/en/_pricing_examples/managed-kafka/usd-hour.md @@ -1,60 +1,60 @@ Cost calculation for {{ KF }} broker hosts: -> 3 × (2 × $0.012080 + 8 × $0.003200) = $0.149280 +> 3 × (2 × {{ sku|USD|mdb.cluster.kafka.v3.cpu.c100|string }} + 8 × {{ sku|USD|mdb.cluster.kafka.v3.ram|string }}) = {% calc [currency=USD] 3 × (2 × {{ sku|USD|mdb.cluster.kafka.v3.cpu.c100|number }} + 8 × {{ sku|USD|mdb.cluster.kafka.v3.ram|number }}) %} > -> Total: $0.149280, per hour cost of {{ KF }} broker hosts. +> Total: {% calc [currency=USD] 3 × (2 × {{ sku|USD|mdb.cluster.kafka.v3.cpu.c100|number }} + 8 × {{ sku|USD|mdb.cluster.kafka.v3.ram|number }}) %}, per hour cost of {{ KF }} broker hosts. Where: * 3: Number of {{ KF }} broker hosts. * 2: Number of vCPUs. -* $0.012080: Cost of using 100% vCPU per hour. +* {{ sku|USD|mdb.cluster.kafka.v3.cpu.c100|string }}: Cost of using 100% vCPU per hour. * 8: Amount of RAM per host (in GB). -* $0.003200: Cost of using 1 GB of RAM at 100% vCPU per hour. +* {{ sku|USD|mdb.cluster.kafka.v3.ram|string }}: Cost of using 1 GB of RAM at 100% vCPU per hour. Calculating the cost of storage for {{ KF }} broker hosts: -> 3 × 100 × $0.025600 = $7.680000 +> 3 × 100 × {{ sku|USD|mdb.cluster.network-hdd.kafka|month|string }} = {% calc [currency=USD] 3 × 100 × {{ sku|USD|mdb.cluster.network-hdd.kafka|month|number }} %} > -> Total: $7.680000, cost of storage for {{ KF }} broker hosts. +> Total: {% calc [currency=USD] 3 × 100 × {{ sku|USD|mdb.cluster.network-hdd.kafka|month|number }} %}, cost of storage for {{ KF }} broker hosts. Where: * 3: Number of {{ KF }} broker hosts. * 100: Amount of network HDD storage (in GB). -* $0.025600: Cost of using 1 GB of network HDD storage per month. +* {{ sku|USD|mdb.cluster.network-hdd.kafka|month|string }}: Cost of using 1 GB of network HDD storage per month. Cost calculation for {{ ZK }} hosts: -> 3 × (2 × $0.005600 + 4 × $0.002240) = $0.060480 +> 3 × (2 × {{ sku|USD|mdb.zk.kafka.v3.cpu.c50|string }} + 4 × {{ sku|USD|mdb.zk.kafka.v3.ram|string }}) = {% calc [currency=USD] 3 × (2 × {{ sku|USD|mdb.zk.kafka.v3.cpu.c50|number }} + 4 × {{ sku|USD|mdb.zk.kafka.v3.ram|number }}) %} > -> Total: $0.060480, per hour cost of {{ ZK }} hosts. +> Total: {% calc [currency=USD] 3 × (2 × {{ sku|USD|mdb.zk.kafka.v3.cpu.c50|number }} + 4 × {{ sku|USD|mdb.zk.kafka.v3.ram|number }}) %}, per hour cost of {{ ZK }} hosts. Where: * 3: Number of {{ ZK }} hosts. * 2: Number of vCPUs. -* $0.005600: Cost of using 50% vCPU per hour. +* {{ sku|USD|mdb.zk.kafka.v3.cpu.c50|string }}: Cost of using 50% vCPU per hour. * 4: Amount of RAM per host (in GB). -* $0.002240: Cost of using 1 GB of RAM at 50% vCPU per hour. +* {{ sku|USD|mdb.zk.kafka.v3.ram|string }}: Cost of using 1 GB of RAM at 50% vCPU per hour. Calculating the cost of storage for {{ ZK }} hosts: -> 3 × 10 × $0.104080 = $3.122400 +> 3 × 10 × {{ sku|USD|mdb.cluster.network-nvme.kafka|month|string }} = {% calc [currency=USD] 3 × 10 × {{ sku|USD|mdb.cluster.network-nvme.kafka|month|number }} %} > -> Total: $3.122400, cost of storage for {{ ZK }} hosts. +> Total: {% calc [currency=USD] 3 × 10 × {{ sku|USD|mdb.cluster.network-nvme.kafka|month|number }} %}, cost of storage for {{ ZK }} hosts. Where: * 3: Number of {{ ZK }} hosts. * 10: Amount of SSD network storage (in GB). -* $0.104080: Cost of using 1 GB of network SSD storage per month. +* {{ sku|USD|mdb.cluster.network-nvme.kafka|month|string }}: Cost of using 1 GB of network SSD storage per month. Total cost calculation: -> 720 × ($0.149280 + $0.060480) + $7.680000 + $3.122400 = $161.829600 +> 720 × ({% calc [currency=USD] 3 × (2 × {{ sku|USD|mdb.cluster.kafka.v3.cpu.c100|number }} + 8 × {{ sku|USD|mdb.cluster.kafka.v3.ram|number }}) %} + {% calc [currency=USD] 3 × (2 × {{ sku|USD|mdb.zk.kafka.v3.cpu.c50|number }} + 4 × {{ sku|USD|mdb.zk.kafka.v3.ram|number }}) %}) + {% calc [currency=USD] 3 × 100 × {{ sku|USD|mdb.cluster.network-hdd.kafka|month|number }} %} + {% calc [currency=USD] 3 × 10 × {{ sku|USD|mdb.cluster.network-nvme.kafka|month|number }} %} = {% calc [currency=USD] 720 × ((3 × (2 × {{ sku|USD|mdb.cluster.kafka.v3.cpu.c100|number }} + 8 × {{ sku|USD|mdb.cluster.kafka.v3.ram|number }})) + (3 × (2 × {{ sku|USD|mdb.zk.kafka.v3.cpu.c50|number }} + 4 × {{ sku|USD|mdb.zk.kafka.v3.ram|number }}))) + (3 × 100 × {{ sku|USD|mdb.cluster.network-hdd.kafka|month|number }}) + (3 × 10 × {{ sku|USD|mdb.cluster.network-nvme.kafka|month|number }}) %} > -> Total: $161.829600, cost of using the cluster for 30 days. +> Total: {% calc [currency=USD] 720 × ((3 × (2 × {{ sku|USD|mdb.cluster.kafka.v3.cpu.c100|number }} + 8 × {{ sku|USD|mdb.cluster.kafka.v3.ram|number }})) + (3 × (2 × {{ sku|USD|mdb.zk.kafka.v3.cpu.c50|number }} + 4 × {{ sku|USD|mdb.zk.kafka.v3.ram|number }}))) + (3 × 100 × {{ sku|USD|mdb.cluster.network-hdd.kafka|month|number }}) + (3 × 10 × {{ sku|USD|mdb.cluster.network-nvme.kafka|month|number }}) %}, cost of using the cluster for 30 days. Where: * 720: Number of hours in 30 days. -* $0.149280: Per hour cost of {{ KF }} broker hosts. -* $0.060480: Per hour cost of {{ ZK }} hosts. -* $7.680000: Cost of storage for {{ KF }} broker hosts. -* $3.122400: Cost of storage for {{ ZK }} hosts. \ No newline at end of file +* {% calc [currency=USD] 3 × (2 × {{ sku|USD|mdb.cluster.kafka.v3.cpu.c100|number }} + 8 × {{ sku|USD|mdb.cluster.kafka.v3.ram|number }}) %}: Per hour cost of {{ KF }} broker hosts. +* {% calc [currency=USD] 3 × (2 × {{ sku|USD|mdb.zk.kafka.v3.cpu.c50|number }} + 4 × {{ sku|USD|mdb.zk.kafka.v3.ram|number }}) %}: Per hour cost of {{ ZK }} hosts. +* {% calc [currency=USD] 3 × 100 × {{ sku|USD|mdb.cluster.network-hdd.kafka|month|number }} %}: Cost of storage for {{ KF }} broker hosts. +* {% calc [currency=USD] 3 × 10 × {{ sku|USD|mdb.cluster.network-nvme.kafka|month|number }} %}: Cost of storage for {{ ZK }} hosts. \ No newline at end of file diff --git a/en/_pricing_examples/managed-mongodb/usd-host.md b/en/_pricing_examples/managed-mongodb/usd-host.md index cbda5bdff5f..815b99f421b 100644 --- a/en/_pricing_examples/managed-mongodb/usd-host.md +++ b/en/_pricing_examples/managed-mongodb/usd-host.md @@ -1,10 +1,10 @@ -> 3 × (2 × $0.012800 + 8 × $0.007200) = $0.249600 +> 3 × (2 × {{ sku|USD|mdb.cluster.mongodb.v3.cpu.c100|string }} + 8 × {{ sku|USD|mdb.cluster.mongodb.v3.ram|string }}) = {% calc [currency=USD] 3 × (2 × {{ sku|USD|mdb.cluster.mongodb.v3.cpu.c100|number }} + 8 × {{ sku|USD|mdb.cluster.mongodb.v3.ram|number }}) %} -> Total: $0.249600, cost of operation of {{ MG }} hosts per hour. +> Total: {% calc [currency=USD] 3 × (2 × {{ sku|USD|mdb.cluster.mongodb.v3.cpu.c100|number }} + 8 × {{ sku|USD|mdb.cluster.mongodb.v3.ram|number }}) %}, cost of operation of {{ MG }} hosts per hour. Where: * 3: Number of {{ MG }} hosts * 2: Number of vCPUs -* $0.012800: Cost of using 100% vCPU per hour +* {{ sku|USD|mdb.cluster.mongodb.v3.cpu.c100|string }}: Cost of using 100% vCPU per hour * 8: Amount of RAM per {{ MG }} host (in GB) -* $0.007200: Cost of using 1 GB of RAM at 100% vCPU per hour \ No newline at end of file +* {{ sku|USD|mdb.cluster.mongodb.v3.ram|string }}: Cost of using 1 GB of RAM at 100% vCPU per hour \ No newline at end of file diff --git a/en/_pricing_examples/managed-mongodb/usd-storage.md b/en/_pricing_examples/managed-mongodb/usd-storage.md index e2b1c4f5c26..07ccb896e93 100644 --- a/en/_pricing_examples/managed-mongodb/usd-storage.md +++ b/en/_pricing_examples/managed-mongodb/usd-storage.md @@ -1,9 +1,9 @@ -> 720 × $0.249600 + 100 × $0.025600 = $182.272000 +> 720 × {% calc [currency=USD] 3 × (2 × {{ sku|USD|mdb.cluster.mongodb.v3.cpu.c100|number }} + 8 × {{ sku|USD|mdb.cluster.mongodb.v3.ram|number }}) %} + 100 × {{ sku|USD|mdb.cluster.network-hdd.ch|month|string }} = {% calc [currency=USD] 720 × (3 × (2 × {{ sku|USD|mdb.cluster.mongodb.v3.cpu.c100|number }} + 8 × {{ sku|USD|mdb.cluster.mongodb.v3.ram|number }})) + 100 × {{ sku|USD|mdb.cluster.network-hdd.ch|month|number }} %} > -> Total: $182.272000, cost of using the cluster for 30 days. +> Total: {% calc [currency=USD] 720 × (3 × (2 × {{ sku|USD|mdb.cluster.mongodb.v3.cpu.c100|number }} + 8 × {{ sku|USD|mdb.cluster.mongodb.v3.ram|number }})) + 100 × {{ sku|USD|mdb.cluster.network-hdd.ch|month|number }} %}, cost of using the cluster for 30 days. Where: * 720: Number of hours in 30 days -* $0.249600: Cost of operation of {{ MG }} hosts per hour +* {% calc [currency=USD] 3 × (2 × {{ sku|USD|mdb.cluster.mongodb.v3.cpu.c100|number }} + 8 × {{ sku|USD|mdb.cluster.mongodb.v3.ram|number }}) %}: Cost of operation of {{ MG }} hosts per hour * 100: Amount of network HDD storage (in GB) -* $0.025600: Cost of using 1 GB of network HDD storage per month \ No newline at end of file +* {{ sku|USD|mdb.cluster.network-hdd.ch|month|string }}: Cost of using 1 GB of network HDD storage per month \ No newline at end of file diff --git a/en/_pricing_examples/smartwebsecurity/usd-smartwebsecurity-pack.md b/en/_pricing_examples/smartwebsecurity/usd-smartwebsecurity-pack.md index 94f4219e6e6..66143c77c74 100644 --- a/en/_pricing_examples/smartwebsecurity/usd-smartwebsecurity-pack.md +++ b/en/_pricing_examples/smartwebsecurity/usd-smartwebsecurity-pack.md @@ -1,7 +1,7 @@ | Number of requests per month, million | Cost of requests allowed by the security profile, including VAT | Cost of requests allowed by the security profile and WAF, including VAT | | --- | --- | --- | -| 1 | $200.00 | $400.00 | -| 10 | $452.00 | $904.00 | -| 100 | $596.00 | $1,192.00 | -| 1 000 | $1,604.00 | $3,208.00 | -| 10 000 | $5,204.00 | $10,408.00 | \ No newline at end of file +| 1 | {{ sku|USD|sws.requests.v1|pricingRate.0.01|string }} | {% calc [currency=USD] {{ sku|USD|sws.requests.v1|pricingRate.0.01|number }} + {{ sku|USD|sws.waf.requests.v1|pricingRate.0.01|number }} %} | +| 10 | {% calc [currency=USD] {{ sku|USD|sws.requests.v1|pricingRate.0.01|number }} + {{ sku|USD|sws.requests.v1|pricingRate.1|number }} × 9 %} | {% calc [currency=USD] ({{ sku|USD|sws.requests.v1|pricingRate.0.01|number }} + {{ sku|USD|sws.requests.v1|pricingRate.1|number }} × 9) + ({{ sku|USD|sws.waf.requests.v1|pricingRate.0.01|number }} + {{ sku|USD|sws.waf.requests.v1|pricingRate.1|number }} × 9) %} | +| 100 | {% calc [currency=USD] {{ sku|USD|sws.requests.v1|pricingRate.0.01|number }} + {{ sku|USD|sws.requests.v1|pricingRate.1|number }} × 9 + {{ sku|USD|sws.requests.v1|pricingRate.10|number }} × 90 %} | {% calc [currency=USD] ({{ sku|USD|sws.requests.v1|pricingRate.0.01|number }} + {{ sku|USD|sws.requests.v1|pricingRate.1|number }} × 9 + {{ sku|USD|sws.requests.v1|pricingRate.10|number }} × 90) + ({{ sku|USD|sws.waf.requests.v1|pricingRate.0.01|number }} + {{ sku|USD|sws.waf.requests.v1|pricingRate.1|number }} × 9 + {{ sku|USD|sws.waf.requests.v1|pricingRate.10|number }} × 90) %} | +| 1 000 | {% calc [currency=USD] {{ sku|USD|sws.requests.v1|pricingRate.0.01|number }} + {{ sku|USD|sws.requests.v1|pricingRate.1|number }} × 9 + {{ sku|USD|sws.requests.v1|pricingRate.10|number }} × 90 + {{ sku|USD|sws.requests.v1|pricingRate.100|number }} × 900 %} | {% calc [currency=USD] ({{ sku|USD|sws.requests.v1|pricingRate.0.01|number }} + {{ sku|USD|sws.requests.v1|pricingRate.1|number }} × 9 + {{ sku|USD|sws.requests.v1|pricingRate.10|number }} × 90 + {{ sku|USD|sws.requests.v1|pricingRate.100|number }} × 900) + ({{ sku|USD|sws.waf.requests.v1|pricingRate.0.01|number }} + {{ sku|USD|sws.waf.requests.v1|pricingRate.1|number }} × 9 + {{ sku|USD|sws.waf.requests.v1|pricingRate.10|number }} × 90 + {{ sku|USD|sws.waf.requests.v1|pricingRate.100|number }} × 900) %} | +| 10 000 | {% calc [currency=USD] {{ sku|USD|sws.requests.v1|pricingRate.0.01|number }} + {{ sku|USD|sws.requests.v1|pricingRate.1|number }} × 9 + {{ sku|USD|sws.requests.v1|pricingRate.10|number }} × 90 + {{ sku|USD|sws.requests.v1|pricingRate.100|number }} × 900 + {{ sku|USD|sws.requests.v1|pricingRate.1000|number }} × 9000 %} | {% calc [currency=USD] ({{ sku|USD|sws.requests.v1|pricingRate.0.01|number }} + {{ sku|USD|sws.requests.v1|pricingRate.1|number }} × 9 + {{ sku|USD|sws.requests.v1|pricingRate.10|number }} × 90 + {{ sku|USD|sws.requests.v1|pricingRate.100|number }} × 900 + {{ sku|USD|sws.requests.v1|pricingRate.1000|number }} × 9000) + ({{ sku|USD|sws.waf.requests.v1|pricingRate.0.01|number }} + {{ sku|USD|sws.waf.requests.v1|pricingRate.1|number }} × 9 + {{ sku|USD|sws.waf.requests.v1|pricingRate.10|number }} × 90 + {{ sku|USD|sws.waf.requests.v1|pricingRate.100|number }} × 900 + {{ sku|USD|sws.waf.requests.v1|pricingRate.1000|number }} × 9000) %} | \ No newline at end of file diff --git a/en/_pricing_examples/smartwebsecurity/usd-smartwebsecurity-waf.md b/en/_pricing_examples/smartwebsecurity/usd-smartwebsecurity-waf.md new file mode 100644 index 00000000000..2a0210b1cbc --- /dev/null +++ b/en/_pricing_examples/smartwebsecurity/usd-smartwebsecurity-waf.md @@ -0,0 +1,13 @@ +You can only connect a WAF profile when a security profile is used. Therefore, you pay for processing requests both by WAF and security profile rules. + +> Let’s calculate the cost of 315.04 million legitimate requests per month processed by security and WAF profile rules: +> (0.01 × $0.000000 + 0.99 × $200.000000 + 9 × $28.000000 + 90 × $1.600000 + 215.04 × $1.120000) × 2 = $1669.689600, excluding VAT. + +Where: + +* 0.01 × $0.000000: Non-billable threshold of 0.01 million requests. +* 0.99 × $200.000000: Cost of the subsequent 0.99 million requests. +* 9 × $28.000000: Cost of the subsequent 9 million requests. +* 90 × $1.600000: Cost of the subsequent 90 million requests. +* 215.04 × $1.120000: Cost of the remaining 215.04 million requests. +* × 2: The total cost is multiplied by `2` as each request was first processed by security profile rules and then by WAF profile rules. \ No newline at end of file diff --git a/en/_pricing_examples/smartwebsecurity/usd-smartwebsecurity.md b/en/_pricing_examples/smartwebsecurity/usd-smartwebsecurity.md index f859e3126a6..57834447dba 100644 --- a/en/_pricing_examples/smartwebsecurity/usd-smartwebsecurity.md +++ b/en/_pricing_examples/smartwebsecurity/usd-smartwebsecurity.md @@ -1,10 +1,10 @@ -For example, the total cost of sending 315.04 million requests per month to {{ sws-name }} for analysis will be: -> 0.01 × $0.000000 + 0.99 × $200.000000 + 9 × $28.000000 + 90 × $1.600000 + 215.04 × $1.120000 = $834.844800 excluding VAT. +> Let’s calculate the cost of 315.04 million legitimate requests per month processed by security profile rules: +> 0.01 × ${{ sku|USD|sws.requests.v1|number }} + 0.99 × {{ sku|USD|sws.requests.v1|pricingRate.0.01|string }} + 9 × {{ sku|USD|sws.requests.v1|pricingRate.1|string }} + 90 × {{ sku|USD|sws.requests.v1|pricingRate.10|string }} + 215.04 × {{ sku|USD|sws.requests.v1|pricingRate.100|string }} = {% calc [currency=USD] 0.01 × {{ sku|USD|sws.requests.v1|number }} + 0.99 × {{ sku|USD|sws.requests.v1|pricingRate.0.01|number }} + 9 × {{ sku|USD|sws.requests.v1|pricingRate.1|number }} + 90 × {{ sku|USD|sws.requests.v1|pricingRate.10|number }} + 215,04 × {{ sku|USD|sws.requests.v1|pricingRate.100|number }} %} excluding VAT. Where: -* 0.01 × $0.000000: Non-billable threshold of 0.01 million requests. -* 0.99 × $200.000000: Cost of the subsequent 0.99 million requests. -* 9 × $28.000000: Cost of the subsequent 9 million requests. -* 90 × $1.600000: Cost of the subsequent 90 million requests. -* 215.04 × $1.120000: Cost of the remaining 215.04 million requests. \ No newline at end of file +* 0.01 × ${{ sku|USD|sws.requests.v1|number }}: Non-billable threshold of 0.01 million requests. +* 0.99 × {{ sku|USD|sws.requests.v1|pricingRate.0.01|string }}: Cost of the subsequent 0.99 million requests. +* 9 × {{ sku|USD|sws.requests.v1|pricingRate.1|string }}: Cost of the subsequent 9 million requests. +* 90 × {{ sku|USD|sws.requests.v1|pricingRate.10|string }}: Cost of the subsequent 90 million requests. +* 215.04 × {{ sku|USD|sws.requests.v1|pricingRate.100|string }}: Cost of the remaining 215.04 million requests. diff --git a/en/_pricing_examples/speechkit/usd-speechkit-stt-streaming.md b/en/_pricing_examples/speechkit/usd-speechkit-stt-streaming.md index 1aa5f1d2d4b..40800c7613c 100644 --- a/en/_pricing_examples/speechkit/usd-speechkit-stt-streaming.md +++ b/en/_pricing_examples/speechkit/usd-speechkit-stt-streaming.md @@ -4,6 +4,6 @@ Where: -* 1 is the number of billing units charged for the first 5-second audio fragment rounded up to 15 seconds with recognition settings message considered. -* 3 is the number of billing units charged for the second 37-second audio fragment rounded up to 45 seconds with recognition settings message considered. +* 1 is the number of billing units charged for the first 5-second audio fragment rounded up to 15 seconds. +* 3 is the number of billing units charged for the second 37-second audio fragment rounded up to 45 seconds. * $0.001280: Cost per billing unit. \ No newline at end of file diff --git a/en/_qa/billing/billing-account.md b/en/_qa/billing/billing-account.md index 40f58dca036..260640a149f 100644 --- a/en/_qa/billing/billing-account.md +++ b/en/_qa/billing/billing-account.md @@ -36,6 +36,9 @@ To unblock your new billing account, [upgrade to the paid version](../../billing You cannot change a billing account type once it is created, but you can [create a new one](../../billing/operations/create-new-account.md). +#### How do I enable a billing threshold? {#credit} + +The [billing threshold](../../billing/concepts/billing-threshold.md) gets enabled automatically after you [upgrade to the paid version](../../billing/operations/activate-commercial.md) and the first reporting period ends. {% include [change-payment-method](../../billing/_includes/change-payment-method.md) %} @@ -51,6 +54,11 @@ If you did not receive an email within that period, send a request to [{{ billin {% include [change-payment-docs](../../billing/_includes/change-payment-docs.md) %} +#### I can't link a bank card when creating a billing account. What should I do? {#cant-create} + +Most likely, our service does not support your bank card's payment system. + +To resolve the issue, try linking a different bank card or, if you are a legal entity, create a billing account of the **{{ ui-key.yacloud_billing.billing.account.create-new.account-type_label_company }}** type with the **{{ ui-key.yacloud_billing.billing.account.create-new.payment-type_label_invoice }}** payment method. #### Why do I get an error saying _The country is not available to the payer_ when creating a billing account? {#account-error} diff --git a/en/_qa/billing/common.md b/en/_qa/billing/common.md index 226d10c4f6c..ff343e78f9a 100644 --- a/en/_qa/billing/common.md +++ b/en/_qa/billing/common.md @@ -6,14 +6,14 @@ Yes, you can. For more information, see the [How to create a VM instance](../../ #### Where can I find SLAs? {#sla} -In {{ yandex-cloud }}, each service has its own SLA. You can read the SLA in the [Legal documents](https://yandex.ru/legal/cloud_sla/?lang=en) section. +In {{ yandex-cloud }}, each service has its own SLA. You can read the SLA in the [Legal documents]({{ link-sla }}) section. #### Where can I find the bank details of {{ yandex-cloud }}? {#requisites} -You can find the bank details in the section [Legal documents](https://yandex.com/legal/cloud_customer_agreement/) (paragraph **19. Yandex Details**). +Depending on which company you signed the contract with, you can find the bank details in «Yandex Legal documents» for [Iron Hive doo Beograd (Serbia)](https://yandex.com/legal/cloud_customer_agreement/) or [Direct Cursus Technology L.L.C. (Dubai)](https://yandex.com/legal/cloud_customer_agreement_uae/) (paragraph **19. Yandex Details**). #### How do I contact technical support? {#support} diff --git a/en/_qa/billing/contract.md b/en/_qa/billing/contract.md index b3bb1abefa3..d7bebdc1a64 100644 --- a/en/_qa/billing/contract.md +++ b/en/_qa/billing/contract.md @@ -11,7 +11,7 @@ - Residents of Russia {#russia} - Residents of Russia as well as tax residents of the Republic of Belarus can learn more about the terms of the agreement in [Legal documents]({{ billing-oferta-url }}/?lang=en). + Residents of Russia as well as tax residents of the Republic of Belarus can learn more about the terms of the agreement in [Legal documents]({{ billing-oferta-url }}). - Residents of Kazakhstan {#kazakhstan} @@ -20,7 +20,7 @@ - Non-residents of Russia and Kazakhstan {#nonresidents} - You can learn more about the terms of the agreement in [Yandex Legal documents](https://yandex.com/legal/cloud_customer_agreement/?lang=en). + Depending on which company you signed the contract with, you can review its terms in «Yandex Legal documents» for [Iron Hive doo Beograd (Serbia)](https://yandex.com/legal/cloud_customer_agreement/) or [Direct Cursus Technology L.L.C. (Dubai)](https://yandex.com/legal/cloud_customer_agreement_uae/). {% endlist %} @@ -30,7 +30,9 @@ Businesses may conclude a bilateral agreement. To do this, submit a request usin #### How do I refer to the signed agreement? {#refer-to-contract} -The agreement is represented by the [offer]({{ billing-oferta-url }}). Specify the agreement number and a link to the offer or enclose its printed copy. + +The agreement is represented by the «Yandex Legal documents». Depending on which company you signed the contract with, you can find more details in «Yandex Legal documents» for [Iron Hive doo Beograd (Serbia)](https://yandex.com/legal/cloud_customer_agreement/) or [Direct Cursus Technology L.L.C. (Dubai)](https://yandex.com/legal/cloud_customer_agreement_uae/). Specify the agreement number and a link to the «Yandex Legal documents» or enclose their printed copy. + #### How do I get a hard copy of the agreement? {#paper-contract} diff --git a/en/_qa/billing/payment.md b/en/_qa/billing/payment.md index 1cf5b19c1e5..e8388ae06d6 100644 --- a/en/_qa/billing/payment.md +++ b/en/_qa/billing/payment.md @@ -13,6 +13,8 @@ For more information, see [How to pay for resources](../../billing/payment/index {% include [change-payment-method](../../billing/_includes/change-payment-method.md) %} +#### What cards are accepted for payment? {#card-types} +{% include [payment-card-types](../../_includes/billing/payment-card-types.md) %} #### Is there a minimum payment amount? {#minimum} Depending on the currency, the minimum payment amount is: @@ -49,6 +51,16 @@ Depending on the currency, the minimum payment amount is: +#### I linked a card to my business billing account. When will money be debited from it? {#unlink-card} + +If this is your trial period, funds will not be debited from the bank card you linked. +Since you do not automatically upgrade to the paid version at the end of the trial period, funds are only debited after activating the paid version and using {{ yandex-cloud }} services. + +If you upgraded to the paid version and used {{ yandex-cloud }} services, do the following to stop incurring charges: + +1. Settle your arrears (if any). +1. Delete all billable service resources. +1. Contact [technical support]({{ link-console-support }}) to deactivate your account. #### I linked a cloud to a new billing account. How do I pay for services now? {#unlink-cloud} @@ -62,7 +74,9 @@ For more information, see [Pricing](../../billing/pricing.md). #### If I pay an invoice by bank transfer after the end of the reporting period, will my resources be blocked? {#payment-delay} -According to the [offer]({{ billing-oferta-url }}?lang=en), you can pay within 14 calendar days (not counting public holidays) after the reporting period ends. If you pay within this time period, your resources will not be blocked. Remember that it takes up to three business days for your payment to get through, so do not postpone it. + +You can pay within 14 calendar days (not counting public holidays) after the reporting period ends. Depending on which company you signed the contract with, you can find more details in «Yandex Legal documents» for [Iron Hive doo Beograd (Serbia)](https://yandex.com/legal/cloud_customer_agreement/) or [Direct Cursus Technology L.L.C. (Dubai)](https://yandex.com/legal/cloud_customer_agreement_uae/). + If you pay within this time period, your resources will not be blocked. Remember that it takes up to three business days for your payment to get through, so do not postpone it. #### What goes into the cost of using {{ marketplace-full-name }}? {#marketplace} diff --git a/en/_qa/managed-kubernetes/troubleshooting.md b/en/_qa/managed-kubernetes/troubleshooting.md index 6ac1663c55f..8617483bc2f 100644 --- a/en/_qa/managed-kubernetes/troubleshooting.md +++ b/en/_qa/managed-kubernetes/troubleshooting.md @@ -37,7 +37,7 @@ To fix the issue, delete the stuck resources manually. ```bash kubectl api-resources --verbs=list --namespaced --output=name \ - | xargs --max-args=1 kubectl get --show-kind \ + | xargs --max-args=1 kubectl get --show-kind \ --ignore-not-found --namespace= ``` diff --git a/en/_qa/managed-mongodb/general.md b/en/_qa/managed-mongodb/general.md index 0edbf6ebad0..8b7fcf57b54 100644 --- a/en/_qa/managed-mongodb/general.md +++ b/en/_qa/managed-mongodb/general.md @@ -4,7 +4,7 @@ With {{ mmg-short-name }}, you can: - Create a database with the required performance characteristics. -- Scale processing power and storage dedicated for your databases as needed. +- Scale processing power and storage dedicated for your databases. - Get database logs. {{ mmg-short-name }} takes on time-consuming {{ MG }} infrastructure administration tasks: @@ -48,12 +48,12 @@ To create a database cluster in {{ mmg-short-name }}, you need to define its par - [Host class](../../managed-mongodb/concepts/instance-types.md) (performance characteristics, such as CPUs, RAM, etc.). - [Disk type](../../managed-mongodb/concepts/storage.md) and size (reserved in full when creating a cluster). - Network your cluster will be connected to. -- Number of hosts for the cluster and the availability zone for each host. +- Number of hosts for the cluster and the availability zone for each of them. For detailed instructions, see [{#T}](../../managed-mongodb/quickstart.md). -#### How many database hosts can a cluster contain? {#how-many-hosts} +#### How many database hosts can there be in one cluster? {#how-many-hosts} The minimum number of hosts per cluster depends on the following: * Selected [platform and host class](../../managed-mongodb/concepts/instance-types.md). @@ -78,7 +78,7 @@ For more information on MDB technical and organizational limitations, see [Quota #### How are DB clusters maintained? {#service-window} -Maintenance in {{ mmg-short-name }} implies: +In {{ mmg-short-name }}, maintenance implies: - Automatic installation of DBMS updates and revisions for DB hosts (including disabled clusters). - Changes to the host class and storage size. @@ -110,11 +110,11 @@ In {{ mmg-short-name }}, the usage cost is calculated based on the following par - Selected host class. - Size of the storage reserved for the database host. - Size of the database cluster backups. Backup size equal to the storage size is free of charge. Backup storage that exceeds this size is charged at [special rates](../../managed-mongodb/pricing.md). -- Number of hours of database host operation. Partial hours are rounded to an integer value. You can find the cost per hour of operation for each host class in the [Pricing policy](../../managed-mongodb/pricing.md) section. +- Number of hours of database host operation. Partial hours are rounded to an integer value. You can find the cost per hour for each host class in the [Pricing policy](../../managed-mongodb/pricing.md) section. #### How can I change the computing resources and storage size for a database cluster? {#resources-change} -You can change computing resources and storage size in the management console. All you need to do is choose a different host class for the required cluster. +You can change computing resources and storage size from the [management console]({{ link-console-main }}). All you need to do is choose a different host class for the required cluster. The cluster characteristics change within 30 minutes. During this period, other maintenance activities may also be enabled for the cluster, such as installing updates. @@ -144,7 +144,7 @@ For DB hosts, you can track metrics specific to the corresponding type of DBMS. - Amount of disk space used. - Number of connections, and so on. -Monitoring can be performed with a minimum granularity of 5 seconds. +Monitoring can be performed with a minimum granularity of five seconds. #### How do I set up an alert that triggers as soon as a certain percentage of disk space has been used up? {#disk-space-percentage} @@ -152,8 +152,8 @@ Monitoring can be performed with a minimum granularity of 5 seconds. For `disk.used_bytes`, use notification thresholds. The recommended values are as follows: -* `{{ ui-key.yacloud_monitoring.alert.status_alarm }}`: 90% of disk space -* `{{ ui-key.yacloud_monitoring.alert.status_warn }}`: 70% of disk space +* `{{ ui-key.yacloud_monitoring.alert.status_alarm }}`: 90% of the disk space +* `{{ ui-key.yacloud_monitoring.alert.status_warn }}`: 70% of the disk space Thresholds are set in bytes only. For example, the recommended values for a 100 GB disk are as follows: diff --git a/en/_qa/partner/contracts.md b/en/_qa/partner/contracts.md index ff3402bb7d7..469cf2f2bb8 100644 --- a/en/_qa/partner/contracts.md +++ b/en/_qa/partner/contracts.md @@ -51,8 +51,8 @@ To invoice your organization: 1. In the [management console]({{ link-console-main }}), click ![image](../../_assets/console-icons/dots-9.svg) **All services**. 1. Select ![image](../../_assets/console-icons/credit-card.svg) [**{{ billing-name }}**]({{ link-console-billing }}). 1. Select a billing account. -1. Click **{{ ui-key.yacloud.billing.account.dashboard-overview.button_refill }}**. -1. Enter the payment amount and click **{{ ui-key.yacloud.billing.account.dashboard-overview.popup-refill_button_company-action }}**. +1. Click **{{ ui-key.yacloud_billing.billing.account.dashboard-overview.button_refill }}**. +1. Enter the payment amount and click **{{ ui-key.yacloud_billing.billing.account.dashboard-overview.popup-refill_button_company-action }}**. 1. The document will open in a new browser tab and will be saved in `.pdf` format. #### How to connect to EDM? {#edm} diff --git a/en/_tutorials/_tutorials_includes/airflow-auto-tasks/airflow-auto-tasks-create-cluster.md b/en/_tutorials/_tutorials_includes/airflow-auto-tasks/airflow-auto-tasks-create-cluster.md index 5080aac6169..b2728e4763f 100644 --- a/en/_tutorials/_tutorials_includes/airflow-auto-tasks/airflow-auto-tasks-create-cluster.md +++ b/en/_tutorials/_tutorials_includes/airflow-auto-tasks/airflow-auto-tasks-create-cluster.md @@ -10,7 +10,7 @@ * One uppercase letter * One lowercase letter - * One number + * One digit * One special character {% note info %} diff --git a/en/_tutorials/applied/bind-domain-vm.md b/en/_tutorials/applied/bind-domain-vm.md index 6bf56e578eb..c5f98a96a2d 100644 --- a/en/_tutorials/applied/bind-domain-vm.md +++ b/en/_tutorials/applied/bind-domain-vm.md @@ -30,7 +30,7 @@ You can also assign a domain name to a VM with a web server via {{ TF }} using a The support cost includes: * Fee for using a public IP address (see [{{ vpc-full-name }} pricing](../../vpc/pricing.md)). -* Fee for VM computing resources (see [{{ compute-full-name }} pricing](../../compute/pricing.md)). +* Fee for VM computing resources and disks (see [{{ compute-full-name }} pricing](../../compute/pricing.md)). * Fee for using a public DNS zone and public DNS requests (see [{{ dns-full-name }} pricing](../../dns/pricing.md)). @@ -231,17 +231,18 @@ Before you start, prepare a [key pair](../../compute/operations/vm-connect/ssh.m - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select your folder. + 1. In the [management console]({{ link-console-main }}), select the [folder](../../resource-manager/concepts/resources-hierarchy.md#folder) to create your VM in. 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. 1. In the left-hand panel, select ![image](../../_assets/console-icons/server.svg) **{{ ui-key.yacloud.compute.switch_instances }}**. 1. Click **{{ ui-key.yacloud.compute.instances.button_create }}**. - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**: + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**: + + * Go to the **{{ ui-key.yacloud.compute.instances.create.image_value_marketplace }}** tab. + * Click **{{ ui-key.yacloud.compute.instances.create.button_show-all-marketplace-products }}**. + * In the list of public images, select [LAMP](/marketplace/products/yc/lamp) and click **{{ ui-key.yacloud.marketplace-v2.button_use }}**. - * In the **{{ ui-key.yacloud.common.name }}** field, specify the name: `mywebserver`. - * In the **{{ ui-key.yacloud.compute.instances.create.field_zone }}** field, select `{{ region-id }}-b`. + 1. Under **{{ ui-key.yacloud.k8s.node-groups.create.section_allocation-policy }}**, select the `{{ region-id }}-b` [availability zone](../../overview/concepts/geo-scope.md). - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, go to the **{{ ui-key.yacloud.compute.instances.create.image_value_marketplace }}** tab and click **{{ ui-key.yacloud.compute.instances.create.button_show-all-marketplace-products }}**. - 1. In the window that opens, find and select [LAMP](/marketplace/products/yc/lamp). 1. Under **{{ ui-key.yacloud.compute.instances.create.section_network }}**: * In the **{{ ui-key.yacloud.component.compute.network-select.field_subnetwork }}** field, select the `webserver-subnet-{{ region-id }}-b` subnet you created earlier. @@ -250,9 +251,10 @@ Before you start, prepare a [key pair](../../compute/operations/vm-connect/ssh.m 1. Under **{{ ui-key.yacloud.compute.instances.create.section_access }}**, specify the information required to access the VM: - * Enter the username in the **{{ ui-key.yacloud.compute.instances.create.field_user }}** field: `yc-user`. - * In the **{{ ui-key.yacloud.compute.instances.create.field_key }}** field, paste the contents of the [public key](../../compute/operations/vm-connect/ssh.md#creating-ssh-keys) created earlier. + * In the **{{ ui-key.yacloud.compute.instances.create.field_user }}** field, enter the `yc-user` username. + * {% include [access-ssh-key](../../_includes/compute/create/access-ssh-key.md) %} + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**, specify the VM name: `mywebserver`. 1. Click **{{ ui-key.yacloud.compute.instances.create.button_create }}**. - CLI {#cli} @@ -327,7 +329,7 @@ Before you start, prepare a [key pair](../../compute/operations/vm-connect/ssh.m {% endlist %} -This will create the `mywebserver` VM in your folder. To [connect](../../compute/operations/vm-connect/ssh.md#vm-connect) to the VM over SSH, use the `yc-user` username and the VM's public IP address. If you plan to use the created web server over a long period of time, [make](../../vpc/operations/set-static-ip.md) the VM public IP address static. +This will create the `mywebserver` VM in your folder. To [connect](../../compute/operations/vm-connect/ssh.md#vm-connect) to the VM over SSH, use the `yc-user` username and the VM’s public IP address. If you plan to use the created web server over a long period of time, [make](../../vpc/operations/set-static-ip.md) this VM's public IP address static. ## Create a public DNS zone {#configure-dns} @@ -341,9 +343,9 @@ This will create the `mywebserver` VM in your folder. To [connect](../../compute 1. Click **{{ ui-key.yacloud.dns.button_zone-create }}**. 1. Specify the [DNS zone](../../dns/concepts/dns-zone.md) settings consistent with your domain: - 1. **{{ ui-key.yacloud.dns.label_zone }}**: Domain zone. The zone name must end with a dot. For example, the `example.com.` zone name corresponds to the `example.com` domain. You cannot create public top-level domain (TLD) zones. To create a domain zone with non-Latin characters, use [Punycode](https://{{ lang }}.wikipedia.org/wiki/Punycode) encoding. - 1. **{{ ui-key.yacloud.common.type }}**: `{{ ui-key.yacloud.dns.label_public }}` - 1. **{{ ui-key.yacloud.common.name }}**: Zone name + 1. **{{ ui-key.yacloud.dns.label_zone }}**: Domain zone. The zone name must end with a period. For example, the `example.com.` zone name corresponds to the `example.com` domain. You cannot create public top-level domain (TLD) zones. To create a domain zone with non-Latin characters, use the [Punycode](https://{{ lang }}.wikipedia.org/wiki/Punycode) encoding. + 1. **{{ ui-key.yacloud.common.type }}**: `{{ ui-key.yacloud.dns.label_public }}`. + 1. **{{ ui-key.yacloud.common.name }}**: Zone name. 1. Click **{{ ui-key.yacloud.common.create }}**. @@ -361,7 +363,7 @@ This will create the `mywebserver` VM in your folder. To [connect](../../compute Where: * `--name`: [DNS zone](../../dns/concepts/dns-zone.md) name. - * `--zone`: Domain zone. The zone name must end with a dot. For example, the `example.com.` zone name corresponds to the `example.com` domain. You cannot create public top-level domain (TLD) zones. To create a domain zone with non-Latin characters, use [Punycode](https://{{ lang }}.wikipedia.org/wiki/Punycode) encoding. + * `--zone`: Domain zone. The zone name must end with a period. For example, the `example.com.` zone name corresponds to the `example.com` domain. You cannot create public top-level domain (TLD) zones. To create a domain zone with non-Latin characters, use the [Punycode](https://{{ lang }}.wikipedia.org/wiki/Punycode) encoding. Result: @@ -389,7 +391,7 @@ This will create the `mywebserver` VM in your folder. To [connect](../../compute ## Delegate your domain to {{ dns-name }} {#delegate-domain} -To delegate your domain to {{ dns-name }}, in your domain name registrar account, specify these DNS server addresses in the domain settings: +To delegate a domain to {{ dns-name }}, in your account on your domain registrar's website, specify the DNS server addresses in the domain settings: * `ns1.{{ dns-ns-host-sld }}` * `ns2.{{ dns-ns-host-sld }}` @@ -448,7 +450,7 @@ In your DNS zone, create a [type A resource record](../../dns/concepts/resource- * `--name`: Name of the public DNS zone you created earler. * `--record`: Parameters of the new resource record: - * ``: Domain name must end with a dot. For example, for the `example.com` domain, the correct value is `example.com.`. + * ``: Domain name that must end with a period. For example, for the `example.com` domain, the correct value is `example.com.`. * ``: [Public IP address](../../vpc/concepts/address.md#public-addresses) of the web server. You can find the VM IP address in the **{{ ui-key.yacloud.compute.instance.overview.section_network }}** section on the VM page in the [management console]({{ link-console-main }}) or using this CLI command: `yc compute instance get `. @@ -506,13 +508,13 @@ To create an infrastructure for assigning a domain name to a VM with a web serve - Ready-made archive - 1. Create a directory for the file with the infrastructure description. + 1. Create a folder for the file with the infrastructure description. 1. Download the [archive](https://{{ s3-storage-host }}/doc-files/???) (2 KB). 1. Unpack the archive to the directory. As a result, it should contain the `bind-domain-to-vm.tf` configuration file and the `bind-domain-to-vm.auto.tfvars` user data file. - Creating files manually - 1. Create a directory for the file with the infrastructure description. + 1. Create a folder for the file with the infrastructure description. 1. In the directory, create a configuration file named `bind-domain-to-vm.tf`: {% cut "bind-domain-to-vm.tf" %} diff --git a/en/_tutorials/applied/flask.md b/en/_tutorials/applied/flask.md index 41219d84e76..7140efb4764 100644 --- a/en/_tutorials/applied/flask.md +++ b/en/_tutorials/applied/flask.md @@ -135,7 +135,7 @@ Create a security group that allows inbound TCP traffic on ports `5000` and `22` 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_vpc }}**. 1. In the left-hand panel, select ![image](../../_assets/vpc/security-group.svg) **{{ ui-key.yacloud.vpc.switch_security-groups }}**. 1. Click **{{ ui-key.yacloud.vpc.network.security-groups.button_create }}**. - 1. In the **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-name }}** field, specify the name: `webserver-sg`. + 1. In the **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-name }}** field, enter the name: `webserver-sg`. 1. In the **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-network }}** field, select the `webserver-network` network you created earlier. 1. Under **{{ ui-key.yacloud.vpc.network.security-groups.forms.label_section-rules }}**, [create](../../vpc/operations/security-group-add-rule.md) the following traffic management rules: @@ -214,7 +214,7 @@ Create a security group that allows inbound TCP traffic on ports `5000` and `22` ## Create and set up a virtual machine {#create-setup-vm} -A [VM](../../compute/concepts/vm.md) is similar to a server in the cloud infrastructure. In {{ yandex-cloud }}, you can create VMs with different hardware characteristics in terms of [performance](../../compute/concepts/performance-levels.md), RAM and [disk space](../../compute/concepts/disk.md#maximum-disk-size), as well as running different [operating systems](../../compute/concepts/image.md#public). +A [virtual machine](../../compute/concepts/vm.md) is similar to a server in the cloud infrastructure. In {{ yandex-cloud }}, you can create VMs with different hardware characteristics in terms of [performance](../../compute/concepts/performance-levels.md), RAM, and [disk space](../../compute/concepts/disk.md#maximum-disk-size), as well as running different [operating systems](../../compute/concepts/image.md#public). This web application will be deployed on an [Ubuntu 22.04 LTS](/marketplace/products/yc/ubuntu-22-04-lts) Linux VM. @@ -226,28 +226,24 @@ This web application will be deployed on an [Ubuntu 22.04 LTS](/marketplace/prod - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select your folder. + 1. In the [management console]({{ link-console-main }}), select the [folder](../../resource-manager/concepts/resources-hierarchy.md#folder) to create your VM in. 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. 1. In the left-hand panel, select ![image](../../_assets/console-icons/server.svg) **{{ ui-key.yacloud.compute.switch_instances }}**. - 1. Click **{{ ui-key.yacloud.compute.instances.button_create }}**. - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**: - - * In the **{{ ui-key.yacloud.common.name }}** field, specify the name: `mywebserver`. - * In the **{{ ui-key.yacloud.compute.instances.create.field_zone }}** field, select `{{ region-id }}-b`. - - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, go to the **{{ ui-key.yacloud.compute.instances.create.image_value_marketplace }}** tab and click **{{ ui-key.yacloud.compute.instances.create.button_show-all-marketplace-products }}**. - 1. In the window that opens, find and select [Ubuntu 22.04 LTS](/marketplace/products/yc/ubuntu-22-04-lts). + 1. Click **{{ ui-key.yacloud.compute.instances.button_create }}**. + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, select the [Ubuntu 22.04 LTS](/marketplace/products/yc/ubuntu-22-04-lts) image. + 1. Under **{{ ui-key.yacloud.k8s.node-groups.create.section_allocation-policy }}**, select the `{{ region-id }}-b` [availability zone](../../overview/concepts/geo-scope.md). 1. Under **{{ ui-key.yacloud.compute.instances.create.section_network }}**: - * In the **{{ ui-key.yacloud.component.compute.network-select.field_subnetwork }}** field, select the `webserver-subnet-{{ region-id }}-b` subnet you created earler. + * In the **{{ ui-key.yacloud.component.compute.network-select.field_subnetwork }}** field, select the `webserver-subnet-{{ region-id }}-b` subnet you created earlier. * In the **{{ ui-key.yacloud.component.compute.network-select.field_external }}** field, select `{{ ui-key.yacloud.component.compute.network-select.switch_auto }}`. * In the **{{ ui-key.yacloud.component.compute.network-select.field_security-groups }}** field, select the `webserver-sg` security group you created earlier. 1. Under **{{ ui-key.yacloud.compute.instances.create.section_access }}**, specify the information required to access the VM: - * Enter the `yc-user` username in the **{{ ui-key.yacloud.compute.instances.create.field_user }}** field. - * In the **{{ ui-key.yacloud.compute.instances.create.field_key }}** field, paste the contents of the [public key](../../compute/operations/vm-connect/ssh.md#creating-ssh-keys) created earlier. + * Enter the username in the **{{ ui-key.yacloud.compute.instances.create.field_user }}** field: `yc-user`. + * {% include [access-ssh-key](../../_includes/compute/create/access-ssh-key.md) %} + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**, specify the VM name: `sftp-server`. 1. Click **{{ ui-key.yacloud.compute.instances.create.button_create }}**. - CLI {#cli} @@ -319,7 +315,7 @@ This web application will be deployed on an [Ubuntu 22.04 LTS](/marketplace/prod {% endlist %} - This will create the `mywebserver` VM in your folder. To [connect](../../compute/operations/vm-connect/ssh.md#vm-connect) to the VM over SSH, use the `yc-user` username and the VM's [public IP address](../../vpc/concepts/address.md#public-addresses). If you plan to use the created web server over a long period of time, [make](../../vpc/operations/set-static-ip.md) the VM public IP address static. + This will create the `mywebserver` VM in your folder. To [connect](../../compute/operations/vm-connect/ssh.md#vm-connect) to the VM over SSH, use the `yc-user` username and the VM’s [public IP address](../../vpc/concepts/address.md#public-addresses). If you plan to use the created web server over a long period of time, [make](../../vpc/operations/set-static-ip.md) this VM's public IP address static. 1. Create and activate the virtual environment. @@ -485,7 +481,7 @@ When you open a new terminal window: At this point, the application can only display a plain text message in the browser. To display the data and controls that the user needs, you need to add HTML templates to your application. -To render templates, you can use the [`render_template()` helper function](https://flask.palletsprojects.com/en/latest/api/#flask.render_template) enabled by the [Jinja template engine](https://jinja.palletsprojects.com/en/latest/templates/). You will use HTML templates to create the application pages: the main page listing blog posts and the pages for creating, viewing, and editing a post. +To use templates in the app, you can use [the `render_template()` helper function](https://flask.palletsprojects.com/en/latest/api/#flask.render_template) enabled by the [Jinja template engine](https://jinja.palletsprojects.com/en/latest/templates/). You will use HTML templates to create the application pages: the main page listing blog posts and the pages for creating, viewing, and editing a post. ### Create the main page HTML template {#create-html-template} @@ -596,7 +592,7 @@ To render templates, you can use the [`render_template()` helper function](https } ``` - This CSS code changes the formatting of the text wrapped by `

`: + This CSS code changes the formatting of the text wrapped by the `

` HTML tags: * `border` adds a border. * `color` changes the text color. * `text-align` sets text alignment. @@ -610,7 +606,7 @@ To render templates, you can use the [`render_template()` helper function](https nano templates/index.html ``` -1. Add a link to `style.css` inside ``: +1. Add a link to `style.css` inside the `` section: ```html ... @@ -683,11 +679,11 @@ In other HTML templates, you will need to reuse most of the HTML code from the ` ``` - This file contains HTML code as well as additional code required by Bootstrap. The `` tags contain browser information, the `` tag binds CSS Bootstrap files, and the ` @@ -108,9 +108,10 @@ To create a bucket to place the HTML page of your service in and configure it fo 1. Click **{{ ui-key.yacloud.storage.bucket.button_empty-create }}**. 1. Specify the previously prepared `index.html` file. 1. Click **{{ ui-key.yacloud.storage.button_upload }}**. - 1. In the left-hand panel, select the **{{ ui-key.yacloud.storage.bucket.switch_website }}** tab. - 1. Select **{{ ui-key.yacloud.storage.bucket.website.switch_hosting }}**. - 1. Specify the website's home page: `index.html`. + 1. In the left-hand panel, select **{{ ui-key.yacloud.storage.bucket.switch_settings }}**. + 1. On the **{{ ui-key.yacloud.storage.bucket.switch_website }}** tab: + * Select `{{ ui-key.yacloud.storage.bucket.website.switch_hosting }}`. + * Specify the website's home page: `index.html`. 1. Click **{{ ui-key.yacloud.storage.bucket.website.button_save }}**. {% endlist %} @@ -360,8 +361,8 @@ To publish the service via {{ api-gw-name }}: get: x-yc-apigateway-integration: type: object_storage - bucket: # <-- bucket name - object: index.html # <-- html file name + bucket: #<-- bucket name + object: index.html # <-- HTML file name presigned_redirect: false service_account: # <-- service account ID operationId: static @@ -391,8 +392,8 @@ To publish the service via {{ api-gw-name }}: {% endcut %} Edit the specification code: - * Replace `` with the ID of the previously created service account. - * Replace `` with the ID of the previously created function. + * Replace `` with the ID of the previously created service account. + * Replace `` with the ID of the previously created function. * Replace `` with the name of the previously created bucket. 1. Click **{{ ui-key.yacloud.serverless-functions.gateways.form.button_create-gateway }}**. 1. Click the name of the API gateway you created. diff --git a/en/_tutorials/tracker/tracker-cloud-function.md b/en/_tutorials/tracker/tracker-cloud-function.md index f2f191317f8..58c8ac0d556 100644 --- a/en/_tutorials/tracker/tracker-cloud-function.md +++ b/en/_tutorials/tracker/tracker-cloud-function.md @@ -56,8 +56,8 @@ If you no longer need the resources you created, [delete them](#clear-out). 1. Go to [{{ tracker-name }}](https://tracker.yandex.ru/). Click **Logging in to Yandex Tracker**. 1. In the right-hand panel, click **Administration**. -1. Under **{{ ui-key.startrek.ui_components_page-admin_PageAdmin.access-and-payment }}**, click **{{ ui-key.startrek.ui_components_page-admin_PageAdmin.menu-item-orgs }}**. -1. Under **{{ ui-key.startrek.ui_components_page-admin_OrgPanes_DirectoryOrgPane.source-title }}**, copy and save your organization ID. You will need it to create a function. +1. Under **{{ ui-key.startrek.ui_Common_smart-components_page-admin_PageAdmin.access-and-payment }}**, click **{{ ui-key.startrek.ui_Common_smart-components_page-admin_PageAdmin.menu-item-orgs }}**. +1. Under **{{ ui-key.startrek.ui_Common_smart-components_page-admin_OrgPanes_DirectoryOrgPane.source-title }}**, copy and save your organization ID. You will need it to create a function. ## Create a {{ sf-name }} function {#create-function} @@ -87,17 +87,17 @@ If you no longer need the resources you created, [delete them](#clear-out). ### Create a queue -1. On the left-hand panel, select ![](../../_assets/console-icons/layers-3-diagonal.svg) **{{ ui-key.startrek.ui_components_TrackerSearch.queues }}** → **Create queue**. +1. On the left-hand panel, select ![](../../_assets/console-icons/layers-3-diagonal.svg) **{{ ui-key.startrek.ui_Common_smart-components_TrackerSearch.queues }}** → **Create queue**. 1. Select a queue template, e.g., **Basic development model**. 1. Enter a name, e.g., `Function Test`. 1. Click **Create**. ### Create a trigger -1. In the top-right corner of the queue page, click ![](../../_assets/console-icons/gear.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner of the queue page, click ![](../../_assets/console-icons/gear.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. On the left-hand panel, select **Automation** → **Triggers** and click **Create trigger**. 1. In the **Name** field, enter a trigger name, e.g., `timeupdater`. -1. Under **Trigger conditions**, select **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** → **Time spent**. +1. Under **Trigger conditions**, select **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** → **Time spent**. 1. Under **Trigger actions**, select **HTTP request**. 1. In the form that opens, in the **Address** field, enter: ``` @@ -119,14 +119,14 @@ If you no longer need the resources you created, [delete them](#clear-out). 1. In the form that opens, in the **Issue name** field, enter an issue name, e.g., `Parent Task`. 1. Click **Create**. 1. Create sub-issues: - 1. In the top-right corner of the `Parent Task` issue page, in the **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.title }}** menu, select **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.create-subissue }}**. + 1. In the top-right corner of the `Parent Task` issue page, in the **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.title }}** menu, select **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.create-subissue }}**. 1. In the form that opens, in the **Issue name** field, enter a sub-issue name, e.g., `Subtask-1`. 1. In the same way, create another sub-issue or multiple sub-issues named `Subtask-2`, `Subtask-3`, etc. ### Enter time spent values for the sub-issues -1. In the top-right corner of the `Subtask-1` sub-issue page, in the **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.title }}** menu, select **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.add-worklog }}**. -1. In the dialog that opens, in the **{{ ui-key.startrek.ui_components_issue-actions_worklog_AddWorklogDialog.duration-label }}** field, enter any time value, e.g., `1h25m`. +1. In the top-right corner of the `Subtask-1` sub-issue page, in the **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.title }}** menu, select **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.add-worklog }}**. +1. In the dialog that opens, in the **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_worklog_AddWorklogDialog.duration-label }}** field, enter any time value, e.g., `1h25m`. 1. In the same way, add time spent values for the other sub-issues. ### Check if the function works correctly diff --git a/en/_tutorials/windows/s3-disk-connect.md b/en/_tutorials/windows/s3-disk-connect.md index 99de09ff375..b42337a0a61 100644 --- a/en/_tutorials/windows/s3-disk-connect.md +++ b/en/_tutorials/windows/s3-disk-connect.md @@ -137,7 +137,7 @@ The cost for bucket support includes: - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the folder where you want to create your bucket. + 1. In the [management console]({{ link-console-main }}), select the folder you want to create a bucket in. 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_storage }}**. 1. At the top right, click **{{ ui-key.yacloud.storage.buckets.button_create }}**. 1. In the **{{ ui-key.yacloud.storage.bucket.settings.field_name }}** field, enter a name for the bucket consistent with the [naming conventions](../../storage/concepts/bucket.md#naming). @@ -155,6 +155,7 @@ The cost for bucket support includes: ``` Result: + ```text make_bucket: ``` @@ -312,5 +313,5 @@ You can also configure the service to be run by a system user (for more informat To stop paying for the resources you created: -* [Delete objects](../../storage/operations/objects/delete-all.md) from the bucket. +* [Delete the objects](../../storage/operations/objects/delete-all.md) from the bucket. * [Delete the bucket](../../storage/operations/buckets/delete.md). diff --git a/en/application-load-balancer/api-ref/grpc/BackendGroup/addBackend.md b/en/application-load-balancer/api-ref/grpc/BackendGroup/addBackend.md index 6fac9a2e780..c5248ee9b3a 100644 --- a/en/application-load-balancer/api-ref/grpc/BackendGroup/addBackend.md +++ b/en/application-load-balancer/api-ref/grpc/BackendGroup/addBackend.md @@ -9,7 +9,7 @@ Adds backends to the specified backend group. ## gRPC request -**rpc AddBackend ([AddBackendRequest](#yandex.cloud.apploadbalancer.v1.AddBackendRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc AddBackend ([AddBackendRequest](#yandex.cloud.apploadbalancer.v1.AddBackendRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## AddBackendRequest {#yandex.cloud.apploadbalancer.v1.AddBackendRequest} diff --git a/en/application-load-balancer/api-ref/grpc/BackendGroup/create.md b/en/application-load-balancer/api-ref/grpc/BackendGroup/create.md index b66c5382aa8..75f4539fd57 100644 --- a/en/application-load-balancer/api-ref/grpc/BackendGroup/create.md +++ b/en/application-load-balancer/api-ref/grpc/BackendGroup/create.md @@ -9,7 +9,7 @@ Creates a backend group in the specified folder. ## gRPC request -**rpc Create ([CreateBackendGroupRequest](#yandex.cloud.apploadbalancer.v1.CreateBackendGroupRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Create ([CreateBackendGroupRequest](#yandex.cloud.apploadbalancer.v1.CreateBackendGroupRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## CreateBackendGroupRequest {#yandex.cloud.apploadbalancer.v1.CreateBackendGroupRequest} diff --git a/en/application-load-balancer/api-ref/grpc/BackendGroup/delete.md b/en/application-load-balancer/api-ref/grpc/BackendGroup/delete.md index 6cded6572fd..7823d5d2934 100644 --- a/en/application-load-balancer/api-ref/grpc/BackendGroup/delete.md +++ b/en/application-load-balancer/api-ref/grpc/BackendGroup/delete.md @@ -9,7 +9,7 @@ Deletes the specified backend group. ## gRPC request -**rpc Delete ([DeleteBackendGroupRequest](#yandex.cloud.apploadbalancer.v1.DeleteBackendGroupRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Delete ([DeleteBackendGroupRequest](#yandex.cloud.apploadbalancer.v1.DeleteBackendGroupRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## DeleteBackendGroupRequest {#yandex.cloud.apploadbalancer.v1.DeleteBackendGroupRequest} diff --git a/en/application-load-balancer/api-ref/grpc/BackendGroup/removeBackend.md b/en/application-load-balancer/api-ref/grpc/BackendGroup/removeBackend.md index b3ed75e2591..88aff0e1cb9 100644 --- a/en/application-load-balancer/api-ref/grpc/BackendGroup/removeBackend.md +++ b/en/application-load-balancer/api-ref/grpc/BackendGroup/removeBackend.md @@ -9,7 +9,7 @@ Removes backends from the specified backend group. ## gRPC request -**rpc RemoveBackend ([RemoveBackendRequest](#yandex.cloud.apploadbalancer.v1.RemoveBackendRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc RemoveBackend ([RemoveBackendRequest](#yandex.cloud.apploadbalancer.v1.RemoveBackendRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## RemoveBackendRequest {#yandex.cloud.apploadbalancer.v1.RemoveBackendRequest} diff --git a/en/application-load-balancer/api-ref/grpc/BackendGroup/update.md b/en/application-load-balancer/api-ref/grpc/BackendGroup/update.md index 090665aac13..ccfcb96b63a 100644 --- a/en/application-load-balancer/api-ref/grpc/BackendGroup/update.md +++ b/en/application-load-balancer/api-ref/grpc/BackendGroup/update.md @@ -9,7 +9,7 @@ Updates the specified backend group. ## gRPC request -**rpc Update ([UpdateBackendGroupRequest](#yandex.cloud.apploadbalancer.v1.UpdateBackendGroupRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Update ([UpdateBackendGroupRequest](#yandex.cloud.apploadbalancer.v1.UpdateBackendGroupRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## UpdateBackendGroupRequest {#yandex.cloud.apploadbalancer.v1.UpdateBackendGroupRequest} diff --git a/en/application-load-balancer/api-ref/grpc/BackendGroup/updateBackend.md b/en/application-load-balancer/api-ref/grpc/BackendGroup/updateBackend.md index b2efe5aa94c..cd2e1188cb7 100644 --- a/en/application-load-balancer/api-ref/grpc/BackendGroup/updateBackend.md +++ b/en/application-load-balancer/api-ref/grpc/BackendGroup/updateBackend.md @@ -9,7 +9,7 @@ Updates the specified backend. ## gRPC request -**rpc UpdateBackend ([UpdateBackendRequest](#yandex.cloud.apploadbalancer.v1.UpdateBackendRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc UpdateBackend ([UpdateBackendRequest](#yandex.cloud.apploadbalancer.v1.UpdateBackendRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## UpdateBackendRequest {#yandex.cloud.apploadbalancer.v1.UpdateBackendRequest} diff --git a/en/application-load-balancer/api-ref/grpc/HttpRouter/create.md b/en/application-load-balancer/api-ref/grpc/HttpRouter/create.md index 0659d3a3263..32c88ef2386 100644 --- a/en/application-load-balancer/api-ref/grpc/HttpRouter/create.md +++ b/en/application-load-balancer/api-ref/grpc/HttpRouter/create.md @@ -9,7 +9,7 @@ Creates an HTTP router in the specified folder. ## gRPC request -**rpc Create ([CreateHttpRouterRequest](#yandex.cloud.apploadbalancer.v1.CreateHttpRouterRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Create ([CreateHttpRouterRequest](#yandex.cloud.apploadbalancer.v1.CreateHttpRouterRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## CreateHttpRouterRequest {#yandex.cloud.apploadbalancer.v1.CreateHttpRouterRequest} diff --git a/en/application-load-balancer/api-ref/grpc/HttpRouter/delete.md b/en/application-load-balancer/api-ref/grpc/HttpRouter/delete.md index 7de32329953..cf335d740c0 100644 --- a/en/application-load-balancer/api-ref/grpc/HttpRouter/delete.md +++ b/en/application-load-balancer/api-ref/grpc/HttpRouter/delete.md @@ -9,7 +9,7 @@ Deletes the specified HTTP router. ## gRPC request -**rpc Delete ([DeleteHttpRouterRequest](#yandex.cloud.apploadbalancer.v1.DeleteHttpRouterRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Delete ([DeleteHttpRouterRequest](#yandex.cloud.apploadbalancer.v1.DeleteHttpRouterRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## DeleteHttpRouterRequest {#yandex.cloud.apploadbalancer.v1.DeleteHttpRouterRequest} diff --git a/en/application-load-balancer/api-ref/grpc/HttpRouter/update.md b/en/application-load-balancer/api-ref/grpc/HttpRouter/update.md index 7c457f5fbca..3ad7f93a9df 100644 --- a/en/application-load-balancer/api-ref/grpc/HttpRouter/update.md +++ b/en/application-load-balancer/api-ref/grpc/HttpRouter/update.md @@ -9,7 +9,7 @@ Updates the specified HTTP router. ## gRPC request -**rpc Update ([UpdateHttpRouterRequest](#yandex.cloud.apploadbalancer.v1.UpdateHttpRouterRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Update ([UpdateHttpRouterRequest](#yandex.cloud.apploadbalancer.v1.UpdateHttpRouterRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## UpdateHttpRouterRequest {#yandex.cloud.apploadbalancer.v1.UpdateHttpRouterRequest} diff --git a/en/application-load-balancer/api-ref/grpc/LoadBalancer/addListener.md b/en/application-load-balancer/api-ref/grpc/LoadBalancer/addListener.md index abd1dacd4c8..fed6d49aa16 100644 --- a/en/application-load-balancer/api-ref/grpc/LoadBalancer/addListener.md +++ b/en/application-load-balancer/api-ref/grpc/LoadBalancer/addListener.md @@ -9,7 +9,7 @@ Adds a listener to the specified application load balancer. ## gRPC request -**rpc AddListener ([AddListenerRequest](#yandex.cloud.apploadbalancer.v1.AddListenerRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc AddListener ([AddListenerRequest](#yandex.cloud.apploadbalancer.v1.AddListenerRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## AddListenerRequest {#yandex.cloud.apploadbalancer.v1.AddListenerRequest} diff --git a/en/application-load-balancer/api-ref/grpc/LoadBalancer/addSniMatch.md b/en/application-load-balancer/api-ref/grpc/LoadBalancer/addSniMatch.md index d1c08db67f7..6ccbf2c2fdd 100644 --- a/en/application-load-balancer/api-ref/grpc/LoadBalancer/addSniMatch.md +++ b/en/application-load-balancer/api-ref/grpc/LoadBalancer/addSniMatch.md @@ -11,7 +11,7 @@ This request does not allow to add [TlsListener.defaultHandler](/docs/applicatio ## gRPC request -**rpc AddSniMatch ([AddSniMatchRequest](#yandex.cloud.apploadbalancer.v1.AddSniMatchRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc AddSniMatch ([AddSniMatchRequest](#yandex.cloud.apploadbalancer.v1.AddSniMatchRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## AddSniMatchRequest {#yandex.cloud.apploadbalancer.v1.AddSniMatchRequest} diff --git a/en/application-load-balancer/api-ref/grpc/LoadBalancer/create.md b/en/application-load-balancer/api-ref/grpc/LoadBalancer/create.md index bf13052792f..f24342c6273 100644 --- a/en/application-load-balancer/api-ref/grpc/LoadBalancer/create.md +++ b/en/application-load-balancer/api-ref/grpc/LoadBalancer/create.md @@ -9,7 +9,7 @@ Creates an application load balancer in the specified folder. ## gRPC request -**rpc Create ([CreateLoadBalancerRequest](#yandex.cloud.apploadbalancer.v1.CreateLoadBalancerRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Create ([CreateLoadBalancerRequest](#yandex.cloud.apploadbalancer.v1.CreateLoadBalancerRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## CreateLoadBalancerRequest {#yandex.cloud.apploadbalancer.v1.CreateLoadBalancerRequest} diff --git a/en/application-load-balancer/api-ref/grpc/LoadBalancer/delete.md b/en/application-load-balancer/api-ref/grpc/LoadBalancer/delete.md index dca67ec14eb..0b64d7325b1 100644 --- a/en/application-load-balancer/api-ref/grpc/LoadBalancer/delete.md +++ b/en/application-load-balancer/api-ref/grpc/LoadBalancer/delete.md @@ -9,7 +9,7 @@ Deletes the specified application load balancer. ## gRPC request -**rpc Delete ([DeleteLoadBalancerRequest](#yandex.cloud.apploadbalancer.v1.DeleteLoadBalancerRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Delete ([DeleteLoadBalancerRequest](#yandex.cloud.apploadbalancer.v1.DeleteLoadBalancerRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## DeleteLoadBalancerRequest {#yandex.cloud.apploadbalancer.v1.DeleteLoadBalancerRequest} diff --git a/en/application-load-balancer/api-ref/grpc/LoadBalancer/removeListener.md b/en/application-load-balancer/api-ref/grpc/LoadBalancer/removeListener.md index b0ba605e409..e88738c467b 100644 --- a/en/application-load-balancer/api-ref/grpc/LoadBalancer/removeListener.md +++ b/en/application-load-balancer/api-ref/grpc/LoadBalancer/removeListener.md @@ -9,7 +9,7 @@ Deletes the specified listener. ## gRPC request -**rpc RemoveListener ([RemoveListenerRequest](#yandex.cloud.apploadbalancer.v1.RemoveListenerRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc RemoveListener ([RemoveListenerRequest](#yandex.cloud.apploadbalancer.v1.RemoveListenerRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## RemoveListenerRequest {#yandex.cloud.apploadbalancer.v1.RemoveListenerRequest} diff --git a/en/application-load-balancer/api-ref/grpc/LoadBalancer/removeSniMatch.md b/en/application-load-balancer/api-ref/grpc/LoadBalancer/removeSniMatch.md index 67c5d87e74b..eb13747494e 100644 --- a/en/application-load-balancer/api-ref/grpc/LoadBalancer/removeSniMatch.md +++ b/en/application-load-balancer/api-ref/grpc/LoadBalancer/removeSniMatch.md @@ -11,7 +11,7 @@ This request does not allow to delete [TlsListener.defaultHandler](/docs/applica ## gRPC request -**rpc RemoveSniMatch ([RemoveSniMatchRequest](#yandex.cloud.apploadbalancer.v1.RemoveSniMatchRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc RemoveSniMatch ([RemoveSniMatchRequest](#yandex.cloud.apploadbalancer.v1.RemoveSniMatchRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## RemoveSniMatchRequest {#yandex.cloud.apploadbalancer.v1.RemoveSniMatchRequest} diff --git a/en/application-load-balancer/api-ref/grpc/LoadBalancer/start.md b/en/application-load-balancer/api-ref/grpc/LoadBalancer/start.md index 369567415af..a194d039033 100644 --- a/en/application-load-balancer/api-ref/grpc/LoadBalancer/start.md +++ b/en/application-load-balancer/api-ref/grpc/LoadBalancer/start.md @@ -9,7 +9,7 @@ Starts the specified application load balancer. ## gRPC request -**rpc Start ([StartLoadBalancerRequest](#yandex.cloud.apploadbalancer.v1.StartLoadBalancerRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Start ([StartLoadBalancerRequest](#yandex.cloud.apploadbalancer.v1.StartLoadBalancerRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## StartLoadBalancerRequest {#yandex.cloud.apploadbalancer.v1.StartLoadBalancerRequest} diff --git a/en/application-load-balancer/api-ref/grpc/LoadBalancer/stop.md b/en/application-load-balancer/api-ref/grpc/LoadBalancer/stop.md index a74b171db30..f4a9c2ed90e 100644 --- a/en/application-load-balancer/api-ref/grpc/LoadBalancer/stop.md +++ b/en/application-load-balancer/api-ref/grpc/LoadBalancer/stop.md @@ -9,7 +9,7 @@ Stops the specified application load balancer. ## gRPC request -**rpc Stop ([StopLoadBalancerRequest](#yandex.cloud.apploadbalancer.v1.StopLoadBalancerRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Stop ([StopLoadBalancerRequest](#yandex.cloud.apploadbalancer.v1.StopLoadBalancerRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## StopLoadBalancerRequest {#yandex.cloud.apploadbalancer.v1.StopLoadBalancerRequest} diff --git a/en/application-load-balancer/api-ref/grpc/LoadBalancer/update.md b/en/application-load-balancer/api-ref/grpc/LoadBalancer/update.md index f081e2cbc3a..f1fcb20039f 100644 --- a/en/application-load-balancer/api-ref/grpc/LoadBalancer/update.md +++ b/en/application-load-balancer/api-ref/grpc/LoadBalancer/update.md @@ -9,7 +9,7 @@ Updates the specified application load balancer. ## gRPC request -**rpc Update ([UpdateLoadBalancerRequest](#yandex.cloud.apploadbalancer.v1.UpdateLoadBalancerRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Update ([UpdateLoadBalancerRequest](#yandex.cloud.apploadbalancer.v1.UpdateLoadBalancerRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## UpdateLoadBalancerRequest {#yandex.cloud.apploadbalancer.v1.UpdateLoadBalancerRequest} diff --git a/en/application-load-balancer/api-ref/grpc/LoadBalancer/updateListener.md b/en/application-load-balancer/api-ref/grpc/LoadBalancer/updateListener.md index 8f4bf9532a6..ced75f29321 100644 --- a/en/application-load-balancer/api-ref/grpc/LoadBalancer/updateListener.md +++ b/en/application-load-balancer/api-ref/grpc/LoadBalancer/updateListener.md @@ -9,7 +9,7 @@ Updates the specified listener of the specified application load balancer. ## gRPC request -**rpc UpdateListener ([UpdateListenerRequest](#yandex.cloud.apploadbalancer.v1.UpdateListenerRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc UpdateListener ([UpdateListenerRequest](#yandex.cloud.apploadbalancer.v1.UpdateListenerRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## UpdateListenerRequest {#yandex.cloud.apploadbalancer.v1.UpdateListenerRequest} diff --git a/en/application-load-balancer/api-ref/grpc/LoadBalancer/updateSniMatch.md b/en/application-load-balancer/api-ref/grpc/LoadBalancer/updateSniMatch.md index 511787f496b..f2ff0e2458f 100644 --- a/en/application-load-balancer/api-ref/grpc/LoadBalancer/updateSniMatch.md +++ b/en/application-load-balancer/api-ref/grpc/LoadBalancer/updateSniMatch.md @@ -11,7 +11,7 @@ This request does not allow to update [TlsListener.defaultHandler](/docs/applica ## gRPC request -**rpc UpdateSniMatch ([UpdateSniMatchRequest](#yandex.cloud.apploadbalancer.v1.UpdateSniMatchRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc UpdateSniMatch ([UpdateSniMatchRequest](#yandex.cloud.apploadbalancer.v1.UpdateSniMatchRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## UpdateSniMatchRequest {#yandex.cloud.apploadbalancer.v1.UpdateSniMatchRequest} diff --git a/en/application-load-balancer/api-ref/grpc/TargetGroup/addTargets.md b/en/application-load-balancer/api-ref/grpc/TargetGroup/addTargets.md index 84e1b563f78..761444d7a13 100644 --- a/en/application-load-balancer/api-ref/grpc/TargetGroup/addTargets.md +++ b/en/application-load-balancer/api-ref/grpc/TargetGroup/addTargets.md @@ -9,7 +9,7 @@ Adds targets to the specified target group. ## gRPC request -**rpc AddTargets ([AddTargetsRequest](#yandex.cloud.apploadbalancer.v1.AddTargetsRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc AddTargets ([AddTargetsRequest](#yandex.cloud.apploadbalancer.v1.AddTargetsRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## AddTargetsRequest {#yandex.cloud.apploadbalancer.v1.AddTargetsRequest} diff --git a/en/application-load-balancer/api-ref/grpc/TargetGroup/create.md b/en/application-load-balancer/api-ref/grpc/TargetGroup/create.md index a11fdf37f71..89cbce63384 100644 --- a/en/application-load-balancer/api-ref/grpc/TargetGroup/create.md +++ b/en/application-load-balancer/api-ref/grpc/TargetGroup/create.md @@ -9,7 +9,7 @@ Creates a target group in the specified folder. ## gRPC request -**rpc Create ([CreateTargetGroupRequest](#yandex.cloud.apploadbalancer.v1.CreateTargetGroupRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Create ([CreateTargetGroupRequest](#yandex.cloud.apploadbalancer.v1.CreateTargetGroupRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## CreateTargetGroupRequest {#yandex.cloud.apploadbalancer.v1.CreateTargetGroupRequest} diff --git a/en/application-load-balancer/api-ref/grpc/TargetGroup/delete.md b/en/application-load-balancer/api-ref/grpc/TargetGroup/delete.md index 839e51f88db..32651bc9130 100644 --- a/en/application-load-balancer/api-ref/grpc/TargetGroup/delete.md +++ b/en/application-load-balancer/api-ref/grpc/TargetGroup/delete.md @@ -9,7 +9,7 @@ Deletes the specified target group. ## gRPC request -**rpc Delete ([DeleteTargetGroupRequest](#yandex.cloud.apploadbalancer.v1.DeleteTargetGroupRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Delete ([DeleteTargetGroupRequest](#yandex.cloud.apploadbalancer.v1.DeleteTargetGroupRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## DeleteTargetGroupRequest {#yandex.cloud.apploadbalancer.v1.DeleteTargetGroupRequest} diff --git a/en/application-load-balancer/api-ref/grpc/TargetGroup/removeTargets.md b/en/application-load-balancer/api-ref/grpc/TargetGroup/removeTargets.md index 4516bb52d5a..758b8e55b1d 100644 --- a/en/application-load-balancer/api-ref/grpc/TargetGroup/removeTargets.md +++ b/en/application-load-balancer/api-ref/grpc/TargetGroup/removeTargets.md @@ -9,7 +9,7 @@ Removes targets from the specified target group. ## gRPC request -**rpc RemoveTargets ([RemoveTargetsRequest](#yandex.cloud.apploadbalancer.v1.RemoveTargetsRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc RemoveTargets ([RemoveTargetsRequest](#yandex.cloud.apploadbalancer.v1.RemoveTargetsRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## RemoveTargetsRequest {#yandex.cloud.apploadbalancer.v1.RemoveTargetsRequest} diff --git a/en/application-load-balancer/api-ref/grpc/TargetGroup/update.md b/en/application-load-balancer/api-ref/grpc/TargetGroup/update.md index ee729d7e0fc..3458fa9f6c4 100644 --- a/en/application-load-balancer/api-ref/grpc/TargetGroup/update.md +++ b/en/application-load-balancer/api-ref/grpc/TargetGroup/update.md @@ -9,7 +9,7 @@ Updates the specified target group. ## gRPC request -**rpc Update ([UpdateTargetGroupRequest](#yandex.cloud.apploadbalancer.v1.UpdateTargetGroupRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Update ([UpdateTargetGroupRequest](#yandex.cloud.apploadbalancer.v1.UpdateTargetGroupRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## UpdateTargetGroupRequest {#yandex.cloud.apploadbalancer.v1.UpdateTargetGroupRequest} diff --git a/en/application-load-balancer/api-ref/grpc/VirtualHost/create.md b/en/application-load-balancer/api-ref/grpc/VirtualHost/create.md index 61c7e1eacc5..5cf58939776 100644 --- a/en/application-load-balancer/api-ref/grpc/VirtualHost/create.md +++ b/en/application-load-balancer/api-ref/grpc/VirtualHost/create.md @@ -9,7 +9,7 @@ Creates a virtual host in the specified HTTP router. ## gRPC request -**rpc Create ([CreateVirtualHostRequest](#yandex.cloud.apploadbalancer.v1.CreateVirtualHostRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Create ([CreateVirtualHostRequest](#yandex.cloud.apploadbalancer.v1.CreateVirtualHostRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## CreateVirtualHostRequest {#yandex.cloud.apploadbalancer.v1.CreateVirtualHostRequest} diff --git a/en/application-load-balancer/api-ref/grpc/VirtualHost/delete.md b/en/application-load-balancer/api-ref/grpc/VirtualHost/delete.md index 6d5c93a6c87..a22ee91c02d 100644 --- a/en/application-load-balancer/api-ref/grpc/VirtualHost/delete.md +++ b/en/application-load-balancer/api-ref/grpc/VirtualHost/delete.md @@ -9,7 +9,7 @@ Deletes the specified virtual host. ## gRPC request -**rpc Delete ([DeleteVirtualHostRequest](#yandex.cloud.apploadbalancer.v1.DeleteVirtualHostRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Delete ([DeleteVirtualHostRequest](#yandex.cloud.apploadbalancer.v1.DeleteVirtualHostRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## DeleteVirtualHostRequest {#yandex.cloud.apploadbalancer.v1.DeleteVirtualHostRequest} diff --git a/en/application-load-balancer/api-ref/grpc/VirtualHost/removeRoute.md b/en/application-load-balancer/api-ref/grpc/VirtualHost/removeRoute.md index 14b3d0c121d..7913953d765 100644 --- a/en/application-load-balancer/api-ref/grpc/VirtualHost/removeRoute.md +++ b/en/application-load-balancer/api-ref/grpc/VirtualHost/removeRoute.md @@ -9,7 +9,7 @@ Deletes the specified route from the specified virtual host. ## gRPC request -**rpc RemoveRoute ([RemoveRouteRequest](#yandex.cloud.apploadbalancer.v1.RemoveRouteRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc RemoveRoute ([RemoveRouteRequest](#yandex.cloud.apploadbalancer.v1.RemoveRouteRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## RemoveRouteRequest {#yandex.cloud.apploadbalancer.v1.RemoveRouteRequest} diff --git a/en/application-load-balancer/api-ref/grpc/VirtualHost/update.md b/en/application-load-balancer/api-ref/grpc/VirtualHost/update.md index 940c5e38f9a..b0546a036aa 100644 --- a/en/application-load-balancer/api-ref/grpc/VirtualHost/update.md +++ b/en/application-load-balancer/api-ref/grpc/VirtualHost/update.md @@ -9,7 +9,7 @@ Updates the specified virtual host of the specified HTTP router. ## gRPC request -**rpc Update ([UpdateVirtualHostRequest](#yandex.cloud.apploadbalancer.v1.UpdateVirtualHostRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Update ([UpdateVirtualHostRequest](#yandex.cloud.apploadbalancer.v1.UpdateVirtualHostRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## UpdateVirtualHostRequest {#yandex.cloud.apploadbalancer.v1.UpdateVirtualHostRequest} diff --git a/en/application-load-balancer/api-ref/grpc/VirtualHost/updateRoute.md b/en/application-load-balancer/api-ref/grpc/VirtualHost/updateRoute.md index 4ab5e21acf3..83abb1508ae 100644 --- a/en/application-load-balancer/api-ref/grpc/VirtualHost/updateRoute.md +++ b/en/application-load-balancer/api-ref/grpc/VirtualHost/updateRoute.md @@ -9,7 +9,7 @@ Updates the specified route of the specified virtual host. ## gRPC request -**rpc UpdateRoute ([UpdateRouteRequest](#yandex.cloud.apploadbalancer.v1.UpdateRouteRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc UpdateRoute ([UpdateRouteRequest](#yandex.cloud.apploadbalancer.v1.UpdateRouteRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## UpdateRouteRequest {#yandex.cloud.apploadbalancer.v1.UpdateRouteRequest} diff --git a/en/application-load-balancer/operations/target-group-create.md b/en/application-load-balancer/operations/target-group-create.md index 647c33eda09..3a6417c4a30 100644 --- a/en/application-load-balancer/operations/target-group-create.md +++ b/en/application-load-balancer/operations/target-group-create.md @@ -13,7 +13,7 @@ To create a [target group](../concepts/target-group.md): - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the folder where you want to create your target group. + 1. In the [management console]({{ link-console-main }}), select the folder to create your target group in. 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_application-load-balancer }}**. 1. In the left-hand panel, select ![image](../../_assets/console-icons/target.svg) **{{ ui-key.yacloud.alb.label_target-groups }}**. 1. Click **{{ ui-key.yacloud.alb.button_target-group-create }}**. @@ -175,4 +175,10 @@ To create a [target group](../concepts/target-group.md): Use the [create](../api-ref/TargetGroup/create.md) REST API method for the [TargetGroup](../api-ref/TargetGroup/index.md) resource or the [TargetGroupService/Create](../api-ref/grpc/TargetGroup/create.md) gRPC API call. -{% endlist %} \ No newline at end of file +{% endlist %} + +#### See also {#see-also} + +* [{#T}](../tutorials/application-load-balancer-website.md) +* [{#T}](../tutorials/logging.md) +* [{#T}](../tutorials/alb-with-ddos-protection/console.md) diff --git a/en/application-load-balancer/quickstart-wizard.md b/en/application-load-balancer/quickstart-wizard.md index a0744dff509..d9605a688f1 100644 --- a/en/application-load-balancer/quickstart-wizard.md +++ b/en/application-load-balancer/quickstart-wizard.md @@ -97,9 +97,9 @@ As an example, let's create a balancer with a node in the same subnet and same a 1. Enter the load balancer name: `test-load-balancer`. 1. Under **{{ ui-key.yacloud.mdb.forms.section_network-settings }}**, select the network whose subnet will host the load balancer node. 1. Toggle **{{ ui-key.yacloud.alb.label_detailed-settings }}** on. - 1. Under **{{ ui-key.yacloud.alb.section_allocation-settings }}**, select a subnet in a single [availability zone](../overview/concepts/geo-scope.md) and enable traffic in this subnet. + 1. Under **{{ ui-key.yacloud.alb.section_allocation-settings }}**, select a subnet in one [availability zone](../overview/concepts/geo-scope.md) and enable incoming traffic in this subnet. - Remove all other availability zones by clicking ![xmark](../_assets/console-icons/xmark.svg) in the relevant row. + Remove the other availability zones by clicking ![xmark](../_assets/console-icons/xmark.svg) in the relevant row. 1. Under **{{ ui-key.yacloud.alb.label_listeners }}**, enter the listener name: `test-listener`. @@ -113,16 +113,16 @@ As an example, let's create a balancer with a node in the same subnet and same a In the terminal, run the following command: ```bash -curl -v :80 +curl --verbose :80 ``` -The response must return the `200` HTTP status code and an HTML-formatted list of folders from the test VM folder. +The response must return the HTTP status code `200` and an HTML list of folders from the test VM folder. After that, you can add other VMs to the target group, create new backends for your application, and build routes to the application endpoints. ## How to delete the resources you created {#clear-out} -To stop paying for the resources created, delete them in the following order: +To stop paying for the resources you created, delete them in the following order: {% list tabs group=instructions %} diff --git a/en/application-load-balancer/quickstart.md b/en/application-load-balancer/quickstart.md index 4bed9651924..b957271f849 100644 --- a/en/application-load-balancer/quickstart.md +++ b/en/application-load-balancer/quickstart.md @@ -203,7 +203,7 @@ As an example, let's create a balancer with a node in the same subnet and same a In the terminal, run the following command: ```bash -curl -v :80 +curl --verbose :80 ``` The response must return the HTTP status code `200` and an HTML list of folders from the test VM folder. diff --git a/en/audit-trails/api-ref/Trail/list.md b/en/audit-trails/api-ref/Trail/list.md index 5142bdd86b1..30f2ab5cb6c 100644 --- a/en/audit-trails/api-ref/Trail/list.md +++ b/en/audit-trails/api-ref/Trail/list.md @@ -29,7 +29,7 @@ Default value: 100. || || pageToken | **string** Page token. To get the next page of results, set `page_token` to the -[ListTrailsRequest.nextPageToken](#yandex.cloud.audittrails.v1.ListTrailsResponse) returned by a previous list request. || +[ListTrailsRequest.next_page_token] returned by a previous list request. || || filter | **string** A filter expression that filters subscription locks listed in the response. diff --git a/en/audit-trails/api-ref/Trail/listOperations.md b/en/audit-trails/api-ref/Trail/listOperations.md index 18fbf88af44..39e713f2901 100644 --- a/en/audit-trails/api-ref/Trail/listOperations.md +++ b/en/audit-trails/api-ref/Trail/listOperations.md @@ -35,7 +35,7 @@ Default value: 100. || || pageToken | **string** Page token. To get the next page of results, set `page_token` to the -[ListTrailOperationsRequest.nextPageToken](/docs/audit-trails/api-ref/Trail/list#yandex.cloud.audittrails.v1.ListTrailsResponse) returned by a previous list request. || +[ListTrailOperationsRequest.next_page_token] returned by a previous list request. || |# ## Response {#yandex.cloud.audittrails.v1.ListTrailOperationsResponse} @@ -77,8 +77,8 @@ List of operations for the specified trail. || || nextPageToken | **string** This token allows you to get the next page of results for list requests. If the number of results -is larger than [ListTrailOperationsResponse.pageSize](/docs/audit-trails/api-ref/Trail/list#yandex.cloud.audittrails.v1.ListTrailsRequest), use the `next_page_token` as the value -for the [ListTrailOperationsResponse.pageToken](/docs/audit-trails/api-ref/Trail/list#yandex.cloud.audittrails.v1.ListTrailsRequest) query parameter in the next list request. +is larger than [ListTrailOperationsResponse.page_size], use the `next_page_token` as the value +for the [ListTrailOperationsResponse.page_token] query parameter in the next list request. Each subsequent list request will have its own `next_page_token` to continue paging through the results. || |# diff --git a/en/audit-trails/api-ref/grpc/Trail/list.md b/en/audit-trails/api-ref/grpc/Trail/list.md index 725b95b836f..9f02521a05a 100644 --- a/en/audit-trails/api-ref/grpc/Trail/list.md +++ b/en/audit-trails/api-ref/grpc/Trail/list.md @@ -37,7 +37,7 @@ Default value: 100. || || pageToken | **string** Page token. To get the next page of results, set `page_token` to the -[ListTrailsRequest.nextPageToken](#yandex.cloud.audittrails.v1.ListTrailsResponse) returned by a previous list request. || +[ListTrailsRequest.next_page_token] returned by a previous list request. || || filter | **string** A filter expression that filters subscription locks listed in the response. diff --git a/en/audit-trails/api-ref/grpc/Trail/listOperations.md b/en/audit-trails/api-ref/grpc/Trail/listOperations.md index 121507999e8..c669d45af48 100644 --- a/en/audit-trails/api-ref/grpc/Trail/listOperations.md +++ b/en/audit-trails/api-ref/grpc/Trail/listOperations.md @@ -35,7 +35,7 @@ Default value: 100. || || pageToken | **string** Page token. To get the next page of results, set `page_token` to the -[ListTrailOperationsRequest.nextPageToken](/docs/audit-trails/api-ref/grpc/Trail/list#yandex.cloud.audittrails.v1.ListTrailsResponse) returned by a previous list request. || +[ListTrailOperationsRequest.next_page_token] returned by a previous list request. || |# ## ListTrailOperationsResponse {#yandex.cloud.audittrails.v1.ListTrailOperationsResponse} @@ -69,8 +69,8 @@ List of operations for the specified trail. || || nextPageToken | **string** This token allows you to get the next page of results for list requests. If the number of results -is larger than [ListTrailOperationsResponse.pageSize](/docs/audit-trails/api-ref/grpc/Trail/list#yandex.cloud.audittrails.v1.ListTrailsRequest), use the `next_page_token` as the value -for the [ListTrailOperationsResponse.pageToken](/docs/audit-trails/api-ref/grpc/Trail/list#yandex.cloud.audittrails.v1.ListTrailsRequest) query parameter in the next list request. +is larger than [ListTrailOperationsResponse.page_size], use the `next_page_token` as the value +for the [ListTrailOperationsResponse.page_token] query parameter in the next list request. Each subsequent list request will have its own `next_page_token` to continue paging through the results. || |# diff --git a/en/audit-trails/tutorials/export-logs-to-arcsight.md b/en/audit-trails/tutorials/export-logs-to-arcsight.md index 1388127665d..82cbbb8762e 100644 --- a/en/audit-trails/tutorials/export-logs-to-arcsight.md +++ b/en/audit-trails/tutorials/export-logs-to-arcsight.md @@ -4,7 +4,7 @@ Create a trail to upload management event audit logs of resources in an individu To complete the tutorial successfully, you must have an ArcSight instance installed. -The solution described in the tutorial follows the procedure below: +The solution described in the tutorial follows the steps below: 1. A [trail](../concepts/trail.md) uploads logs to an {{ objstorage-name }} bucket. 1. A [bucket](../../storage/concepts/bucket.md) is mounted via a [FUSE](https://en.wikipedia.org/wiki/Filesystem_in_Userspace) interface to a folder on an intermediate VM. 1. [SmartConnector](https://www.microfocus.com/documentation/arcsight/arcsight-smartconnectors/AS_SmartConn_getstart_HTML/) collects logs from the folder and delivers them to ArcSight for analysis. @@ -38,7 +38,7 @@ The infrastructure support cost includes: * Fee for using VM instances (see [{{ compute-short-name }} pricing](../../compute/pricing.md)). * Fee for storing data in a bucket (see [{{ objstorage-name }} pricing](../../storage/pricing.md#prices-storage)). -* Fee for data operations (see [{{ objstorage-name }} pricing](../../storage/pricing.md#prices-operations)). +* Fee for operations with data (see [{{ objstorage-name }} pricing](../../storage/pricing.md#prices-operations)). * Fee for using {{ kms-short-name }} keys (see [{{ kms-name }} pricing](../../kms/pricing.md#prices)). ## Prepare the environment {#prepare-environment} @@ -48,7 +48,7 @@ The infrastructure support cost includes: You can use a VM that has access to an ArcSight instance or create a new one: 1. [Create a VM](../../compute/operations/vm-create/create-linux-vm.md) from a Linux image based on [Ubuntu 20.04](/marketplace/products/yc/ubuntu-20-04-lts). -1. [Connect to the VM](../../compute/operations/vm-connect/ssh.md#vm-connect) via SSH. +1. [Connect to the VM](../../compute/operations/vm-connect/ssh.md#vm-connect) over SSH. ### Create a bucket for audit logs {#create-backet} @@ -56,10 +56,10 @@ You can use a VM that has access to an ArcSight instance or create a new one: - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the folder to create a bucket in, e.g., `example-folder`. - 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_storage }}**. - 1. Click **{{ ui-key.yacloud.storage.buckets.button_empty-create }}**. - 1. On the bucket creation page: + 1. In the [management console]({{ link-console-main }}), select the folder where you want to create a bucket, e.g., `example-folder`. + 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_storage }}**. + 1. Click **{{ ui-key.yacloud.storage.buckets.button_empty-create }}**. + 1. On the bucket creation page: 1. Enter a name for the bucket according to the [naming requirements](../../storage/concepts/bucket.md#naming). 1. Limit the maximum bucket size, if required. @@ -77,13 +77,13 @@ You can use a VM that has access to an ArcSight instance or create a new one: - Management console {#console} - 1. In the [management console]({{ link-console-main }}), go to `example-folder`. - 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_kms }}**. - 1. Click **{{ ui-key.yacloud.kms.symmetric-keys.button_empty-create }}** and specify: - * **{{ ui-key.yacloud.common.name }}**: `arcsight-kms` - * **{{ ui-key.yacloud.kms.symmetric-key.form.field_algorithm }}**: `AES-256` - * Leave the other parameters at their default settings. - 1. Click **{{ ui-key.yacloud.common.create }}**. + 1. In the [management console]({{ link-console-main }}), go to `example-folder`. + 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_kms }}**. + 1. Click **{{ ui-key.yacloud.kms.symmetric-keys.button_empty-create }}** and specify: + * **{{ ui-key.yacloud.common.name }}**: `arcsight-kms`. + * **{{ ui-key.yacloud.kms.symmetric-key.form.field_algorithm }}**: `AES-256`. + * Leave the other parameters at their default settings. + 1. Click **{{ ui-key.yacloud.common.create }}**. {% endlist %} @@ -93,10 +93,11 @@ You can use a VM that has access to an ArcSight instance or create a new one: - Management console {#console} - 1. In the [management console]({{ link-console-main }}), go to the previously created bucket. - 1. In the left-hand panel, select **{{ ui-key.yacloud.storage.bucket.switch_encryption }}**. - 1. In the **{{ ui-key.yacloud.storage.bucket.encryption.field_key }}** field, select the `arcsight-kms` key. - 1. Click **{{ ui-key.yacloud.storage.bucket.encryption.button_save }}**. + 1. In the [management console]({{ link-console-main }}), go to the previously created bucket. + 1. In the left-hand panel, select **{{ ui-key.yacloud.storage.bucket.switch_security }}**. + 1. Open the **{{ ui-key.yacloud.storage.bucket.switch_encryption }}** tab. + 1. In the **{{ ui-key.yacloud.storage.bucket.encryption.field_key }}** field, select `arcsight-kms`. + 1. Click **{{ ui-key.yacloud.storage.bucket.encryption.button_save }}**. {% endlist %} @@ -104,26 +105,26 @@ You can use a VM that has access to an ArcSight instance or create a new one: You need to create two accounts: one for a trail and one for a bucket. -Create the `sa-arcsight` service account: +Create a service account named `sa-arcsight`: {% list tabs group=instructions %} - Management console {#console} - 1. In the [management console]({{ link-console-main }}), go to `example-folder`. - 1. At the top of the screen, go to the **{{ ui-key.yacloud.iam.folder.switch_service-accounts }}** tab. - 1. Click **{{ ui-key.yacloud.iam.folder.service-accounts.button_add }}**. - 1. Enter a name for the service account according to the naming requirements: - - {% include [name-format](../../_includes/name-format.md) %} - - For example, `sa-arcsight`. - - 1. Click **{{ ui-key.yacloud.iam.folder.service-account.popup-robot_button_add }}**. - + 1. In the [management console]({{ link-console-main }}), go to `example-folder`. + 1. At the top of the screen, go to the **{{ ui-key.yacloud.iam.folder.switch_service-accounts }}** tab. + 1. Click **{{ ui-key.yacloud.iam.folder.service-accounts.button_add }}**. + 1. Enter a name for the service account according to the naming requirements: + + {% include [name-format](../../_includes/name-format.md) %} + + Example: `sa-arcsight`. + + 1. Click **{{ ui-key.yacloud.iam.folder.service-account.popup-robot_button_add }}**. + {% endlist %} -Create the `sa-arcsight-bucket` service account the same way. +Similarly, create a service account named `sa-arcsight-bucket`. ### Create a static key {#create-access-key} @@ -133,13 +134,13 @@ You will need the key ID and secret key when mounting the bucket. - Management console {#console} - 1. In the [management console]({{ link-console-main }}), go to `example-folder`. - 1. At the top of the screen, go to the **{{ ui-key.yacloud.iam.folder.switch_service-accounts }}** tab. - 1. Choose `sa-arcsight-bucket` and click the row with its name. - 1. Click **{{ ui-key.yacloud.iam.folder.service-account.overview.button_create-key-popup }}** on the top panel. - 1. Select **{{ ui-key.yacloud.iam.folder.service-account.overview.button_create_service-account-key }}**. - 1. Enter a description for the key and click **{{ ui-key.yacloud.iam.folder.service-account.overview.popup-key_button_create }}**. - 1. Save the ID and private key. + 1. In the [management console]({{ link-console-main }}), go to `example-folder`. + 1. At the top of the screen, go to the **{{ ui-key.yacloud.iam.folder.switch_service-accounts }}** tab. + 1. Select the `sa-arcsight-bucket` service account and click the row with its name. + 1. Click **{{ ui-key.yacloud.iam.folder.service-account.overview.button_create-key-popup }}** on the top panel. + 1. Select **{{ ui-key.yacloud.iam.folder.service-account.overview.button_create_service-account-key }}**. + 1. Enter a description for the key and click **{{ ui-key.yacloud.iam.folder.service-account.overview.popup-key_button_create }}**. + 1. Save the ID and private key. {% note alert %} @@ -149,7 +150,7 @@ You will need the key ID and secret key when mounting the bucket. - CLI {#cli} - 1. Create an access key for `sa-arcsight-bucket`: + 1. Create an access key for the `sa-arcsight-bucket` service account: ```bash yc iam access-key create --service-account-name sa-arcsight-bucket @@ -166,75 +167,75 @@ You will need the key ID and secret key when mounting the bucket. secret: JyT*******zMP1 ``` - 1. Save the ID (`key_id`) and secret key (`secret`). You will not be able to get the key value again. + 1. Save the ID (`key_id`) and secret key (`secret`). You will not be able to get the key value again. {% endlist %} ## Assign roles to the service accounts {#add-roles} -Assign `sa-arcsight` the `audit-trails.viewer`, `storage.uploader`, and `kms.keys.encrypterDecrypter` roles: +Assign the `audit-trails.viewer`, `storage.uploader`, and `kms.keys.encrypterDecrypter` roles to the `sa-arcsight` service account: {% list tabs group=instructions %} - CLI {#cli} - 1. The `audit-trails.viewer` [role](../../audit-trails/security/#roles) to the folder: - + 1. `audit-trails.viewer` [role](../../audit-trails/security/#roles) for the folder: + ``` yc resource-manager folder add-access-binding \ --role audit-trails.viewer \ --id \ --service-account-id ``` - + Where: - + * `--role`: Role being assigned. - * `--id`: ID of `example-folder`. - * `--service-account-id`: ID of the `sa-arcsight` service account. + * `--id`: `example-folder` ID. + * `--service-account-id`: `sa-arcsight` service account ID. For more information about the `yc resource-manager folder add-access-binding` command, see the [CLI reference](../../cli/cli-ref/managed-services/resource-manager/folder/add-access-binding.md). - - 1. The `storage.uploader` [role](../../storage/security/#storage-uploader) to the folder with a bucket: - + + 1. Assign the `storage.uploader` [role](../../storage/security/#storage-uploader) for the folder the bucket is in: + ``` yc resource-manager folder add-access-binding \ --role storage.uploader \ --id \ --service-account-id ``` - + Where: - + * `--role`: Role being assigned. - * `--id`: ID of `example-folder`. - * `--service-account-id`: ID of the `sa-arcsight` service account. - - 1. The `kms.keys.encrypterDecrypter` [role](../../kms/security/#service) to the `arcsight-kms` encryption key: + * `--id`: `example-folder` ID. + * `--service-account-id`: `sa-arcsight` service account ID. + 1. `kms.keys.encrypterDecrypter` [role](../../kms/security/#service) for the `arcsight-kms` encryption key: + ``` yc kms symmetric-key add-access-binding \ --role kms.keys.encrypterDecrypter \ --id \ --service-account-id ``` - + Where: - + * `--role`: Role being assigned. * `--id`: ID of the `arcsight-kms` {{ kms-short-name }} key. - * `--service-account-id`: ID of the `sa-arcsight` service account. + * `--service-account-id`: `sa-arcsight` service account ID. {% endlist %} -Assign `sa-arcsight-bucket` the `storage.viewer` and `kms.keys.encrypterDecrypter` roles: +Assign the `storage.viewer` and `kms.keys.encrypterDecrypter` roles to the `sa-arcsight-bucket` service account: {% list tabs group=instructions %} - CLI {#cli} - 1. The `storage.viewer` role to the folder: - + 1. `storage.viewer` role for the folder: + ``` yc resource-manager folder add-access-binding \ --id \ @@ -243,26 +244,26 @@ Assign `sa-arcsight-bucket` the `storage.viewer` and `kms.keys.encrypterDecrypte ``` Where: - - * `--id`: ID of `example-folder`. + + * `--id`: `example-folder` ID. * `--role`: Role being assigned. - * `--service-account-id`: ID of `sa-arcsight-bucket`. - - 1. The `kms.keys.encrypterDecrypter` role to the `arcsight-kms` encryption key: - + * `--service-account-id`: `sa-arcsight-bucket` service account ID. + + 1. `kms.keys.encrypterDecrypter` role for the `arcsight-kms` encryption key: + ``` yc kms symmetric-key add-access-binding \ --role kms.keys.encrypterDecrypter \ --id \ --service-account-id ``` - + Where: - + * `--role`: Role being assigned. * `--id`: ID of the `arcsight-kms` {{ kms-short-name }} key. - * `--service-account-id`: ID of the `sa-arcsight-bucket` service account. - + * `--service-account-id`: `sa-arcsight-bucket` service account ID. + {% endlist %} ## Create a trail {#create-trail} @@ -271,46 +272,46 @@ Assign `sa-arcsight-bucket` the `storage.viewer` and `kms.keys.encrypterDecrypte - Management console {#console} - 1. In the [management console]({{ link-console-main }}), go to `example-folder`. - 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_audit-trails }}**. - 1. Click **{{ ui-key.yacloud.audit-trails.button_create-trail }}** and specify: + 1. In the [management console]({{ link-console-main }}), go to `example-folder`. + 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_audit-trails }}**. + 1. Click **{{ ui-key.yacloud.audit-trails.button_create-trail }}** and specify: - * **{{ ui-key.yacloud.common.name }}**: Name of the trail being created, e.g., `arcsight-trail`. - * **{{ ui-key.yacloud.common.description }}**: Description of the trail (optional). + * **{{ ui-key.yacloud.common.name }}**: Name of the trail you want to create, e.g., `arcsight-trail`. + * **{{ ui-key.yacloud.common.description }}**: Trail description (optional). - 1. Under **{{ ui-key.yacloud.audit-trails.label_destination }}**, set up the destination object: + 1. Under **{{ ui-key.yacloud.audit-trails.label_destination }}**, configure the destination object: - * **{{ ui-key.yacloud.audit-trails.label_destination }}**: `{{ ui-key.yacloud.audit-trails.label_objectStorage }}`. - * **{{ ui-key.yacloud.audit-trails.label_bucket }}**: Bucket name. - * **{{ ui-key.yacloud.audit-trails.label_object-prefix }}**: Optional parameter used in the [full name](../../audit-trails/concepts/format.md#log-file-name) of the audit log file. + * **{{ ui-key.yacloud.audit-trails.label_destination }}**: `{{ ui-key.yacloud.audit-trails.label_objectStorage }}` + * **{{ ui-key.yacloud.audit-trails.label_bucket }}**: Bucket name. + * **{{ ui-key.yacloud.audit-trails.label_object-prefix }}**: Optional parameter used in the [full name](../../audit-trails/concepts/format.md#log-file-name) of the audit log file. + + {% include [note-bucket-prefix](../../_includes/audit-trails/note-bucket-prefix.md) %} - {% include [note-bucket-prefix](../../_includes/audit-trails/note-bucket-prefix.md) %} + * **{{ ui-key.yacloud.audit-trails.title_kms-key }}**: Specify the `arcsight-kms` encryption key used to [encrypt](../../storage/concepts/encryption.md) the bucket. + + 1. Under **{{ ui-key.yacloud.audit-trails.label_service-account }}**, select `sa-arcsight`. - * **{{ ui-key.yacloud.audit-trails.title_kms-key }}**: Specify the `arcsight-kms` encryption key the bucket is [encrypted](../../storage/concepts/encryption.md) with. + 1. Under **{{ ui-key.yacloud.audit-trails.label_path-filter-section }}**, configure the collection of management event audit logs: - 1. Under **{{ ui-key.yacloud.audit-trails.label_service-account }}**, select `sa-arcsight`. + * **{{ ui-key.yacloud.audit-trails.label_collecting-logs }}**: Select `{{ ui-key.yacloud.common.enabled }}`. + * **{{ ui-key.yacloud.audit-trails.label_resource-type }}**: Select `{{ ui-key.yacloud.audit-trails.label_resource-manager.folder }}`. + * **{{ ui-key.yacloud.audit-trails.label_resource-manager.folder }}**: Automatically populated field containing the name of the current folder. - 1. Under **{{ ui-key.yacloud.audit-trails.label_path-filter-section }}**, set up the collection of management event audit logs: + 1. Under **{{ ui-key.yacloud.audit-trails.label_event-filter-section }}**, select `{{ ui-key.yacloud.common.disabled }}` in the **{{ ui-key.yacloud.audit-trails.label_collecting-logs }}** field. + 1. Click **{{ ui-key.yacloud.common.create }}**. - * **{{ ui-key.yacloud.audit-trails.label_collecting-logs }}**: Select `{{ ui-key.yacloud.common.enabled }}`. - * **{{ ui-key.yacloud.audit-trails.label_resource-type }}**: Select `{{ ui-key.yacloud.audit-trails.label_resource-manager.folder }}`. - * **{{ ui-key.yacloud.audit-trails.label_resource-manager.folder }}**: Automatically populated field containing the name of the current folder. - - 1. Under **{{ ui-key.yacloud.audit-trails.label_event-filter-section }}**, select `{{ ui-key.yacloud.common.disabled }}` in the **{{ ui-key.yacloud.audit-trails.label_collecting-logs }}** field. - 1. Click **{{ ui-key.yacloud.common.create }}**. - - {% note warning %} - - The solution will delete the logs from the bucket after they are exported to ArcSight. If you need to keep the logs in the bucket, create a separate bucket and trail. - - {% endnote %} + {% note warning %} + + The solution will delete the logs from the bucket after they are exported to ArcSight. If you need to keep the logs in the bucket, create a separate bucket and trail. + + {% endnote %} {% endlist %} ## Mount a bucket {#mount-bucket} A bucket is mounted on an intermediate VM where ArcSight SmartConnector is installed. -To mount the bucket, create a file with the `sa-arcsight-bucket` service account static access key. +To mount the bucket, create a file with the static access key of the `sa-arcsight-bucket` service account. 1. On the intermediate VM, create a file with the static access key: @@ -325,7 +326,7 @@ To mount the bucket, create a file with the `sa-arcsight-bucket` service account sudo apt install s3fs ``` -1. Create a directory where the bucket will be mounted. For example: `mybucket` in the home directory: +1. Create a directory to mount the bucket to, e.g., `mybucket`, in your home directory: ```bash sudo mkdir ${HOME}/mybucket @@ -352,17 +353,17 @@ To complete this stage of the tutorial, you need an ArcSight SmartConnector dist {% endnote %} 1. On the intermediate VM, [install](https://www.microfocus.com/documentation/arcsight/arcsight-smartconnectors/AS_smartconn_install/) `ArcSight SmartConnector`: - 1. When installing it, select **ArcSight FlexConnector JSON Folder Follower** and specify the path to the `mybucket` folder. - 1. Specify **JSON configuration filename prefix**: `yc`. + 1. When installing it, select **ArcSight FlexConnector JSON Folder Follower** and specify the path to the `mybucket` folder. + 1. Specify **JSON configuration filename prefix**: `yc`. 1. [Download](https://github.com/yandex-cloud-examples/yc-export-auditlogs-to-arcsight/tree/main/arcsight_content) the `arcsight_content` files. -1. Copy the `yc.jsonparser.properties` file from the `flex` folder to the `/current/user/agent/flexagent` folder. -1. Copy the `map.0.properties` file from the `flex` folder to the `/current/user/agent/map` folder. -1. Edit the file `/current/user/agent/agent.properties`: +1. Copy the `yc.jsonparser.properties` file from the `flex` folder to the folder with this address: `/current/user/agent/flexagent`. +1. Copy the `map.0.properties` file from the `flex` folder to the folder with this address: `/current/user/agent/map`. +1. Edit the `/current/user/agent.properties` file: - ```bash - agents[0].mode=DeleteFile - agents[0].proccessfoldersrecursively=true - ``` + ```bash + agents[0].mode=DeleteFile + agents[0].proccessfoldersrecursively=true + ``` 1. Start the connector and make sure that events are received by ArcSight: @@ -373,5 +374,5 @@ To complete this stage of the tutorial, you need an ArcSight SmartConnector dist Some resources are not free of charge. To avoid paying for them, delete the resources you no longer need: 1. [Delete](../../storage/operations/buckets/delete.md) the {{ objstorage-name }} bucket. -1. [Destroy](../../kms/operations/key.md#delete) the {{ kms-name }} key. +1. [Delete](../../kms/operations/key.md#delete) the {{ kms-name }} key. 1. [Delete](../../compute/operations/vm-control/vm-delete.md) the intermediate VM if you created it in {{ compute-short-name }}. diff --git a/en/audit-trails/tutorials/export-logs-to-splunk.md b/en/audit-trails/tutorials/export-logs-to-splunk.md index dabc3b99a19..d3b938c4bce 100644 --- a/en/audit-trails/tutorials/export-logs-to-splunk.md +++ b/en/audit-trails/tutorials/export-logs-to-splunk.md @@ -38,7 +38,7 @@ The infrastructure support cost includes: * Fee for using VM instances (see [{{ compute-short-name }} pricing](../../compute/pricing.md)). * Fee for storing data in a bucket (see [{{ objstorage-name }} pricing](../../storage/pricing.md#prices-storage)). -* Fee for data operations (see [{{ objstorage-name }} pricing](../../storage/pricing.md#prices-operations)). +* Fee for operations with data (see [{{ objstorage-name }} pricing](../../storage/pricing.md#prices-operations)). * Fee for using KMS keys (see [{{ kms-name }} pricing](../../kms/pricing.md#prices)). ## Prepare the environment {#prepare-environment} @@ -49,10 +49,10 @@ The infrastructure support cost includes: - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the folder where you want to create a [bucket](../../storage/concepts/bucket.md). - 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_storage }}**. - 1. Click **{{ ui-key.yacloud.storage.buckets.button_empty-create }}**. - 1. On the bucket creation page: + 1. In the [management console]({{ link-console-main }}), select the folder where you want to create a [bucket](../../storage/concepts/bucket.md). + 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_storage }}**. + 1. Click **{{ ui-key.yacloud.storage.buckets.button_empty-create }}**. + 1. On the bucket creation page: 1. Enter a name for the bucket according to the [naming requirements](../../storage/concepts/bucket.md#naming). By default, a bucket with a dot in the name is only available over HTTP. To provide HTTPS support for your bucket, [upload your own security certificate](../../storage/operations/hosting/certificate.md) to {{ objstorage-name }}. @@ -73,16 +73,16 @@ The infrastructure support cost includes: - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the folder containing your bucket. - 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_kms }}**. - 1. Click **{{ ui-key.yacloud.kms.symmetric-keys.button_empty-create }}** and set the key attributes: + 1. In the [management console]({{ link-console-main }}), select the folder containing your bucket. + 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_kms }}**. + 1. Click **{{ ui-key.yacloud.kms.symmetric-keys.button_empty-create }}** and set the key attributes: - * Any name and optional description. - * Encryption algorithm, e.g., AES-256. - * [Rotation](../../kms/concepts/index.md#rotation) period (how often to change key versions). - * Click **{{ ui-key.yacloud.common.create }}**. + * Any name and optional description. + * Encryption algorithm, e.g., AES-256. + * [Rotation](../../kms/concepts/index.md#rotation) period (how often to change key versions). + * Click **{{ ui-key.yacloud.common.create }}**. - The key is created together with its first version: click the key in the list to open a page with its attributes. + The key is created together with its first version: click the key in the list to open a page with its attributes. {% endlist %} @@ -92,13 +92,14 @@ The infrastructure support cost includes: - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the bucket for which you want to configure encryption. - 1. In the left-hand panel, select **{{ ui-key.yacloud.storage.bucket.switch_encryption }}**. - 1. In the **{{ ui-key.yacloud.storage.bucket.encryption.field_key }}** field, select an existing key or create a new one: + 1. In the [management console]({{ link-console-main }}), select the bucket you want to configure encryption for. + 1. In the left-hand panel, select **{{ ui-key.yacloud.storage.bucket.switch_security }}**. + 1. Open the **{{ ui-key.yacloud.storage.bucket.switch_encryption }}** tab. + 1. In the **{{ ui-key.yacloud.storage.bucket.encryption.field_key }}** field, select an existing key or create a new one: - {% include [storage-create-kms](../../storage/_includes_service/storage-create-kms.md) %} + {% include [storage-create-kms](../../storage/_includes_service/storage-create-kms.md) %} - 1. Click **{{ ui-key.yacloud.storage.bucket.encryption.button_save }}**. + 1. Click **{{ ui-key.yacloud.storage.bucket.encryption.button_save }}**. {% endlist %} @@ -108,14 +109,14 @@ The infrastructure support cost includes: - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the folder where you want to create a service account. - 1. At the top of the screen, go to the **{{ ui-key.yacloud.iam.folder.switch_service-accounts }}** tab. - 1. Click **{{ ui-key.yacloud.iam.folder.service-accounts.button_add }}**. - 1. Enter a name for the service account. The naming requirements are as follows: + 1. In the [management console]({{ link-console-main }}), select the folder where you want to create a service account. + 1. At the top of the screen, go to the **{{ ui-key.yacloud.iam.folder.switch_service-accounts }}** tab. + 1. Click **{{ ui-key.yacloud.iam.folder.service-accounts.button_add }}**. + 1. Enter a name for the service account. The naming requirements are as follows: {% include [name-format](../../_includes/name-format.md) %} - 1. Click **{{ ui-key.yacloud.iam.folder.service-account.popup-robot_button_add }}**. + 1. Click **{{ ui-key.yacloud.iam.folder.service-account.popup-robot_button_add }}**. {% endlist %} @@ -125,106 +126,106 @@ The infrastructure support cost includes: - CLI {#cli} - 1. Assign the [audit-trails.viewer](../../audit-trails/security/#roles) role to the folder whose resources will be polled for audit logs: - + 1. Assign the [audit-trails.viewer](../../audit-trails/security/#roles) role to the folder whose resources will be polled for audit logs: + ``` yc resource-manager folder add-access-binding \ --role audit-trails.viewer \ --id \ --service-account-id ``` - + Where: - - * `--role`: Role being assigned. + + * `--role`: Role you want to assign. * `--id`: ID of the folder from which audit logs will be collected. * `--service-account-id`: Service account ID. - - 1. Assign the [storage.uploader](../../storage/security/#storage-uploader) role to the folder to host the trail: - + + 1. Assign the [storage.uploader](../../storage/security/#storage-uploader) role to the folder to host the trail: + ``` yc resource-manager folder add-access-binding \ --role storage.uploader \ --id \ --service-account-id ``` - + Where: - - * `--role`: Role being assigned. + + * `--role`: Role you want to assign. * `--id`: ID of the folder to host the trail. * `--service-account-id`: Service account ID. - - 1. Assign the [kms.keys.encrypterDecrypter](../../kms/security/#service) role to the encryption key: - + + 1. Assign the [kms.keys.encrypterDecrypter](../../kms/security/#service) role to the encryption key: + ``` yc kms symmetric-key add-access-binding \ --role kms.keys.encrypterDecrypter \ --id \ --service-account-id ``` - + Where: - - * `--role`: Role being assigned. + + * `--role`: Role you want to assign. * `--id`: KMS key ID. * `--service-account-id`: Service account ID. - + {% endlist %} ## Create a trail {#create-trail} To create the trail, make sure you have the following roles: -* `iam.serviceAccounts.user` for the service account. -* `audit-trails.editor` for the folder to host the trail. -* `audit-trails.viewer` for the folder from which audit logs will be collected. -* `storage.viewer` for the bucket or folder. + * `iam.serviceAccounts.user` for the service account. + * `audit-trails.editor` for the folder to host the trail. + * `audit-trails.viewer` for the folder to collect audit logs from. + * `storage.viewer` for the bucket or folder. {% list tabs group=instructions %} - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the folder where you want to create the trail. - 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_audit-trails }}**. - 1. Click **{{ ui-key.yacloud.audit-trails.button_create-trail }}** and specify: - - * **{{ ui-key.yacloud.common.name }}**: Name of the trail being created. - * **{{ ui-key.yacloud.common.description }}**: Description of the trail (optional). + 1. In the [management console]({{ link-console-main }}), select the folder where you want to create the trail. + 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_audit-trails }}**. + 1. Click **{{ ui-key.yacloud.audit-trails.button_create-trail }}** and specify: - 1. Under **{{ ui-key.yacloud.audit-trails.label_destination }}**, configure the destination object: + * **{{ ui-key.yacloud.common.name }}**: Name of the new trail. + * **{{ ui-key.yacloud.common.description }}**: Trail description (optional). - * **{{ ui-key.yacloud.audit-trails.label_destination }}**: `{{ ui-key.yacloud.audit-trails.label_objectStorage }}`. - * **{{ ui-key.yacloud.audit-trails.label_bucket }}**: Name of the [bucket](../../storage/operations/buckets/create.md) to which you want to upload audit logs. - * **{{ ui-key.yacloud.audit-trails.label_object-prefix }}**: Optional parameter used in the [full name](../../audit-trails/concepts/format.md#log-file-name) of the audit log file. + 1. Under **{{ ui-key.yacloud.audit-trails.label_destination }}**, configure the destination object: - {% include [note-bucket-prefix](../../_includes/audit-trails/note-bucket-prefix.md) %} + * **{{ ui-key.yacloud.audit-trails.label_destination }}**: `{{ ui-key.yacloud.audit-trails.label_objectStorage }}`. + * **{{ ui-key.yacloud.audit-trails.label_bucket }}**: Name of the [bucket](../../storage/operations/buckets/create.md) to which you want to upload audit logs. + * **{{ ui-key.yacloud.audit-trails.label_object-prefix }}**: Optional parameter used in the [full name](../../audit-trails/concepts/format.md#log-file-name) of the audit log file. + + {% include [note-bucket-prefix](../../_includes/audit-trails/note-bucket-prefix.md) %} * **{{ ui-key.yacloud.audit-trails.title_kms-key }}**: Specify the encryption key the bucket is [encrypted](../../storage/concepts/encryption.md) with. + + 1. Under **{{ ui-key.yacloud.audit-trails.label_service-account }}**, select the service account that the trail will use to upload audit log files to the bucket. - 1. Under **{{ ui-key.yacloud.audit-trails.label_service-account }}**, select the service account that the trail will use to upload audit log files to the bucket. + 1. Under **{{ ui-key.yacloud.audit-trails.label_path-filter-section }}**, configure the collection of management event audit logs: - 1. Under **{{ ui-key.yacloud.audit-trails.label_path-filter-section }}**, configure the collection of management event audit logs: + * **{{ ui-key.yacloud.audit-trails.label_collecting-logs }}**: Select `{{ ui-key.yacloud.common.enabled }}`. + * **{{ ui-key.yacloud.audit-trails.label_resource-type }}**: Select `{{ ui-key.yacloud.audit-trails.label_resource-manager.folder }}`. + * **{{ ui-key.yacloud.audit-trails.label_resource-manager.folder }}**: Automatically populated field containing the name of the current folder. - * **{{ ui-key.yacloud.audit-trails.label_collecting-logs }}**: Select `{{ ui-key.yacloud.common.enabled }}`. - * **{{ ui-key.yacloud.audit-trails.label_resource-type }}**: Select `{{ ui-key.yacloud.audit-trails.label_resource-manager.folder }}`. - * **{{ ui-key.yacloud.audit-trails.label_resource-manager.folder }}**: Automatically populated field containing the name of the current folder. + 1. Under **{{ ui-key.yacloud.audit-trails.label_event-filter-section }}**, select `{{ ui-key.yacloud.common.disabled }}` in the **{{ ui-key.yacloud.audit-trails.label_collecting-logs }}** field. - 1. Under **{{ ui-key.yacloud.audit-trails.label_event-filter-section }}**, select `{{ ui-key.yacloud.common.disabled }}` in the **{{ ui-key.yacloud.audit-trails.label_collecting-logs }}** field. + 1. Click **{{ ui-key.yacloud.common.create }}**. - 1. Click **{{ ui-key.yacloud.common.create }}**. - - {% note warning %} - - The solution will delete the logs from the bucket after they are exported to Splunk. If you need to keep the logs in the bucket, create a separate bucket and trail. - - {% endnote %} + {% note warning %} + + The solution will delete the logs from the bucket after they are exported to Splunk. If you need to keep the logs in the bucket, create a separate bucket and trail. + + {% endnote %} {% endlist %} ## Set up Splunk for import {#prepare-splunk} -Enable `HTTPEventCollector` and get an `Event Collector` token by following this [guide](https://docs.splunk.com/Documentation/SplunkCloud/8.2.2105/Data/UsetheHTTPEventCollector#Configure_HTTP_Event_Collector_on_Splunk_Cloud_Platform). +Enable `HTTPEventCollector` and follow this [guide](https://docs.splunk.com/Documentation/SplunkCloud/8.2.2105/Data/UsetheHTTPEventCollector#Configure_HTTP_Event_Collector_on_Splunk_Cloud_Platform) to get the `Event Collector` token. ## Set up a NAT gateway for the subnet with the intermediate VM {#enable-nat} @@ -232,18 +233,18 @@ Enable `HTTPEventCollector` and get an `Event Collector` token by following this - Management console {#console} - 1. Create a NAT gateway: + 1. Create a NAT gateway: 1. In the [management console]({{ link-console-main }}), select the folder containing the subnet for the intermediate VM. 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_vpc }}**. 1. In the left-hand panel, select **{{ ui-key.yacloud.vpc.switch_gateways }}**. 1. Click **{{ ui-key.yacloud.common.create }}**. 1. Enter a name for the gateway. The naming requirements are as follows: - {% include [name-format](../../_includes/name-format.md) %} - + {% include [name-format](../../_includes/name-format.md) %} + 1. The default gateway type is `{{ ui-key.yacloud.vpc.gateways.value_gateway-type-egress-nat }}`. 1. Click **{{ ui-key.yacloud.common.save }}**. - 1. Create a route table: + 1. Create a route table: 1. In the left-hand panel, select ![image](../../_assets/console-icons/route.svg) **{{ ui-key.yacloud.vpc.network.switch_route-table }}**. 1. Click **{{ ui-key.yacloud.common.create }}** to [add](../../vpc/operations/static-route-create.md) a new table, or select an existing one. 1. Click **{{ ui-key.yacloud.vpc.route-table-form.label_add-static-route }}**. @@ -251,9 +252,9 @@ Enable `HTTPEventCollector` and get an `Event Collector` token by following this 1. In the **{{ ui-key.yacloud.vpc.add-static-route.value_gateway }}** field, select the NAT gateway you created. The destination prefix will be propagated automatically. 1. Click **{{ ui-key.yacloud.vpc.add-static-route.button_add }}**. 1. Click **{{ ui-key.yacloud.vpc.route-table.edit.button_edit }}**. - 1. Link the route table to the subnet where you want to deploy the intermediate VM, to forward its traffic via the NAT gateway: + 1. Link the route table to the subnet where you want to deploy the intermediate VM, to forward its traffic via the NAT gateway: 1. In the left-hand panel, select ![image](../../_assets/console-icons/nodes-right.svg) **{{ ui-key.yacloud.vpc.switch_networks }}**. - 1. In the required subnet row, click ![image](../../_assets/console-icons/ellipsis.svg). + 1. In the row with the subnet you need, click ![image](../../_assets/console-icons/ellipsis.svg). 1. In the menu that opens, select **{{ ui-key.yacloud.vpc.subnetworks.button_action-add-route-table }}**. 1. In the window that opens, select the created table from the list. 1. Click **{{ ui-key.yacloud.vpc.subnet.add-route-table.button_add }}**. @@ -266,54 +267,54 @@ Enable `HTTPEventCollector` and get an `Event Collector` token by following this - {{ TF }} {#tf} - 1. {% include [terraform-install](../../_includes/terraform-install.md) %} - 1. Clone a [repository](https://github.com/yandex-cloud-examples/yc-export-auditlogs-to-splunk) from [{{ yandex-cloud }} Security Solution Library](https://github.com/yandex-cloud-examples/yc-security-solutions-library): - - ``` - git clone https://github.com/yandex-cloud-examples/yc-export-auditlogs-to-splunk.git - ``` - - 1. Create a subfolder in `/yc-export-auditlogs-to-splunk/terraform/` and go there. - 1. Create a configuration file to invoke the `yc-splunk-trail` module: - - ``` - module "yc-splunk-trail" { - source = "../modules/yc-splunk-trail/" - folder_id = - splunk_token = - splunk_server = :8088 - bucket_name = - bucket_folder = - sa_id = - coi_subnet_id = - } - ``` - Where: - - * `folder_id`: Folder ID. - * `splunk_token`: Event Collector token retrieved from Splunk. - * `splunk_server`: Address of your Splunk server as `https://`. - * `bucket_name`: Bucket name. - * `bucket_folder`: Name of the root folder in the bucket. - * `sa_id`: Service account ID. - * `coi_subnet_id`: ID of the subnet where you set up the NAT gateway. - - 1. Make sure that the configuration files are correct: - - ``` - terraform plan - ``` - - If the configuration is described correctly, the terminal will display a list of created resources and their parameters. If the configuration contains any errors, {{ TF }} will point them out. - - 1. Deploy cloud resources. - 1. If the configuration does not contain any errors, run this command: - - ``` - terraform apply - ``` - - 1. Confirm resource creation: enter `yes` in the terminal and press **Enter**. + 1. {% include [terraform-install](../../_includes/terraform-install.md) %} + 1. Clone a [repository](https://github.com/yandex-cloud-examples/yc-export-auditlogs-to-splunk) from [{{ yandex-cloud }} Security Solution Library](https://github.com/yandex-cloud-examples/yc-security-solutions-library): + + ``` + git clone https://github.com/yandex-cloud-examples/yc-export-auditlogs-to-splunk.git + ``` + + 1. Create a subfolder in `/yc-export-auditlogs-to-splunk/terraform/` and go there. + 1. Create a configuration file to invoke the `yc-splunk-trail` module: + + ``` + module "yc-splunk-trail" { + source = "../modules/yc-splunk-trail/" + folder_id = + splunk_token = + splunk_server = :8088 + bucket_name = + bucket_folder = + sa_id = + coi_subnet_id = + } + ``` + Where: + + * `folder_id`: Folder ID. + * `splunk_token`: Event Collector token retrieved from Splunk. + * `splunk_server`: Address of your Splunk server as `https://`. + * `bucket_name`: Bucket name. + * `bucket_folder`: Name of the root folder in the bucket. + * `sa_id`: Service account ID. + * `coi_subnet_id`: ID of the subnet where you set up the NAT gateway. + + 1. Make sure that the configuration files are correct: + + ``` + terraform plan + ``` + + If the configuration is described correctly, the terminal will display a list of created resources and their parameters. If the configuration contains any errors, {{ TF }} will point them out. + + 1. Deploy cloud resources. + 1. If the configuration does not contain any errors, run this command: + + ``` + terraform apply + ``` + + 1. Confirm resource creation: enter `yes` in the terminal and press **Enter**. {% endlist %} @@ -325,7 +326,7 @@ Enable `HTTPEventCollector` and get an `Event Collector` token by following this index="main" authentication.subject_type="SERVICE_ACCOUNT" | stats count by event_type ``` -1. To visualize the results, select the **Visualization** tab and select a suitable format (`LineChart`, `PieChart`, and so on): +1. To visualize the results, go to the **Visualization** tab and select a suitable format (`LineChart`, `PieChart`, etc.): Data visualization example: diff --git a/en/backup/backup/api-ref/Backup/list.md b/en/backup/backup/api-ref/Backup/list.md index c6e2c1d5b87..d078e8b7193 100644 --- a/en/backup/backup/api-ref/Backup/list.md +++ b/en/backup/backup/api-ref/Backup/list.md @@ -59,6 +59,13 @@ Supported parameters are: Supported logic operators: * AND || +|| type | **enum** (ResourceType) + +Type of resource. Could be compute VM or baremetal server. + +- `RESOURCE_TYPE_UNSPECIFIED` +- `COMPUTE`: Resource is Compute Cloud VM +- `BMS`: Resource is baremetal server || |# ## ArchiveParameters {#yandex.cloud.backup.v1.ListBackupsRequest.ArchiveParameters} diff --git a/en/backup/backup/api-ref/grpc/Backup/list.md b/en/backup/backup/api-ref/grpc/Backup/list.md index 0d85e6b1390..b31a9b32a37 100644 --- a/en/backup/backup/api-ref/grpc/Backup/list.md +++ b/en/backup/backup/api-ref/grpc/Backup/list.md @@ -30,7 +30,8 @@ List backups using filters. "policyId": "string", // end of the list of possible fields "orderBy": "string", - "filter": "string" + "filter": "string", + "type": "ResourceType" } ``` @@ -78,6 +79,13 @@ Supported parameters are: Supported logic operators: * AND || +|| type | enum **ResourceType** + +Type of resource. Could be compute VM or baremetal server. + +- `RESOURCE_TYPE_UNSPECIFIED` +- `COMPUTE`: Resource is Compute Cloud VM +- `BMS`: Resource is baremetal server || |# ## ArchiveParameters {#yandex.cloud.backup.v1.ListBackupsRequest.ArchiveParameters} diff --git a/en/backup/concepts/index.md b/en/backup/concepts/index.md index f0741f4ec48..60ba1aa7ea2 100644 --- a/en/backup/concepts/index.md +++ b/en/backup/concepts/index.md @@ -1,6 +1,10 @@ # {{ backup-full-name }} overview -{{ backup-full-name }} is a service for creating backups and restoring {{ yandex-cloud }} resources and their data. Backup and recovery is available for [{{ compute-name }} VMs](../../compute/concepts/vm.md) VMs with [supported operating systems](vm-connection.md#os). +{{ backup-full-name }} is a service for creating backups and restoring {{ yandex-cloud }} resources and their data. Backup and recovery is available for [{{ compute-name }}](../../compute/concepts/vm.md) VMs with [supported operating systems](vm-connection.md#os). + +{% include [baremetal-note](../../_includes/backup/baremetal-note.md) %} + +{% include [baremetal-note](../../_includes/backup/baremetal-note.md) %} VM backups are application-consistent: they save not only the data stored on disks but also the data already sent but not yet fully written. This allows you to resume applications that were running at the time of creating a backup directly after recovering a VM. This is important for VMs forming a part of data storage systems, e.g., those hosting a DBMS. diff --git a/en/backup/concepts/policy.md b/en/backup/concepts/policy.md index b853c201e87..e80f9fa8df5 100644 --- a/en/backup/concepts/policy.md +++ b/en/backup/concepts/policy.md @@ -10,7 +10,7 @@ By default, VMs in {{ backup-name }} are not linked to any backup policies. To s The backup policy specifies: -* Backup frequency: By hour, day, week, or month. The time is provided for the [UTC±00:00](https://{{ lang }}.wikipedia.org/wiki/UTC±00:00) time zone. +* Backup frequency: By hour, day, week, or month. All times are now [UTC±00:00](https://{{ lang }}.wikipedia.org/wiki/UTC±00:00). * Backup type: Full or incremental. For more information, see [{#T}](backup.md#types). * Settings for [storing backups](#retention). diff --git a/en/backup/concepts/vm-connection.md b/en/backup/concepts/vm-connection.md index 3d3248a4ee6..5c7e6e41ee2 100644 --- a/en/backup/concepts/vm-connection.md +++ b/en/backup/concepts/vm-connection.md @@ -2,6 +2,8 @@ To back up your [{{ compute-full-name }}](../../compute/) [VM](../../compute/concepts/vm.md) using {{ backup-name }}, you need to connect it to this service and set it up properly. +{% include [baremetal-note](../../_includes/backup/baremetal-note.md) %} + To connect your VM to {{ backup-name }}, make sure it has one of the [supported operating systems](#os) installed. For more information on connecting VMs, see [this guide](../operations/index.md#connect-vm). For the connection to work properly, assign a [service account](#sa) with the `backup.editor` role to your VM and configure [network access](#vm-network-access) for the VM. @@ -10,7 +12,7 @@ After connecting to {{ backup-name }}, [add](../operations/policy-vm/attach-and- {% include [vm-running](../../_includes/backup/vm-running.md) %} -You can also link a policy to a virtual machine while creating it. Policy is linked asynchronously after you create and initialize a VM, as well as install and configure a backup agent. This may take up to 10-15 minutes. For more information, see [{#T}](../tutorials/vm-with-backup-policy/index.md). +You can also link a policy to a virtual machine while creating it. A policy is linked asynchronously after you create and initialize a VM, as well as install and configure a backup agent. This may take up to 10-15 minutes. For more information, see [{#T}](../tutorials/vm-with-backup-policy/index.md). ## VM configuration requirements {#requirements} diff --git a/en/backup/operations/refresh-connection.md b/en/backup/operations/refresh-connection.md index c91c56f2ed4..a5210c93964 100644 --- a/en/backup/operations/refresh-connection.md +++ b/en/backup/operations/refresh-connection.md @@ -87,9 +87,9 @@ To avoid conflicts between the two VMs when making backups, update the outdated 1. In the [management console]({{ link-console-main }}), select the folder where {{ backup-name }} is connected. 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_backup }}**. - 1. On the ![machines](../../_assets/console-icons/server.svg) **{{ ui-key.yacloud.backup.label_instances }}** tab, check that the list does not contain the outdated VM marked as ![irrelevant](../../_assets/console-icons/circle-info-fill.svg). + 1. On ![machines](../../_assets/console-icons/server.svg) **{{ ui-key.yacloud.backup.label_instances }}** tab, check that the outdated VM is not listed with the ![irrelevant](../../_assets/console-icons/circle-info-fill.svg) label. - If the outdated VM is still there, click ![image](../../_assets/console-icons/ellipsis.svg) next to it, select **{{ ui-key.yacloud.common.delete }}**, and confirm the deletion. + If the VM is still there, click ![image](../../_assets/console-icons/ellipsis.svg), select **{{ ui-key.yacloud.common.delete }}** and confirm deletion. {% endlist %} diff --git a/en/backup/pricing.md b/en/backup/pricing.md index 61693cc2bce..53027039a13 100644 --- a/en/backup/pricing.md +++ b/en/backup/pricing.md @@ -18,7 +18,7 @@ The cost of {{ backup-name }} depends on the number of protected VMs and the tot You start paying for a VM in {{ backup-name }} as soon as you link it to a [backup policy](./concepts/policy.md). Regardless of the VM status, you will be charged for the VM until you unlink it from the policy. -If you delete a VM in [{{ compute-full-name }}](../compute/) using the [management console]({{ link-console-main }}), this will unlink such a VM from all policies. If you delete a VM using the CLI, {{ TF }}, or API, it will not be unlinked from policies automatically. You need to unlink it yourself. +If you delete a VM in [{{ compute-full-name }}](../compute/) using the [management console]({{ link-console-main }}), this will also unlink such a VM from all policies. If you delete a VM using the CLI, {{ TF }}, or API, it will not be unlinked from policies automatically. You need to unlink it yourself. The minimum billing unit is 1 VM per hour. diff --git a/en/backup/quickstart.md b/en/backup/quickstart.md index 7990b99ce0f..c10c1337985 100644 --- a/en/backup/quickstart.md +++ b/en/backup/quickstart.md @@ -15,6 +15,8 @@ To get started with {{ backup-name }}: If you no longer need the resources you created, [delete them](#clear-out). +{% include [baremetal-note](../_includes/backup/baremetal-note.md) %} + ## Prepare your cloud {#before-you-begin} {% include [before-you-begin](../_tutorials/_tutorials_includes/before-you-begin.md) %} @@ -138,19 +140,12 @@ To activate the service, you need _at least_ the `backup.editor` [role](security - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the folder you want to create a VM with a {{ backup-name }} connection in. + 1. In the [management console]({{ link-console-main }}), select the [folder](../resource-manager/concepts/resources-hierarchy.md#folder) where you want to create a VM with a {{ backup-name }} connection. 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. - 1. In the left-hand panel, select ![image](../_assets/console-icons/server.svg) **{{ ui-key.yacloud.compute.switch_instances }}** and click **{{ ui-key.yacloud.compute.instances.button_create }}**. - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**: - - 1. Enter the VM name. The naming requirements are as follows: - - {% include [name-format](../_includes/name-format.md) %} - - 1. Select an [availability zone](../overview/concepts/geo-scope.md) to place your VM in. - - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, select one of the [supported operating systems](./concepts/vm-connection.md#os), e.g., [Ubuntu 20.04](/marketplace/products/yc/ubuntu-20-04-lts). - + 1. In the left-hand panel, select ![image](../_assets/console-icons/server.svg) **{{ ui-key.yacloud.compute.switch_instances }}**. + 1. Click **{{ ui-key.yacloud.compute.instances.button_create }}**. + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, select an [image](../compute/concepts/image.md) with a [supported OS](./concepts/vm-connection.md#os), e.g., [Ubuntu 20.04](/marketplace/products/yc/ubuntu-20-04-lts). + 1. Under **{{ ui-key.yacloud.k8s.node-groups.create.section_allocation-policy }}**, select an [availability zone](../overview/concepts/geo-scope.md) to place your VM in. 1. Under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}** and **{{ ui-key.yacloud.compute.instances.create.section_platform }}**, set the preferred VM parameters. {% include [vm-requirements](../_includes/backup/vm-requirements.md) %} @@ -162,19 +157,18 @@ To activate the service, you need _at least_ the `backup.editor` [role](security Instead of assigning a public IP address to your VM, you can link the subnet hosting this VM to a [route table](../vpc/concepts/routing.md#rt-vm) allowing internet access via a [NAT gateway](../vpc/concepts/gateways.md) or a custom router. - 1. In the **{{ ui-key.yacloud.component.compute.network-select.field_security-groups }}** field, select the security group you [configured previously](#sg-setup). - - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_access }}**, specify the data for access to the VM: + 1. In the **{{ ui-key.yacloud.component.compute.network-select.field_security-groups }}** field, select the security group you [configured earlier](#sg-setup). - 1. Select the service account you [created earlier](#prepare-service-account). - 1. Enter the username into the **{{ ui-key.yacloud.compute.instances.create.field_user }}** field. - 1. In the **{{ ui-key.yacloud.compute.instances.create.field_key }}** field, paste the contents of the public key file. + 1. {% include [section-access](../_includes/compute/create/section-access.md) %} + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**, specify the VM name: - You will need to create a key pair for the SSH connection yourself; see [{#T}](../compute/operations/vm-connect/ssh.md#creating-ssh-keys) for details. + {% include [name-format](../_includes/name-format.md) %} 1. Under **{{ ui-key.yacloud.compute.instances.create.section_additional }}**: - {% include [backup-enable](../_includes/compute/backup-enable.md) %} + 1. Select the service account you [created earlier](#prepare-service-account). + 1. Enable **{{ ui-key.yacloud.compute.instances.create.section_backup }}**. + 1. Optionally, select a backup policy or click **{{ ui-key.yacloud.common.create }}** to [create](operations/policy-vm/create.md) a new one. 1. Click **{{ ui-key.yacloud.compute.instances.create.button_create }}**. diff --git a/en/backup/toc.yaml b/en/backup/toc.yaml index ab0e1d7b629..855013fee82 100644 --- a/en/backup/toc.yaml +++ b/en/backup/toc.yaml @@ -53,6 +53,8 @@ items: href: operations/get-stats.md - name: Tutorials items: + - name: Connecting BareMetal to Cloud Backup + href: tutorials/backup-baremetal.md - name: Linking a backup policy to a VM automatically items: - name: Overview diff --git a/en/backup/tutorials/backup-baremetal.md b/en/backup/tutorials/backup-baremetal.md new file mode 100644 index 00000000000..beac7e91bff --- /dev/null +++ b/en/backup/tutorials/backup-baremetal.md @@ -0,0 +1,317 @@ +# Connecting a {{ baremetal-full-name }} server to {{ backup-full-name }} + +In {{ backup-name }}, you can configure [{{ baremetal-name }} server backup](../../baremetal/concepts/servers.md). + +_{{ baremetal-name }} and the server backup feature will be released at the [Preview stage](../../overview/concepts/launch-stages.md) in Q4 2024._ + +The following server operating systems are supported: {#os-support} +* Ubuntu 22.04 LTS +* Ubuntu 20.04 LTS +* Ubuntu 18.04 LTS +* Ubuntu 16.04 LTS + +To connect a server to {{ backup-full-name }}: +1. [Prepare your cloud](#before-you-begin). +1. [Create a service account](#prepare-service-account). +1. [Activate {{ backup-name }}](#activate-provider). +1. [Lease a test server](#server-lease). +1. [Connect to the server](#server-connect). +1. [Install a backup agent](#agent-install). +1. [Link your server to a backup policy](#add-policy). +1. [Take a backup of your server](#execute-policy). +1. [Restore your server from a backup](#server-recovery). + +See also [How to cancel a lease and delete resources](#clear-out). + +## Prepare your cloud {#before-you-begin} + +{% include [before-you-begin](../../_tutorials/_tutorials_includes/before-you-begin.md) %} + +{% include [include](../../_includes/cli-install.md) %} + +{% include [default-catalogue](../../_includes/default-catalogue.md) %} + +### Required paid resources {#paid-resources} + +Currently, {{ baremetal-name }} and the server backup feature are offered at no charge. + +## Create a service account {#prepare-service-account} + +{% list tabs group=instructions %} + +- Management console {#console} + + 1. In the [management console]({{ link-console-main }}), select the folder you want to lease a {{ baremetal-name }} server in. + 1. At the top of the page, go to the **{{ ui-key.yacloud.iam.folder.switch_service-accounts }}** tab. + 1. Click **{{ ui-key.yacloud.iam.folder.service-accounts.button_add }}**. + 1. Enter a name for the [service account](../../iam/concepts/users/service-accounts.md). The name format requirements are as follows: + + {% include [name-format](../../_includes/name-format.md) %} + + 1. Click ![plus-sign](../../_assets/console-icons/plus.svg) **{{ ui-key.yacloud.iam.folder.service-account.label_add-role }}** and select the `backup.editor` [role](../security/index.md#backup-editor). + 1. Click **{{ ui-key.yacloud.iam.folder.service-account.popup-robot_button_add }}**. + 1. To select the service account you created earlier, click the row with its name. + 1. In the top panel, click **{{ ui-key.yacloud.iam.folder.service-account.overview.button_create-key-popup }}**. + 1. Select **{{ ui-key.yacloud.iam.folder.service-account.overview.button_create_key }}**. + 1. Select an encryption algorithm and click **{{ ui-key.yacloud.iam.folder.service-account.overview.popup-key_button_create }}**. + 1. In the window that opens, click **{{ ui-key.yacloud.iam.folder.service-account.overview.action_download-keys-file }}** and then click **{{ ui-key.yacloud.iam.folder.service-account.overview.popup-key_button_close }}**. + + You will need the authorized key of the service account in later steps. + +{% endlist %} + +## Activate {{ backup-name }} {#activate-provider} + +To activate {{ backup-name }}, you need _at least_ the `backup.editor` [role](../security/index.md#backup-editor) for the [folder](../../resource-manager/concepts/resources-hierarchy.md#folder) where you want to lease a server and connect it to {{ backup-name }}. + +{% list tabs group=instructions %} + +- Management console {#console} + + 1. In the [management console]({{ link-console-main }}), select the folder where you want to lease a server and connect it to {{ backup-name }}. + 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_backup }}**. + 1. If you have not activated {{ backup-name }} yet, click **{{ ui-key.yacloud.backup.button_action-activate }}**. + + If there is no **{{ ui-key.yacloud.backup.button_action-activate }}** button, {{ backup-name }} is already activated. Proceed to the next step. + +{% endlist %} + +After activation, the system automatically creates the following backup policies: +* `Default daily`: Daily incremental backup with the last 15 backups retained. +* `Default weekly`: Weekly incremental backup with the last 15 backups retained. +* `Default monthly`: Monthly incremental backup with the last 15 backups retained. + +## Lease a test server {#server-lease} + +If you are already leasing a server with an [appropriate OS](#os-support), go to [Connect to the server](#server-connect). Make sure to check the [network permissions](#ip-access) you need to configure on the server. + +{% list tabs group=instructions %} + +- Management console {#console} + + 1. In the [management console]({{ link-console-main }}), select the folder you want to lease a server in. + 1. In the list of services, select **{{ baremetal-name }}**. + 1. Click **Lease server**. + 1. Select the `{{ region-id }}-m` [availability zone](../../overview/concepts/geo-scope.md). + 1. Select the `{{ region-id }}-m3` pool. + 1. Under **{{ ui-key.yacloud.baremetal.title_section-server-config }}**: + + 1. Select the `BA-i103-S-10G` server configuration. + 1. Configure the disk layout: + + 1. Click **{{ ui-key.yacloud.baremetal.action_disk-layout-settings }}**. + 1. Keep the default layout and click **{{ ui-key.yacloud.common.save }}**. + + 1. Under **{{ ui-key.yacloud.baremetal.title_section-server-product }}**, select the `Ubuntu 22.04 LTS` image. + 1. Under **{{ ui-key.yacloud.baremetal.title_section-lease-conditions }}**, specify: + + 1. **{{ ui-key.yacloud.baremetal.field_server-count }}**: `1` + 1. **{{ ui-key.yacloud.baremetal.field_server-lease-duration }}**: `{{ ui-key.yacloud.baremetal.label_one-month-duration }}` + + 1. Under **{{ ui-key.yacloud.baremetal.title_section-server-network-settings }}**: + + 1. Click ![image](../../_assets/console-icons/plus.svg) **{{ ui-key.yacloud.baremetal.action-create-subnetwork }}**. + 1. Optionally, if you need to enable DHCP to assign IP addresses automatically, use the **Routing settings** section. + 1. Enter `bm-subnetwork` for the subnet name and click **Create subnet**. + 1. In the **{{ ui-key.yacloud.baremetal.field_needed-public-ip }}** field, select `{{ ui-key.yacloud.baremetal.label_public-ip-auto }}`. + + For the {{ backup-name }} agent to exchange data with the [backup provider](../concepts/index.md#providers) servers, make sure the server has network access to the IP addresses of {{ backup-name }} resources based on the following table: {#ip-access} + + {% include [outgoing traffic](../../_includes/backup/outgoing-rules.md) %} + + 1. Under **{{ ui-key.yacloud.baremetal.title_server-access }}**: + + 1. Generate a password for the root user. To do this, click **Generate** next to the **{{ ui-key.yacloud.baremetal.field_password }}** field. + + {% note warning %} + + Once you lease a server, you will no longer be able to view the password. Make sure to save the password in a secure location right away. + + {% endnote %} + + 1. In the **{{ ui-key.yacloud.baremetal.field_ssh-public-key }}** field, paste the contents of the public key file. You need to [create](../../compute/operations/vm-connect/ssh.md#creating-ssh-keys) an SSH key pair yourself. + + 1. Under **{{ ui-key.yacloud.baremetal.title_section-server-info }}**, enter the server **{{ ui-key.yacloud.baremetal.field_name }}**: `bm-server`. + 1. Click **Lease server**. + +{% endlist %} + +Save the server name and ID for use in the later steps. + +## Connect to the server {#server-connect} + +{% list tabs group=operating_system %} + +- KVM console {#console} + + 1. In the [management console]({{ link-console-main }}), select the folder the server belongs to. + 1. In the list of services, select **{{ baremetal-name }}**. + 1. In the row with the server you need, click ![image](../../_assets/console-icons/ellipsis.svg) and select **Start KVM console**. + 1. In the window that opens, click **KVM console**. + +- Linux/macOS {#linux-macos} + + To connect to a server, specify its public IP address, which you can find in the management console on the server page (the **{{ ui-key.yacloud.baremetal.field_needed-public-ip }}** field of **{{ ui-key.yacloud.baremetal.title_section-server-network-settings }}**). + + 1. In the terminal, run this command: + + ```bash + ssh root@ + ``` + + If this is your first time connecting to the server, you will get an unknown host warning: + + ```text + The authenticity of host '51.250.83.243 (51.250.83.243)' can't be established. + ED25519 key fingerprint is SHA256:6Mjv93NJDCaf/vu3NYwiLQK4tKI+4cfLtkd********. + This key is not known by any other names. + Are you sure you want to continue connecting (yes/no/[fingerprint])? + ``` + + 1. Type `yes` in the terminal and press **Enter**. + 1. Enter the password you specified when creating the server and press **Enter**. + +- Windows 10/11 {#windows} + + To connect to a server, specify its public IP address, which you can find in the management console on the server page (the **{{ ui-key.yacloud.baremetal.field_needed-public-ip }}** field of **{{ ui-key.yacloud.baremetal.title_section-server-network-settings }}**). + + Make sure the Windows account has read permissions for the folder containing the keys. + + 1. To connect to the server, run the following command in the command line: + + ```shell + ssh root@ + ``` + + If this is your first time connecting to the server, you will get an unknown host warning: + + ```text + The authenticity of host '89.169.132.223 (89.169.132.223)' can't be established. + ECDSA key fingerprint is SHA256:DfjfFB+in0q0MGi0HnqLNMdHssLfm1yRanB********. + Are you sure you want to continue connecting (yes/no/[fingerprint])? + ``` + + 1. Type `yes` in the terminal and press **Enter**. + 1. Enter the password you specified when creating the server and press **Enter**. + +{% endlist %} + +## Install a backup agent {#agent-install} + +1. Copy the file with the service account authorized key [you created earlier](#prepare-service-account) to the server. To do this, run this command _on the local machine_: + + ```bash + scp \ + root@: + ``` + +1. Install the [{{ yandex-cloud }} CLI](../../cli/). To do this, run this command _on the server_: + + ```bash + curl -sSL https://{{ s3-storage-host-cli }}{{ yc-install-path }} | bash + ``` + +1. Authenticate in the {{ yandex-cloud }} CLI as a service account: + + ```bash + yc config set service-account-key + ``` + +1. Get an IAM token: + + ```bash + yc iam create-token + ``` + +1. Install the [jq](https://jqlang.github.io/jq/) utility: + + ```bash + apt update && apt install -y jq + ``` + +1. Install the backup agent: + + ```bash + wget https://{{ s3-storage-host }}/backup-distributions/agent_installer_bms.sh && \ + bash agent_installer_bms.sh \ + -i "``-`date +%s`" \ + -n "``-`date +%Y%m%d.%H%M%S`" \ + -t "``" + ``` + + Wait for the message informing you the agent is registered: + + ```text + ... + Agent registered with id D9CA44FC-716A-4B3B-A702-C6********** + ``` + +## Link your server to a backup policy {#add-policy} + +1. Get a list of resources connected to {{ backup-name }}. To do this, run this command _on the local machine_: + + ```bash + yc backup resource list + ``` + + The server connected to {{ backup-name }} will be displayed with `BMS` as its `TYPE`. + + Save the server ID (`INSTANCE ID`). + +1. Get a list of backup policies: + + ```bash + yc backup policy list + ``` + + Save the `ID` of the policy you want to link to the server. + +1. Link your server to a backup policy: + + ```bash + yc backup policy apply \ + --id \ + --instance-ids="" + ``` + +## Take a backup of your server {#execute-policy} + +To take a server backup at a time other than the scheduled time defined in a backup policy, run this command: + +```bash +yc backup policy execute \ + --id \ + --instance-id +``` + +Wait for the operation to complete. + +Also, you can run the command in asynchronous mode using the `--async` parameter and track the backup process using the [yc backup resource list-tasks](../../cli/cli-ref/managed-services/backup/vm/list-tasks.md) command. + +## Restore your server from a backup {#server-recovery} + +1. Get a list of server backups: + + ```bash + yc backup backup list \ + --instance-id + ``` + + Save the backup `ID`. + +1. Restore your server from the backup: + + ```bash + yc backup backup recover \ + --source-backup-id="" \ + --destination-instance-id="" + ``` + + Wait for the operation to complete. + + Also, you can run the command in asynchronous mode using the `--async` parameter and track the backup process using the [yc backup resource list-tasks](../../cli/cli-ref/managed-services/backup/vm/list-tasks.md) command. + +## How to cancel a lease and delete resources {#clear-out} + +1. [Cancel](../../baremetal/operations/servers/server-lease-cancel.md) a {{ baremetal-name }} server lease. +1. Delete the backup in {{ backup-name }} using the CLI. diff --git a/en/billing/_includes/change-payment-docs.md b/en/billing/_includes/change-payment-docs.md index 482e7720b45..1f7a255fd4c 100644 --- a/en/billing/_includes/change-payment-docs.md +++ b/en/billing/_includes/change-payment-docs.md @@ -2,15 +2,15 @@ Your request should contain: {% list tabs group=customers %} -- Individual entrepreneurs {#entrepreneurs} - - * Scanned copy of the individual entrepreneur register record sheet or a scanned copy of your registration with the tax office as an individual entrepreneur - * [Billing account](../../billing/concepts/billing-account.md) ID - - Businesses {#businesses} * Full company name * Copy of the minutes or resolution on the appointment of the general director * [Billing account](../../billing/concepts/billing-account.md) ID +- Individual entrepreneurs {#entrepreneurs} + + * Scanned copy of the individual entrepreneur register record sheet or a scanned copy of your registration with the tax office as an individual entrepreneur + * [Billing account](../../billing/concepts/billing-account.md) ID + {% endlist %} \ No newline at end of file diff --git a/en/billing/_includes/change-payment-method.md b/en/billing/_includes/change-payment-method.md index 8b137891791..29af97332e2 100644 --- a/en/billing/_includes/change-payment-method.md +++ b/en/billing/_includes/change-payment-method.md @@ -1 +1,5 @@ +#### How do I change my payment method? {#payment-method} +You can only [change](../operations/change-payment-method.md) your payment method if your billing account type is **{{ ui-key.yacloud_billing.billing.account.create-new.account-type_label_company }}**; in this case, along with bank card transfer, you can use [bank account transfer](../payment/payment-methods-business.md). + +If your billing account type is **{{ ui-key.yacloud_billing.billing.account.create-new.account-type_label_individual }}**, you cannot change your payment method. \ No newline at end of file diff --git a/en/billing/_includes/payment-amount.md b/en/billing/_includes/payment-amount.md index d1a3c521ef0..4d68e36d7d6 100644 --- a/en/billing/_includes/payment-amount.md +++ b/en/billing/_includes/payment-amount.md @@ -1,7 +1,41 @@ The total amount debited depends on whether you used up your [grant](../concepts/bonus-account.md) and topped up your [personal account](../concepts/personal-account.md#balance) during the reporting period. - The write-off amount is calculated using the formula: ![image](../../_assets/billing/formula.png) + +{% list tabs %} + +- Example 1 + +
The personal account balance at the beginning of the reporting period is 0 dollars. +
The personal account was never topped up during the reporting period (0 dollars). +
The grant amount is 10 dollars. +
The billing threshold is 20 dollars. +
In the middle of the reporting period, the established billing threshold is reached and the amount for consumed resources is 30 dollars. +
Total amount: 30 - (0 + 0 + 10) = 20 (dollars). +
+ In the middle of the reporting period, 20 dollars could be debited from the linked bank card. + +- Example 2 + +
The personal account balance at the beginning of the reporting period is 0 dollars. +
The personal account was never topped up during the reporting period (0 dollars). +
The grant amount is 10 dollars. +
At the end of the reporting period, the amount for consumed resources is 8 dollars. +
The grant amount at the end of the reporting period is 2 dollars. The personal account balance has not changed. +
At the beginning of the next reporting month, no funds will be debited from the linked bank card. + +- Example 3 + +
The personal account balance at the beginning of the reporting period is 0 dollars. +
The personal account was never topped up during the reporting period (0 dollars). +
The grant amount is 10 dollars. +
The billing threshold is 20 dollars. +
At the end of the reporting period, the amount for consumed resources is 23 dollars. The billing threshold has not been reached and the grant has been fully spent. +
Total amount: 23 - (0 + 0 + 10) = 13 (dollars). +
+ At the beginning of the next reporting period, 13 dollars are debited from the linked bank card. + +{% endlist %} diff --git a/en/billing/_includes/payment-card-validation.md b/en/billing/_includes/payment-card-validation.md index c62f23df2bc..ddcaae9d504 100644 --- a/en/billing/_includes/payment-card-validation.md +++ b/en/billing/_includes/payment-card-validation.md @@ -1 +1 @@ -To verify your bank card, we will hold a small amount in your account. This amount will not be written off and will be released as soon as the verification is complete. The time required to release the money may vary from bank to bank. +To verify your bank card, we will hold a small amount (USD 1.30) in your account. This amount will not be written off and will be released as soon as the verification is complete. The time required to release the money may vary from bank to bank. diff --git a/en/billing/_includes/payment-methods.md b/en/billing/_includes/payment-methods.md index c7c5baed2f3..199ff04674c 100644 --- a/en/billing/_includes/payment-methods.md +++ b/en/billing/_includes/payment-methods.md @@ -9,6 +9,7 @@ The method for crediting funds depends on your legal status ([billing account ty - Businesses and individual entrepreneurs {#businesses} - [Wire transfer](../payment/payment-methods-business.md) - + + - [Bank card transfer](../payment/payment-methods-card-business.md) {% endlist %} \ No newline at end of file diff --git a/en/billing/api-ref/Customer/createResellerServed.md b/en/billing/api-ref/Customer/createResellerServed.md index a2462e7001d..6cf74f89453 100644 --- a/en/billing/api-ref/Customer/createResellerServed.md +++ b/en/billing/api-ref/Customer/createResellerServed.md @@ -36,11 +36,12 @@ POST https://billing.{{ api-host }}/billing/v1/customers:createResellerServedCus ||Field | Description || || resellerId | **string** -Required field. ID of the reseller that customer will be associated with. +Required field. ID of the reseller that customer will be associated with.
-Value must match either one of the two regular expressions: -`^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\|[0-9a-f]{32})$` -or `^[a-z][-a-zA-Z0-9.]{0,48}[a-zA-Z0-9]$`. || +Value must match either one of the three regular expressions: +
- `^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$` +
- `^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{32})$` +
- `^[a-z][-a-zA-Z0-9.]{0,48}[a-zA-Z0-9]$` || || name | **string** Required field. Name of the customer. diff --git a/en/billing/api-ref/grpc/Customer/createResellerServed.md b/en/billing/api-ref/grpc/Customer/createResellerServed.md index 123dad8e054..7357c415829 100644 --- a/en/billing/api-ref/grpc/Customer/createResellerServed.md +++ b/en/billing/api-ref/grpc/Customer/createResellerServed.md @@ -34,11 +34,12 @@ Creates new reseller-served customer. ||Field | Description || || resellerId | **string** -Required field. ID of the reseller that customer will be associated with. +Required field. ID of the reseller that customer will be associated with.
-Value must match either one of the two regular expressions: -`^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\|[0-9a-f]{32})$` -or `^[a-z][-a-zA-Z0-9.]{0,48}[a-zA-Z0-9]$`. || +Value must match either one of the three regular expressions: +
- `^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$` +
- `^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{32})$` +
- `^[a-z][-a-zA-Z0-9.]{0,48}[a-zA-Z0-9]$` || || name | **string** Required field. Name of the customer. diff --git a/en/billing/concepts/bill.md b/en/billing/concepts/bill.md index fc40126a41e..02f625eb4c5 100644 --- a/en/billing/concepts/bill.md +++ b/en/billing/concepts/bill.md @@ -23,7 +23,10 @@ Payment invoices can only be sent to the [billing account](billing-account.md) o {% endnote %} -Under Section 6 of the [offer]({{ billing-oferta-url }}), a Сustomer qualifying as a legal entity and not using a linked corporate bank card to top up their account must [generate a payment invoice](../operations/pay-the-bill.md#legal-entities) using the management console. + +A Сustomer qualifying as a legal entity and not using a linked corporate bank card to top up their account must [generate a payment invoice](../operations/pay-the-bill.md#legal-entities) using the management console. Depending on which company you signed the contract with, you can find more details in «Yandex Legal documents» for [Iron Hive doo Beograd (Serbia)](https://yandex.com/legal/cloud_customer_agreement/) or [Direct Cursus Technology L.L.C. (Dubai)](https://yandex.com/legal/cloud_customer_agreement_uae/). + + A payment invoice is not a primary accounting document. There are no special legal requirements for drafting this document. In accounting, correct charges for services are made based on reports and tax invoices where all the required details are specified. A payment invoice is generated automatically and there is no way to change customer data. ## Payment invoice amount {#payment-amount} diff --git a/en/billing/concepts/billing-account.md b/en/billing/concepts/billing-account.md index 170e8ca3377..fe6ff66f4b1 100644 --- a/en/billing/concepts/billing-account.md +++ b/en/billing/concepts/billing-account.md @@ -35,8 +35,8 @@ To access the list of billing accounts, navigate to [**{{ billing-name }}**]({{ - Business account {#business} * For residents of Russia and Kazakhstan and non-residents of Russia and Kazakhstan. - * Businesses pay for resources they consume by bank transfer from the [corporate bank account](../payment/payment-methods-business.md). - * Payments for resources are either made based on the [agreement](../concepts/contract.md) against [invoices](bill.md). For more information, see [Billing cycle for legal entities](../payment/billing-cycle-business.md). + * Businesses pay for resources they consume by bank transfer from the [corporate bank account](../payment/payment-methods-business.md) or using a [bank card](../payment/payment-methods-card-business.md). + * Payments for resources are either made based on the [agreement](../concepts/contract.md) against [invoices](bill.md) or debited automatically from the linked bank card. For more information, see [Billing cycle for legal entities](../payment/billing-cycle-business.md). * New customers are eligible for a [trial period](trial-period.md). {% endlist %} diff --git a/en/billing/concepts/billing-threshold.md b/en/billing/concepts/billing-threshold.md index 06e4492c009..51f9c8077a6 100644 --- a/en/billing/concepts/billing-threshold.md +++ b/en/billing/concepts/billing-threshold.md @@ -19,8 +19,6 @@ The billing threshold amount and the total arrears when you are blocked may be d The billing threshold is only valid when you select a bank card as your payment method. If you do, when you reach your threshold, an attempt will be made to debit your card to cover what you owe. -{% include [card-business-nonresidents](../../_includes/billing/card-business-nonresidents.md) %} - ## Billing threshold amount {#amount} The billing threshold amount is calculated individually and depends on a combination of factors, including: diff --git a/en/billing/concepts/contract.md b/en/billing/concepts/contract.md index 8ae40c08c7d..2d98a20f6e3 100644 --- a/en/billing/concepts/contract.md +++ b/en/billing/concepts/contract.md @@ -8,7 +8,7 @@ Once the offer has been accepted, both parties start acting under the agreement in accordance with the Civil Code of the Russian Federation. The agreement stipulates that you must pay for the resources consumed at the end of the reporting period. For more information, see [How to pay for resources](../payment/index.md). -You can learn more about the terms of the agreement in [Yandex Legal documents]({{ billing-oferta-url }}?lang=en). +You can learn more about the terms of the agreement in [Yandex Legal documents]({{ billing-oferta-url }}). {% note info %} @@ -33,7 +33,7 @@ Companies and individual entrepreneurs can sign a bilateral agreement. For this, Once the offer has been accepted, both parties start acting under the agreement. The agreement stipulates that you must pay for the resources consumed at the end of the reporting period. For more information, see [How to pay for resources](../payment/index.md). -You can learn more about the terms of the agreement in [Yandex Legal documents](https://yandex.com/legal/cloud_customer_agreement/?lang=en). +Depending on which company you signed the contract with, you can review its terms in «Yandex Legal documents» for [Iron Hive doo Beograd (Serbia)](https://yandex.com/legal/cloud_customer_agreement/) or [Direct Cursus Technology L.L.C. (Dubai)](https://yandex.com/legal/cloud_customer_agreement_uae/). ## Agreement number {#id} @@ -41,4 +41,4 @@ You can find the agreement number in {{ billing-name }} on the ![image](../../_a ## Agreement termination {#termination} -After you [delete your billing account](../operations/delete-account.md), your agreement will be terminated. In this case, you do not have to notify Yandex.Cloud LLC, Cloud Services Kazakhstan LLP or Iron Hive doo Beograd (Serbia) of the termination. +After you [delete your billing account](../operations/delete-account.md), your agreement will be terminated. In this case, you do not have to notify Yandex.Cloud LLC, Cloud Services Kazakhstan LLP, Iron Hive doo Beograd (Serbia) or Direct Cursus Technology L.L.C. (Dubai) of the termination. diff --git a/en/billing/concepts/cvos.md b/en/billing/concepts/cvos.md index 5310dd5caae..36e4ca84e22 100644 --- a/en/billing/concepts/cvos.md +++ b/en/billing/concepts/cvos.md @@ -58,7 +58,7 @@ See details of using and paying for your CVoS below. 4.2. If the actual volume exceeds the CVoS, the difference between the total volume and the CVoS will be additionally charged based on [standard prices](/prices). Go to step 5. -1. At the beginning of the next billing period, your personal account balance and payments for the services are reviewed. Depending on your [billing account type](../concepts/billing-account.md#ba-types), you may get an invoice. For more information, see [Billing cycle for individuals](../../billing/payment/billing-cycle-individual.md) and [Billing cycle for businesses and individual entrepreneurs](../../billing/payment/billing-cycle-business.md). +1. At the beginning of the next billing period, your personal account balance and payments for the services are reviewed. Depending on your [billing account type](../concepts/billing-account.md#ba-types), you may get an invoice or have your linked bank card debited. For more information, see [Billing cycle for individuals](../../billing/payment/billing-cycle-individual.md) and [Billing cycle for businesses and individual entrepreneurs](../../billing/payment/billing-cycle-business.md). ## Charged amount {#formula} diff --git a/en/billing/concepts/glossary.md b/en/billing/concepts/glossary.md index 867178c80eb..2610cf2f5c4 100644 --- a/en/billing/concepts/glossary.md +++ b/en/billing/concepts/glossary.md @@ -59,7 +59,7 @@ Billing account
For more information, refer to the [Billing account](billing-account.md) section for details. Payer -: Individual, individual entrepreneur, or business that pays for the {{ yandex-cloud }} services used. Basically, these are payment details used to register agreements and issue invoices. +: Individual, individual entrepreneur, or business that pays for the {{ yandex-cloud }} services used. Basically, these are payment details used to register agreements, issue invoices, and debit the payer's bank card. Trial period : Opportunity to gain hands-on experience with {{ yandex-cloud }} without paying for the resources you consume. Only available for legal entities. diff --git a/en/billing/concepts/personal-account.md b/en/billing/concepts/personal-account.md index 6f082b4fd34..9c7448ba3b1 100644 --- a/en/billing/concepts/personal-account.md +++ b/en/billing/concepts/personal-account.md @@ -1,6 +1,10 @@ # Personal account -A personal account is your unique {{ billing-name }} ID used to pay for resources throughout the term of your [agreement](contract.md). It holds the money you add to it via wire transfer (the method depends on your legal status). + +{% include [non-residents-functional-access](../../_includes/billing/non-residents-functional-access.md) %} + + +A personal account is your unique {{ billing-name }} ID used to pay for resources throughout the term of your [agreement](contract.md). It holds the money you add to it via your bank card or wire transfer (the method depends on your legal status). Your personal account money is used only if there are no [grants](bonus-account.md). @@ -18,6 +22,7 @@ Upon activation of the paid version, your personal account balance will be zero {% include [personal-account-balance](../_includes/personal-account-balance.md) %} +Your balance can go negative due to the [billing threshold](billing-threshold.md) applied after you activate the paid version – and only if paying with a bank card. We recommend that you [keep track](../operations/pay-the-bill.md) and maintain a positive balance at all times. diff --git a/en/billing/concepts/reporting-period.md b/en/billing/concepts/reporting-period.md index eabf62d55c9..3891b052efc 100644 --- a/en/billing/concepts/reporting-period.md +++ b/en/billing/concepts/reporting-period.md @@ -4,7 +4,7 @@ The reporting period is equal to one calendar month during which you are using { At the beginning of each month, you are required to pay for the resources consumed during the previous period. If you are in arrears, your use of {{ yandex-cloud }} resources may be suspended. The [payment method](../payment/index.md) depends on your legal status ([billing account type](billing-account.md#ba-types)). -On the last day of the month, [Yandex Balance](https://balance.yandex.com/) will generate [reporting documents](../payment/documents.md) for businesses and individual entrepreneurs. +On the last day of the month, [Yandex Balance](https://balance.yandex.com/) will generate [reporting documents](../payment/documents.md) for businesses and individual entrepreneurs. If there is a bank card linked to your billing account, the system [calculates](../payment/payment-methods-card-business.md#payment-amount) the total amount due and debits it from that card. Learn more about billing cycles: * [For individuals](../payment/billing-cycle-individual.md) diff --git a/en/billing/operations/change-data.md b/en/billing/operations/change-data.md index ad4b2b39599..a849ef756c1 100644 --- a/en/billing/operations/change-data.md +++ b/en/billing/operations/change-data.md @@ -42,11 +42,12 @@ You can use [Yandex Balance](https://balance.yandex.ru/) to update payer's conta ## Changing a business or TIN {#change-legal-entity} You cannot change a business or TIN in the billing account settings. If these details have changed: -1. [Create](create-new-account.md) a billing account with new details by selecting **{{ ui-key.startrek.ui_components_page-admin_BillingAccountInfo.person-type-company }}** as the payer type. +1. [Create](create-new-account.md) a billing account with new details by selecting **Legal entity or individual entrepreneur** as the payer type. 1. Wait until the billing account is activated to avoid downtime of resources. 1. Transfer all clouds from the old billing account to the new one. All you have to do is [link](pin-cloud.md) them to the new billing account. ##### See also +* [Linking a different bank card](pin-card.md) * [Changing the payment method](change-payment-method.md) * [Configuring notifications](budgets.md) \ No newline at end of file diff --git a/en/billing/operations/change-payment-method.md b/en/billing/operations/change-payment-method.md index a0774b53cd0..3b4f89c08be 100644 --- a/en/billing/operations/change-payment-method.md +++ b/en/billing/operations/change-payment-method.md @@ -1,19 +1,24 @@ -# Change payment method +--- +title: How to change the payment method in {{ billing-name }} +description: Follow this guide to change the payment method in {{ billing-name }}. +--- -The payment method can only be changed for the billing account of the **{{ ui-key.yacloud_billing.billing.account.create-new.account-type_label_company }}**. You can use wire transfer instead of bank card payment. +# Changing the payment method + +The payment method can only be changed for billing accounts of the **{{ ui-key.yacloud_billing.billing.account.create-new.account-type_label_company }}** type. You can use wire transfer instead of your bank card for payments. To change the payment method: -1. Draw up a request to change the payment method. +1. Draw up a request to have your payment method changed. {% include [change-payment-docs](../_includes/change-payment-docs.md) %} -1. Send your request to [{{ billing-docs-email }}](mailto:{{ billing-docs-email }}). The request will be reviewed within three business days. Your {{ yandex-cloud }} account manager will notify you of the decision. +1. Email your request to [{{ billing-docs-email }}](mailto:{{ billing-docs-email }}). The request will be reviewed within three business days. Your {{ yandex-cloud }} account manager will notify you of the decision. {% note info %} -Once your card is unlinked from your billing account, you will not be able to add a new one. You will only be able to [top up your billing account](../operations/pay-the-bill.md) using a [wire transfer (via a bank)](../payment/payment-methods-business.md). +Once your card is unlinked from your billing account, you will not be able to link a new one. You will only be able to [top up your billing account](../operations/pay-the-bill.md) using a [wire transfer (via a bank)](../payment/payment-methods-business.md). {% endnote %} diff --git a/en/billing/operations/delete-account.md b/en/billing/operations/delete-account.md index a9dfa401df5..51e348cfd6a 100644 --- a/en/billing/operations/delete-account.md +++ b/en/billing/operations/delete-account.md @@ -23,7 +23,7 @@ To delete a {{ yandex-cloud }} billing account you no longer need: {% note info %} -After you delete your billing account, your agreement with Yandex.Cloud LLC, Cloud Services Kazakhstan LLP, or Iron Hive doo Beograd (Serbia) will be terminated accordingly. +After you delete your billing account, your agreement with Yandex.Cloud LLC, Cloud Services Kazakhstan LLP, Iron Hive doo Beograd (Serbia) or Direct Cursus Technology L.L.C. (Dubai) will be terminated accordingly. {% endnote %} diff --git a/en/billing/operations/get-folder-report.md b/en/billing/operations/get-folder-report.md index 50aa4799eec..4f1709179ed 100644 --- a/en/billing/operations/get-folder-report.md +++ b/en/billing/operations/get-folder-report.md @@ -10,10 +10,10 @@ You can get a CSV file with your general or per-resource spending details. You c 1. {% include [move-to-billing-step](../_includes/move-to-billing-step.md) %} 1. Select the account you want to get details for. - 1. In the left-hand panel, select ![image](../../_assets/console-icons/chart-area-stacked.svg) **{{ ui-key.yacloud.billing.account.switch_detail }}**. + 1. In the left-hand panel, select ![image](../../_assets/console-icons/chart-area-stacked.svg) **{{ ui-key.yacloud_billing.billing.account.switch_detail }}**. 1. Click **{{ ui-key.yacloud_billing.billing.account.detail.button_download-csv }}**. 1. Select the time period to get the details for. - 1. Click **{{ ui-key.yacloud.billing.account.detail.popup-csv_button_download }}**. + 1. Click **{{ ui-key.yacloud_billing.billing.account.detail.popup-csv_button_download }}**. {% endlist %} diff --git a/en/billing/operations/pay-the-bill.md b/en/billing/operations/pay-the-bill.md index 62aef95f5bd..42dcd274678 100644 --- a/en/billing/operations/pay-the-bill.md +++ b/en/billing/operations/pay-the-bill.md @@ -5,13 +5,17 @@ description: Follow this guide to top up your personal account. # Top up your personal account -{% include [card-business-nonresidents](../../_includes/billing/card-business-nonresidents.md) %} - {% include [personal-account-balance](../_includes/personal-account-balance.md) %} +{{ yandex-cloud }} reserves the right to automatically debit your linked card during the current reporting period if your account balance exceeds the established credit limit. The method for topping up your personal account depends on your legal status. +{% note info %} + +A billing cycle runs automatically for [individuals](../payment/billing-cycle-individual.md) as well as [businesses and individual entrepreneurs](../payment/billing-cycle-business.md) if they have a bank card linked to their billing account. + +{% endnote %} ## Individuals {#individuals} @@ -55,7 +59,10 @@ To top up your personal account: Before paying, please make sure the following is correct in your payment order: * Payment amount. - * Banking information of Yandex.Cloud LLC (Russia), Cloud Services Kazakhstan LLP (Kazakhstan), and Iron Hive doo Beograd (Serbia) for non-residents of Russia and Kazakhstan. + * Banking information of Yandex.Cloud LLC (Russia), Cloud Services Kazakhstan LLP (Kazakhstan), Iron Hive doo Beograd (Serbia) or Direct Cursus Technology L.L.C. (Dubai) for non-residents of Russia and Kazakhstan. + + {% include [legal-entity-nonresidents](../../_includes/billing/legal-entity-nonresidents.md) %} + * Your company or individual entrepreneur TIN. * [Personal account number](../concepts/personal-account.md#id) in the payment details. * [Contract number](../concepts/contract.md) in the payment details. @@ -64,5 +71,12 @@ To top up your personal account: {% include [payment-bill-note](../_includes/payment-bill-note.md) %} +- Bank card {#card} -{% endlist %} + Enter the payment amount and click **{{ ui-key.yacloud_billing.billing.account.dashboard-overview.button_refill }}**. Then enter your card details and click **Pay**. + + {% include [payment-card-types](../../_includes/billing/payment-card-types.md) %} + + Your payment will be processed in real time and completed within 15 minutes. + +{% endlist %} \ No newline at end of file diff --git a/en/billing/payment/billing-cycle-business.md b/en/billing/payment/billing-cycle-business.md index a49ed91b5a9..2f6f0228184 100644 --- a/en/billing/payment/billing-cycle-business.md +++ b/en/billing/payment/billing-cycle-business.md @@ -1,5 +1,8 @@ # Billing cycle for businesses and individual entrepreneurs +The diagram shows the cycle of issuing and paying invoices for businesses and individual entrepreneurs, as well as suspending and blocking access to the use of resources. + +![image](../../_assets/billing/billing-cycle-business-credit.svg) 1. You [activate the paid version](../operations/activate-commercial.md) before the [trial period](../../billing/concepts/trial-period.md) expires. @@ -12,28 +15,54 @@ * If the grant amount is greater than zero and the grant has not expired, go back to step 2. * If the grant has expired or the grant amount is zero, go to step 4. +1. The payment method is verified: + + * If you are paying for resources from a bank account, go to step 5. + * If you are paying for resources with a card, go to step 7. 1. You consume and pay for the use of {{ yandex-cloud }} resources at the end of each reporting period, and a [billing threshold](../concepts/billing-threshold.md) is not provided. 1. Verification is performed to check whether it is past the end of the reporting period: - * If the reporting period has not ended yet, go back to step 4. - * If a reporting period has ended, a [report](../concepts/act.md) and an [invoice](../concepts/invoice.md) are generated. Copies of these documents will be sent to the email address of the billing account owner. Go to step 5.1. + * If the reporting period has not ended yet, go back to step 5. + * If a reporting period has ended, a [report](../concepts/act.md) and an [invoice](../concepts/invoice.md) are generated. Copies of these documents will be sent to the email address of the billing account owner. Go to step 6.1. 1. At the end of the reporting period, your personal account balance is checked: - * If the balance is positive, go back to step 4. - * If the balance is negative, go to step 6. + * If the balance is positive, go back to step 5. + * If the balance is negative, go to step 10. + +1. Your [personal account balance](../concepts/personal-account.md#balance) decreases as {{ yandex-cloud }} service resources are consumed. + + 1. Your personal account balance is checked throughout the reporting period. + + * If the balance is positive, go back to step 7. + * If the balance is negative, go to step 8. + +1. [Your billing threshold](../concepts/billing-threshold.md) is used. Your billing threshold is valid for a calendar month. + + 1. The billing threshold amount and validity period are checked: + * If your billing threshold is used up or has expired, go to step 10. + * Otherwise, go back to step 9. + +1. Verification is performed to check whether it is past the end of the reporting period: + + * If the reporting period has not ended yet, go back to step 8. + * If a reporting period has ended, a [report](../concepts/act.md) and an [invoice](../concepts/invoice.md) are generated. Copies of these documents will be sent to the email address of the billing account owner. Go to step 10. 1. Payment is made for consumed {{ yandex-cloud }} resources: - * [Top up](../operations/pay-the-bill.md) your personal account to a positive value within the deadline stipulated in the agreement. + * [Top up](../operations/pay-the-bill.md) your personal account to a positive value within the deadline stipulated in the agreement. + * If there is a bank card linked to your billing account, the system [calculates](payment-methods-card-business.md#payment-amount) the total amount due and debits it from that card. + + {% include [pay-by-card-note](../_includes/pay-by-card-note.md) %} 1. Payment for used resources is verified: - * If you top up your personal account before the deadline stipulated in the agreement, go back to step 2. - * If you failed to top up your personal account, {{ yandex-cloud }} reserves the right to change the status of your billing account to [SUSPENDED](../concepts/billing-account-statuses.md). Go to step 7. + * If you top up your personal account before the deadline stipulated in the agreement or the funds are debited from the linked bank card within one day, go back to step 2. + * If your bank card balance is insufficient on the debit date and you fail to [top up](../operations/pay-the-bill.md) your personal account, another attempt to debit the funds will be made later. + * If you failed to top up your personal account, have no bank card linked, or the funds cannot be debited from any of your bank cards, {{ yandex-cloud }} reserves the right to change the status of your billing account to [SUSPENDED](../concepts/billing-account-statuses.md). Go to step 11. {% include [suspended](../_includes/billing-suspended.md) %} @@ -42,7 +71,7 @@ * Your VM instances and DB clusters will be stopped completely. * You will not be able to read or download any saved data. - During the suspension period, you will be charged the cost of data storage services and a late payment fee. Go to step 8. + During the suspension period, you will be charged the cost of data storage services and a late payment fee. Go to step 12. 1. Payment of the entire outstanding amount is checked throughout the 60-day suspension period: @@ -50,10 +79,8 @@ 1. Otherwise, access to {{ yandex-cloud }} services may be permanently blocked. All your data, including your [billing account](../concepts/billing-account.md), will be permanently deleted. - {% include [blocked-note](../_includes/blocked-note.md) %} - #### See also * [Grant](../concepts/bonus-account.md) diff --git a/en/billing/payment/index.md b/en/billing/payment/index.md index 63770ba8d08..b93d9c9f892 100644 --- a/en/billing/payment/index.md +++ b/en/billing/payment/index.md @@ -9,6 +9,7 @@ Individuals: Businesses and individual entrepreneurs: * [Billing cycle](billing-cycle-business.md) +* [Paying by bank card](payment-methods-card-business.md) * [Bank account transfers](payment-methods-business.md) * [Reporting documents](documents.md) * [Promo code activation](../operations/activate-promocode.md) \ No newline at end of file diff --git a/en/billing/payment/payment-methods-business.md b/en/billing/payment/payment-methods-business.md index a124c2e5628..168b53e7124 100644 --- a/en/billing/payment/payment-methods-business.md +++ b/en/billing/payment/payment-methods-business.md @@ -8,7 +8,10 @@ To have funds transferred, you should first receive a [payment invoice](../conce * Payment amount. -* Banking information of Yandex.Cloud LLC (Russia) and Belarus, Cloud Services Kazakhstan LLP (Kazakhstan), and Iron Hive doo Beograd (Serbia) for non-residents of Russia and Kazakhstan. +* Banking information of Yandex.Cloud LLC (Russia) and Belarus, Cloud Services Kazakhstan LLP (Kazakhstan), Iron Hive doo Beograd (Serbia) or Direct Cursus Technology L.L.C. (Dubai) for non-residents of Russia and Kazakhstan. + + {% include [legal-entity-nonresidents](../../_includes/billing/legal-entity-nonresidents.md) %} + * Your company or individual entrepreneur TIN. * [Personal account number](../concepts/personal-account.md#id) in the payment details. * [Contract number](../concepts/contract.md) in the payment details. diff --git a/en/billing/payment/payment-methods-card-business.md b/en/billing/payment/payment-methods-card-business.md index e9a9fe8fef7..255c70f73ef 100644 --- a/en/billing/payment/payment-methods-card-business.md +++ b/en/billing/payment/payment-methods-card-business.md @@ -1,7 +1,5 @@ # Bank card payments for businesses -{% include [card-business-nonresidents](../../_includes/billing/card-business-nonresidents.md) %} - Businesses and individual entrepreneurs can top up their personal accounts and pay for consumed resources using a corporate bank card linked to the billing account. {% include [payment-card-types](../../_includes/billing/payment-card-types.md) %} diff --git a/en/billing/pricing.md b/en/billing/pricing.md index 49ba6c94f3f..59b5b4ee476 100644 --- a/en/billing/pricing.md +++ b/en/billing/pricing.md @@ -24,6 +24,7 @@ Billable service costs are calculated based on the amount of consumed resources * [{{ sf-full-name }}](../functions/pricing.md) * [{{ interconnect-full-name }}](../interconnect/pricing.md) * [{{ cloud-logging-full-name }}](../logging/pricing.md) +* [{{ cns-full-name }}](../notifications/pricing.md) * [{{ compute-full-name }}](../compute/pricing.md) * [{{ container-registry-full-name }}](../container-registry/pricing.md) * [{{ dataproc-full-name }}](../data-proc/pricing.md) diff --git a/en/cdn/concepts/servers-to-origins-host.md b/en/cdn/concepts/servers-to-origins-host.md index 5d09a240938..1295fcb037a 100644 --- a/en/cdn/concepts/servers-to-origins-host.md +++ b/en/cdn/concepts/servers-to-origins-host.md @@ -9,7 +9,7 @@ To make sure that CDN servers send correct requests to [origins](origins.md), co * **{{ ui-key.yacloud.cdn.value_host-header-default }}**: First [domain name for content distribution](resource.md#hostnames) specified in the CDN resource settings. * **{{ ui-key.yacloud.cdn.value_host-header-custom }}**: Arbitrary domain name. -* **{{ ui-key.yacloud.cdn.value_protocol-match }}**: Same value as that of the `Host` header in the client request to the CDN. +* **{{ ui-key.yacloud.cdn.value_protocol-match }}**: Same value as the `Host` header value in the client request to CDN. The `Host` header value is selected when creating a resource. You can change it afterwards along with other basic resource settings. For more information, see these guides: @@ -18,37 +18,43 @@ The `Host` header value is selected when creating a resource. You can change it ## How to set up the header properly {#best-practices} -Choosing the right setting for the `Host` header depends on the origins you use in your resource: +Choosing the correct setting for the `Host` header depends on the origins you use in your resource: {% list tabs %} - A single origin - If the origin is a bucket, select the `{{ ui-key.yacloud.cdn.value_host-header-custom }}` option and specify the `.{{ s3-storage-host }}` (or `.{{ s3-web-host }}` if the bucket is configured for [static website hosting](../../storage/concepts/hosting.md)). + If the origin is a bucket, select the `{{ ui-key.yacloud.cdn.value_host-header-custom }}` option and specify `.{{ s3-storage-host }}` as the value. If the bucket is configured for [static website hosting](../../storage/concepts/hosting.md), specify `.{{ s3-web-host }}`. - In other cases, the setting depends on what requests the origin accepts. + In other cases, the setting depends on what requests the origin accepts. - > For example, in [blue-green and canary deployment scenarios](../tutorials/blue-green-canary-deployment.md), the L7 load balancer is configured to accept requests with two values of the `Host` header. For the CDN resource, the `{{ ui-key.yacloud.cdn.value_protocol-match }}` option is selected. + > For example, in [blue-green and canary deployment scenarios](../tutorials/blue-green-canary-deployment.md), the L7 load balancer is configured to accept requests with two values of the `Host` header. For the CDN resource, the `{{ ui-key.yacloud.cdn.value_protocol-match }}` option is selected. - To check that the origin accepts requests with the selected `Host` header value correctly, run the following command: + To check that the origin accepts requests with the selected `Host` header value correctly, run this command: - ```bash - curl -Ik -H "Host: " - ``` + ```bash + curl \ + --head \ + --insecure \ + --header "Host: " + ``` - Origin group - If there is one bucket in the group: + If there is one bucket in the group: - 1. Select the `{{ ui-key.yacloud.cdn.value_host-header-custom }}` option and specify the `.{{ s3-storage-host }}` (or `.{{ s3-web-host }}` if the bucket is configured for [static website hosting](../../storage/concepts/hosting.md)). - 1. Configure other origins (servers and L7 load balancers) so that they accept requests with the specified header value. + 1. Select the `{{ ui-key.yacloud.cdn.value_host-header-custom }}` option and specify `.{{ s3-storage-host }}` as the value. If the bucket is configured for [static website hosting](../../storage/concepts/hosting.md), specify `.{{ s3-web-host }}`. + 1. Configure other origins (servers and L7 load balancers) so that they accept requests with the specified header value. - If there are multiple buckets in the group, we recommend using the L7 load balancer with buckets that act as backends instead (see the configuration example for [blue-green and canary deployment](../tutorials/blue-green-canary-deployment.md)). + If there are multiple buckets in the group, we recommend using the L7 load balancer with buckets that act as backends instead (see the configuration example for [blue-green and canary deployment](../tutorials/blue-green-canary-deployment.md)). - In other cases, the setting depends on what requests the origins accept. To check that the origin accepts requests with the selected `Host` header value correctly, run the following command: + In other cases, the setting depends on what requests the origins accept. To check that the origin accepts requests with the selected `Host` header value correctly, run this command: - ```bash - curl -Ik -H "Host: " - ``` + ```bash + curl \ + --head \ + --insecure \ + --header "Host: " + ``` {% endlist %} diff --git a/en/cdn/operations/origin-groups/get-group-info.md b/en/cdn/operations/origin-groups/get-group-info.md index 0a08ccd21e3..6e8ce212401 100644 --- a/en/cdn/operations/origin-groups/get-group-info.md +++ b/en/cdn/operations/origin-groups/get-group-info.md @@ -26,7 +26,7 @@ To get the URL and other details of an origin: {% include [default-catalogue](../../../_includes/default-catalogue.md) %} - 1. View a description of the CLI command to get information about an origin: + 1. See the description of the CLI command to get information about an origin: ```bash yc cdn origin get --help @@ -76,7 +76,7 @@ To get the name, set of origins, and other details of an origin group: {% include [default-catalogue](../../../_includes/default-catalogue.md) %} - 1. View a description of the CLI command to get information about an origin group: + 1. See the description of the CLI command to get information about an origin group: ```bash yc cdn origin-group get --help diff --git a/en/cdn/operations/resources/configure-basics.md b/en/cdn/operations/resources/configure-basics.md index 32ed6a2b336..4b02fae785a 100644 --- a/en/cdn/operations/resources/configure-basics.md +++ b/en/cdn/operations/resources/configure-basics.md @@ -181,7 +181,7 @@ To edit the basic settings of a [resource](../../concepts/resource.md): terraform apply ``` - 1. Confirm the changes: type `yes` into the terminal and click **Enter**. + 1. Confirm the changes: type `yes` into the terminal and press **Enter**. You can check the changes to the CDN resource in the [management console]({{ link-console-main }}) or using this [CLI](../../../cli/quickstart.md) command: diff --git a/en/cdn/operations/resources/configure-caching.md b/en/cdn/operations/resources/configure-caching.md index b25e7b5615b..95d90f6e622 100644 --- a/en/cdn/operations/resources/configure-caching.md +++ b/en/cdn/operations/resources/configure-caching.md @@ -34,7 +34,7 @@ To configure the [caching](../../concepts/caching.md) parameters of a [resource] * Enable **{{ ui-key.yacloud.cdn.label_resource-cache-browser-cache-enabled }}**. - 1. (Optional) Under **{{ ui-key.yacloud.cdn.label_additional }}**: + 1. Optionally, under **{{ ui-key.yacloud.cdn.label_additional }}**: * Select the option to ignore Cookies. * Select the option to ignore the Query parameters. @@ -164,10 +164,10 @@ To configure the [caching](../../concepts/caching.md) parameters of a [resource] Where: * `cname`: Primary domain name used for content distribution. This is a required parameter. - * `active`: Flag indicating access to content for end users. If set to `True`, CDN content will be available to clients. This is an optional parameter. The default value is `true`. - * `origin_protocol`: Origin protocol. This is an optional parameter. The default value is `http`. + * `active`: Flag indicating content availablity to end users. `True`: CDN content will be available to clients. This is an optional parameter. The default value is `true`. + * `origin_protocol`: Protocol for origins. This is an optional parameter. The default value is `http`. * `secondary_hostnames`: Additional domain names. This is an optional parameter. - * `origin_group_id`: [Origin group](../../concepts/origins.md) ID. This is a required parameter. Use the ID from the origin group description in the `yandex_cdn_origin_group` resource. + * `origin_group_id`: [Origin group](../../concepts/origins.md) ID. This is a required parameter. Use the ID from the description of the origin group in the `yandex_cdn_origin_group` resource. * The `options` section contains additional parameters of CDN resources: * `browser_cache_settings`: Browser cache lifetime in seconds. This is an optional parameter. The default value is `0`. * `edge_cache_settings`: Cache lifetime for response codes in seconds. This is an optional parameter. The default value is `345600`. @@ -203,7 +203,7 @@ To configure the [caching](../../concepts/caching.md) parameters of a [resource] 1. Confirm the changes: type `yes` into the terminal and press **Enter**. - You can check the CDN resource update in the [management console]({{ link-console-main }}) or using this [CLI](../../../cli/quickstart.md) command: + You can check the changes to the CDN resource in the [management console]({{ link-console-main }}) or using this [CLI](../../../cli/quickstart.md) command: ``` yc cdn resource list diff --git a/en/cdn/operations/resources/configure-cors.md b/en/cdn/operations/resources/configure-cors.md index d14e92937be..a717c9443af 100644 --- a/en/cdn/operations/resources/configure-cors.md +++ b/en/cdn/operations/resources/configure-cors.md @@ -141,10 +141,10 @@ To configure cross-domain requests with [CORS](../../concepts/cors.md) for the [ Where: * `cname`: Primary domain name used for content distribution. This is a required parameter. - * `active`: Flag showing whether content is available to end users. When set to `True`, the CDN content will be available to clients. This is an optional parameter. Its default value is `true`. - * `origin_protocol`: Origin protocol. This is an optional parameter. Its default value is `http`. + * `active`: Flag indicating content availablity to end users. `True`: CDN content will be available to clients. This is an optional parameter. The default value is `true`. + * `origin_protocol`: Protocol for origins. This is an optional parameter. The default value is `http`. * `secondary_hostnames`: Additional domain names. This is an optional parameter. - * `origin_group_id`: [Origin group](../../concepts/origins.md) ID. This is a required parameter. Use the ID from the origin group description in the `yandex_cdn_origin_group` resource. + * `origin_group_id`: [Origin group](../../concepts/origins.md) ID. This is a required parameter. Use the ID from the description of the origin group in the `yandex_cdn_origin_group` resource. * The `options` section contains additional parameters of CDN resources: * `cors`: Value the CDN will send in the `Access-Control-Allow-Origin` header in response to a [CORS request](../../concepts/cors.md). * `allowed_http_methods`: HTTP methods allowed for your CDN content. By default, the following methods are allowed: `GET`, `HEAD`, `POST`, `PUT`, `PATCH`, `DELETE`, and `OPTIONS`. If the user is not allowed to use any method, they will get the `405` _Method Not Allowed_ response. For methods that are not supported, the user will get `501` (_Not Implemented_). This is an optional parameter. Its default values are `GET`, `HEAD`, `POST`, and `OPTIONS`. diff --git a/en/cdn/operations/resources/configure-headers.md b/en/cdn/operations/resources/configure-headers.md index a1fd23e3018..da90218848a 100644 --- a/en/cdn/operations/resources/configure-headers.md +++ b/en/cdn/operations/resources/configure-headers.md @@ -192,7 +192,7 @@ The `Access-Control-Allow-Origin` header for the CORS configuration is configure terraform apply ``` - 1. Confirm the changes: type `yes` into the terminal and click **Enter**. + 1. Confirm the changes: type `yes` into the terminal and press **Enter**. You can check the changes to the CDN resource in the [management console]({{ link-console-main }}) or using this [CLI](../../../cli/quickstart.md) command: diff --git a/en/cdn/operations/resources/configure-http.md b/en/cdn/operations/resources/configure-http.md index f84328e16a3..09586089625 100644 --- a/en/cdn/operations/resources/configure-http.md +++ b/en/cdn/operations/resources/configure-http.md @@ -135,10 +135,10 @@ To configure the allowed HTTP client requests methods for a resource: Where: * `cname`: Primary domain name used for content distribution. This is a required parameter. - * `active`: Flag showing whether content is available to end users. When set to `True`, the CDN content will be available to clients. This is an optional parameter. Its default value is `true`. - * `origin_protocol`: Origin protocol. This is an optional parameter. Its default value is `http`. + * `active`: Flag indicating content availablity to end users. `True`: CDN content will be available to clients. This is an optional parameter. The default value is `true`. + * `origin_protocol`: Protocol for origins. This is an optional parameter. The default value is `http`. * `secondary_hostnames`: Additional domain names. This is an optional parameter. - * `origin_group_id`: [Origin group](../../concepts/origins.md) ID. This is a required parameter. Use the ID from the origin group description in the `yandex_cdn_origin_group` resource. + * `origin_group_id`: [Origin group](../../concepts/origins.md) ID. This is a required parameter. Use the ID from the description of the origin group in the `yandex_cdn_origin_group` resource. * The `options` section contains additional parameters of CDN resources: * `allowed_http_methods`: HTTP methods allowed for your CDN content. By default, the following methods are allowed: `GET`, `HEAD`, `POST`, `PUT`, `PATCH`, `DELETE`, and `OPTIONS`. If the user is not allowed to use any method, they will get the `405` _Method Not Allowed_ response. For methods that are not supported, the user will get `501` (_Not Implemented_). This is an optional parameter. Its default values are `GET`, `HEAD`, `POST`, and `OPTIONS`. diff --git a/en/cdn/operations/resources/enable-compression.md b/en/cdn/operations/resources/enable-compression.md index 3bc67e35e32..30ec77de566 100644 --- a/en/cdn/operations/resources/enable-compression.md +++ b/en/cdn/operations/resources/enable-compression.md @@ -139,10 +139,10 @@ Before delivery, the content will be compressed by CDN servers using the GZIP co Where: * `cname`: Primary domain name used for content distribution. This is a required parameter. - * `active`: Flag indicating whether content is available to end users. When set to `True`, CDN content will be available to clients. This is an optional parameter. The default value is `true`. + * `active`: Flag indicating content availablity to end users. `True`: CDN content will be available to clients. This is an optional parameter. The default value is `true`. * `origin_protocol`: Protocol for origins. This is an optional parameter. * `secondary_hostnames`: Additional domain names. This is an optional parameter. - * `origin_group_id`: [Origin group](../../concepts/origins.md) ID. This is a required parameter. Use the ID from the origin group description in the `yandex_cdn_origin_group` resource. + * `origin_group_id`: [Origin group](../../concepts/origins.md) ID. This is a required parameter. Use the ID from the description of the origin group in the `yandex_cdn_origin_group` resource. * The `options` section contains additional parameters of CDN resources: * `gzip_on`: Flag indicating whether compression will be used. diff --git a/en/cdn/operations/resources/enable-segmentation.md b/en/cdn/operations/resources/enable-segmentation.md index 59fcc40a625..8625f64f06d 100644 --- a/en/cdn/operations/resources/enable-segmentation.md +++ b/en/cdn/operations/resources/enable-segmentation.md @@ -134,10 +134,10 @@ To enable [segmentation](../../concepts/slicing.md) of [resource](../../concepts Where: * `cname`: Primary domain name used for content distribution. This is a required parameter. - * `active`: Flag indicating access to content for end users. If set to `True`, CDN content will be available to clients. This is an optional parameter. The default value is `true`. - * `origin_protocol`: Origin protocol. This is an optional parameter. The default value is `http`. + * `active`: Flag indicating content availablity to end users. `True`: CDN content will be available to clients. This is an optional parameter. The default value is `true`. + * `origin_protocol`: Protocol for origins. This is an optional parameter. The default value is `http`. * `secondary_hostnames`: Additional domain names. This is an optional parameter. - * `origin_group_id`: [Origin group](../../concepts/origins.md) ID. This is a required parameter. Use the ID from the origin group description in the `yandex_cdn_origin_group` resource. + * `origin_group_id`: [Origin group](../../concepts/origins.md) ID. This is a required parameter. Use the ID from the description of the origin group in the `yandex_cdn_origin_group` resource. * The `options` section contains additional parameters of CDN resources: * `slice`: Flag indicating whether segmentation will be used. This is an optional parameter. The default value is `false`. @@ -170,7 +170,7 @@ To enable [segmentation](../../concepts/slicing.md) of [resource](../../concepts 1. Confirm the changes: type `yes` into the terminal and press **Enter**. - You can check the CDN resource update in the [management console]({{ link-console-main }}) or using this [CLI](../../../cli/quickstart.md) command: + You can check the changes to the CDN resource in the [management console]({{ link-console-main }}) or using this [CLI](../../../cli/quickstart.md) command: ``` yc cdn resource list diff --git a/en/cdn/operations/resources/get-resources-info.md b/en/cdn/operations/resources/get-resources-info.md index d34122f0e71..c91afed1708 100644 --- a/en/cdn/operations/resources/get-resources-info.md +++ b/en/cdn/operations/resources/get-resources-info.md @@ -19,7 +19,7 @@ title: How to get information about a resource in {{ cdn-full-name }} {% include [default-catalogue](../../../_includes/default-catalogue.md) %} - 1. View a description of the CLI command to get information about a [resource](../../concepts/resource.md): + 1. See the description of the CLI command to get information about a [resource](../../concepts/resource.md): ```bash yc cdn resource get --help @@ -121,7 +121,7 @@ title: How to get information about a resource in {{ cdn-full-name }} 1. In the [management console]({{ link-console-main }}), select the folder containing your resource. 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_cdn }}**. 1. Select the created CDN resource. - 1. The **{{ ui-key.yacloud.cdn.label_dns-settings_title }}** section on the **{{ ui-key.yacloud.common.overview }}** page will show the `.edgecdn.ru` domain name generated by the service. + 1. The **{{ ui-key.yacloud.common.overview }}** section on the **{{ ui-key.yacloud.cdn.label_dns-settings_title }}** page will show the `.edgecdn.ru` domain name generated by the service. - CLI {#cli} @@ -129,7 +129,7 @@ title: How to get information about a resource in {{ cdn-full-name }} {% include [default-catalogue](../../../_includes/default-catalogue.md) %} - 1. View a description of the CLI command to get information about a resource: + 1. See the description of the CLI command to get information about a resource: ```bash yc cdn resource get-provider-cname --help diff --git a/en/cdn/operations/resources/prefetch-files.md b/en/cdn/operations/resources/prefetch-files.md index cfffa70c136..967335e4288 100644 --- a/en/cdn/operations/resources/prefetch-files.md +++ b/en/cdn/operations/resources/prefetch-files.md @@ -19,7 +19,7 @@ To [prefetch content](../../concepts/caching.md#prefetch) from [origins](../../c 1. Go to the **{{ ui-key.yacloud.cdn.label_resource-content }}** tab. - 1. In the top-right corner, click ![image](../../../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud.cdn.button_resource-content-prefetch-cache }}**. + 1. In the top-right corner, click ![image](../../../_assets/console-icons/ellipsis.svg) and choose **{{ ui-key.yacloud.cdn.button_resource-content-prefetch-cache }}**. 1. Enter the file names in the **{{ ui-key.yacloud.cdn.label_resource-content-prefetch-cache-paths }}** field. @@ -97,4 +97,5 @@ To [prefetch content](../../concepts/caching.md#prefetch) from [origins](../../c Use the [prefetch](../../api-ref/Cache/prefetch.md) REST API method for the [Cache](../../api-ref/Cache/index.md) resource or the [CacheService/Prefetch](../../api-ref/grpc/Cache/prefetch.md) gRPC API call. -{% endlist %} \ No newline at end of file +{% endlist %} + \ No newline at end of file diff --git a/en/certificate-manager/quickstart/index.md b/en/certificate-manager/quickstart/index.md index 8ec0196688e..e9198874200 100644 --- a/en/certificate-manager/quickstart/index.md +++ b/en/certificate-manager/quickstart/index.md @@ -24,7 +24,7 @@ To get started with {{ certificate-manager-name }}, you need: - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the folder you want to create a [bucket](../../storage/concepts/bucket.md) in. + 1. In the [management console]({{ link-console-main }}), select the folder you want to create a bucket in. 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_storage }}**. 1. Click **{{ ui-key.yacloud.storage.buckets.button_create }}**. 1. Enter exactly the same name for the bucket as the domain name. @@ -42,8 +42,9 @@ To get started with {{ certificate-manager-name }}, you need: 1. In the [management console]({{ link-console-main }}), select **{{ ui-key.yacloud.iam.folder.dashboard.label_storage }}**. 1. In the **{{ ui-key.yacloud.storage.switch_buckets }}** tab, click the bucket with the same name as the domain. - 1. In the left-hand panel, select **{{ ui-key.yacloud.storage.bucket.switch_website }}**. - 1. Select **{{ ui-key.yacloud.storage.bucket.website.switch_hosting }}** and specify your website home page. + 1. In the left-hand panel, select **{{ ui-key.yacloud.storage.bucket.switch_settings }}**. + 1. Open the **{{ ui-key.yacloud.storage.bucket.switch_website }}** tab. + 1. Select `{{ ui-key.yacloud.storage.bucket.website.switch_hosting }}` and specify the website's homepage. 1. Click **{{ ui-key.yacloud.storage.bucket.website.button_save }}** to complete the operation. {% endlist %} @@ -146,8 +147,9 @@ To renew a certificate, you have to perform certain actions. Keep track of the l 1. Log in to the [management console]({{ link-console-main }}). 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_storage }}**. 1. In the **{{ ui-key.yacloud.storage.switch_buckets }}** tab, click the bucket with the same name as the domain. + 1. In the left-hand panel, select **{{ ui-key.yacloud.storage.bucket.switch_security }}**. 1. Go to the **{{ ui-key.yacloud.storage.bucket.switch_https }}** tab. - 1. In the right-hand panel that opens, click **{{ ui-key.yacloud.storage.bucket.https.button_action-configure }}**. + 1. Click **{{ ui-key.yacloud.storage.bucket.https.button_action-configure }}** at the top right. 1. In the **{{ ui-key.yacloud.storage.bucket.https.field_source }}** field, select `{{ ui-key.yacloud.storage.bucket.https.value_method-certificate-manager }}`. 1. In the **{{ ui-key.yacloud.storage.bucket.https.field_certificate-manager }}** field, select the certificate from the list that opens. 1. Click **{{ ui-key.yacloud.storage.bucket.https.button_save }}**. diff --git a/en/certificate-manager/release-notes.md b/en/certificate-manager/release-notes.md new file mode 100644 index 00000000000..b88b4a01490 --- /dev/null +++ b/en/certificate-manager/release-notes.md @@ -0,0 +1,11 @@ +--- +title: '{{ certificate-manager-full-name }} release notes' +description: This section contains {{ certificate-manager-name }} release notes. +--- + +# {{ certificate-manager-full-name }} release notes + +## Q3 2024 {#q3-2024} + +* In the management console, added the feature to [export](operations/managed/cert-get-content.md) a certificate, certificate chain, and private key obtained from Let’s Encrypt. Certificates are saved in Base64 encoded text format: +* Added the `GetCertificateContent` event to collect audit logs in [{{ at-name }}](../audit-trails/concepts/events-data-plane.md#certificate-manager) by the _Getting SSL certificate contents_ event. \ No newline at end of file diff --git a/en/certificate-manager/toc.yaml b/en/certificate-manager/toc.yaml index c09e033a67e..62e2ad12fdd 100644 --- a/en/certificate-manager/toc.yaml +++ b/en/certificate-manager/toc.yaml @@ -21,7 +21,7 @@ items: href: operations/managed/cert-modify.md - name: Deleting a certificate href: operations/managed/cert-delete.md - - name: Custom certificate + - name: User certificate items: - name: Adding a certificate href: operations/import/cert-create.md @@ -43,7 +43,7 @@ items: href: operations/domain/domain-modify.md - name: Deleting a domain href: operations/domain/domain-delete.md - - name: Backups + - name: Backup href: operations/cert-backup.md - name: Adding alerts for certificates href: operations/alert.md @@ -57,7 +57,7 @@ items: href: tutorials/nginx-ingress-certificate-manager.md - name: Setting up virtual hosting href: tutorials/virtual-hosting.md - - name: Hosting a static Gatsby-based website in {{ objstorage-name }} + - name: Hosting a static Gatsby website in {{ objstorage-name }} href: tutorials/gatsby-static-website.md - name: Terminating TLS connections items: @@ -73,7 +73,7 @@ items: href: concepts/index.md - name: Certificate from Let's Encrypt href: concepts/managed-certificate.md - - name: Custom certificate + - name: User certificate href: concepts/imported-certificate.md - name: Checking rights for a domain href: concepts/challenges.md @@ -191,6 +191,8 @@ items: href: metrics.md - name: '{{ at-name }} events' href: at-ref.md + - name: Release notes + href: release-notes.md - name: FAQ href: qa/index.md base: en/certificate-manager diff --git a/en/cli/cli-ref/managed-services/lockbox/secret/add-version.md b/en/cli/cli-ref/managed-services/lockbox/secret/add-version.md index 7ffe40bd726..4dd32359886 100644 --- a/en/cli/cli-ref/managed-services/lockbox/secret/add-version.md +++ b/en/cli/cli-ref/managed-services/lockbox/secret/add-version.md @@ -21,7 +21,7 @@ Syntax: |`--name`|`string`
Secret name.| |`--async`|Display information about the operation in progress, without waiting for the operation to complete.| |`--description`|`string`
Version description.| -|`--payload`|`string`
YAML or JSON array defining how to change payload from the base version.
Each item of the array must match the format: https://yandex.cloud/ru/docs/lockbox/api-ref/grpc/secret_service#PayloadEntryChange
For instance, to modify the value of "password" entry from the base version payload:
[{"key": "username", "text_value": "alice"}, {"key": "password", "text_value": "p@$$w0rd"}]
the following JSON can be passed:
[{"key": "password", "text_value": "another-p@$$w0rd"}]
so the resulting payload of the newly added version will be:
[{"key": "username", "text_value": "alice"}, {"key": "password", "text_value": "another-p@$$w0rd"}]
To remove the entry pass an item containing only the "key" field, e.g.:
[..., {"key": "the-key-of-the-entry-to-remove"}, ...]
Use - value to pass payload string via stdin.| +|`--payload`|`string`
YAML or JSON array defining how to change payload from the base version.
Each item of the array must match the format: https://yandex.cloud/ru/docs/lockbox/api-ref/grpc/Secret/create#yandex.cloud.lockbox.v1.PayloadEntryChange
For instance, to modify the value of "password" entry from the base version payload:
[{"key": "username", "text_value": "alice"}, {"key": "password", "text_value": "p@$$w0rd"}]
the following JSON can be passed:
[{"key": "password", "text_value": "another-p@$$w0rd"}]
so the resulting payload of the newly added version will be:
[{"key": "username", "text_value": "alice"}, {"key": "password", "text_value": "another-p@$$w0rd"}]
To remove the entry pass an item containing only the "key" field, e.g.:
[..., {"key": "the-key-of-the-entry-to-remove"}, ...]
Use - value to pass payload string via stdin.| |`--base-version-id`|`string`
Base version id. By default, the current one is used.| #### Global Flags diff --git a/en/cli/cli-ref/managed-services/lockbox/secret/create.md b/en/cli/cli-ref/managed-services/lockbox/secret/create.md index fb485017143..bebd11a0828 100644 --- a/en/cli/cli-ref/managed-services/lockbox/secret/create.md +++ b/en/cli/cli-ref/managed-services/lockbox/secret/create.md @@ -22,7 +22,7 @@ Syntax: |`--labels`|`key=value[,key=value...]`
A list of label KEY=VALUE pairs to add. For example, to add two labels named 'foo' and 'bar', both with the value 'baz', use '--labels foo=baz,bar=baz'.| |`--kms-key-id`|`string`
KMS key ID will be used to encrypt the secret payload.| |`--version-description`|`string`
Description of the first version.| -|`--payload`|`string`
YAML or JSON array defining the entries of the secret payload.
Each item of the array must match the format: https://yandex.cloud/ru/docs/lockbox/api-ref/grpc/secret_service#PayloadEntryChange
For instance, the following payload JSON defines a payload containing two text value entries:
[{"key": "username", "text_value": "alice"}, {"key": "password", "text_value": "p@$$w0rd"}]
Use - value to pass payload string via stdin.| +|`--payload`|`string`
YAML or JSON array defining the entries of the secret payload.
Each item of the array must match the format: https://yandex.cloud/ru/docs/lockbox/api-ref/grpc/Secret/create#yandex.cloud.lockbox.v1.PayloadEntryChange
For instance, the following payload JSON defines a payload containing two text value entries:
[{"key": "username", "text_value": "alice"}, {"key": "password", "text_value": "p@$$w0rd"}]
Use - value to pass payload string via stdin.| |`--deletion-protection`|Enable deletion protection for the secret.| |`--async`|Display information about the operation in progress, without waiting for the operation to complete.| diff --git a/en/cli/operations/profile/profile-activate.md b/en/cli/operations/profile/profile-activate.md index 8e59dc465e9..1eea0b52490 100644 --- a/en/cli/operations/profile/profile-activate.md +++ b/en/cli/operations/profile/profile-activate.md @@ -4,7 +4,7 @@ Multiple profiles let you quickly switch your command execution context. {% include [profile-name](../../../_includes/cli-profile-name.md) %} -1. Activate the `test` profile: +1. Activate the `test` profile: ```bash yc config profile activate test diff --git a/en/cloud-desktop/api-ref/Desktop/create.md b/en/cloud-desktop/api-ref/Desktop/create.md index 73e530bdafc..0f92e350114 100644 --- a/en/cloud-desktop/api-ref/Desktop/create.md +++ b/en/cloud-desktop/api-ref/Desktop/create.md @@ -20,7 +20,8 @@ POST https://cloud-desktop.{{ api-host }}/cloud-desktop/v1/desktops "desktopGroupId": "string", "users": [ { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } ] } @@ -43,6 +44,9 @@ List of users. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# ## Response {#yandex.cloud.operation.Operation} @@ -88,7 +92,8 @@ Required field. Identity of the access binding. || ], "users": [ { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } ] } @@ -262,4 +267,7 @@ Required field. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# \ No newline at end of file diff --git a/en/cloud-desktop/api-ref/Desktop/get.md b/en/cloud-desktop/api-ref/Desktop/get.md index 3e5386fefea..22d2927ca92 100644 --- a/en/cloud-desktop/api-ref/Desktop/get.md +++ b/en/cloud-desktop/api-ref/Desktop/get.md @@ -51,7 +51,8 @@ To get the desktop ID use a [DesktopService.List](/docs/cloud-desktop/api-ref/De ], "users": [ { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } ] } @@ -126,4 +127,7 @@ Required field. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# \ No newline at end of file diff --git a/en/cloud-desktop/api-ref/Desktop/getRdpFile.md b/en/cloud-desktop/api-ref/Desktop/getRdpFile.md index b34871dabc1..ea258499fad 100644 --- a/en/cloud-desktop/api-ref/Desktop/getRdpFile.md +++ b/en/cloud-desktop/api-ref/Desktop/getRdpFile.md @@ -40,6 +40,9 @@ User of the desktop. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# ## Response {#yandex.cloud.clouddesktop.v1.api.RdpFileResponse} diff --git a/en/cloud-desktop/api-ref/Desktop/list.md b/en/cloud-desktop/api-ref/Desktop/list.md index f6be2e1eb46..ce6a4ed7436 100644 --- a/en/cloud-desktop/api-ref/Desktop/list.md +++ b/en/cloud-desktop/api-ref/Desktop/list.md @@ -73,7 +73,8 @@ The default sorting order is ascending. || ], "users": [ { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } ] } @@ -168,4 +169,7 @@ Required field. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# \ No newline at end of file diff --git a/en/cloud-desktop/api-ref/Desktop/resetPassword.md b/en/cloud-desktop/api-ref/Desktop/resetPassword.md index 710d4881498..3fcb8f047a0 100644 --- a/en/cloud-desktop/api-ref/Desktop/resetPassword.md +++ b/en/cloud-desktop/api-ref/Desktop/resetPassword.md @@ -27,7 +27,8 @@ Required field. ID of the desktop. || ```json { "user": { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } } ``` @@ -46,6 +47,9 @@ Required field. User of the desktop. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# ## Response {#yandex.cloud.clouddesktop.v1.api.ResetPasswordResponse} diff --git a/en/cloud-desktop/api-ref/DesktopGroup/listDesktops.md b/en/cloud-desktop/api-ref/DesktopGroup/listDesktops.md index a4322534712..e25efead77e 100644 --- a/en/cloud-desktop/api-ref/DesktopGroup/listDesktops.md +++ b/en/cloud-desktop/api-ref/DesktopGroup/listDesktops.md @@ -77,7 +77,8 @@ The default sorting order is ascending. || ], "users": [ { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } ] } @@ -172,4 +173,7 @@ Required field. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# \ No newline at end of file diff --git a/en/cloud-desktop/api-ref/grpc/Desktop/create.md b/en/cloud-desktop/api-ref/grpc/Desktop/create.md index c06cb4bf23b..1a9e8bee5ff 100644 --- a/en/cloud-desktop/api-ref/grpc/Desktop/create.md +++ b/en/cloud-desktop/api-ref/grpc/Desktop/create.md @@ -18,7 +18,8 @@ Creates desktop in the specified folder. "desktopGroupId": "string", "users": [ { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } ] } @@ -41,6 +42,9 @@ List of users. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# ## operation.Operation {#yandex.cloud.operation.Operation} @@ -78,7 +82,8 @@ Required field. Identity of the access binding. || ], "users": [ { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } ] } @@ -214,4 +219,7 @@ Required field. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# \ No newline at end of file diff --git a/en/cloud-desktop/api-ref/grpc/Desktop/get.md b/en/cloud-desktop/api-ref/grpc/Desktop/get.md index 0470a7b8cc3..47b8a412f48 100644 --- a/en/cloud-desktop/api-ref/grpc/Desktop/get.md +++ b/en/cloud-desktop/api-ref/grpc/Desktop/get.md @@ -53,7 +53,8 @@ To get the desktop ID use a [DesktopService.List](/docs/cloud-desktop/api-ref/gr ], "users": [ { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } ] } @@ -121,4 +122,7 @@ Required field. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# \ No newline at end of file diff --git a/en/cloud-desktop/api-ref/grpc/Desktop/getRdpFile.md b/en/cloud-desktop/api-ref/grpc/Desktop/getRdpFile.md index 59bc7354ac4..cac0053eb23 100644 --- a/en/cloud-desktop/api-ref/grpc/Desktop/getRdpFile.md +++ b/en/cloud-desktop/api-ref/grpc/Desktop/getRdpFile.md @@ -17,7 +17,8 @@ Returns a RDP file for the specified desktop. { "desktopId": "string", "user": { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } } ``` @@ -41,6 +42,9 @@ User of the desktop. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# ## RdpFileResponse {#yandex.cloud.clouddesktop.v1.api.RdpFileResponse} diff --git a/en/cloud-desktop/api-ref/grpc/Desktop/list.md b/en/cloud-desktop/api-ref/grpc/Desktop/list.md index 71068d27a04..d9e5b7305bc 100644 --- a/en/cloud-desktop/api-ref/grpc/Desktop/list.md +++ b/en/cloud-desktop/api-ref/grpc/Desktop/list.md @@ -79,7 +79,8 @@ The default sorting order is ascending. || ], "users": [ { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } ] } @@ -167,4 +168,7 @@ Required field. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# \ No newline at end of file diff --git a/en/cloud-desktop/api-ref/grpc/Desktop/resetPassword.md b/en/cloud-desktop/api-ref/grpc/Desktop/resetPassword.md index 539bfd66c35..a5219df80b9 100644 --- a/en/cloud-desktop/api-ref/grpc/Desktop/resetPassword.md +++ b/en/cloud-desktop/api-ref/grpc/Desktop/resetPassword.md @@ -17,7 +17,8 @@ Reset password { "desktopId": "string", "user": { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } } ``` @@ -39,6 +40,9 @@ Required field. User of the desktop. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# ## ResetPasswordResponse {#yandex.cloud.clouddesktop.v1.api.ResetPasswordResponse} diff --git a/en/cloud-desktop/api-ref/grpc/Desktop/restart.md b/en/cloud-desktop/api-ref/grpc/Desktop/restart.md index 462df0d3175..57d0d8a60d3 100644 --- a/en/cloud-desktop/api-ref/grpc/Desktop/restart.md +++ b/en/cloud-desktop/api-ref/grpc/Desktop/restart.md @@ -61,7 +61,8 @@ Required field. ID of the desktop. || ], "users": [ { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } ] } @@ -197,4 +198,7 @@ Required field. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# \ No newline at end of file diff --git a/en/cloud-desktop/api-ref/grpc/DesktopGroup/listDesktops.md b/en/cloud-desktop/api-ref/grpc/DesktopGroup/listDesktops.md index eacc7528919..533c2082fcb 100644 --- a/en/cloud-desktop/api-ref/grpc/DesktopGroup/listDesktops.md +++ b/en/cloud-desktop/api-ref/grpc/DesktopGroup/listDesktops.md @@ -77,7 +77,8 @@ The default sorting order is ascending. || ], "users": [ { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } ] } @@ -165,4 +166,7 @@ Required field. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# \ No newline at end of file diff --git a/en/cloud-desktop/concepts/acl.md b/en/cloud-desktop/concepts/acl.md new file mode 100644 index 00000000000..e97293820ae --- /dev/null +++ b/en/cloud-desktop/concepts/acl.md @@ -0,0 +1,39 @@ +# Access control list (ACL) + +{{ cloud-desktop-full-name }} leverages [{{ iam-full-name }} roles](../security/index.md) for access control. + +{{ cloud-desktop-name }} ACL is a list of permissions for a given [desktop group](desktops-and-groups.md). + +By default, an empty ACL is created for each new desktop group. A user with the `vdi.admin` [role](../security/index.md#vdi-admin) can [edit](../operations/desktop-groups/update-acl.md) an ACL. + +Using an ACL, you can grant desktop group access to: +* [{{ yandex-cloud }} user](../../iam/concepts/users/accounts.md) +* [Service account](../../iam/concepts/users/service-accounts.md) +* [{{ org-full-name }} user group](../../organization/concepts/groups.md) +* [Public group](../../iam/concepts/access-control/public-group.md) +* [System group](../../iam/concepts/access-control/system-group.md) + +Each desktop is assigned to a specific {{ yandex-cloud }} user. + +To [connect to a desktop](../operations/desktops/connect.md), the user gets a unique RDP file with a built-in [IAM token](../../iam/concepts/authorization/iam-token.md). This means only a certain user can access the desktop. + +The IAM token [lifetime](../../iam/concepts/authorization/iam-token.md#lifetime) is 12 hours. Once it expires, the RDP file is no longer valid. To connect to the desktop, the user needs to request a new RDP file. + +If a user is removed from the list of {{ yandex-cloud }} users for any reason, e.g., if they were transferred to a different department or suspected of unauthorized activity, their RDP file becomes invalid regardless of when it was issued. + +## Example of access control in {{ cloud-desktop-name }} {#example} + +1. The organization administrator (user with the `organization-manager.admin` [role](../../organization/security/index.md#organization-manager-admin) for the [cloud](../../resource-manager/concepts/resources-hierarchy.md#cloud)) creates a {{ org-full-name }} [user group](../../organization/concepts/groups.md) for which a desktop group will be deployed. +1. The {{ cloud-desktop-name }} administrator (user with the `vdi.admin` [role](../security/index.md#vdi-admin) for the [folder](../../resource-manager/concepts/resources-hierarchy.md#folder)) [creates](../operations/desktop-groups/create.md) a desktop group and [grants](../operations/desktop-groups/update-acl.md) permissions for it to a user group. + + The administrator can also create a custom [image](images.md) for the desktop group. + +1. The {{ cloud-desktop-name }} administrator [creates](../operations/desktops/create.md) a personal desktop for each memeber in the user group. +1. A user group member gets authenticated using [Yandex ID](https://yandex.ru/support/id/index.html) or [Single Sign-On (SSO)](../../organization/concepts/add-federation.md) on the [User desktop showcase](showcase.md) page. The showcase displays the desktops available to a given user. +1. From the showcase, the user group member downloads the RDP file for the appropriate desktop and [connects](../operations/desktops/connect.md) to it. + +## See also {#see-also} + +* [Getting started with {{ cloud-desktop-name }}](../quickstart.md) +* [Access management](../security/index.md) +* [{#T}](../operations/desktop-groups/update-acl.md) \ No newline at end of file diff --git a/en/cloud-desktop/concepts/desktops-and-groups.md b/en/cloud-desktop/concepts/desktops-and-groups.md index 48d29286b27..c67aa787b0a 100644 --- a/en/cloud-desktop/concepts/desktops-and-groups.md +++ b/en/cloud-desktop/concepts/desktops-and-groups.md @@ -2,8 +2,10 @@ In {{ cloud-desktop-name }}, the main resource is a _desktop_. This is a virtual [Ubuntu](https://ubuntu.com/)-based workspace deployed in the {{ yandex-cloud }} infrastructure. -One desktop is assigned to one user within an organization created in [{{ org-name }}](../../organization/). You can establish a desktop connection using the [Remote Desktop Protocol](https://en.wikipedia.org/wiki/Remote_Desktop_Protocol) (RDP). +One desktop is assigned to one user within an organization created in [{{ org-name }}](../../organization/). Users connect to desktops over the [Remote Desktop Protocol](https://en.wikipedia.org/wiki/Remote_Desktop_Protocol) (RDP). Each desktop belongs to a _desktop group_. All desktops in the group use the same computing resources and the same [network](../../vpc/concepts/network.md). -All desktop and desktop group operations are [logged](../operations/logging.md). \ No newline at end of file +All desktop and desktop group operations are [logged](../operations/logging.md). + +{% include [access-options](../../_includes/cloud-desktop/access-options.md) %} \ No newline at end of file diff --git a/en/cloud-desktop/operations/desktop-groups/update-acl.md b/en/cloud-desktop/operations/desktop-groups/update-acl.md index 1d619923436..ab0624b1de7 100644 --- a/en/cloud-desktop/operations/desktop-groups/update-acl.md +++ b/en/cloud-desktop/operations/desktop-groups/update-acl.md @@ -1,17 +1,19 @@ --- -title: Tutorial on changing access rights for a desktop group in {{ cloud-desktop-full-name }} -description: In this tutorial, you will learn how to change access rights for a desktop group in {{ cloud-desktop-full-name }}. +title: Tutorial on changing access permissions for a desktop group in {{ cloud-desktop-full-name }} +description: In this tutorial, you will learn how to change access permissions for a desktop group in {{ cloud-desktop-full-name }}. --- -# Changing permissions to a desktop group +# Changing desktop group permissions + +{% include [access-options](../../../_includes/cloud-desktop/access-options.md) %} {% list tabs group=instructions %} - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the folder where the desktop group is located. - 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_cloud-desktop }}**. - 1. Click ![image](../../../_assets/console-icons/ellipsis.svg) to the right of the desktop group to change access rights for and select **{{ ui-key.yacloud.vdi.button_acl }}**. - 1. In the **{{ ui-key.yacloud.component.acl-dialog.label_title }}** window that opens, grant or revoke the appropriate permissions. + 1. In the [management console]({{ link-console-main }}), select the folder the desktop group is in. + 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_cloud-desktop }}**. + 1. Click ![image](../../../_assets/console-icons/ellipsis.svg) to the right of the desktop group you want to change access permissions for and select **{{ ui-key.yacloud.vdi.button_acl }}**. + 1. In the **{{ ui-key.yacloud.component.acl-dialog.label_title }}** window that opens, grant or revoke the appropriate permissions. {% endlist %} diff --git a/en/cloud-desktop/operations/images/delete.md b/en/cloud-desktop/operations/images/delete.md index 26206c4e3f5..05e548535e4 100644 --- a/en/cloud-desktop/operations/images/delete.md +++ b/en/cloud-desktop/operations/images/delete.md @@ -15,10 +15,10 @@ You cannot delete {{ cloud-desktop-name }} [system images](../../concepts/images - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the folder where you want to create an image. - 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_cloud-desktop }}**. - 1. In the left-hand panel, select ![image](../../../_assets/console-icons/layers.svg) **{{ ui-key.yacloud.vdi.label_desktop-images }}**. - 1. Click ![image](../../../_assets/console-icons/ellipsis.svg) to the right of the custom image you want to delete and select **{{ ui-key.yacloud.common.delete }}**. - 1. Confirm the deletion. + 1. In the [management console]({{ link-console-main }}), select the folder where you want to delete an image. + 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_cloud-desktop }}**. + 1. In the left-hand panel, select ![image](../../../_assets/console-icons/layers.svg) **{{ ui-key.yacloud.vdi.label_desktop-images }}**. + 1. Click ![image](../../../_assets/console-icons/ellipsis.svg) to the right of the custom image you want to delete and select **{{ ui-key.yacloud.common.delete }}**. + 1. Confirm the deletion. {% endlist %} diff --git a/en/cloud-desktop/quickstart.md b/en/cloud-desktop/quickstart.md index ec0cc058847..db408a903c9 100644 --- a/en/cloud-desktop/quickstart.md +++ b/en/cloud-desktop/quickstart.md @@ -1,38 +1,122 @@ --- -title: How to get started with {{ cloud-desktop-name }} +title: Getting started with {{ cloud-desktop-name }} description: This guide describes how you can create and set up a desktop group. --- -# Getting started with {{ cloud-desktop-name }} +# Getting started with {{ cloud-desktop-full-name }} {% note info %} -This guide contains information on how to create and set up a [desktop group](concepts/desktops-and-groups.md). If you received a link to the [user desktop showcase](concepts/showcase.md) from an admin, proceed to [{#T}](#get-credentials). +This guide contains information on how to create and set up a [desktop group](concepts/desktops-and-groups.md). If you received a link to the [user desktop showcase](concepts/showcase.md) from an administrator, go to [{#T}](#get-credentials). {% endnote %} -Create a {{ cloud-desktop-name }} desktop group in your cloud: +{{ cloud-desktop-name }} is a service to manage virtual Linux-based desktop infrastructure. + +Create a {{ org-full-name }} [user group](../organization/concepts/groups.md) and deploy a {{ cloud-desktop-name }} [desktop group](./concepts/desktops-and-groups.md) for it: 1. [Prepare your cloud](#before-you-begin). -1. [Create a desktop group](#create-desktop-group). +1. [Create a user group](#create-user-group). +1. [Deploy a desktop group](#create-desktop-group). +1. [Configure an ACL for the desktop group](#setup-acl). 1. [Create a desktop](#create-desktop). 1. [Get the connection credentials](#get-credentials). 1. [Connect to the desktop](#connect-desktop). ## Getting started {#before-you-begin} -1. Log in to or register in the [management console]({{ link-console-main }}). If you do not have an account yet, go to the management console and follow the guide. -1. On the [**{{ ui-key.yacloud.component.navigation-menu.label_billing }}**]({{ link-console-billing }}) page, make sure you have a [billing account](../billing/concepts/billing-account.md) linked and it has the `ACTIVE` or `TRIAL_ACTIVE` status. If you do not yet have a billing account, [create one](../billing/quickstart/index.md#create_billing_account). -1. If you do not have any folders yet, [create one](../resource-manager/operations/folder/create.md). -1. To make sure your desktops have access to the internet, [set up](../vpc/operations/create-nat-gateway.md) a NAT gateway for the [subnets](../vpc/concepts/network.md#subnet) that will host them. +1. Log in or sign up to the [management console]({{ link-console-main }}). If not signed up yet, navigate to the management console and follow the instructions. +1. On the [**{{ ui-key.yacloud.component.navigation-menu.label_billing }}**]({{ link-console-billing }}) page, make sure you have a [billing account](../billing/concepts/billing-account.md) linked and it has the `ACTIVE` or `TRIAL_ACTIVE` status. If you do not have a billing account yet, [create one](../billing/quickstart/index.md#create_billing_account). +1. If you do not have a folder yet, [create one](../resource-manager/operations/folder/create.md). +1. Make sure you have the following _minimum_ roles: + * [organization-manager.admin](../organization/security/index.md#organization-manager-admin) for the [cloud](../resource-manager/concepts/resources-hierarchy.md#cloud): To create a user group. + * [vdi.admin](./security/index.md#vdi-admin) for the [folder](../resource-manager/concepts/resources-hierarchy.md#folder): To create a desktop group and assign an [ACL](./concepts/acl.md) to it. + + If you have a primitive [admin](../iam/roles-reference.md#admin) role for a folder, you do not need to assign any additional roles. + +1. To make sure your desktops have access to the internet, [set up](../vpc/concepts/network.md#subnet) a NAT gateway for the [subnets](../vpc/operations/create-nat-gateway.md) that will host them. + +## Create a user group {#create-user-group} + +{% list tabs group=instructions %} + +- {{ org-name }} interface {#cloud-org} + + 1. [Log in]({{ link-passport-login }}) as the organization administrator. + 1. Go to [{{ org-full-name }}]({{ link-org-main }}). + 1. In the left-hand panel, select **{{ ui-key.yacloud_org.pages.groups }}** ![persons](../_assets/console-icons/persons.svg). + 1. In the top-right corner, click **{{ ui-key.yacloud_org.entity.group.action_create }}** and enter a name for the user group. + + The name must be unique within the [organization](../overview/roles-and-resources.md) and follow the naming requirements: + + {% include [group-name-format](../_includes/organization/group-name-format.md) %} + + 1. Click **{{ ui-key.yacloud_org.entity.group.action_create }}**. + 1. In the **{{ ui-key.yacloud_org.entity.group.title_tab-members }}** tab that opens, click **{{ ui-key.yacloud_org.entity.group.action_add-member }}**. + 1. In the **{{ ui-key.yacloud_org.component.subject-select-dialog.title_dialog }}** window, select the users to deploy a desktop group for. + 1. Click **{{ ui-key.yacloud_org.component.subject-select-dialog.action_apply }}**. + +{% endlist %} + +## Deploy a desktop group {#create-desktop-group} + +{% list tabs group=instructions %} + +- Management console {#console} -## Create a desktop group {#create-desktop-group} + 1. In the [management console]({{ link-console-main }}), select the folder to create your desktop group in. + 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_cloud-desktop }}**. + 1. Click **{{ ui-key.yacloud.vdi.button_empty-create-desktop-group }}**. + 1. Enter a name for the desktop group. + 1. Select `Ubuntu 20.04 LTS` for the OS [image](./concepts/images.md). + 1. Under **{{ ui-key.yacloud.vdi.section_disks }}**: + * Select `SSD` for the boot and working [disk](./concepts/disks.md) [types](../compute/concepts/disk.md#disks-types). + * Set the boot disk size to `60 GB`. + * Set the working disk size to `4 GB`. + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_platform }}**: + * Set the number of vCPU cores to `2`. + * Select `100%` for the [guaranteed vCPU share](../compute/concepts/performance-levels.md). + * Set RAM to `8 GB`. + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_network }}**, select the [cloud network](../vpc/concepts/network.md#network) and [subnets](../vpc/concepts/network.md#subnet) to host desktops. + 1. Click **{{ ui-key.yacloud.common.create }}**. -{% include [create-desktop-group](../_includes/cloud-desktop/create-desktop-group.md) %} +{% endlist %} + +## Configure an ACL for the desktop group {#setup-acl} + +{% include [access-options](../_includes/cloud-desktop/access-options.md) %} + +{% list tabs group=instructions %} + +- Management console {#console} + + 1. To the right of the desktop group created earlier, click ![image](../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud.vdi.button_acl }}**. + 1. In the **{{ ui-key.yacloud.component.acl-dialog.label_title }}** window that appears, select the user group you created earlier, specify the `vdi.viewer` [role](./security/index.md#vdi-viewer) for it, and click **{{ ui-key.yacloud.common.add }}**. + 1. Click **{{ ui-key.yacloud.common.save }}**. + +{% endlist %} ## Create a desktop {#create-desktop} -{% include [create-desktop](../_includes/cloud-desktop/create-desktop.md) %} +{% list tabs group=instructions %} + +- Management console {#console} + + 1. In the left-hand panel, select ![image](../_assets/console-icons/display.svg) **{{ ui-key.yacloud.vdi.label_desktops }}**. + 1. Click **{{ ui-key.yacloud.vdi.button_desktop-create }}**. + 1. Select the desktop group you created earlier. + 1. Specify the subnet to place the desktop in. + + {% note info %} + + To provide your desktop with internet access, make sure to [configure a NAT gateway](../vpc/operations/create-nat-gateway.md) in the subnet. + + {% endnote %} + + 1. Specify the user that the desktop is created for. + 1. Click **{{ ui-key.yacloud.common.create }}**. + +{% endlist %} ## Get the connection credentials {#get-credentials} @@ -40,6 +124,6 @@ Create a {{ cloud-desktop-name }} desktop group in your cloud: ## Connect to the desktop {#connect-desktop} -You can establish a desktop connection using the [Remote Desktop Protocol](https://en.wikipedia.org/wiki/Remote_Desktop_Protocol) (RDP). +To establish a desktop connection, use the [Remote Desktop Protocol](https://en.wikipedia.org/wiki/Remote_Desktop_Protocol) (RDP). {% include [desktop-connect](../_includes/cloud-desktop/desktop-connect.md) %} diff --git a/en/cloud-desktop/security/index.md b/en/cloud-desktop/security/index.md index 3cfa7a7d900..c3549f437cc 100644 --- a/en/cloud-desktop/security/index.md +++ b/en/cloud-desktop/security/index.md @@ -3,7 +3,9 @@ title: Access management in {{ cloud-desktop-full-name }} description: 'Access management in {{ cloud-desktop-full-name }}. Permissions are granted when assigning a role. You can assign a role for an organization, folder, or cloud: all permissions from a cloud or organization are inherited.' --- -# Access management in {{ cloud-desktop-name }} +# Access management in {{ cloud-desktop-full-name }} + +In {{ cloud-desktop-name }}, access control is achieved by using {{ iam-full-name }} roles and [access control lists (ACL)](../concepts/acl.md). See the [example of using access control mechanisms](../concepts/acl.md#example). In this section, you will learn: * [Which resources you can assign a role for](#resources). diff --git a/en/cloud-desktop/toc.yaml b/en/cloud-desktop/toc.yaml index f4123839bd6..be62429ad6c 100644 --- a/en/cloud-desktop/toc.yaml +++ b/en/cloud-desktop/toc.yaml @@ -48,6 +48,8 @@ items: items: - name: Desktops and their groups href: concepts/desktops-and-groups.md + - name: Access control lists (ACLs) + href: concepts/acl.md - name: Disks href: concepts/disks.md - name: Images diff --git a/en/code-assistant/concepts/index.md b/en/code-assistant/concepts/index.md index 708daca25ec..99655507195 100644 --- a/en/code-assistant/concepts/index.md +++ b/en/code-assistant/concepts/index.md @@ -8,6 +8,8 @@ LLMs that are used in {{ ca-name }} have been fine-tuned based on the open-source code corpus. +The {{ ca-name }} plugin is available for [Visual Studio Code](https://code.visualstudio.com/) and [JetBrains IDE](https://www.jetbrains.com/ides/) versions 2024.1 and 2024.2. + {% note info %} To work with {{ ca-name }}, you need continuous internet access. @@ -27,4 +29,5 @@ The code analysis is running using the {{ yandex-cloud }} computing resources, w ## See also {#see-also} * [{#T}](../quickstart.md) -* [Terms of Use of {{ ca-full-name }}](https://yandex.com/legal/cloud_terms_code_assistant/) +* [{{ ca-full-name }} terms of use](https://yandex.com/legal/cloud_terms_code_assistant/) + diff --git a/en/code-assistant/qa.md b/en/code-assistant/qa.md new file mode 100644 index 00000000000..e406f2ceef3 --- /dev/null +++ b/en/code-assistant/qa.md @@ -0,0 +1,34 @@ + +# FAQ about {{ ca-full-name }} + +#### Authentication error in Visual Studio Code {#crypto-is-not-defined} + +Error message: + +```text +crypto is not defined +``` + +This is an error returned by the internal IDE library used for authentication in {{ yandex-cloud }}. To resolve this error, [upgrade](https://code.visualstudio.com/docs/setup/setup-overview#_update-cadence) your Visual Studio Code version. + +{% cut "Example of a Visual Studio Code build compatible with the plugin" %} + +```text +Version: 1.92.2 (system setup) +Commit: fee1edb8d6d72a0ddff41e5f71a671c23ed924b9 +Date: 2024-08-14T17:29:30.058Z +Electron: 30.1.2 +ElectronBuildId: 9870757 +Chromium: 124.0.6367.243 +Node.js: 20.14.0 +V8: 12.4.254.20-electron.0 +OS: Windows_NT x64 10.0.19045 +``` + +{% endcut %} + +See also [How to find out your IDE version](https://code.visualstudio.com/docs/setup/setup-overview#_how-do-i-know-which-version-im-running). + +#### Do I need a billing account to work with {{ ca-name }}? {#billing-account} + +You **do not need** a [billing account](../billing/concepts/billing-account.md). diff --git a/en/code-assistant/quickstart.md b/en/code-assistant/quickstart.md index 37a681db8d9..a42383923dc 100644 --- a/en/code-assistant/quickstart.md +++ b/en/code-assistant/quickstart.md @@ -33,7 +33,7 @@ If your [organization](../overview/roles-and-resources.md) in {{ yandex-cloud }} 1. Download the [{{ ca-name }} plugin]({{ link-ca-vscode }}) for [Visual Studio Code](https://code.visualstudio.com/). - If you cannot download it for any reason, contact your system administrator so that they open network access to {{ yandex-cloud }} resources. + {% include [unable-to-download](../_includes/code-assistant/unable-to-download.md) %} 1. Install the plugin: 1. Open Visual Studio Code. @@ -56,6 +56,41 @@ If your [organization](../overview/roles-and-resources.md) in {{ yandex-cloud }} {{ ca-name }} is now enabled, ready to go, and displayed in the bottom panel of the editor as ![image](../_assets/code-assistant/vsc-icon-small.svg). +- JetBrains IDE {#jb} + + {% note warning %} + + The supported IDE versions are 2024.1 and 2024.2. + + {% endnote %} + + 1. Download the {{ ca-name }} plugin for your [JetBrains IDE](https://www.jetbrains.com/ides/) version: + * [2024.1]({{ link-ca-jb-2024-1 }}) + * [2024.2]({{ link-ca-jb-2024-2 }}) + + {% include [unable-to-download](../_includes/code-assistant/unable-to-download.md) %} + + 1. Install the plugin: + 1. Open the IDE. + 1. Open settings by pressing **Ctrl** + **Alt** + **S** for Windows or Linux or **Command** + **,** for macOS. + 1. Go to **Plugins**. + 1. Click ![image](../_assets/console-icons/gear.svg) and select **Install Plugin from Disk...**. + 1. Select the plugin file you downloaded previously. + 1. Confirm that you would like to use a third-party plugin and click **OK**. + + 1. To get started with {{ ca-name }}, get authenticated in {{ yandex-cloud }}: + 1. In the **Yandex Code Assistant OAuth** pop-up window, click **Yandex Code Assist: Login**. + 1. In your browser, go to the {{ yandex-cloud }} [management console]({{ link-console-main }}). + 1. Go back to the IDE. + + The `Code Assist plugin started` message means the plugin is active and ready for use. + + {% note tip %} + + If the plugin failed to start, or you do not see suggestions from {{ ca-name }}, try restarting the IDE. + + {% endnote %} + {% endlist %} ## Test the plugin {#work-with-plugin} @@ -72,61 +107,68 @@ To work with {{ ca-name }}, you will need continuous internet access. How to work with {{ ca-name }}: -{% list tabs group=ide %} +1. Open the IDE and create a test file named `server.cpp` with the following contents: -- Visual Studio Code {#vscode} + ```cpp + // simple web-server to work with sockets - 1. Open Visual Studio Code and create the `server.cpp` test file with the following content: + #include + #include + #include + #include + #include - ```cpp - // simple web-server to work with sockets + using namespace std; - #include - #include - #include - #include - #include + int main() { - using namespace std; + } + ``` - int main() { +1. In the `int main()` section, start typing something, e.g., `//create socket`. See the {{ ca-name }} suggestion: - } - ``` + ```cpp + ... + int main() { - 1. In the `int main()` section, start typing something, e.g., `//create socket`. See the {{ ca-name }} suggestion: + //create socket + int sockfd = socket(AF_INET, SOCK_STREAM, 0); - ```cpp - ... - int main() { + } + ``` - //create socket - int sockfd = socket(AF_INET, SOCK_STREAM, 0); +1. Select an action for the suggestion: - } - ``` + {% list tabs group=ide %} - Click **Tab** to accept the suggestion. + - Visual Studio Code {#vscode} - To start accepting the suggestion word by word, press **Ctrl** + **→** for Windows or Linux or **Command** + **→** for macOS. + * Click **Tab** to accept the suggestion. + * To start accepting the suggestion word by word, press **Ctrl** + **→** for Windows or Linux or **Command** + **→** for macOS. + * To discard the suggestion, press **Esc**. + * If there are multiple suggestions, you can switch between them using **Alt** + **[** and **Alt** + **]** for Windows or Linux or **Option** + **[** and **Option** + **]** for macOS. - To discard the suggestion, press **Esc**. + - JetBrains IDE {#jb} - If there are various suggestions, you can switch between them using **Alt** + **[** and **Alt** + **]** for Windows or Linux or **Option** + **[** and **Option** + **]** for macOS. + * Click **Tab** to accept the suggestion. + * To discard the suggestion, press **Esc**. -{% endlist %} + {% endlist %} You can also watch our {{ ca-name }} video tutorial [here](https://cloud.yandex.ru/services/code-assistant). ## Manage the plugin {#manage-plugin} -### Enable or disable {{ ca-name }} {#enable-disable-plugin} +### Enable or disable auto suggestions {#enable-disable-plugin} + +You can enable or disable auto suggestions only in Visual Studio Code. {% list tabs group=ide %} - Visual Studio Code {#vscode} - To enable or disable {{ ca-name }}, click ![image](../_assets/code-assistant/vsc-icon-small.svg) on the Visual Studio Code bottom panel. + 1. Click ![image](../_assets/code-assistant/vsc-icon-small.svg) in the Visual Studio Code bottom panel. + 1. In the list that opens, select ![image](../_assets/console-icons/triangle-right.svg) **Enable autotrigger** or ![image](../_assets/console-icons/stop.svg) **Disable autotrigger**. {% endlist %} @@ -138,6 +180,13 @@ You can also watch our {{ ca-name }} video tutorial [here](https://cloud.yandex. Download the [{{ ca-name }} current version]({{ link-ca-vscode }}) for Visual Studio Code and [install it](#install-plugin). +- JetBrains IDE {#jb} + + 1. Download the appropriate {{ ca-name }} plugin for your JetBrains IDE version: + * [2024.1]({{ link-ca-jb-2024-1 }}) + * [2024.2]({{ link-ca-jb-2024-2 }}) + 1. [Install the plugin](#install-plugin). + {% endlist %} ### Remove the plugin {#remove-plugin} @@ -149,6 +198,13 @@ You can also watch our {{ ca-name }} video tutorial [here](https://cloud.yandex. 1. Open the list of installed plugins by pressing **Ctrl** + **Shift** + **X** for Windows or Linux or **Command** + **Shift** + **X** for macOS. 1. In the {{ ca-full-name }} row, click ![image](../_assets/console-icons/gear.svg) and select **Uninstall**. +- JetBrains IDE {#jb} + + 1. Open settings by pressing **Ctrl** + **Alt** + **S** for Windows or Linux or **Command** + **,** for macOS. + 1. Go to the **Plugins** section and select the {{ ca-full-name }} plugin. + 1. In the plugin description section, click ![image](../_assets/console-icons/chevron-down.svg) and select **Uninstall**. + 1. Confirm deletion and click **OK**. + {% endlist %} ### See also {#see-also} diff --git a/en/code-assistant/toc.yaml b/en/code-assistant/toc.yaml index 44b60b51eed..11022fff654 100644 --- a/en/code-assistant/toc.yaml +++ b/en/code-assistant/toc.yaml @@ -5,14 +5,14 @@ items: - name: Getting started href: quickstart.md - name: Concepts - items: - - name: Overview - href: concepts/index.md - - name: Quotas and limits - href: concepts/limits.md + href: concepts/index.md + - name: Quotas and limits + href: concepts/limits.md - name: Access management href: security/index.md - name: Pricing policy href: pricing.md + - name: FAQ + href: qa.md base: en/code-assistant deepBase: 2 diff --git a/en/compute/_includes_service/create-instance-via-console-dsvm.md b/en/compute/_includes_service/create-instance-via-console-dsvm.md index 2cc8d392be2..fc04096bc85 100644 --- a/en/compute/_includes_service/create-instance-via-console-dsvm.md +++ b/en/compute/_includes_service/create-instance-via-console-dsvm.md @@ -4,49 +4,30 @@ Creating an instance from a public [DSVM](/marketplace/products/f2e4v304qn35mhil - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the folder to create the virtual machine in. - 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. - 1. Click **{{ ui-key.yacloud.compute.instances.button_create }}**. - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**: - * Enter a name and description for the VM. The naming requirements are as follows: + 1. In the [management console]({{ link-console-main }}), select the [folder](../../resource-manager/concepts/resources-hierarchy.md#folder) to create your VM in. + 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. + 1. In the left-hand panel, select ![image](../../_assets/console-icons/server.svg) **{{ ui-key.yacloud.compute.switch_instances }}**. + 1. Click **{{ ui-key.yacloud.compute.instances.button_create }}**. + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, go to the **{{ ui-key.yacloud.compute.instances.create.image_value_marketplace }}** tab and select the [DSVM](/marketplace/products/yc/dsvm) image. + 1. Under **{{ ui-key.yacloud.k8s.node-groups.create.section_allocation-policy }}**, select an [availability zone](../../overview/concepts/geo-scope.md) to place your VM in. + 1. (Optional) Configure the boot [disk](../concepts/disk.md) in the **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}** section: - {% include [name-format](../../_includes/name-format.md) %} - - {% include [name-fqdn](../../_includes/compute/name-fqdn.md) %} - - * Select an [availability zone](../../overview/concepts/geo-scope.md) to put your virtual machine in. - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, go to the **{{ ui-key.yacloud.compute.instances.create.image_value_marketplace }}** tab and select the [DSVM](/marketplace/products/yc/dsvm) image. - 1. (Optional) Under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}**, select the **{{ ui-key.yacloud.compute.instances.create.section_disk }}** tab and configure a boot disk: * Select the [disk type](../concepts/disk.md#disks_types). * Specify the required disk size. - 1. (Optional) Under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}**, select the **{{ ui-key.yacloud.compute.nfs.label_filesystems }}** tab and attach the [file storage](../concepts/filesystem.md). [Create](../operations/filesystem/create.md) the storages first. - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_platform }}**: - * Choose a [platform](../concepts/vm-platforms.md). - * Specify the [guaranteed share](../../compute/concepts/performance-levels.md) and the required number of vCPUs as well as the amount of RAM. - * Make your VM [preemptible](../concepts/preemptible-vm.md), if required. - * (Optional) Enable a [software-accelerated network](../concepts/software-accelerated-network.md). - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_network }}**: - * Enter a subnet ID or select a [cloud network](../../vpc/concepts/network.md#network) from the list. You can select the search scope: in the current folder or in all folders. If you do not have a network, click ![image](../../_assets/console-icons/plus.svg) **{{ ui-key.yacloud.component.vpc.network-select.button_create-network }}** to create one: - * In the window that opens, enter the folder to host the new network, as well as the network name. - * In the **{{ ui-key.yacloud.vpc.networks.create.field_advanced }}** field, enable **{{ ui-key.yacloud.vpc.networks.create.field_is-default }}** (each network must have at least one [subnet](../../vpc/concepts/network.md#subnet)). - * Click **{{ ui-key.yacloud.vpc.networks.create.button_create }}**. - * In the **{{ ui-key.yacloud.component.compute.network-select.field_external }}** field, choose a method for assigning an IP address: - * `{{ ui-key.yacloud.component.compute.network-select.switch_auto }}`: Assign a random IP address from the {{ yandex-cloud }} IP pool. - * `{{ ui-key.yacloud.component.compute.network-select.switch_list }}`: Select a public IP address from the list of previously reserved static addresses. For more information, see [{#T}](../../vpc/operations/set-static-ip.md). - * `{{ ui-key.yacloud.component.compute.network-select.switch_none }}`: Do not assign a public IP address. - * (Optional) Enable [DDoS protection](../../vpc/ddos-protection/index.md) in the **{{ ui-key.yacloud.component.compute.network-select.field_advanced }}** field, if required. - * Select the [appropriate security groups](../../vpc/concepts/security-groups.md) in the **{{ ui-key.yacloud.component.compute.network-select.field_security-groups }}** field. - - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_access }}**, specify the data required to access the VM: - * (Optional) Select or create a [service account](../../iam/concepts/index.md#sa). With a service account, you can flexibly configure access rights for your resources. - * Enter the username in the **{{ ui-key.yacloud.compute.instances.create.field_user }}** field. - * In the **{{ ui-key.yacloud.compute.instances.create.field_key }}** field, paste the contents of the [public key](../operations/vm-connect/ssh.md#creating-ssh-keys) file. - * (Optional) Enable access to the [serial console](../operations/index.md#serial-console) in the **{{ ui-key.yacloud.compute.instances.create.field_access-advanced }}** field, if required. - - {% include [vm-connect-linux](../../_includes/vm-connect-linux.md) %} - - 1. Click **{{ ui-key.yacloud.compute.instances.create.button_create }}**. - - The virtual machine will appear in the list. When a VM is created, it is assigned an [IP address](../../vpc/concepts/address) and [host name](../../vpc/concepts/address.md#fqdn) (FQDN). + + 1. {% include [section-storages-filesystem](../../_includes/compute/create/section-storages-filesystem.md) %} + 1. {% include [section-platform](../../_includes/compute/create/section-platform.md) %} + 1. {% include [network-settings](../../_includes/compute/create/section-network.md) %} + 1. {% include [section-access](../../_includes/compute/create/section-access.md) %} + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**, specify the VM name: + + {% include [name-format](../../_includes/name-format.md) %} + + {% include [name-fqdn](../../_includes/compute/name-fqdn.md) %} + + 1. {% include [section-additional](../../_includes/compute/create/section-additional.md) %} + 1. Click **{{ ui-key.yacloud.compute.instances.create.button_create }}**. + + The virtual machine will appear in the list. When a VM is created, it is assigned an [IP address](../../vpc/concepts/address) and [host name](../../vpc/concepts/address.md#fqdn) (FQDN). {% endlist %} diff --git a/en/compute/_includes_service/create-instance-via-console-linux.md b/en/compute/_includes_service/create-instance-via-console-linux.md index 1cbb87dd2d5..22f575135d9 100644 --- a/en/compute/_includes_service/create-instance-via-console-linux.md +++ b/en/compute/_includes_service/create-instance-via-console-linux.md @@ -1,77 +1,32 @@ 1. In the [management console]({{ link-console-main }}), select the [folder](../../resource-manager/concepts/resources-hierarchy.md#folder) to create your VM in. 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. +1. In the left-hand panel, select ![image](../../_assets/console-icons/server.svg) **{{ ui-key.yacloud.compute.switch_instances }}**. 1. Click **{{ ui-key.yacloud.compute.instances.button_create }}**. -1. Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**: - * Enter a name and description for the VM. The naming requirements are as follows: - - {% include [name-format](../../_includes/name-format.md) %} - - {% include [name-fqdn](../../_includes/compute/name-fqdn.md) %} - - * Select an [availability zone](../../overview/concepts/geo-scope.md) to place your VM in. 1. Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, select an [image](../concepts/image.md) and a Linux-based OS version. -1. (Optional) Under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}**, select the **{{ ui-key.yacloud.compute.instances.create.section_disk }}** tab and configure a boot [disk](../concepts/disk.md): - * Select the [disk type](../concepts/disk.md#disks_types). - * Specify the required disk size. - - - * {% include [encryption-section-boot](../../_includes/compute/encryption-section-boot.md) %} - - - If you want to create a VM from an existing disk, under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}**, [add a disk](../operations/vm-create/create-from-disks.md): - * Click **{{ ui-key.yacloud.compute.component.instance-storage-dialog.button_add-disk }}**. - * Enter the disk name. - * Select the [disk type](../concepts/disk.md#disks_types). - * Specify the required block size. - * Specify the required disk size. - - - * {% include [encryption-section-secondary](../../_includes/compute/encryption-section-secondary.md) %} - - - * (Optional) Enable the **{{ ui-key.yacloud.compute.field_additional }}** option in the **{{ ui-key.yacloud.compute.field_disk-autodelete }}** field if you need to automatically delete the disk when deleting the VM it will be attached to. - * In the **{{ ui-key.yacloud.compute.instances.create-disk.field_source }}** field, select `{{ ui-key.yacloud.compute.instances.create-disk.value_source-disk }}`. - * Click **{{ ui-key.yacloud.compute.instances.create-disk.button_create }}**. - - -1. (Optional) Under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}**, select the **{{ ui-key.yacloud.compute.nfs.label_filesystems }}** tab and attach the [file storage](../concepts/filesystem.md): - * Click **{{ ui-key.yacloud.compute.nfs.button_attach-filesystem-to-the-instance }}**. - * In the window that opens, specify the file storage. - * Enter the device name. - * Click **{{ ui-key.yacloud.compute.nfs.button_attach-filesystem-to-the-instance }}**. - - -1. Under **{{ ui-key.yacloud.compute.instances.create.section_platform }}**: - * Choose a [platform](../concepts/vm-platforms.md). - * Specify the [guaranteed share](../../compute/concepts/performance-levels.md) and the required number of vCPUs, as well as the amount of RAM. - * If required, make your VM [preemptible](../concepts/preemptible-vm.md). - * (Optional) Enable a [software-accelerated network](../concepts/software-accelerated-network.md). - -1. Under **{{ ui-key.yacloud.compute.instances.create.section_network }}**: - - {% include [network-settings](../../_includes/compute/network-settings.md) %} - - -1. {% include [backup-info](../../_includes/compute/backup-info.md) %} + {% include [change-custom-disk-settings-image](../../_includes/compute/create/change-custom-disk-settings-image.md) %} -1. Under **{{ ui-key.yacloud.compute.instances.create.section_access }}**, specify the information required to access the instance: - * (Optional) Select or create a [service account](../../iam/concepts/users/service-accounts.md). With a service account, you can flexibly configure access rights for your resources. - * Enter the username in the **{{ ui-key.yacloud.compute.instances.create.field_user }}** field. +1. Under **{{ ui-key.yacloud.k8s.node-groups.create.section_allocation-policy }}**, select an [availability zone](../../overview/concepts/geo-scope.md) to place your VM in. +1. (Optional) Configure the boot [disk](../concepts/disk.md) in the **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}** section: - {% note alert %} + * Select the [disk type](../concepts/disk.md#disks_types). + * Specify the required disk size. + * {% include [encryption-section-secondary](../../_includes/compute/encryption-section-secondary.md) %} - Do not use the `root` username or other names reserved by the OS. To perform operations that require superuser permissions, use the `sudo` command. + {% include [change-custom-disk-settings-storages](../../_includes/compute/create/change-custom-disk-settings-storages.md) %} - {% endnote %} +1. {% include [section-storages-secondary-disk](../../_includes/compute/create/section-storages-secondary-disk.md) %} +1. {% include [section-storages-filesystem](../../_includes/compute/create/section-storages-filesystem.md) %} +1. {% include [section-platform](../../_includes/compute/create/section-platform.md) %} +1. {% include [network-settings](../../_includes/compute/create/section-network.md) %} +1. {% include [section-access](../../_includes/compute/create/section-access.md) %} +1. Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**, specify the VM name: - * In the **{{ ui-key.yacloud.compute.instances.create.field_key }}** field, paste the contents of the [public key](../operations/vm-connect/ssh.md#creating-ssh-keys) file. You need to [create](../../compute/operations/vm-connect/ssh.md#creating-ssh-keys) a key pair for the SSH connection yourself. - * If required, grant access to the [serial console](../operations/serial-console/index.md). - * If you want to add several users with SSH keys to the VM at the same time, [specify](../concepts/vm-metadata.md#how-to-send-metadata) these users' data under **{{ ui-key.yacloud.common.metadata }}**. You can also use metadata to [install additional software](../operations/vm-create/create-with-cloud-init-scripts.md) on a VM when creating it. + {% include [name-format](../../_includes/name-format.md) %} - {% include [vm-connect-linux](../../_includes/vm-connect-linux.md) %} + {% include [name-fqdn](../../_includes/compute/name-fqdn.md) %} -1. (Optional) Under **{{ ui-key.yacloud.compute.instances.create.section_placement }}**, select a VM [placement group](../concepts/placement-groups.md). +1. {% include [section-additional](../../_includes/compute/create/section-additional.md) %} 1. Click **{{ ui-key.yacloud.compute.instances.create.button_create }}**. The VM appears in the list. Once created, the VM is assigned an [IP address](../../vpc/concepts/address.md) and a [host name](../../vpc/concepts/address.md#fqdn) (FQDN). \ No newline at end of file diff --git a/en/compute/api-ref/Disk/create.md b/en/compute/api-ref/Disk/create.md index d562dfac9e7..49cbebcf7da 100644 --- a/en/compute/api-ref/Disk/create.md +++ b/en/compute/api-ref/Disk/create.md @@ -46,7 +46,8 @@ POST https://compute.{{ api-host }}/compute/v1/disks }, "generation2Features": "object" // end of the list of possible fields - } + }, + "kmsKeyId": "string" } ``` @@ -101,6 +102,9 @@ List of IDs of the snapshot schedules to attach the disk to. || Specify the overrides to hardware_generation of a source disk, image or snapshot, or to the default values if the source does not define it. || +|| kmsKeyId | **string** + +ID of KMS key for disk encryption. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} @@ -200,6 +204,10 @@ Allows switching to PCI_TOPOLOGY_V2 and back. }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -381,6 +389,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy2} @@ -422,4 +433,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/Disk/get.md b/en/compute/api-ref/Disk/get.md index 4ad8c8998f4..54b052faf5b 100644 --- a/en/compute/api-ref/Disk/get.md +++ b/en/compute/api-ref/Disk/get.md @@ -63,6 +63,10 @@ To get the disk ID use a [DiskService.List](/docs/compute/api-ref/Disk/list#List }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ``` @@ -145,6 +149,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} @@ -186,4 +193,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/Disk/list.md b/en/compute/api-ref/Disk/list.md index 0a3f1ee43a2..3b2aceaa927 100644 --- a/en/compute/api-ref/Disk/list.md +++ b/en/compute/api-ref/Disk/list.md @@ -88,6 +88,10 @@ The default sorting order is ascending || }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ], @@ -190,6 +194,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} @@ -231,4 +238,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/Disk/move.md b/en/compute/api-ref/Disk/move.md index 571a8cd358b..468880916b7 100644 --- a/en/compute/api-ref/Disk/move.md +++ b/en/compute/api-ref/Disk/move.md @@ -99,6 +99,10 @@ To get the folder ID, make a [yandex.cloud.resourcemanager.v1.FolderService.List }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -286,6 +290,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} @@ -327,4 +334,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/Disk/relocate.md b/en/compute/api-ref/Disk/relocate.md index 642782ac0c6..01c8c9d94c8 100644 --- a/en/compute/api-ref/Disk/relocate.md +++ b/en/compute/api-ref/Disk/relocate.md @@ -119,6 +119,10 @@ Placement group ID. || }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -306,6 +310,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy2} @@ -347,4 +354,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/Disk/update.md b/en/compute/api-ref/Disk/update.md index d220250e11f..c07900e47dd 100644 --- a/en/compute/api-ref/Disk/update.md +++ b/en/compute/api-ref/Disk/update.md @@ -136,6 +136,10 @@ Placement group ID. || }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -317,6 +321,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy2} @@ -358,4 +365,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/DiskPlacementGroup/listDisks.md b/en/compute/api-ref/DiskPlacementGroup/listDisks.md index 12c13825efc..a0d8e207867 100644 --- a/en/compute/api-ref/DiskPlacementGroup/listDisks.md +++ b/en/compute/api-ref/DiskPlacementGroup/listDisks.md @@ -80,6 +80,10 @@ returned by a previous list request. || }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ], @@ -182,6 +186,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} @@ -223,4 +230,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/Image/create.md b/en/compute/api-ref/Image/create.md index 2ea30703a6d..d84d68e61e9 100644 --- a/en/compute/api-ref/Image/create.md +++ b/en/compute/api-ref/Image/create.md @@ -214,6 +214,10 @@ Allows switching to PCI_TOPOLOGY_V2 and back. }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -386,6 +390,9 @@ When true, indicates there is an image pool for fast creation disks from the ima If specified, forces the same HardwareGeneration features to be applied to the instance created using this image as a source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## Os {#yandex.cloud.compute.v1.Os2} @@ -432,4 +439,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/Image/get.md b/en/compute/api-ref/Image/get.md index 9807b2ed8a1..ecbdc4a07ab 100644 --- a/en/compute/api-ref/Image/get.md +++ b/en/compute/api-ref/Image/get.md @@ -55,6 +55,10 @@ To get the image ID, use a [ImageService.List](/docs/compute/api-ref/Image/list# }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ``` @@ -128,6 +132,9 @@ When true, indicates there is an image pool for fast creation disks from the ima If specified, forces the same HardwareGeneration features to be applied to the instance created using this image as a source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## Os {#yandex.cloud.compute.v1.Os} @@ -174,4 +181,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/Image/getLatestByFamily.md b/en/compute/api-ref/Image/getLatestByFamily.md index 60a8b5a449a..ee1c4659591 100644 --- a/en/compute/api-ref/Image/getLatestByFamily.md +++ b/en/compute/api-ref/Image/getLatestByFamily.md @@ -56,6 +56,10 @@ Name of the image family to search for. || }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ``` @@ -129,6 +133,9 @@ When true, indicates there is an image pool for fast creation disks from the ima If specified, forces the same HardwareGeneration features to be applied to the instance created using this image as a source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## Os {#yandex.cloud.compute.v1.Os} @@ -175,4 +182,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/Image/list.md b/en/compute/api-ref/Image/list.md index 74aeba77771..7891c5785b6 100644 --- a/en/compute/api-ref/Image/list.md +++ b/en/compute/api-ref/Image/list.md @@ -80,6 +80,10 @@ The default sorting order is ascending || }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ], @@ -173,6 +177,9 @@ When true, indicates there is an image pool for fast creation disks from the ima If specified, forces the same HardwareGeneration features to be applied to the instance created using this image as a source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## Os {#yandex.cloud.compute.v1.Os} @@ -219,4 +226,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/Image/update.md b/en/compute/api-ref/Image/update.md index 62c81442cde..f06c3ed78c4 100644 --- a/en/compute/api-ref/Image/update.md +++ b/en/compute/api-ref/Image/update.md @@ -112,6 +112,10 @@ Existing set of `labels` is completely replaced by the provided set. || }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -284,6 +288,9 @@ When true, indicates there is an image pool for fast creation disks from the ima If specified, forces the same HardwareGeneration features to be applied to the instance created using this image as a source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## Os {#yandex.cloud.compute.v1.Os} @@ -330,4 +337,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/Instance/attachDisk.md b/en/compute/api-ref/Instance/attachDisk.md index ddbd1205a4c..f969024f1d3 100644 --- a/en/compute/api-ref/Instance/attachDisk.md +++ b/en/compute/api-ref/Instance/attachDisk.md @@ -37,15 +37,16 @@ To get the instance ID, use a [InstanceService.List](/docs/compute/api-ref/Insta "description": "string", "typeId": "string", "size": "string", - "blockSize": "string", + // Includes only one of the fields `imageId`, `snapshotId` + "imageId": "string", + "snapshotId": "string", + // end of the list of possible fields "diskPlacementPolicy": { "placementGroupId": "string", "placementGroupPartition": "string" }, - // Includes only one of the fields `imageId`, `snapshotId` - "imageId": "string", - "snapshotId": "string" - // end of the list of possible fields + "blockSize": "string", + "kmsKeyId": "string" }, "diskId": "string" // end of the list of possible fields @@ -110,12 +111,6 @@ To get a list of available disk types, use the [yandex.cloud.compute.v1.DiskType || size | **string** (int64) Required field. Size of the disk, specified in bytes. || -|| blockSize | **string** (int64) - -Block size of the disk, specified in bytes. The default is 4096. || -|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** - -Placement policy configuration. || || imageId | **string** ID of the image to create the disk from. @@ -126,6 +121,15 @@ Includes only one of the fields `imageId`, `snapshotId`. || ID of the snapshot to restore the disk from. Includes only one of the fields `imageId`, `snapshotId`. || +|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** + +Placement policy configuration. || +|| blockSize | **string** (int64) + +Block size of the disk, specified in bytes. The default is 4096. || +|| kmsKeyId | **string** + +ID of KMS key for disk encryption || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} diff --git a/en/compute/api-ref/Instance/create.md b/en/compute/api-ref/Instance/create.md index 20c3fe5f4c4..d8fdda4b7d8 100644 --- a/en/compute/api-ref/Instance/create.md +++ b/en/compute/api-ref/Instance/create.md @@ -47,15 +47,16 @@ POST https://compute.{{ api-host }}/compute/v1/instances "description": "string", "typeId": "string", "size": "string", - "blockSize": "string", + // Includes only one of the fields `imageId`, `snapshotId` + "imageId": "string", + "snapshotId": "string", + // end of the list of possible fields "diskPlacementPolicy": { "placementGroupId": "string", "placementGroupPartition": "string" }, - // Includes only one of the fields `imageId`, `snapshotId` - "imageId": "string", - "snapshotId": "string" - // end of the list of possible fields + "blockSize": "string", + "kmsKeyId": "string" }, "diskId": "string" // end of the list of possible fields @@ -71,15 +72,16 @@ POST https://compute.{{ api-host }}/compute/v1/instances "description": "string", "typeId": "string", "size": "string", - "blockSize": "string", + // Includes only one of the fields `imageId`, `snapshotId` + "imageId": "string", + "snapshotId": "string", + // end of the list of possible fields "diskPlacementPolicy": { "placementGroupId": "string", "placementGroupPartition": "string" }, - // Includes only one of the fields `imageId`, `snapshotId` - "imageId": "string", - "snapshotId": "string" - // end of the list of possible fields + "blockSize": "string", + "kmsKeyId": "string" }, "diskId": "string" // end of the list of possible fields @@ -393,12 +395,6 @@ To get a list of available disk types, use the [yandex.cloud.compute.v1.DiskType || size | **string** (int64) Required field. Size of the disk, specified in bytes. || -|| blockSize | **string** (int64) - -Block size of the disk, specified in bytes. The default is 4096. || -|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** - -Placement policy configuration. || || imageId | **string** ID of the image to create the disk from. @@ -409,6 +405,15 @@ Includes only one of the fields `imageId`, `snapshotId`. || ID of the snapshot to restore the disk from. Includes only one of the fields `imageId`, `snapshotId`. || +|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** + +Placement policy configuration. || +|| blockSize | **string** (int64) + +Block size of the disk, specified in bytes. The default is 4096. || +|| kmsKeyId | **string** + +ID of KMS key for disk encryption || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} diff --git a/en/compute/api-ref/Instance/index.md b/en/compute/api-ref/Instance/index.md index 608d02ce8e8..c38bc32621f 100644 --- a/en/compute/api-ref/Instance/index.md +++ b/en/compute/api-ref/Instance/index.md @@ -16,7 +16,7 @@ A set of methods for managing Instance resources. || [Create](create.md) | Creates an instance in the specified folder. || || [Update](update.md) | Updates the specified instance. || || [Delete](delete.md) | Deletes the specified instance. || -|| [UpdateMetadata](updateMetadata.md) | Updates the metadata of the specified instance. || +|| [UpdateMetadata](updateMetadata.md) | Updates the metadata of the specified instance. For more information on metadata, see [VM metadata](/docs/compute/concepts/vm-metadata). || || [GetSerialPortOutput](getSerialPortOutput.md) | Returns the serial port output of the specified Instance resource. || || [Stop](stop.md) | Stops the running instance. || || [Start](start.md) | Starts the stopped instance. || diff --git a/en/compute/api-ref/Instance/updateMetadata.md b/en/compute/api-ref/Instance/updateMetadata.md index c07101c0899..58e9f7be1c4 100644 --- a/en/compute/api-ref/Instance/updateMetadata.md +++ b/en/compute/api-ref/Instance/updateMetadata.md @@ -5,7 +5,7 @@ sourcePath: en/_api-ref/compute/v1/api-ref/Instance/updateMetadata.md # Compute Cloud API, REST: Instance.UpdateMetadata {#UpdateMetadata} -Updates the metadata of the specified instance. +Updates the metadata of the specified instance. For more information on metadata, see [VM metadata](/docs/compute/concepts/vm-metadata). ## HTTP request diff --git a/en/compute/api-ref/Snapshot/create.md b/en/compute/api-ref/Snapshot/create.md index 3ed1eaefe68..469bf549b3b 100644 --- a/en/compute/api-ref/Snapshot/create.md +++ b/en/compute/api-ref/Snapshot/create.md @@ -134,6 +134,10 @@ Allows switching to PCI_TOPOLOGY_V2 and back. }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -299,6 +303,9 @@ ID of the source disk used to create this snapshot. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this snapshot as source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## HardwareGeneration {#yandex.cloud.compute.v1.HardwareGeneration2} @@ -330,4 +337,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/Snapshot/get.md b/en/compute/api-ref/Snapshot/get.md index d1decb6c467..5c2804a96c9 100644 --- a/en/compute/api-ref/Snapshot/get.md +++ b/en/compute/api-ref/Snapshot/get.md @@ -51,6 +51,10 @@ To get the snapshot ID, use a [SnapshotService.List](/docs/compute/api-ref/Snaps }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ``` @@ -114,6 +118,9 @@ ID of the source disk used to create this snapshot. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this snapshot as source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## HardwareGeneration {#yandex.cloud.compute.v1.HardwareGeneration} @@ -145,4 +152,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/Snapshot/list.md b/en/compute/api-ref/Snapshot/list.md index 1803f26a9e8..6d9d049c2f6 100644 --- a/en/compute/api-ref/Snapshot/list.md +++ b/en/compute/api-ref/Snapshot/list.md @@ -76,6 +76,10 @@ The default sorting order is ascending || }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ], @@ -159,6 +163,9 @@ ID of the source disk used to create this snapshot. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this snapshot as source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## HardwareGeneration {#yandex.cloud.compute.v1.HardwareGeneration} @@ -190,4 +197,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/Snapshot/update.md b/en/compute/api-ref/Snapshot/update.md index 3a4e46703c7..6e87efc6cd3 100644 --- a/en/compute/api-ref/Snapshot/update.md +++ b/en/compute/api-ref/Snapshot/update.md @@ -105,6 +105,10 @@ Existing set of `labels` is completely replaced by the provided set. || }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -267,6 +271,9 @@ ID of the source disk used to create this snapshot. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this snapshot as source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## HardwareGeneration {#yandex.cloud.compute.v1.HardwareGeneration} @@ -298,4 +305,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/SnapshotSchedule/listDisks.md b/en/compute/api-ref/SnapshotSchedule/listDisks.md index 1eb64ca4562..c02dd2869d9 100644 --- a/en/compute/api-ref/SnapshotSchedule/listDisks.md +++ b/en/compute/api-ref/SnapshotSchedule/listDisks.md @@ -81,6 +81,10 @@ Page token. To get the next page of results, set `pageToken` to the }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ], @@ -182,6 +186,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} @@ -223,4 +230,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/SnapshotSchedule/listSnapshots.md b/en/compute/api-ref/SnapshotSchedule/listSnapshots.md index 2d6ff57af10..47bd10864e3 100644 --- a/en/compute/api-ref/SnapshotSchedule/listSnapshots.md +++ b/en/compute/api-ref/SnapshotSchedule/listSnapshots.md @@ -69,6 +69,10 @@ Page token. To get the next page of results, set `pageToken` to the }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ], @@ -151,6 +155,9 @@ ID of the source disk used to create this snapshot. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this snapshot as source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## HardwareGeneration {#yandex.cloud.compute.v1.HardwareGeneration} @@ -182,4 +189,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/grpc/Disk/create.md b/en/compute/api-ref/grpc/Disk/create.md index c9a78d8adf6..3215eeac205 100644 --- a/en/compute/api-ref/grpc/Disk/create.md +++ b/en/compute/api-ref/grpc/Disk/create.md @@ -44,7 +44,8 @@ Method starts an asynchronous operation that can be cancelled while it is in pro }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields - } + }, + "kmsKeyId": "string" } ``` @@ -99,6 +100,9 @@ List of IDs of the snapshot schedules to attach the disk to. || Specify the overrides to hardware_generation of a source disk, image or snapshot, or to the default values if the source does not define it. || +|| kmsKeyId | **string** + +ID of KMS key for disk encryption. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} @@ -200,6 +204,10 @@ and UEFI boot (with UEFI related features). }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -343,6 +351,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy2} @@ -394,4 +405,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/grpc/Disk/get.md b/en/compute/api-ref/grpc/Disk/get.md index fba864cf277..288245c0fd4 100644 --- a/en/compute/api-ref/grpc/Disk/get.md +++ b/en/compute/api-ref/grpc/Disk/get.md @@ -65,6 +65,10 @@ To get the disk ID use a [DiskService.List](/docs/compute/api-ref/grpc/Disk/list }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ``` @@ -140,6 +144,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} @@ -191,4 +198,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/grpc/Disk/list.md b/en/compute/api-ref/grpc/Disk/list.md index 8c826f86312..2a2842ba62e 100644 --- a/en/compute/api-ref/grpc/Disk/list.md +++ b/en/compute/api-ref/grpc/Disk/list.md @@ -94,6 +94,10 @@ The default sorting order is ascending || }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ], @@ -189,6 +193,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} @@ -240,4 +247,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/grpc/Disk/move.md b/en/compute/api-ref/grpc/Disk/move.md index 17b62ce4bcd..2039baa9c8d 100644 --- a/en/compute/api-ref/grpc/Disk/move.md +++ b/en/compute/api-ref/grpc/Disk/move.md @@ -84,6 +84,10 @@ To get the folder ID, make a [yandex.cloud.resourcemanager.v1.FolderService.List }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -233,6 +237,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} @@ -284,4 +291,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/grpc/Disk/relocate.md b/en/compute/api-ref/grpc/Disk/relocate.md index 82f8a5f3aa2..8076865af38 100644 --- a/en/compute/api-ref/grpc/Disk/relocate.md +++ b/en/compute/api-ref/grpc/Disk/relocate.md @@ -104,6 +104,10 @@ Placement group ID. || }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -253,6 +257,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy2} @@ -304,4 +311,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/grpc/Disk/update.md b/en/compute/api-ref/grpc/Disk/update.md index c81aa271447..843d4bdb474 100644 --- a/en/compute/api-ref/grpc/Disk/update.md +++ b/en/compute/api-ref/grpc/Disk/update.md @@ -114,6 +114,10 @@ Placement group ID. || }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -257,6 +261,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy2} @@ -308,4 +315,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/grpc/DiskPlacementGroup/listDisks.md b/en/compute/api-ref/grpc/DiskPlacementGroup/listDisks.md index e0480bef255..602ac51b23a 100644 --- a/en/compute/api-ref/grpc/DiskPlacementGroup/listDisks.md +++ b/en/compute/api-ref/grpc/DiskPlacementGroup/listDisks.md @@ -78,6 +78,10 @@ returned by a previous list request. || }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ], @@ -173,6 +177,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} @@ -224,4 +231,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/grpc/Image/create.md b/en/compute/api-ref/grpc/Image/create.md index 9d889273d41..1fd1da54673 100644 --- a/en/compute/api-ref/grpc/Image/create.md +++ b/en/compute/api-ref/grpc/Image/create.md @@ -214,6 +214,10 @@ and UEFI boot (with UEFI related features). }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -348,6 +352,9 @@ When true, indicates there is an image pool for fast creation disks from the ima If specified, forces the same HardwareGeneration features to be applied to the instance created using this image as a source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## Os {#yandex.cloud.compute.v1.Os2} @@ -404,4 +411,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/grpc/Image/get.md b/en/compute/api-ref/grpc/Image/get.md index 55b19a1a9e4..edf491e1d2d 100644 --- a/en/compute/api-ref/grpc/Image/get.md +++ b/en/compute/api-ref/grpc/Image/get.md @@ -57,6 +57,10 @@ To get the image ID, use a [ImageService.List](/docs/compute/api-ref/grpc/Image/ }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ``` @@ -123,6 +127,9 @@ When true, indicates there is an image pool for fast creation disks from the ima If specified, forces the same HardwareGeneration features to be applied to the instance created using this image as a source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## Os {#yandex.cloud.compute.v1.Os} @@ -179,4 +186,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/grpc/Image/getLatestByFamily.md b/en/compute/api-ref/grpc/Image/getLatestByFamily.md index 302c97a109b..7b9ee390de8 100644 --- a/en/compute/api-ref/grpc/Image/getLatestByFamily.md +++ b/en/compute/api-ref/grpc/Image/getLatestByFamily.md @@ -59,6 +59,10 @@ Name of the image family to search for. || }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ``` @@ -125,6 +129,9 @@ When true, indicates there is an image pool for fast creation disks from the ima If specified, forces the same HardwareGeneration features to be applied to the instance created using this image as a source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## Os {#yandex.cloud.compute.v1.Os} @@ -181,4 +188,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/grpc/Image/list.md b/en/compute/api-ref/grpc/Image/list.md index 15a51f16889..b7e73f9d2eb 100644 --- a/en/compute/api-ref/grpc/Image/list.md +++ b/en/compute/api-ref/grpc/Image/list.md @@ -86,6 +86,10 @@ The default sorting order is ascending || }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ], @@ -172,6 +176,9 @@ When true, indicates there is an image pool for fast creation disks from the ima If specified, forces the same HardwareGeneration features to be applied to the instance created using this image as a source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## Os {#yandex.cloud.compute.v1.Os} @@ -228,4 +235,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/grpc/Image/update.md b/en/compute/api-ref/grpc/Image/update.md index 06e2e268e0a..411aeea5281 100644 --- a/en/compute/api-ref/grpc/Image/update.md +++ b/en/compute/api-ref/grpc/Image/update.md @@ -90,6 +90,10 @@ Existing set of `labels` is completely replaced by the provided set. || }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -224,6 +228,9 @@ When true, indicates there is an image pool for fast creation disks from the ima If specified, forces the same HardwareGeneration features to be applied to the instance created using this image as a source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## Os {#yandex.cloud.compute.v1.Os} @@ -280,4 +287,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/grpc/Instance/attachDisk.md b/en/compute/api-ref/grpc/Instance/attachDisk.md index 384e3bd395e..3b0a0e4de17 100644 --- a/en/compute/api-ref/grpc/Instance/attachDisk.md +++ b/en/compute/api-ref/grpc/Instance/attachDisk.md @@ -26,15 +26,16 @@ Attaches the disk to the instance. "description": "string", "typeId": "string", "size": "int64", - "blockSize": "int64", + // Includes only one of the fields `imageId`, `snapshotId` + "imageId": "string", + "snapshotId": "string", + // end of the list of possible fields "diskPlacementPolicy": { "placementGroupId": "string", "placementGroupPartition": "int64" }, - // Includes only one of the fields `imageId`, `snapshotId` - "imageId": "string", - "snapshotId": "string" - // end of the list of possible fields + "blockSize": "int64", + "kmsKeyId": "string" }, "diskId": "string" // end of the list of possible fields @@ -103,12 +104,6 @@ To get a list of available disk types, use the [yandex.cloud.compute.v1.DiskType || size | **int64** Required field. Size of the disk, specified in bytes. || -|| blockSize | **int64** - -Block size of the disk, specified in bytes. The default is 4096. || -|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** - -Placement policy configuration. || || imageId | **string** ID of the image to create the disk from. @@ -119,6 +114,15 @@ Includes only one of the fields `imageId`, `snapshotId`. || ID of the snapshot to restore the disk from. Includes only one of the fields `imageId`, `snapshotId`. || +|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** + +Placement policy configuration. || +|| blockSize | **int64** + +Block size of the disk, specified in bytes. The default is 4096. || +|| kmsKeyId | **string** + +ID of KMS key for disk encryption || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} diff --git a/en/compute/api-ref/grpc/Instance/create.md b/en/compute/api-ref/grpc/Instance/create.md index 36888b1e7c9..f365a4c7a42 100644 --- a/en/compute/api-ref/grpc/Instance/create.md +++ b/en/compute/api-ref/grpc/Instance/create.md @@ -45,15 +45,16 @@ Method starts an asynchronous operation that can be cancelled while it is in pro "description": "string", "typeId": "string", "size": "int64", - "blockSize": "int64", + // Includes only one of the fields `imageId`, `snapshotId` + "imageId": "string", + "snapshotId": "string", + // end of the list of possible fields "diskPlacementPolicy": { "placementGroupId": "string", "placementGroupPartition": "int64" }, - // Includes only one of the fields `imageId`, `snapshotId` - "imageId": "string", - "snapshotId": "string" - // end of the list of possible fields + "blockSize": "int64", + "kmsKeyId": "string" }, "diskId": "string" // end of the list of possible fields @@ -69,15 +70,16 @@ Method starts an asynchronous operation that can be cancelled while it is in pro "description": "string", "typeId": "string", "size": "int64", - "blockSize": "int64", + // Includes only one of the fields `imageId`, `snapshotId` + "imageId": "string", + "snapshotId": "string", + // end of the list of possible fields "diskPlacementPolicy": { "placementGroupId": "string", "placementGroupPartition": "int64" }, - // Includes only one of the fields `imageId`, `snapshotId` - "imageId": "string", - "snapshotId": "string" - // end of the list of possible fields + "blockSize": "int64", + "kmsKeyId": "string" }, "diskId": "string" // end of the list of possible fields @@ -391,12 +393,6 @@ To get a list of available disk types, use the [yandex.cloud.compute.v1.DiskType || size | **int64** Required field. Size of the disk, specified in bytes. || -|| blockSize | **int64** - -Block size of the disk, specified in bytes. The default is 4096. || -|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** - -Placement policy configuration. || || imageId | **string** ID of the image to create the disk from. @@ -407,6 +403,15 @@ Includes only one of the fields `imageId`, `snapshotId`. || ID of the snapshot to restore the disk from. Includes only one of the fields `imageId`, `snapshotId`. || +|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** + +Placement policy configuration. || +|| blockSize | **int64** + +Block size of the disk, specified in bytes. The default is 4096. || +|| kmsKeyId | **string** + +ID of KMS key for disk encryption || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} diff --git a/en/compute/api-ref/grpc/Instance/index.md b/en/compute/api-ref/grpc/Instance/index.md index f2359dcebcd..27c436945da 100644 --- a/en/compute/api-ref/grpc/Instance/index.md +++ b/en/compute/api-ref/grpc/Instance/index.md @@ -16,7 +16,7 @@ A set of methods for managing Instance resources. || [Create](create.md) | Creates an instance in the specified folder. || || [Update](update.md) | Updates the specified instance. || || [Delete](delete.md) | Deletes the specified instance. || -|| [UpdateMetadata](updateMetadata.md) | Updates the metadata of the specified instance. || +|| [UpdateMetadata](updateMetadata.md) | Updates the metadata of the specified instance. For more information on metadata, see [VM metadata](/docs/compute/concepts/vm-metadata). || || [GetSerialPortOutput](getSerialPortOutput.md) | Returns the serial port output of the specified Instance resource. || || [Stop](stop.md) | Stops the running instance. || || [Start](start.md) | Starts the stopped instance. || diff --git a/en/compute/api-ref/grpc/Instance/updateMetadata.md b/en/compute/api-ref/grpc/Instance/updateMetadata.md index 04cae171e03..15a642fea61 100644 --- a/en/compute/api-ref/grpc/Instance/updateMetadata.md +++ b/en/compute/api-ref/grpc/Instance/updateMetadata.md @@ -5,7 +5,7 @@ sourcePath: en/_api-ref-grpc/compute/v1/api-ref/grpc/Instance/updateMetadata.md # Compute Cloud API, gRPC: InstanceService.UpdateMetadata {#UpdateMetadata} -Updates the metadata of the specified instance. +Updates the metadata of the specified instance. For more information on metadata, see [VM metadata](/docs/compute/concepts/vm-metadata). ## gRPC request diff --git a/en/compute/api-ref/grpc/Snapshot/create.md b/en/compute/api-ref/grpc/Snapshot/create.md index dd743dcdbff..3866d7c0721 100644 --- a/en/compute/api-ref/grpc/Snapshot/create.md +++ b/en/compute/api-ref/grpc/Snapshot/create.md @@ -134,6 +134,10 @@ and UEFI boot (with UEFI related features). }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -261,6 +265,9 @@ ID of the source disk used to create this snapshot. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this snapshot as source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## HardwareGeneration {#yandex.cloud.compute.v1.HardwareGeneration2} @@ -302,4 +309,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/grpc/Snapshot/get.md b/en/compute/api-ref/grpc/Snapshot/get.md index 19450d879b6..5bbb71f7eb4 100644 --- a/en/compute/api-ref/grpc/Snapshot/get.md +++ b/en/compute/api-ref/grpc/Snapshot/get.md @@ -53,6 +53,10 @@ To get the snapshot ID, use a [SnapshotService.List](/docs/compute/api-ref/grpc/ }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ``` @@ -109,6 +113,9 @@ ID of the source disk used to create this snapshot. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this snapshot as source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## HardwareGeneration {#yandex.cloud.compute.v1.HardwareGeneration} @@ -150,4 +157,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/grpc/Snapshot/list.md b/en/compute/api-ref/grpc/Snapshot/list.md index 34435d12d93..1b6a4084035 100644 --- a/en/compute/api-ref/grpc/Snapshot/list.md +++ b/en/compute/api-ref/grpc/Snapshot/list.md @@ -82,6 +82,10 @@ The default sorting order is ascending || }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ], @@ -158,6 +162,9 @@ ID of the source disk used to create this snapshot. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this snapshot as source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## HardwareGeneration {#yandex.cloud.compute.v1.HardwareGeneration} @@ -199,4 +206,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/grpc/Snapshot/update.md b/en/compute/api-ref/grpc/Snapshot/update.md index 5ea0c25801d..3874c2257a2 100644 --- a/en/compute/api-ref/grpc/Snapshot/update.md +++ b/en/compute/api-ref/grpc/Snapshot/update.md @@ -83,6 +83,10 @@ Existing set of `labels` is completely replaced by the provided set. || }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -207,6 +211,9 @@ ID of the source disk used to create this snapshot. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this snapshot as source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## HardwareGeneration {#yandex.cloud.compute.v1.HardwareGeneration} @@ -248,4 +255,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/grpc/SnapshotSchedule/listDisks.md b/en/compute/api-ref/grpc/SnapshotSchedule/listDisks.md index 20e69145828..92ef0bec89b 100644 --- a/en/compute/api-ref/grpc/SnapshotSchedule/listDisks.md +++ b/en/compute/api-ref/grpc/SnapshotSchedule/listDisks.md @@ -79,6 +79,10 @@ Page token. To get the next page of results, set `pageToken` to the }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ], @@ -173,6 +177,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} @@ -224,4 +231,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/api-ref/grpc/SnapshotSchedule/listSnapshots.md b/en/compute/api-ref/grpc/SnapshotSchedule/listSnapshots.md index 81392b480fe..69d044ee556 100644 --- a/en/compute/api-ref/grpc/SnapshotSchedule/listSnapshots.md +++ b/en/compute/api-ref/grpc/SnapshotSchedule/listSnapshots.md @@ -67,6 +67,10 @@ Page token. To get the next page of results, set `pageToken` to the }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ], @@ -142,6 +146,9 @@ ID of the source disk used to create this snapshot. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this snapshot as source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## HardwareGeneration {#yandex.cloud.compute.v1.HardwareGeneration} @@ -183,4 +190,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/en/compute/concepts/instance-groups/autohealing.md b/en/compute/concepts/instance-groups/autohealing.md index 0b8d861028b..081e889dc3a 100644 --- a/en/compute/concepts/instance-groups/autohealing.md +++ b/en/compute/concepts/instance-groups/autohealing.md @@ -4,7 +4,7 @@ {% note info %} -If you [pause processes](stopping-pausing.md) (switch them to the `PAUSED` [status](statuses.md#group-statuses)) in an instance group, your instances will not be healed. +If you [pause processes](stopping-pausing.md) (`PAUSED` [status](statuses.md#group-statuses)) for an instance group, its instances will not be healed. {% endnote %} @@ -14,23 +14,23 @@ To ensure autohealing, {{ ig-name }} performs two types of health checks: * [Instance operability check](#auto-healthcheck). * [Application health check on the instance](#functional-healthcheck). -Do not confuse these checks with those the load balancer performs if an instance group is [integrated with {{ network-load-balancer-full-name }} or {{ alb-full-name }}](balancers.md). The load balancer health check only affects the deployment process: when, at startup, the instance switches to the `OPENING_TRAFFIC` [status](statuses.md), {{ ig-name }} waits until the instance status switches to `HEALTHY` in the load balancer. After that, {{ ig-name }} stops monitoring the instance status in the load balancer. You can also set up instance autohealing for health checks from the load balancer. For more information, see [{#T}](balancers.md#principles-health-checks). +Do not confuse these checks with those the load balancer performs if an instance group is [integrated with {{ network-load-balancer-full-name }} or {{ alb-full-name }}](balancers.md). The load balancer health check affects only the deployment process: when the instance gets the `OPENING_TRAFFIC` [status](statuses.md) at startup, {{ ig-name }} will wait until its status turns to `HEALTHY` in the load balancer. After that, {{ ig-name }} will stop monitoring the instance status in the load balancer. You can also set up instance autohealing for health checks from the load balancer. For more information, see [{#T}](balancers.md#principles-health-checks). ### Instance operability check {#auto-healthcheck} -{{ ig-name }} checks the [instance status](../vm-statuses.md) in {{ compute-name }} every few seconds. If an instance stopped or an error occurred (the VM switched to the `STOPPED`, `ERROR`, or `CRASHED` status), {{ ig-name }} will try to restart the instance and create a new one, depending on the [recovery policy](policies/healing-policy.md). The instances will be healed based on the [deployment policy](#healthcheck-and-deploy). +{{ ig-name }} checks the [instance status](../vm-statuses.md) in {{ compute-name }} every few seconds. If an instance stops or throws an error (`STOPPED`, `ERROR`, or `CRASHED` status), {{ ig-name }} will try to restart the instance or create a new one, depending on the [recovery policy](policies/healing-policy.md). The instances will be healed based on the [deployment policy](#healthcheck-and-deploy). ### Application health check on the instance {#functional-healthcheck} This check will detect if the app running on your instance has frozen, terminated, or is taking too long to respond. You can [enable the application health check](../../operations/instance-groups/enable-autohealing.md) when creating or editing an instance. -If you enabled this check, {{ ig-name }} will poll the application status on the instance at preset intervals while the instance group is in the `ACTIVE` [status](statuses.md). +If you enable this check, {{ ig-name }} will poll the application status on the instance at preset intervals while the instance group is in the `ACTIVE` [status](statuses.md). #### Recommendations for instance groups with a load balancer {#healthcheck-and-balancer} -If your instance group is integrated with {{ network-load-balancer-name }} or {{ alb-name }}, use less strict settings for checks in {{ ig-name }} than those for the load balancer health checks (to learn more about health checks, see the [{{ network-load-balancer-name }}](../../../network-load-balancer/concepts/health-check.md) or [{{ alb-name }}](../../../application-load-balancer/concepts/backend-group.md#health) documentation). The load balancer allocates the load on the app, while {{ ig-name }} only monitors the app performance. +If your instance group is integrated with {{ network-load-balancer-name }} or {{ alb-name }}, use less strict settings for checks in {{ ig-name }} than those for the load balancer health checks (to learn more about health checks, see the [{{ network-load-balancer-name }}](../../../network-load-balancer/concepts/health-check.md) or [{{ alb-name }}](../../../application-load-balancer/concepts/backend-group.md#health) documentation). The load balancer distributes load to the app, while {{ ig-name }} only monitors its performance. -> For example, if you set the 1-second response timeout in the load balancer, then set 30 seconds in {{ ig-name }}. If the application does not respond for 3 to 5 seconds, it might not be able to handle the current traffic. If it does not respond for more than 30 seconds, it is probably not working at all and you need to heal your instance. +> For example, if you set the response timeout of 1 second in the load balancer, you should set 30 seconds in {{ ig-name }}. If the application does not respond for 3 to 5 seconds, it might not be able to handle the current traffic. If it does not respond for more than 30 seconds, it is probably not working at all and you need to heal your instance. #### Settings for application health checks {#settings} @@ -72,56 +72,60 @@ The fields and options in the management console are located under **{{ ui-key.y | --- | --- | | `health_checks_spec`
**{{ ui-key.yacloud.compute.groups.create.field_enable-health-check }}** | Settings for application health checks If the key is missing in the YAML specification or the option is disabled in the management console, no health checks are run. | | `health_checks_specs` | List of health checks. If health checks are enabled, the list should contain at least one health check. You can set up multiple health checks in the YAML specification and only one health check in the management console. | -| `interval`
**{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-interval }}** | Interval between two consecutive health checks, from 1 to 300 seconds. It must be at least one second longer than the timeout. The default value is `2s`. | -| `timeout`
**{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-timeout }}** | Check timeout, from 1 to 60 seconds: if the instance fails to respond to the health check during this time, it fails the health check. The default value is `1s`. | +| `interval`
**{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-interval }}** | Interval between two consecutive health checks, from 1 to 300 seconds. It must be at least one second longer than the timeout. The default value is two seconds (`2s`). | +| `timeout`
**{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-timeout }}** | Check timeout, from 1 to 60 seconds: if the instance fails to respond to the health check during this time, it fails the health check. The default value is one second (`1s`). | | `unhealthy_threshold`
**{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-unhealthy-threshold }}** | Number of consecutive failed health checks after which the instance is considered unhealthy and autohealed. Possible values: 0 and from 2 to 10. The default value is 2. The value of 0 is equivalent to the default value. | | `healthy_threshold`
**{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-healthy-threshold }}** | Number of consecutive successful health checks after which the instance is considered healthy. Possible values: 0 and from 2 to 10. The default value is 2. The value of 0 is equivalent to the default value. | | `http_options`
**{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-protocol }}**: `HTTP` | Settings for HTTP health checks Health checks are performed over HTTP or TCP. Therefore, the health check description in the YAML specification must contain only one key: either `http_options` or `tcp_options`. | -| `port`
**{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-port }}** | Port in the range from 1 to 65535 to send health check requests over HTTP to. | -| `path`
**{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-path }}** | Path to send health check requests over HTTP through. | +| `port`
**{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-port }}** | Port in the range from 1 to 65535 to send health check requests over HTTP to. +| `path`
**{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-path }}** | Path to send health check requests over HTTP through. | `tcp_options`
**{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-protocol }}**: `TCP` | Settings for TCP health checks Health checks are performed over HTTP or TCP. Therefore, the health check description in the YAML specification must contain only one key: either `http_options` or `tcp_options`. | | `port`
**{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-port }}** | Port in the range from 1 to 65535 to send health check requests over TCP to. | -| `max_checking_health_duration`
**{{ ui-key.yacloud.compute.groups.create.field_max-healthcheck-duration }}** | Time during which a new instance in the group (added to the group or restarted after being stopped) must pass health checks and get healthy. Possible values: 0 and 1+ sec. The default value is 0 (unlimited). | +| `max_checking_health_duration`
**{{ ui-key.yacloud.compute.groups.create.field_max-healthcheck-duration }}** | Time during which a new instance in the group (added to the group or restarted after being stopped) must pass health checks and get healthy. The possible values are 0 and 1+ sec. The default value is 0 (unlimited). | -## Auto-healing specifics {#healthcheck-cases} +## Autohealing features {#healthcheck-cases} -### Auto-healing and deployment policies {#healthcheck-and-deploy} +### Autohealing and deployment policies {#healthcheck-and-deploy} To autoheal instances, {{ ig-name }} may restart them or create new ones. The healing method is defined by the [deployment policies](policies/deploy-policy.md). -* Creating new instances - {{ ig-name }} will create new instances to replace those that failed the health check, provided that the deployment policy permits expanding the target size of the instance group. You can set the maximum number of instances that can be allocated to expand the target size of the group by using the `max_expansion` parameter, which may take values from `0` to `100`. In this case, {{ ig-name }} will first create a new instance, wait until it passes all checks, and then undeploy the instance that failed the check. +* Creating new VMs + {{ ig-name }} will create new instances to replace those that have failed the check, provided the deployment policy permits exceeding the group's target size. You use the `max_expansion` parameter to set the maximum number of instances by which the target size of the group can be exceeded. The possible values range from `0` to `100`. In this case, {{ ig-name }} will first create a new instance, wait until it passes all checks, and then delete the instance that failed the check. -* Restarting the instance - {{ ig-name }} will restart instances that failed the health check if the deployment policy permits reducing the target size of the instance group. You can use the `max_unavailable` parameter to set the maximum number of instances that can be made unavailable at the same time. The acceptable values range from `0` to `100`. {{ ig-name }} will try not to exceed this value during autohealing. + When bringing the number of instances in the group to the target value, instances created under the `max_expansion` quota can remain in the group, while those that existed in the group before may be deleted, even if they passed all checks. - This restriction does not apply to instances with the `CRASHED`, `ERROR`, and `STOPPED` [statuses](../vm-statuses.md), because, in these cases, the instance is already unavailable and must be restarted immediately. +* Restarting a VM + {{ ig-name }} will restart instances that have failed health check if the deployment policy permits reducing the target group size. You can use the `max_unavailable` parameter to set the maximum number of instances you can make unavailable at the same time. The acceptable values range from `0` to `100`. {{ ig-name }} will try not to exceed this value during autohealing. + + This restriction does not apply to instances with the`CRASHED`, `ERROR`, and `STOPPED` [statuses](../vm-statuses.md), because these mean that the instance is already unavailable and must be restarted immediately. If you set both `max_expansion` and `max_unavailable`, {{ ig-name }} will use both autohealing methods. -A fully loaded instance with the `RUNNING_ACTUAL` or `RUNNING_OUTDATED` status is considered running in terms of the `max_unavailable` quota even if it did not pass a health check. To stop such an instance automatically, you need to have unused `max_unavailable` quota. +A fully booted instance with the `RUNNING_ACTUAL` or `RUNNING_OUTDATED` status is considered running in terms of the `max_unavailable` quota, even if it did not pass the health check. To stop such an instance automatically, you need to have unused `max_unavailable` quota. -Additional instances under the `max_expansion` quota are created only in case you do not have sufficient `max_unavailable` quota. In other words, restarting an instance takes priority over creating a new one. +Additional instances are created under the `max_expansion` quota only if the `max_unavailable` quota is not enough. In other words, restarting an instance takes priority over creating a new one. -> For example, let's assume you set `max_expansion = 1` and `max_unavailable = 1`. When one of the instances fails the check, {{ ig-name }} will restart this instance. If another instance fails the check at the same time, {{ ig-name }} will not be able to restart it due to exceeding the `max_unavailable` parameter. Instead, it will begin to create a new instance while restarting the first one. +> Let’s assume you specified `max_expansion = 1` and `max_unavailable = 1`. When one of the instances fails the check, {{ ig-name }} will restart this instance. If another instance fails the check at the same time, {{ ig-name }} will not be able to restart it because the `max_unavailable` parameter is exceeded. Instead, it will begin to create a new instance while restarting the first one. To limit the autohealing and deployment speed, you can also set: -* Maximum number of instances deployed simultaneously, using the `max_creating` parameter. This includes the instances being created and started with the `CREATING` and `STARTING` statuses. +* Maximum number of instances deployed simultaneously in the `max_creating` parameter. This includes instances with the `CREATING` and `STARTING` statuses. - The acceptable values range from `0` to `100`. `0` means any number of instances within the allowed range. + The possible values range from `0` to `100`. `0` means any number of instances within the allowed range. -* Maximum number of instances undeployed simultaneously, using the `max_deleting` parameter. This includes the instances being stopped with the `STOPPING` status, since {{ ig-name }} always stops instances before undeploying them. +* Maximum number of instances undeployed simultaneously in the `max_deleting` parameter. This includes instances in the `STOPPING` status, since {{ ig-name }} always stops instances before deleting them. - The acceptable values range from `0` to `100`. `0` means any number of instances within the allowed range. + The possible values range from `0` to `100`. `0` means any number of instances within the allowed range. ### Changing instance status during autohealing {#healtcheck-and-vm-state} {{ ig-name }} will not try to heal an instance if it is no longer needed. -> For example, if all 10 instances out of 10 in a group are unavailable and `max_unavailable = 3`, {{ ig-name }} will restart the first three instances. If the remaining seven instances become operable again in the meantime, {{ ig-name }} will not restart them. +> For example, if all 10 instances out of 10 in a group are unavailable and `max_unavailable = 3`, {{ ig-name }} will restart the first three instances. If the remaining seven instances become operational again in the meantime, {{ ig-name }} will not restart them. +> +> If `max_expansion = 3`, {{ ig-name }} will start creating three new instances. The old instances will not be deleted until the new ones are created. If all instances in an instance group become operational again during the creation process, {{ ig-name }} will cancel the creation of new instances. > -> If `max_expansion = 3`, {{ ig-name }} will start creating three new instances. The old instances will not be deleted until the new ones are created. If all instances in an instance group become operable again during the creation process, {{ ig-name }} will cancel the creation of new instances. +> When bringing the number of instances in the group to the target value, instances created under the `max_expansion` quota can remain in the group, while those that existed in the group before may be deleted, even if they are operational. ### Healing while updating instance configurations {#healtcheck-and-vm-update} @@ -135,17 +139,17 @@ Instance healing has a higher priority than instance configuration update. When the target size of an instance group is reduced, the instances that failed the check, if any, will be deleted first. -If you increase the target size of the instance group, new instances will be created at the same time as the instances that failed the check, if this is allowed by `max_creating` and `max_expansion`: +If you increase the instance group's target size, new instances will be created in parallel with the instances that had failed the check, if allowed by `max_creating` and `max_expansion`: > Let's assume two out of four instances in an instance group failed the [application health check](#functional-healthcheck). At that point, the target size of the instance group has increased to six instances. You have two instances to create and another two to heal. > -> If `max_expansion = 1` and `max_creating` is not set, {{ ig-name }} will start creating three instances in parallel: two under the instance group expansion, and one under the autohealing process. +> If `max_expansion = 1` and `max_creating` is not set, {{ ig-name }} will start creating three instances in parallel: two as part of group expansion, and one as part of autohealing. ### Autohealing preemptible instances {#healthcheck-preemptible-vm} -[Preemptible instances](../preemptible-vm.md) can only be autohealed if the computing resources in the availability zone allow for this. If the resources are insufficient, {{ ig-name }} will resume autohealing as soon as the resources become available; this, however, may take a long time. +[Preemptible instances](../preemptible-vm.md) can only be autohealed if there is enough computing resources in the availability zone. If the resources are insufficient, {{ ig-name }} will resume autohealing as soon as the resources become available; this, however, may take a long time. -Preemptible VMs must be terminated within 24 hours of their launch. In this case, there is a risk that the entire instance group will restart at the same time and stop handling the load of running applications. To avoid this, {{ ig-name }} stops preemptible instances after a random interval of 22 to 24 hours, rather than exactly after 24 hours. +Preemptible instances must be terminated within 24 hours of their launch. In this case, there is a risk that the entire instance group will restart at the same time and stop handling the load of running applications. To avoid this, {{ ig-name }} stops preemptible instances after a random interval of 22 to 24 hours, rather than exactly after 24 hours. #### See also {#see-also} diff --git a/en/compute/concepts/instance-groups/policies/deploy-policy.md b/en/compute/concepts/instance-groups/policies/deploy-policy.md index d12009de7b1..495808065db 100644 --- a/en/compute/concepts/instance-groups/policies/deploy-policy.md +++ b/en/compute/concepts/instance-groups/policies/deploy-policy.md @@ -2,7 +2,7 @@ When creating an instance group, you can choose how the instances will be deployed in the group. -The deployment policy is a set of restrictions defined in the `deploy_policy` key in the YAML file. Each restriction is set in its own key as a `key-value` pair. +The deployment policy is a set of restrictions defined in the `deploy_policy` key in the YAML file. Each restriction is set in a separate key as a `key:value` pair. Here is how a YAML file entry may look like: @@ -19,26 +19,28 @@ deploy_policy: Where: -| Key | Value | -| ----- | ----- | -| `max_creating` | Maximum number of instances being started at the same time.
Valid values range from 0 to 100. 0 means any number of instances within the allowed range. | -| `max_deleting` | Maximum number of instances being stopped at the same time.
Valid values range from 0 to 100. 0 means any number of instances within the allowed range. | -| `max_unavailable` | Maximum number of instances in the `RUNNING` status that can be removed to reduce the target size of the group.
Valid values range from 0 to 100. | -| `max_expansion` | Maximum number of instances that can be additionally allocated to expand the target size of the group. If the `max_unavailable` key is not specified or is zero, the `max_expansion` key value must not be zero.
Valid values range from 0 to 100. | -| `startup_duration` | Startup duration of an instance in the group. The instance starts receiving traffic only after the startup time expires and all health checks are passed.
Valid values range from 0 to 100. | +Key | Value +----- | ----- +`max_creating` | Maximum number of isntances started simultaneously.
Acceptable values: 0 to 100. 0 means any number of instances within the allowed range. +`max_deleting` | Maximum number of instances stopped simultaneously.
Acceptable values: 0 to 100. 0 means any number of instances within the allowed range. +`max_unavailable` | Maximum number of instances in the `RUNNING` status by which the group's target size can be reduced.
Acceptable values: 0 to 100. +`max_expansion` | Maximum number of instances by which the group's target size can be exceeded^1^. If the `max_unavailable` key is not specified or is zero, a non-zero value must be specified for the `max_expansion` key.
Acceptable values: 0 to 100. +`startup_duration` | Startup duration of an instance in the group. The instance starts receiving traffic only after the startup time expires and all the health checks are passed.
The acceptable values range from 0 to 3,600 seconds. + +^1^ Subsequently, when bringing the number of instances in the group to the target value, instances created under the `max_expansion` quota can remain in the group, while those that existed in the group before may be deleted. ## Strategies for stopping instances {#strategy} -{{ ig-name }} supports two strategies for stopping instances when updating or [automatically scaling](../scale.md#auto-scale) a group: `PROACTIVE` and `OPPORTUNISTIC`. +{{ ig-name }} supports two strategies for stopping instances when updating or [automatically scaling](../scale.md#auto-scale) a group: automatic (`PROACTIVE`) and manual (`OPPORTUNISTIC`). -If you use the proactive strategy, {{ ig-name }} will select which instances to stop on its own. +If you use the proactive strategy, {{ ig-name }} will select which instances to stop by itself. With the opportunistic strategy, {{ ig-name }} does not stop the instances but waits until at least one of the following conditions is met: * User [stops](../../../operations/vm-control/vm-stop-and-start.md#stop) an instance in {{ compute-name }}. * Application or user stops the instance internally. * Instance fails the application [health check](../autohealing.md#functional-healthcheck). -For example, let's assume you created an instance group with automatic scaling based on the [custom metric](../scale.md#custom-metrics) of the number of jobs in the queue. {{ ig-name }} will create an instance group to run the jobs from the queue. As soon as there are no more jobs, {{ ig-name }} must reduce the group size from the actual size to the target one according to the [scaling policy](scale-policy.md). +For example, you created an instance group with automatic scaling based on the [custom metric](../scale.md#custom-metrics) of the number of jobs in the queue. {{ ig-name }} creates an instance group that executes the jobs from the queue. As soon as there are no more jobs, {{ ig-name }} must reduce the group size from the actual size to the target one according to the [scaling policy](scale-policy.md). * If you selected the proactive stop, {{ ig-name }} will change the target group size and decrease the actual number of instances in the group to the target amount. * If you use the opportunistic strategy, {{ ig-name }} will change the target group size but will not stop the instances until they stop by themselves or are stopped by the user. @@ -53,17 +55,17 @@ deploy_policy: Where: -| Key | Value | -| ----- | ----- | -| `strategy` | Strategy for stopping instances in a group.
Possible values include:
  • `PROACTIVE`: {{ ig-name }} selects which instances to stop on its own.
  • `OPPORTUNISTIC`: {{ ig-name }} waits for the instances to stop on their own or until the user stops them.
The default value is `PROACTIVE`. | +Key | Value +----- | ----- +`strategy` | Strategy for stopping instances in a group.
Possible values:
  • `PROACTIVE`: {{ ig-name }} selects which instances to stop by itself.
  • `OPPORTUNISTIC`: {{ ig-name }} waits for the instances to stop by themselves or be stopped by the user.
Default value: `PROACTIVE`. -## Minimum actions to perform for an instance's update {#minimal-action} +## Minimum instance update actions {#minimal-action} -By default, when updating an instance, {{ ig-name }} decides whether to restart or recreate them based on the [rules](../../instance-groups/deploy/instance.md). However, you can also set the minimum action to perform for updating an instance yourself. It will be executed even if the rules do not require that. This may be needed for cleaning up RAM or disks at an instance's update or redeploying the instance. +By default, when updating an instance, {{ ig-name }} decides whether to restart or recreate them based on the [rules](../../instance-groups/deploy/instance.md). However, you can also set the minimum instance update action yourself. It will be executed even if the rules do not require that. This may be needed for cleaning up RAM or disks at an instance's update or redeploying the instance. -Please note that the update rules take priority over the minimum actions you set. For example, if you select an instance's restart as the minimum action, the instance may also be deleted if this is required by the rules. +Please note that the update rules take priority over the minimum actions. For example, if instance restart is selected as the minimum action, the instance may be also deleted if so required by the rules. -You can manage minimum actions to perform for an instance's update using the [CLI](../../../../cli/quickstart.md) and [API](../../../api-ref/). +You can manage your minimum instance update actions using the [CLI](../../../../cli/quickstart.md) and [API](../../../api-ref/). Here is how a YAML file entry may look like: @@ -76,12 +78,12 @@ deploy_policy: Where: -| Key | Value | -| ----- | ----- | -| `minimal_action` | Minimum action to perform for an instance's update. The possible values are:
  • `LIVE_UPDATE`: Update an instance without stopping it.
  • `RESTART`: Update an instance by restarting it.
  • `RECREATE`: Update an instance by recreating it.
The default value is `LIVE_UPDATE`. | +Key | Value +----- | ----- +`minimal_action` | Minimum instance update action. Possible values:
  • `LIVE_UPDATE`: Live update.
  • `RESTART`: Update and restart.
  • `RECREATE`: Update and recreate.
Default value: `LIVE_UPDATE`. #### See also {#see-also} * [{#T}](healing-policy.md) * [{#T}](scale-policy.md) -* [{#T}](allocation-policy.md) +* [{#T}](allocation-policy.md) \ No newline at end of file diff --git a/en/compute/concepts/storage-read-write.md b/en/compute/concepts/storage-read-write.md index 5f03fa3864f..0e8658d305f 100644 --- a/en/compute/concepts/storage-read-write.md +++ b/en/compute/concepts/storage-read-write.md @@ -19,7 +19,7 @@ Read and write operations utilize the same disk resource. The more read operatio ![image](../../_assets/compute/max-iops.svg) Where: -* ![image](../../_assets/compute/alpha.svg): Share of write operations out of the total number of read and write operations per second. The possible values are: α∈[0,1]. +* ![image](../../_assets/compute/alpha.svg) is the share of write operations out of the total number of read and write operations per second. Possible values: α∈[0,1]. * _WriteIOPS_: IOPS write value obtained using the formula for the actual IOPS value. * _ReadIOPS_: IOPS read value obtained using the formula for the actual IOPS value. @@ -47,6 +47,7 @@ You can test the performance of your network disks with [fio](https://fio.readth 1. [Attach](../operations/vm-control/vm-attach-disk.md) a disk to a VM instance. 1. Install [fio](https://fio.readthedocs.io/en/latest/fio_doc.html) on your VM instance. + Sample command for Ubuntu: ```bash @@ -266,7 +267,7 @@ Result: If a VM exceeds [disk limits](limits.md#compute-limits-disks) at any time, this will trigger throttling. -_Throttling_ is a feature that intentionally limits performance. When throttled, disk operations are suspended, and the disk operation wait time (`iowait`) is increased. Since all write and read operations are processed in a single thread (vCPU), overloading system disks may cause network problems. This is true for both VMs and physical servers. +_Throttling_ is a feature that forcibly limits the performance. When throttled, disk operations are suspended, and the disk operation wait time (`iowait`) is increased. Since all write and read operations are processed in a single thread (vCPU), overloading system disks may cause network problems. This is true for both VMs and physical servers. > For example, let's assume there is a write limit of 300 IPOS. The limit is split into 10 parts and applies once every 100 ms. 300 / 10 = 30 IOPS per write request will be allowed every 100 ms. If you send 30 requests once and then 30 more requests within 100 ms (evenly distributed across the 100 ms interval), this will trigger throttling and only the first 30 requests will be sent. The rest of them will be enqueued and processed within the next 100 ms. If write requests are executed sporadically, throttling may cause significant delays. At times, there will be up to N IOPS of requests within 100 ms. diff --git a/en/compute/concepts/vm-metadata.md b/en/compute/concepts/vm-metadata.md index c7372f79f17..95eab221692 100644 --- a/en/compute/concepts/vm-metadata.md +++ b/en/compute/concepts/vm-metadata.md @@ -30,7 +30,7 @@ You can provide metadata when creating or [updating](../operations/vm-control/vm In the CLI, you can provide metadata in any of the three parameters: - * `--metadata-from-file`: As a configuration file formatted as `--metadata-from-file key=`. Use this method to conveniently deliver a value consisting of several lines. + * `--metadata-from-file`: As a configuration file in this format: `--metadata-from-file key=`. Use this method to conveniently deliver a value consisting of several lines. For example, to add several users to a VM at the same time, describe the configuration in a `YAML` file: @@ -72,7 +72,7 @@ You can provide metadata when creating or [updating](../operations/vm-control/vm {% endcut %} - * Under `metadata`, as a line with user metadata. For a multiline value, use `\n` as a separator. For example: + * Under `metadata`, as a line with user metadata. For a multiline value, use `\n` as a separator. Here is an example: ```hcl ... diff --git a/en/compute/operations/dedicated-host/access.md b/en/compute/operations/dedicated-host/access.md index adc75c59d31..883d115a931 100644 --- a/en/compute/operations/dedicated-host/access.md +++ b/en/compute/operations/dedicated-host/access.md @@ -17,7 +17,7 @@ To grant a user, group, or [service account](../../../iam/concepts/users/service 1. In the [management console]({{ link-console-main }}), select the folder containing the dedicated host group. 1. Select **{{ ui-key.yacloud.compute.label_service }}**. 1. In the left-hand panel, select ![image](../../../_assets/horizontal-ellipsis.svg) → **{{ ui-key.yacloud.compute.switch_host-groups }}**. - 1. Select a dedicated host group. + 1. Select the dedicated host group. 1. Go to the ![image](../../../_assets/console-icons/persons.svg) **{{ ui-key.yacloud.common.resource-acl.label_access-bindings }}** tab. 1. Click **{{ ui-key.yacloud.common.resource-acl.button_new-bindings }}**. 1. In the window that opens, select the group, user, or service account to grant access to the dedicated host group. @@ -91,7 +91,7 @@ To grant a user, group, or [service account](../../../iam/concepts/users/service 1. In the [management console]({{ link-console-main }}), select the folder containing the dedicated host group. 1. Select **{{ ui-key.yacloud.compute.label_service }}**. 1. In the left-hand panel, select ![image](../../../_assets/horizontal-ellipsis.svg) → **{{ ui-key.yacloud.compute.switch_host-groups }}**. - 1. Select a dedicated host group. + 1. Select the dedicated host group. 1. Go to the ![image](../../../_assets/console-icons/persons.svg) **{{ ui-key.yacloud.common.resource-acl.label_access-bindings }}** tab. 1. Click **{{ ui-key.yacloud.common.resource-acl.button_new-bindings }}**. 1. In the window that opens, select the group, user, or service account to grant access to the dedicated host group. @@ -151,7 +151,7 @@ To grant a user, group, or [service account](../../../iam/concepts/users/service {% note alert %} - The `setAccessBindings` method and the `HostGroupService/SetAccessBindings` call completely rewrite access permissions for the resource. All current resource roles will be deleted. + The `setAccessBindings` method and the `HostGroupService/SetAccessBindings` call completely overwrite access permissions for the resource. All current resource roles will be deleted. {% endnote %} @@ -166,7 +166,7 @@ To grant a user, group, or [service account](../../../iam/concepts/users/service 1. In the [management console]({{ link-console-main }}), select the folder containing the dedicated host group. 1. Select **{{ ui-key.yacloud.compute.label_service }}**. 1. In the left-hand panel, select ![image](../../../_assets/horizontal-ellipsis.svg) → **{{ ui-key.yacloud.compute.switch_host-groups }}**. - 1. Select a dedicated host group. + 1. Select the dedicated host group. 1. Go to the ![image](../../../_assets/console-icons/persons.svg) **{{ ui-key.yacloud.common.resource-acl.label_access-bindings }}** tab. 1. In the line with the user you need, click ![image](../../../_assets/horizontal-ellipsis.svg) and select **{{ ui-key.yacloud.common.resource-acl.button_assign-binding }}**. 1. Next to the role, click ![image](../../../_assets/cross.svg). diff --git a/en/compute/operations/dedicated-host/running-host-group-vms.md b/en/compute/operations/dedicated-host/running-host-group-vms.md index 309d39a3a2f..ad2737531c5 100644 --- a/en/compute/operations/dedicated-host/running-host-group-vms.md +++ b/en/compute/operations/dedicated-host/running-host-group-vms.md @@ -107,7 +107,7 @@ Create a VM with the following characteristics: * Number of vCPUs: 64 * Amount of RAM: 704 GB * Number of local disks: 2 -* Size of a single local disk: 3,198,924,357,632 B (~ 2.91 TB) +* Size of a single local disk: 3,198,924,357,632 B (~2.91 TB) * Operating system: [Ubuntu 22.04 LTS](/marketplace/products/yc/ubuntu-22-04-lts) To do this, follow these steps: diff --git a/en/compute/operations/dedicated-host/running-host-vms.md b/en/compute/operations/dedicated-host/running-host-vms.md index 2500ce83f84..0c61223b2c4 100644 --- a/en/compute/operations/dedicated-host/running-host-vms.md +++ b/en/compute/operations/dedicated-host/running-host-vms.md @@ -126,7 +126,7 @@ Create a VM with the following characteristics: * Number of vCPUs: 64 * Amount of RAM: 704 GB * Number of local disks: 1 -* Local disk size: 3,198,924,357,632 B (~ 2.91 TB) +* Local disk size: 3,198,924,357,632 B (~2.91 TB) * Operating system: [Ubuntu 22.04 LTS](/marketplace/products/yc/ubuntu-22-04-lts) To do this, follow these steps: diff --git a/en/compute/operations/disk-control/get-info.md b/en/compute/operations/disk-control/get-info.md index ef22bf5fdaa..dce5655f6c8 100644 --- a/en/compute/operations/disk-control/get-info.md +++ b/en/compute/operations/disk-control/get-info.md @@ -70,7 +70,7 @@ description: Follow this guide to get information about a disk. Where: - * `data "yandex_compute_image"`: Describes the [disk](../../concepts/disk.md) as a data source: + * `data "yandex_compute_disk"`: Description of the [disk](../../concepts/disk.md) as a data source: * `disk_id`: Disk ID. * `output "my_disk_size"`: Output variable that contains information about the disk size: * `value`: Returned value. diff --git a/en/compute/operations/disk-create/empty.md b/en/compute/operations/disk-create/empty.md index 1adc2e4bc6b..00e70946d78 100644 --- a/en/compute/operations/disk-create/empty.md +++ b/en/compute/operations/disk-create/empty.md @@ -31,7 +31,8 @@ You can create an empty disk of the specified size. {% include [snapshot-disk-types](../../../_includes/compute/snapshot-disk-types.md) %} When creating a disk, you can select only one snapshot schedule. After the disk is created, you can add a few more schedules, if required, by following [this guide](../disk-control/configure-schedule.md#add-schedule). - 1. Click **{{ ui-key.yacloud.compute.disks.create.button_create }}**. + + 1. Click **{{ ui-key.yacloud.compute.disks.create.button_create }}**. - CLI {#cli} diff --git a/en/compute/operations/disk-placement-groups/access.md b/en/compute/operations/disk-placement-groups/access.md index 37b17fd61e8..41258a2f61d 100644 --- a/en/compute/operations/disk-placement-groups/access.md +++ b/en/compute/operations/disk-placement-groups/access.md @@ -98,7 +98,7 @@ To grant a user, group, or [service account](../../../iam/concepts/users/service * `disk_placement_group_id`: Disk placement group ID. * `role`: [Role](../../security/index.md#roles-list) to assign. - * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) getting the role. Specify it as `userAccount:` or `serviceAccount:`. + * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) the roles are assigned to. Specify it as `userAccount:` or `serviceAccount:`. For more information about the `yandex_compute_disk_placement_group_iam_binding` resource parameters, see the [provider documentation]({{ tf-provider-resources-link }}/compute_disk_placement_group_iam_binding). @@ -205,11 +205,11 @@ To grant a user, group, or [service account](../../../iam/concepts/users/service } ``` - Where: + Where: * `disk_placement_group_id`: Disk placement group ID. * `role`: [Role](../../security/index.md#roles-list) to assign. - * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) getting the role. Specify it as `userAccount:` or `serviceAccount:`. + * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) the roles are assigned to. Specify it as `userAccount:` or `serviceAccount:`. For more information about the `yandex_compute_disk_placement_group_iam_binding` resource parameters, see the [provider documentation]({{ tf-provider-resources-link }}/compute_disk_placement_group_iam_binding). @@ -229,7 +229,7 @@ To grant a user, group, or [service account](../../../iam/concepts/users/service {% note alert %} - The `setAccessBindings` method and the `DiskPlacementGroupService/SetAccessBindings` call completely rewrite the resource access permissions. All current resource roles will be deleted. + The `setAccessBindings` method and the `DiskPlacementGroupService/SetAccessBindings` call completely overwrite access permissions for the resource. All current resource roles will be deleted. {% endnote %} diff --git a/en/compute/operations/filesystem/filesystem-access.md b/en/compute/operations/filesystem/filesystem-access.md index 233afbb7dc2..47470b2b87f 100644 --- a/en/compute/operations/filesystem/filesystem-access.md +++ b/en/compute/operations/filesystem/filesystem-access.md @@ -96,7 +96,7 @@ To grant a user, group, or [service account](../../../iam/concepts/users/service * `filesystem_id`: File storage ID. * `role`: [Role](../../security/index.md#roles-list) to assign. - * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) the role is assigned to. Specify it as `userAccount:` or `serviceAccount:`. + * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) the roles are assigned to. Specify it as `userAccount:` or `serviceAccount:`. For more information about the `yandex_compute_filesystem_iam_binding` resource parameters, see the [provider documentation]({{ tf-provider-resources-link }}/compute_filesystem_iam_binding). @@ -164,7 +164,7 @@ To grant a user, group, or [service account](../../../iam/concepts/users/service Where: - * `--access-binding`: Role you want to assign: + * `--access-binding`: Role to assign: * `role`: ID of the role to assign. * `subject`: Type and ID of the [subject](../../../iam/concepts/access-control/index.md#subject) getting the role. @@ -206,7 +206,7 @@ To grant a user, group, or [service account](../../../iam/concepts/users/service * `filesystem_id`: File storage ID. * `role`: [Role](../../security/index.md#roles-list) to assign. - * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) the role is assigned to. Specify it as `userAccount:` or `serviceAccount:`. + * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) the roles are assigned to. Specify it as `userAccount:` or `serviceAccount:`. For more information about the `yandex_compute_filesystem_iam_binding` resource parameters, see the [provider documentation]({{ tf-provider-resources-link }}/compute_filesystem_iam_binding). diff --git a/en/compute/operations/image-control/access.md b/en/compute/operations/image-control/access.md index e86a864bb54..6097ba3799e 100644 --- a/en/compute/operations/image-control/access.md +++ b/en/compute/operations/image-control/access.md @@ -97,7 +97,7 @@ To grant a user, group, or [service account](../../../iam/concepts/users/service * `image_id`: Image ID. * `role`: [Role](../../security/index.md#roles-list) to assign. - * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) getting the role. Specify it as `userAccount:` or `serviceAccount:`. + * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) the roles are assigned to. Specify it as `userAccount:` or `serviceAccount:`. For more information about the `yandex_compute_image_iam_binding` resource parameters, see the [provider documentation]({{ tf-provider-resources-link }}/compute_image_iam_binding). @@ -204,11 +204,11 @@ To grant a user, group, or [service account](../../../iam/concepts/users/service } ``` - Where: + Where: * `image_id`: Image ID. * `role`: [Role](../../security/index.md#roles-list) to assign. - * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) getting the role. Specify it as `userAccount:` or `serviceAccount:`. + * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) the roles are assigned to. Specify it as `userAccount:` or `serviceAccount:`. For more information about the `yandex_compute_image_iam_binding` resource parameters, see the [provider documentation]({{ tf-provider-resources-link }}/compute_image_iam_binding). @@ -228,7 +228,7 @@ To grant a user, group, or [service account](../../../iam/concepts/users/service {% note alert %} - The `setAccessBindings` method and the `ImageService/SetAccessBindings` call completely rewrite the resource access permissions. All current resource roles will be deleted. + The `setAccessBindings` method and the `ImageService/SetAccessBindings` call completely overwrite access permissions for the resource. All current resource roles will be deleted. {% endnote %} diff --git a/en/compute/operations/image-control/image-control-get-info.md b/en/compute/operations/image-control/image-control-get-info.md index 7092b8c99c9..90dd5348b1e 100644 --- a/en/compute/operations/image-control/image-control-get-info.md +++ b/en/compute/operations/image-control/image-control-get-info.md @@ -67,12 +67,12 @@ title: How to get information about a disk image in {{ compute-full-name }} Where: - * `data "yandex_compute_image"`: Describes the disk image as the data source: + * `data "yandex_compute_image"`: Description of the disk image as a data source: * `image_id`: Disk image ID. * `output "image"`: Output variable that contains information about the minimum disk size: * `value`: Returned value. - You can replace `min_disk_size` with any other parameter to get the information you need. For more information about the `yandex_compute_image` data source parameters, see the [relevant provider documentation]({{ tf-provider-datasources-link }}/datasource_compute_image). + Instead of `min_disk_size` you can select any other parameter to get the information you need. For more information about the `yandex_compute_image` data source parameters, see the [relevant provider documentation]({{ tf-provider-datasources-link }}/datasource_compute_image). 1. Create resources: diff --git a/en/compute/operations/image-control/import.md b/en/compute/operations/image-control/import.md index ef95099a8bf..c05ee369a24 100644 --- a/en/compute/operations/image-control/import.md +++ b/en/compute/operations/image-control/import.md @@ -26,7 +26,7 @@ To import an image from another cloud or folder: {{ yc-compute }} image create --help ``` - 1. To get a list of available images in the source cloud or folder, run the following command: `{{ yc-compute }} image list --folder-name `. For example: + 1. To get a list of available images in the source cloud or folder, run the following command: `{{ yc-compute }} image list --folder-name `. Here is an example: ```bash {{ yc-compute }} image list --folder-name my-source-folder @@ -44,7 +44,7 @@ To import an image from another cloud or folder: 1. Select `ID` or `NAME` of the image you are importing. - 1. To import an image, run the following command: `{{ yc-compute }} image create --source-image-id=`. For example: + 1. To import an image, run the following command: `{{ yc-compute }} image create --source-image-id=`. Here is an example: ```bash {{ yc-compute }} image create --source-image-id=fd8o0pt9qfbt******** @@ -66,7 +66,7 @@ To import an image from another cloud or folder: type: LINUX ``` - 1. Check the result by running the following command: `{{ yc-compute }} image list --folder-name `. For example: + 1. Check the result by running the following command: `{{ yc-compute }} image list --folder-name `. Here is an example: ```bash {{ yc-compute }} image list --folder-name my-destination-folder diff --git a/en/compute/operations/images-with-pre-installed-software/create.md b/en/compute/operations/images-with-pre-installed-software/create.md index d8ef9cec66c..995a7765a2b 100644 --- a/en/compute/operations/images-with-pre-installed-software/create.md +++ b/en/compute/operations/images-with-pre-installed-software/create.md @@ -12,27 +12,20 @@ To create a [VM](../../concepts/vm.md): - Management console {#console} - 1. In the [management console]({{ link-console-main }}), open the [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder) to create your VM in. - 1. At the top right, click **{{ ui-key.yacloud.iam.folder.dashboard.button_add }}**. + 1. In the [management console]({{ link-console-main }}), select the [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder) to create your VM in. + 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. + 1. In the left-hand panel, select ![image](../../../_assets/console-icons/server.svg) **{{ ui-key.yacloud.compute.switch_instances }}**. + 1. Click **{{ ui-key.yacloud.compute.instances.button_create }}**. + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, select a public [image](../../concepts/image.md) with the software you want to use. + 1. Under **{{ ui-key.yacloud.k8s.node-groups.create.section_allocation-policy }}**, select an [availability zone](../../../overview/concepts/geo-scope.md) to place your VM in. + 1. (Optional) Configure the boot [disk](../../concepts/disk.md) in the **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}** section: - 1. In the list that opens, select **{{ ui-key.yacloud.iam.folder.dashboard.value_compute }}**. + * Select the [disk type](../../concepts/disk.md#disks_types). + * Specify the required disk size. - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**: - * Enter the VM name. The naming requirements are as follows: - - {% include [name-format](../../../_includes/name-format.md) %} - - * Select an [availability zone](../../../overview/concepts/geo-scope.md) to place your VM in. - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, select a public [image](../../concepts/image.md) with the software you want to use. - 1. (Optional) If you want to add more [disks](../../concepts/disk.md) to the VM, [select them](../vm-create/create-from-disks.md) under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}** by clicking the **{{ ui-key.yacloud.compute.instances.create.section_disk }}** tab. - - - 1. (Optional) If you want to add more [file stores](../../concepts/filesystem.md) to the VM, add them under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}** by clicking the **{{ ui-key.yacloud.compute.nfs.label_filesystems }}** tab. [Create](../filesystem/create.md) the storages first. - - - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_platform }}**: - * Choose a [platform](../../concepts/vm-platforms.md). - * Specify the [guaranteed share](../../concepts/performance-levels.md) and the required number of vCPUs as well as the amount of RAM. + 1. {% include [section-storages-secondary-disk](../../../_includes/compute/create/section-storages-secondary-disk.md) %} + 1. {% include [section-storages-filesystem](../../../_includes/compute/create/section-storages-filesystem.md) %} + 1. {% include [section-platform](../../../_includes/compute/create/section-platform.md) %} {% note info %} @@ -40,69 +33,64 @@ To create a [VM](../../concepts/vm.md): {% endnote %} - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_network }}**: - - {% include [network-settings](../../../_includes/compute/network-settings.md) %} + 1. {% include [network-settings](../../../_includes/compute/create/section-network.md) %} + 1. {% include [section-access](../../../_includes/compute/create/section-access.md) %} - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_access }}**, specify the information required to access the instance: - * (Optional) Select or create a [service account](../../../iam/concepts/index.md#sa). With a service account, you can flexibly configure access rights for your resources. - * (Optional) [Enable VM access via OS Login](../vm-connect/os-login.md). The option is available for Linux images from [{{ marketplace-name }}](/marketplace) with `OS Login` in their names. - * Enter the username in the **{{ ui-key.yacloud.compute.instances.create.field_user }}** field. - * In the **{{ ui-key.yacloud.compute.instances.create.field_key }}** field, paste the contents of the [public key](../vm-connect/ssh.md#creating-ssh-keys) file. + {% note info %} - {% note info %} + On VMs with access via OS Login enabled, provide your custom SSH keys through [metadata](../../concepts/vm-metadata.md#how-to-send-metadata). - On VMs with access via OS Login enabled, provide your custom SSH keys through [metadata](../../concepts/vm-metadata.md#how-to-send-metadata). + {% endnote %} - {% endnote %} + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**, specify the VM name: - * (Optional) Enable access to the [serial console](../index.md#serial-console) in the **{{ ui-key.yacloud.compute.instances.create.field_access-advanced }}** field, if required. - * If you want to add several users with SSH keys to the VM at the same time, [specify](../../concepts/vm-metadata.md#how-to-send-metadata) these users' data under **{{ ui-key.yacloud.common.metadata }}**. + {% include [name-format](../../../_includes/name-format.md) %} - {% include [vm-connect-linux](../../../_includes/vm-connect-linux.md) %} + {% include [name-fqdn](../../../_includes/compute/name-fqdn.md) %} - 1. Click **{{ ui-key.yacloud.compute.instances.create.button_create }}**. + 1. {% include [section-additional](../../../_includes/compute/create/section-additional.md) %} + 1. Click **{{ ui-key.yacloud.compute.instances.create.button_create }}**. - VM creation takes several minutes. When the VM status changes to `RUNNING`, proceed to [configuring software](setup.md). You can monitor VM statuses on the list of VMs in the folder. + VM creation takes several minutes. When the VM status changes to `RUNNING`, proceed to [configuring software](setup.md). You can monitor VM statuses on the list of VMs in the folder. - CLI {#cli} - {% include [cli-install](../../../_includes/cli-install.md) %} + {% include [cli-install](../../../_includes/cli-install.md) %} - {% include [default-catalogue](../../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../../_includes/default-catalogue.md) %} - 1. View a description of the CLI create VM command: + 1. View the description of the CLI command to create a VM: - ```bash - yc compute instance create --help - ``` + ```bash + yc compute instance create --help + ``` - 1. Prepare the [key pair](../../operations/vm-connect/ssh.md#creating-ssh-keys) (public and private keys) for SSH access to the VM. - 1. Select one of the {{ marketplace-full-name }} public [images](../images-with-pre-installed-software/get-list.md). + 1. Prepare the public and private [key pair](../../operations/vm-connect/ssh.md#creating-ssh-keys) for SSH access to the VM. + 1. Select one of the {{ marketplace-full-name }} public [images](../images-with-pre-installed-software/get-list.md). - {% include [id-info](../../../_includes/compute/id-info.md) %} + {% include [id-info](../../../_includes/compute/id-info.md) %} - {% include [standard-images](../../../_includes/standard-images.md) %} + {% include [standard-images](../../../_includes/standard-images.md) %} - 1. Select a [subnet](../../../vpc/concepts/network.md#subnet): + 1. Select a [subnet](../../../vpc/concepts/network.md#subnet): - ```bash - yc vpc subnet list - ``` + ```bash + yc vpc subnet list + ``` - Result: + Result: - ```text - +----------------------+---------------------------+----------------------+----------------+-------------------+-----------------+ - | ID | NAME | NETWORK ID | ROUTE TABLE ID | ZONE | RANGE | - +----------------------+---------------------------+----------------------+----------------+-------------------+-----------------+ - | b0c6n43f9lgh******** | default-{{ region-id }}-a | enpe3m3fa00u******** | | {{ region-id }}-a | [10.130.0.0/24] | - | e2l2da8a20b3******** | default-{{ region-id }}-b | enpe3m3fa00u******** | | {{ region-id }}-a | [10.129.0.0/24] | - | e9bnlm18l70a******** | default-{{ region-id }}-d | enpe3m3fa00u******** | | {{ region-id }}-a | [10.128.0.0/24] | - +----------------------+---------------------------+----------------------+----------------+-------------------+-----------------+ - ``` + ```text + +----------------------+---------------------------+----------------------+----------------+-------------------+-----------------+ + | ID | NAME | NETWORK ID | ROUTE TABLE ID | ZONE | RANGE | + +----------------------+---------------------------+----------------------+----------------+-------------------+-----------------+ + | b0c6n43f9lgh******** | default-{{ region-id }}-a | enpe3m3fa00u******** | | {{ region-id }}-a | [10.130.0.0/24] | + | e2l2da8a20b3******** | default-{{ region-id }}-b | enpe3m3fa00u******** | | {{ region-id }}-a | [10.129.0.0/24] | + | e9bnlm18l70a******** | default-{{ region-id }}-d | enpe3m3fa00u******** | | {{ region-id }}-a | [10.128.0.0/24] | + +----------------------+---------------------------+----------------------+----------------+-------------------+-----------------+ + ``` - 1. Create a VM in the default [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder): + 1. Create a VM in the default [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder): ```bash yc compute instance create \ @@ -117,139 +105,139 @@ To create a [VM](../../concepts/vm.md): * `--name`: VM name. The naming requirements are as follows: - {% include [name-format](../../../_includes/name-format.md) %} + {% include [name-format](../../../_includes/name-format.md) %} - {% include [name-fqdn](../../../_includes/compute/name-fqdn.md) %} + {% include [name-fqdn](../../../_includes/compute/name-fqdn.md) %} - * `--zone`: [Availability zone](../../../overview/concepts/geo-scope.md) that corresponds to the selected subnet. - * `--network-interface`: VM's [network interface](../../concepts/network.md) settings: - * `subnet-name`: Name of the selected subnet. - * `nat-ip-version=ipv4`: [Public IP address](../../../vpc/concepts/address.md#public-addresses). To create a VM without a public IP address, disable this parameter. + * `--zone`: [Availability zone](../../../overview/concepts/geo-scope.md) corresponding to the selected subnet. + * `--network-interface`: VM [network interface](../../concepts/network.md) settings. + * `subnet-name`: Name of the selected subnet. + * `nat-ip-version=ipv4`: [Public IP address](../../../vpc/concepts/address.md#public-addresses). To create a VM without a public IP address, disable this parameter. - {% include [add-several-net-interfaces-notice-cli](../../../_includes/compute/add-several-net-interfaces-notice-cli.md) %} + {% include [add-several-net-interfaces-notice-cli](../../../_includes/compute/add-several-net-interfaces-notice-cli.md) %} * `--create-boot-disk`: VM boot disk settings: - * `image-family`: [Image family](../../concepts/image.md#family), such as `centos-7`. This option allows you to install the latest version of the OS from the specified family. + * `image-family`: [Image family](../../concepts/image.md#family), e.g., `centos-7`. This option allows you to install the latest version of the OS from the specified family. * `--ssh-key`: Path to the file with the [public SSH key](../vm-connect/ssh.md#creating-ssh-keys). The VM will automatically create a user named `yc-user` for this key. - {% include [ssh-note](../../../_includes/compute/ssh-note.md) %} + {% include [ssh-note](../../../_includes/compute/ssh-note.md) %} - If you want to add several users with SSH keys to the VM at the same time, [specify](../../concepts/vm-metadata.md#how-to-send-metadata) these users' data using the `--metadata-from-file` parameter. + If you want to add several users with SSH keys to the VM at the same time, [specify](../../concepts/vm-metadata.md#how-to-send-metadata) these users' data using the `--metadata-from-file` parameter. - {% include [vm-create-check](../../../_includes/compute/vm-create-check.md) %} + {% include [vm-create-check](../../../_includes/compute/vm-create-check.md) %} - {% include [ip-fqdn-connection](../../../_includes/ip-fqdn-connection.md) %} + {% include [ip-fqdn-connection](../../../_includes/ip-fqdn-connection.md) %} - {{ TF }} {#tf} - {% include [terraform-install](../../../_includes/terraform-install.md) %} - - 1. In the configuration file, describe the parameters of the resources you want to create: - - ```hcl - - resource "yandex_compute_disk" "boot-disk" { - name = "" - type = "" - zone = "" - size = "" - image_id = "" - } - - resource "yandex_compute_instance" "linux-vm" { - name = "linux-vm" - platform_id = "standard-v3" - zone = "" - - resources { - cores = "" - memory = "" - } - - boot_disk { - disk_id = yandex_compute_disk.boot-disk.id - } - - network_interface { - subnet_id = yandex_vpc_subnet.subnet-1.id - nat = true - } - - metadata = { - user-data = "#cloud-config\nusers:\n - name: \n groups: sudo\n shell: /bin/bash\n sudo: 'ALL=(ALL) NOPASSWD:ALL'\n ssh-authorized-keys:\n - ${file("")}" - } - } - - resource "yandex_vpc_network" "network-1" { - name = "network1" - } - - resource "yandex_vpc_subnet" "subnet-1" { - name = "subnet1" - zone = "" - v4_cidr_blocks = ["192.168.10.0/24"] - network_id = yandex_vpc_network.network-1.id - } - ``` + {% include [terraform-install](../../../_includes/terraform-install.md) %} - Where: + 1. In the configuration file, describe the parameters of the resources you want to create: - * `yandex_compute_disk`: Boot [disk](../../concepts/disk.md) description: - * `name`: Disk name. - * `type`: Disk type. - * `zone`: [Availability zone](../../../overview/concepts/geo-scope.md) to host the disk. - * `size`: Disk size in GB. - * `image_id`: ID of the image to create the VM from. You can get the image ID from the [list of public images](../images-with-pre-installed-software/get-list.md). + ```hcl - {% include [id-info](../../../_includes/compute/id-info.md) %} + resource "yandex_compute_disk" "boot-disk" { + name = "" + type = "" + zone = "" + size = "" + image_id = "" + } - * `yandex_compute_instance`: Description of the VM: - * `name`: VM name. - * `platform_id`: [Platform](../../concepts/vm-platforms.md). - * `zone`: Availability zone to host the VM. - * `resources`: Number of vCPU cores and the amount of RAM available to the VM. The values must match the selected [platform](../../concepts/vm-platforms.md). - * `boot_disk`: Boot disk settings. Specify the disk ID. - * `network_interface`: VM's [network interface](../../concepts/network.md) settings. Specify the ID of the selected [subnet](../../../vpc/concepts/network.md#subnet). To automatically assign a [public IP address](../../../vpc/concepts/address.md#public-addresses) to the VM, set `nat = true`. + resource "yandex_compute_instance" "linux-vm" { + name = "linux-vm" + platform_id = "standard-v3" + zone = "" - {% include [add-several-net-interfaces-notice-tf](../../../_includes/compute/add-several-net-interfaces-notice-tf.md) %} + resources { + cores = "" + memory = "" + } - * `metadata`: In the metadata, provide the username and [public key for accessing the VM via SSH](../vm-connect/ssh.md#creating-ssh-keys). For more information, see [{#T}](../../concepts/vm-metadata.md). + boot_disk { + disk_id = yandex_compute_disk.boot-disk.id + } - If you want to add several users with SSH keys to the VM at the same time, [specify](../../concepts/vm-metadata.md#how-to-send-metadata) these users' data in a file and provide it under `metadata`. - * `yandex_vpc_network`: Description of the cloud network. - * `yandex_vpc_subnet`: Description of the subnet your VM will connect to. + network_interface { + subnet_id = yandex_vpc_subnet.subnet-1.id + nat = true + } - {% note info %} + metadata = { + user-data = "#cloud-config\nusers:\n - name: \n groups: sudo\n shell: /bin/bash\n sudo: 'ALL=(ALL) NOPASSWD:ALL'\n ssh-authorized-keys:\n - ${file("")}" + } + } - If you already have suitable resources, such as a cloud network and subnet, you do not need to describe them again. Use their names and IDs in the appropriate parameters. + resource "yandex_vpc_network" "network-1" { + name = "network1" + } - {% endnote %} + resource "yandex_vpc_subnet" "subnet-1" { + name = "subnet1" + zone = "" + v4_cidr_blocks = ["192.168.10.0/24"] + network_id = yandex_vpc_network.network-1.id + } + ``` + + Where: + + * `yandex_compute_disk`: Boot [disk](../../concepts/disk.md) description: + * `name`: Disk name. + * `type`: Disk type. + * `zone`: [Availability zone](../../../overview/concepts/geo-scope.md) the disk will be in. + * `size`: Disk size in GB. + * `image_id`: ID of the image to create the VM from. You can get the image ID from the [list of public images](../images-with-pre-installed-software/get-list.md). + + {% include [id-info](../../../_includes/compute/id-info.md) %} + + * `yandex_compute_instance`: VM description. + * `name`: VM name. + * `platform_id`: [Platform](../../concepts/vm-platforms.md). + * `zone`: Availability zone the VM will be in. + * `resources`: Number of vCPU cores and RAM available to the VM. The values must match the selected [platform](../../concepts/vm-platforms.md). + * `boot_disk`: Boot disk settings. Specify the disk ID. + * `network_interface`: VM's [network interface](../../concepts/network.md) settings. Specify the ID of the selected [subnet](../../../vpc/concepts/network.md#subnet). To automatically assign a [public IP address](../../../vpc/concepts/address.md#public-addresses) to the VM, set `nat = true`. + + {% include [add-several-net-interfaces-notice-tf](../../../_includes/compute/add-several-net-interfaces-notice-tf.md) %} + + * `metadata`: In the metadata, provide the username and [public key for SSH access](../vm-connect/ssh.md#creating-ssh-keys) to the VM. For more information, see [{#T}](../../concepts/vm-metadata.md). + + If you want to add several users with SSH keys to the VM at the same time, [specify](../../concepts/vm-metadata.md#how-to-send-metadata) these users' data in a file and provide it under `metadata`. + * `yandex_vpc_network`: Description of the cloud network. + * `yandex_vpc_subnet`: Description of the subnet your VM will be connected to. + + {% note info %} + + If you already have suitable resources, such as a cloud network and subnet, you do not need to describe them again. Use their names and IDs in the appropriate parameters. + + {% endnote %} - For more information about the resources that you can create using {{ TF }}, see the [provider documentation]({{ tf-provider-resources-link }}/compute_instance). - 1. Make sure the configuration files are correct. - 1. In the command line, go to the directory where you created the configuration file. - 1. Run a check using this command: + For more information about the resources you can create with {{ TF }}, see the [provider documentation]({{ tf-provider-resources-link }}/compute_instance). + 1. Make sure the configuration files are correct. + 1. In the command line, go to the folder where you created the configuration file. + 1. Run a check using this command: - ```bash - terraform plan - ``` + ```bash + terraform plan + ``` - If the configuration is described correctly, the terminal will display a list of created resources and their parameters. If the configuration contains any errors, {{ TF }} will point them out. - 1. Deploy cloud resources. - 1. If the configuration does not contain any errors, run this command: + If the configuration is described correctly, the terminal will display a list of created resources and their parameters. If the configuration contains any errors, {{ TF }} will point them out. + 1. Deploy cloud resources. + 1. If the configuration does not contain any errors, run this command: - ```bash - terraform apply - ``` + ```bash + terraform apply + ``` - 1. Confirm creating the resources: type `yes` in the terminal and press **Enter**. + 1. Confirm creating the resources: type `yes` in the terminal and press **Enter**. - {% include [vm-create-check](../../../_includes/compute/vm-create-check.md) %} + {% include [vm-create-check](../../../_includes/compute/vm-create-check.md) %} - {% include [ip-fqdn-connection](../../../_includes/ip-fqdn-connection.md) %} + {% include [ip-fqdn-connection](../../../_includes/ip-fqdn-connection.md) %} {% endlist %} \ No newline at end of file diff --git a/en/compute/operations/images-with-pre-installed-software/get-info.md b/en/compute/operations/images-with-pre-installed-software/get-info.md index 9d019da3c08..479a272e89a 100644 --- a/en/compute/operations/images-with-pre-installed-software/get-info.md +++ b/en/compute/operations/images-with-pre-installed-software/get-info.md @@ -191,7 +191,7 @@ You can get a public image ID or other information about it. * `output "image"`: Output variable containing information about the OS [family](../../concepts/image.md#family): * `value`: Returned value. - Instead of `family` you can select any other parameter to get the information you need. For more information about the `yandex_compute_image` data source parameters, see the [provider documentation]({{ tf-provider-datasources-link }}/datasource_compute_image). + Instead of `family` you can select any other parameter to get the information you need. For more information about the `yandex_compute_image` data source parameters, see the [relevant provider documentation]({{ tf-provider-datasources-link }}/datasource_compute_image). 1. Create resources: diff --git a/en/compute/operations/instance-groups/access.md b/en/compute/operations/instance-groups/access.md index 1cee847cbe2..13206ebc6d5 100644 --- a/en/compute/operations/instance-groups/access.md +++ b/en/compute/operations/instance-groups/access.md @@ -109,7 +109,7 @@ To grant a user, group, or [service account](../../../iam/concepts/users/service 1. Make sure the resource has no roles assigned that you would not want to lose: ```bash - {{ yc-compute-ig }} list-access-bindings + {{ yc-compute-ig }} list-access-bindings ``` 1. See the CLI command description for assigning roles for an instance group: diff --git a/en/compute/operations/instance-groups/create-with-balancer.md b/en/compute/operations/instance-groups/create-with-balancer.md index c4f5a648b89..440cc9f7a92 100644 --- a/en/compute/operations/instance-groups/create-with-balancer.md +++ b/en/compute/operations/instance-groups/create-with-balancer.md @@ -15,403 +15,405 @@ To create an instance group with a network load balancer: - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder) to create your instance group in. - 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. - 1. In the left-hand panel, select ![image](../../../_assets/console-icons/layers-3-diagonal.svg) **{{ ui-key.yacloud.compute.switch_groups }}**. - 1. Click **{{ ui-key.yacloud.compute.groups.button_create }}**. - 1. Under **{{ ui-key.yacloud.compute.groups.create.section_base }}**: - * Enter a name and description of the instance group. The naming requirements are as follows: - - {% include [name-format](../../../_includes/name-format.md) %} - - {% include [name-fqdn](../../../_includes/compute/name-fqdn.md) %} - - * Select a [service account](../../../iam/concepts/users/service-accounts.md) from the list or create a new one. To be able to create, update, and delete instances in the instance group, assign the `editor` [role](../../../iam/concepts/access-control/roles.md) to the service account. By default, all operations with instance groups are performed on behalf of the service account. - - {% include [sa-dependence-brief](../../../_includes/instance-groups/sa-dependence-brief.md) %} - - * Enable the **{{ ui-key.yacloud.compute.groups.create.field_deletion-protection }}** option, if needed. You cannot delete a group with this option enabled. - 1. Under **{{ ui-key.yacloud.compute.groups.create.section_allocation }}**, select the required ones in the **{{ ui-key.yacloud.compute.groups.create.field_zone }}** field. Instances of a group may reside in [different availability zones](../../../overview/concepts/geo-scope.md). - 1. Under **{{ ui-key.yacloud.compute.groups.create.section_instance }}**, click **{{ ui-key.yacloud.compute.groups.create.button_instance_empty-create }}** to configure a basic instance: - * Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**, enter a description for the [template](../../concepts/instance-groups/instance-template.md). - * Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, select a system to be deployed on the VM instance's boot [disk](../../concepts/disk.md). - * Under **{{ ui-key.yacloud.compute.instances.create.section_disk }}**: - * Select the [disk type](../../../compute/concepts/disk.md#disks_types). - * Specify the disk size. - * To add more disks, click **{{ ui-key.yacloud.compute.component.instance-storage-dialog.button_add-disk }}**. - * Under **{{ ui-key.yacloud.compute.instances.create.section_platform }}**: - * Choose a [platform](../../../compute/concepts/vm-platforms.md). - * Enter the required number of vCPUs, [guaranteed vCPU performance](../../concepts/performance-levels.md), and the amount of RAM. - * {% include [include](../../../_includes/instance-groups/specify-preemptible-vm.md) %} - * (Optional) Enable a [software-accelerated network](../../concepts/software-accelerated-network.md). - * Under **{{ ui-key.yacloud.compute.instances.create.section_network }}**: - - {% include [network-settings-group](../../../_includes/compute/network-settings-group.md) %} - - * Under **{{ ui-key.yacloud.compute.instances.create.section_access }}**, specify the information required to access the instance: - * Select a service account to link to the instance. - * If you selected a Linux [image](../../concepts/image.md), fill out the fields **{{ ui-key.yacloud.compute.instances.create.field_user }}** and **{{ ui-key.yacloud.compute.instances.create.field_key }}**. For a key, use the contents of the [public key](../../../compute/operations/vm-connect/ssh.md#creating-ssh-keys) file. - * Select `{{ ui-key.yacloud.compute.instances.create.field_serial-port-enable }}`, if needed. - * Click **{{ ui-key.yacloud.compute.groups.create.button_edit }}**. - 1. Under **{{ ui-key.yacloud.compute.groups.create.section_deploy }}**: - * In the **{{ ui-key.yacloud.compute.groups.create.field_deploy-max-expansion }}** field, specify the number of instances you can exceed the group size by. - * In the field **{{ ui-key.yacloud.compute.groups.create.field_deploy-max-unavailable }}**, specify the number of instances you can decrease the group size by. - * In the **{{ ui-key.yacloud.compute.groups.create.field_deploy-max-creating }}** field, specify how many instances can be created at the same time. - * In **{{ ui-key.yacloud.compute.groups.create.field_deploy-startup-duration }}**, specify the period after which the VM instance will start receiving the load. - * In the **{{ ui-key.yacloud.compute.groups.create.field_deploy-max-deleting }}** field, specify how many instances can be stopped at the same time. - * In the **{{ ui-key.yacloud.compute.groups.create.field_deploy-strategy }}** field, specify one of the [strategies](../../concepts/instance-groups/policies/deploy-policy.md#strategy): - * `{{ ui-key.yacloud.compute.groups.create.value_strategy-proactive }}`: {{ compute-name }} itself chooses which instances to stop when updating or scaling down the group. - * `{{ ui-key.yacloud.compute.groups.create.value_strategy-opportunistic }}`: {{ compute-name }} waits for the instances to stop on their own or be stopped by the user. - 1. Under **{{ ui-key.yacloud.compute.groups.create.section_scale }}**: - * Select the `{{ ui-key.yacloud.compute.groups.create.value_scale-fixed }}` [scaling type](../../../compute/concepts/instance-groups/scale.md). - * Specify the instance group size. - 1. Under **{{ ui-key.yacloud.compute.groups.create.section_ylb }}**, enable the **{{ ui-key.yacloud.compute.groups.create.field_target-group-attached }}** option. - 1. Specify the target group settings. For more information, see [{#T}](../../concepts/instance-groups/balancers.md#settings-nlb). - 1. If needed, enable the **{{ ui-key.yacloud.compute.groups.create.section_health-check }}** to get information about the state of instances and their automatic recovery on failure. - * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-protocol }}** field, select the protocol for the health checks: `{{ ui-key.yacloud.common.label_http }}` or `{{ ui-key.yacloud.common.label_tcp }}`. - * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-path }}** field (for the HTTP type), specify the URL path for the instance group to send HTTP check requests. - * Under **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-port }}**, specify the port number from 1 to 32767 on which the instance group will send health check requests. - * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-timeout }}** field, specify the response waiting time from 1 to 60 seconds. - * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-interval }}** field, specify the interval between the repeat checks from 1 to 60 seconds. The interval must be at least 1 second longer than the waiting time. - * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-healthy-threshold }}** field, specify the number of successful health checks required for the instance to be considered healthy. - * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-unhealthy-threshold }}** field, specify the number of failed health checks for the instance to be considered unhealthy. - 1. Under **{{ ui-key.yacloud.compute.groups.create.section_variables }}**, enter the `{{ ui-key.yacloud.common.label_key }}`-`{{ ui-key.yacloud.common.value }}` pairs, if needed. - 1. Click **{{ ui-key.yacloud.common.create }}**. + 1. In the [management console]({{ link-console-main }}), select the [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder) to create your instance group in. + 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. + 1. In the left-hand panel, select ![image](../../../_assets/console-icons/layers-3-diagonal.svg) **{{ ui-key.yacloud.compute.switch_groups }}**. + 1. Click **{{ ui-key.yacloud.compute.groups.button_create }}**. + 1. Under **{{ ui-key.yacloud.compute.groups.create.section_base }}**: + * Enter a name and description of the instance group. The naming requirements are as follows: + + {% include [name-format](../../../_includes/name-format.md) %} + + {% include [name-fqdn](../../../_includes/compute/name-fqdn.md) %} + + * Select a [service account](../../../iam/concepts/users/service-accounts.md) from the list or create a new one. To be able to create, update, and delete VM instances in the instance group, assign the `editor` [role](../../../iam/concepts/access-control/roles.md) to the service account. By default, all operations with instance groups are performed on behalf of the service account. + + {% include [sa-dependence-brief](../../../_includes/instance-groups/sa-dependence-brief.md) %} + + * Enable the **{{ ui-key.yacloud.compute.groups.create.field_deletion-protection }}** option, if needed. You cannot delete a group with this option enabled. + 1. Under **{{ ui-key.yacloud.compute.groups.create.section_allocation }}**, select the required ones in the **{{ ui-key.yacloud.compute.groups.create.field_zone }}** field. Instance groups may reside in [different availability zones](../../../overview/concepts/geo-scope.md). + 1. Under **{{ ui-key.yacloud.compute.groups.create.section_instance }}**, click **{{ ui-key.yacloud.compute.groups.create.button_instance_empty-create }}** to configure a basic instance: + * Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**, enter a description for the [template](../../concepts/instance-groups/instance-template.md). + * Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, select a system to be deployed on the VM instance's boot [disk](../../concepts/disk.md). + * Under **{{ ui-key.yacloud.compute.instances.create.section_disk }}**: + * Select the [disk type](../../../compute/concepts/disk.md#disks_types). + * Specify the disk size. + * To add more disks, click **{{ ui-key.yacloud.compute.component.instance-storage-dialog.button_add-disk }}**. + * Under **{{ ui-key.yacloud.compute.instances.create.section_platform }}**: + * Choose a [platform](../../../compute/concepts/vm-platforms.md). + * Enter the required number of vCPUs, [guaranteed vCPU performance](../../concepts/performance-levels.md), and the amount of RAM. + * {% include [include](../../../_includes/instance-groups/specify-preemptible-vm.md) %} + * (Optional) Enable a [software-accelerated network](../../concepts/software-accelerated-network.md). + * Under **{{ ui-key.yacloud.compute.instances.create.section_network }}**: + + {% include [network-settings-group](../../../_includes/compute/network-settings-group.md) %} + + * Under **{{ ui-key.yacloud.compute.instances.create.section_access }}**, specify the data for access to the instance: + * Select a service account to link to the instance. + * If you selected a Linux [image](../../concepts/image.md), fill out the fields **{{ ui-key.yacloud.compute.instances.create.field_user }}** and **{{ ui-key.yacloud.compute.instances.create.field_key }}**. For a key, use the contents of the [public key](../../../compute/operations/vm-connect/ssh.md#creating-ssh-keys) file. + * Select `{{ ui-key.yacloud.compute.instances.create.field_serial-port-enable }}`, if needed. + * Click **{{ ui-key.yacloud.compute.groups.create.button_edit }}**. + 1. Under **{{ ui-key.yacloud.compute.groups.create.section_deploy }}**: + * In the **{{ ui-key.yacloud.compute.groups.create.field_deploy-max-expansion }}** field, specify the number of instances you can exceed the group size by. + + {% include [max-expansion-notice](../../../_includes/instance-groups/max-expansion-notice.md) %} + * In the field **{{ ui-key.yacloud.compute.groups.create.field_deploy-max-unavailable }}**, specify the number of instances you can decrease the group size by. + * In the **{{ ui-key.yacloud.compute.groups.create.field_deploy-max-creating }}** field, specify how many instances can be created at the same time. + * In **{{ ui-key.yacloud.compute.groups.create.field_deploy-startup-duration }}**, specify the period after which the VM instance will start receiving the load. + * In the **{{ ui-key.yacloud.compute.groups.create.field_deploy-max-deleting }}** field, specify how many instances can be stopped at the same time. + * In the **{{ ui-key.yacloud.compute.groups.create.field_deploy-strategy }}** field, specify one of the [strategies](../../concepts/instance-groups/policies/deploy-policy.md#strategy): + * `{{ ui-key.yacloud.compute.groups.create.value_strategy-proactive }}`: {{ compute-name }} itself chooses which instances to stop when updating or scaling down the group. + * `{{ ui-key.yacloud.compute.groups.create.value_strategy-opportunistic }}`: {{ compute-name }} waits for the instances to stop on their own or be stopped by the user. + 1. Under **{{ ui-key.yacloud.compute.groups.create.section_scale }}**: + * Select the `{{ ui-key.yacloud.compute.groups.create.value_scale-fixed }}` [scaling type](../../../compute/concepts/instance-groups/scale.md). + * Specify the instance group size. + 1. Under **{{ ui-key.yacloud.compute.groups.create.section_ylb }}**, enable the **{{ ui-key.yacloud.compute.groups.create.field_target-group-attached }}** option. + 1. Specify the target group settings. For more information, see [{#T}](../../concepts/instance-groups/balancers.md#settings-nlb). + 1. If needed, enable the **{{ ui-key.yacloud.compute.groups.create.section_health-check }}** to get information about the state of instances and their automatic recovery on failure. + * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-protocol }}** field, select the protocol for the health checks: `{{ ui-key.yacloud.common.label_http }}` or `{{ ui-key.yacloud.common.label_tcp }}`. + * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-path }}** field (for the HTTP type), specify the URL path for the instance group to send HTTP check requests. + * Under **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-port }}**, specify the port number from 1 to 32767 on which the instance group will send health check requests. + * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-timeout }}** field, specify the response waiting time from 1 to 60 seconds. + * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-interval }}** field, specify the interval between the repeat checks from 1 to 60 seconds. The interval must be at least 1 second longer than the waiting time. + * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-healthy-threshold }}** field, specify the number of successful health checks required for the instance to be considered healthy. + * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-unhealthy-threshold }}** field, specify the number of failed health checks for the instance to be considered unhealthy. + 1. Under **{{ ui-key.yacloud.compute.groups.create.section_variables }}**, enter the `{{ ui-key.yacloud.common.label_key }}`-`{{ ui-key.yacloud.common.value }}` pairs, if needed. + 1. Click **{{ ui-key.yacloud.common.create }}**. - CLI {#cli} - {% include [cli-install.md](../../../_includes/cli-install.md) %} + {% include [cli-install.md](../../../_includes/cli-install.md) %} - {% include [default-catalogue.md](../../../_includes/default-catalogue.md) %} + {% include [default-catalogue.md](../../../_includes/default-catalogue.md) %} - 1. View the description of the [CLI](../../../cli/) command to create an instance group: + 1. View the description of the [CLI](../../../cli/) command to create an instance group: - ```bash - {{ yc-compute-ig }} create --help - ``` + ```bash + {{ yc-compute-ig }} create --help + ``` - 1. Check if there are any [networks](../../../vpc/concepts/network.md#network) in the [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder): + 1. Check whether the [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder) contains any [networks](../../../vpc/concepts/network.md#network): - ```bash - yc vpc network list - ``` + ```bash + yc vpc network list + ``` - If there are none, [create a network](../../../vpc/operations/network-create.md). - 1. Select one of the {{ marketplace-full-name }} public images, e.g., [CentOS 7](/marketplace/products/yc/centos-7). + If there are none, [create a network](../../../vpc/operations/network-create.md). + 1. Select one of the {{ marketplace-full-name }} public images, e.g., [CentOS 7](/marketplace/products/yc/centos-7). - {% include [standard-images.md](../../../_includes/standard-images.md) %} + {% include [standard-images.md](../../../_includes/standard-images.md) %} - 1. Create a YAML file with any name, e.g., `specification.yaml`. - 1. In the created file, indicate the following: - * General information about the instance group: + 1. Create a YAML file with any name, e.g., `specification.yaml`. + 1. In the created file, indicate the following: + * General information about the instance group: - ```yaml - name: first-fixed-group-with-balancer - service_account_id: - description: "This instance group was created from YAML config." - ``` + ```yaml + name: first-fixed-group-with-balancer + service_account_id: + description: "This instance group was created using a YAML configuration file." + ``` - Where: - * `name`: Name of the instance group. The name must be unique within the folder. The name may contain lowercase Latin letters, numbers, and hyphens. The first character must be a letter. The last character cannot be a hyphen. The name may be up to 63 characters long. - * `service_account_id`: Service account ID. + Where: + * `name`: Instance group name. The name must be unique within the folder. The name may contain lowercase Latin letters, numbers, and hyphens. The first character must be a letter. The last character cannot be a hyphen. The name may be up to 63 characters long. + * `service_account_id`: Service account ID. - {% include [sa-dependence-brief](../../../_includes/instance-groups/sa-dependence-brief.md) %} - - * `description`: Description of the instance group. - * [Instance template](../../concepts/instance-groups/instance-template.md), such as: - - ```yaml - instance_template: - platform_id: standard-v3 - resources_spec: - memory: 2g - cores: 2 - boot_disk_spec: - mode: READ_WRITE - disk_spec: - image_id: fdvk34al8k5n******** - type_id: network-hdd - size: 32g - network_interface_specs: - - network_id: c64mknqgnd8a******** - primary_v4_address_spec: {} - security_group_ids: - - enps0ar5s3ti******** - scheduling_policy: - preemptible: false - placement_policy: - placement_group_id: rmppvhrgm77g******** - ``` - - {% include [default-unit-size](../../../_includes/instance-groups/default-unit-size.md) %} - - Where: - * `platform_id`: [Platform](../../concepts/vm-platforms.md) ID. - * `memory`: Amount of RAM. - * `cores`: Number of processor cores (vCPUs). - * `mode`: [Disk](../../concepts/disk.md) access mode. - * `READ_ONLY`: Read-only access. - * `READ_WRITE`: Read/write access. - * `image_id`: ID of the public image. You can view image IDs in the [management console]({{ link-console-main }}) when creating a VM or in [{{ marketplace-name }}](/marketplace) on the image page under **Product IDs**. - * `type_id`: Disk type. - * `size`: Disk size. - * `network_id`: ID of the `default-net` network. - * `primary_v4_address_spec`: IPv4 specification. You can allow public access to the group's instances by specifying the IP version for the [public IP address](../../../vpc/concepts/address.md#public-addresses). For more information, see [{#T}](../../concepts/instance-groups/instance-template.md#instance-template). - * `security_group_ids`: List of [security group](../../../vpc/concepts/security-groups.md) IDs. - * `scheduling_policy`: Scheduling policy configuration. - * `preemptible`: Flag for creating [preemptible VMs](../../concepts/preemptible-vm.md). - * `true`: Create a preemptible VM. - * `false` (default): Create a regular VM. - - When creating a preemptible instance group, keep in mind that the VM instances will terminate after 24 hours of continuous operation or earlier. VMs may not be able to restart immediately due to insufficient resources. This may occur in the event of a sharp increase in the use of {{ yandex-cloud }} computing resources. - * `placement_policy`: (Optional) [VM placement group](../../concepts/placement-groups.md) parameters: - * `placement_group_id`: Placement group ID. - * [Policies](../../concepts/instance-groups/policies/index.md): - - ```yaml - deploy_policy: - max_unavailable: 1 - max_expansion: 0 - scale_policy: - fixed_scale: - size: 3 - allocation_policy: - zones: - - zone_id: {{ region-id }}-a - instance_tags_pool: - - first - - second - - third - ``` - - Where: - * `deploy_policy`: [Deployment policy](../../concepts/instance-groups/policies/deploy-policy.md) for instances in the group. - * `scale_policy`: [Scaling policy](../../concepts/instance-groups/policies/scale-policy.md) for instances in the group. - * `allocation_policy`: [Policy for allocating](../../concepts/instance-groups/policies/allocation-policy.md) VM instances across [availability zones](../../../overview/concepts/geo-scope.md). - * {{ network-load-balancer-name }} [target group](../../../network-load-balancer/concepts/target-resources.md): - - ```yaml - load_balancer_spec: - target_group_spec: - name: first-target-group - ``` - - Where: - * `target_group_spec`: Specification of the {{ network-load-balancer-name }} target group associated with the instance group. - * `name`: Any name of the {{ network-load-balancer-name }} target group. The name must be unique within the folder. The name may contain lowercase Latin letters, numbers, and hyphens. The first character must be a letter. The last character cannot be a hyphen. The name may be up to 63 characters long. - - For more information about the target group settings, see [{#T}](../../concepts/instance-groups/balancers.md#settings-nlb). - - Full code for the `specification.yaml` file: - - ```yaml - name: first-fixed-group-with-balancer - service_account_id: - description: "This instance group was created from YAML config." - instance_template: - platform_id: standard-v3 - resources_spec: - memory: 2g - cores: 2 - boot_disk_spec: - mode: READ_WRITE - disk_spec: - image_id: fdvk34al8k5n******** - type_id: network-hdd - size: 32g - network_interface_specs: - - network_id: c64mknqgnd8a******** - primary_v4_address_spec: {} - security_group_ids: - - enps0ar5s3ti******** - placement_policy: - placement_group_id: rmppvhrgm77g******** - deploy_policy: - max_unavailable: 1 - max_expansion: 0 - scale_policy: - fixed_scale: - size: 3 - allocation_policy: - zones: - - zone_id: {{ region-id }}-a - instance_tags_pool: - - first - - second - - third - load_balancer_spec: - target_group_spec: - name: first-target-group - ``` - - 1. Create an instance group in the default folder: - - ```bash - {{ yc-compute-ig }} create --file specification.yaml - ``` - - This command creates a group of three similar instances with the following configuration: - * Name: `first-fixed-group-with-balancer` - * OS: CentOS 7 - * Network: `default-net` - * Availability zone: `{{ region-id }}-a` - * vCPUs: 2; RAM: 2 GB - * Network HDD: 32 GB - * Target group: `first-target-group` - 1. [Create a network load balancer](../../../network-load-balancer/operations/load-balancer-create.md) and add `first-target-group` to it. - -- {{ TF }} {#tf} + {% include [sa-dependence-brief](../../../_includes/instance-groups/sa-dependence-brief.md) %} - {% include [terraform-install](../../../_includes/terraform-install.md) %} - - 1. In the configuration file, describe the parameters of the resources you want to create: - - ```hcl - resource "yandex_iam_service_account" "ig-sa" { - name = "ig-sa" - description = "Service account for managing the instance group." - } - - resource "yandex_resourcemanager_folder_iam_member" "editor" { - folder_id = "" - role = "editor" - member = "serviceAccount:${yandex_iam_service_account.ig-sa.id}" - } - - resource "yandex_compute_instance_group" "ig-1" { - name = "fixed-ig-with-balancer" - folder_id = "" - service_account_id = "${yandex_iam_service_account.ig-sa.id}" - deletion_protection = "" - instance_template { - platform_id = "standard-v3" - resources { - memory = - cores = - } - - boot_disk { - mode = "READ_WRITE" - initialize_params { - image_id = "" - } - } - - network_interface { - network_id = "${yandex_vpc_network.network-1.id}" - subnet_ids = ["${yandex_vpc_subnet.subnet-1.id}"] - security_group_ids = [""] - } - - metadata = { - ssh-keys = ":" - } - } - - scale_policy { - fixed_scale { - size = - } - } - - allocation_policy { - zones = ["{{ region-id }}-a"] - } - - deploy_policy { - max_unavailable = 1 - max_expansion = 0 - } - - load_balancer { - target_group_name = "target-group" - target_group_description = "{{ network-load-balancer-name }} target group" - } - } - - resource "yandex_lb_network_load_balancer" "lb-1" { - name = "network-load-balancer-1" - - listener { - name = "network-load-balancer-1-listener" - port = 80 - external_address_spec { - ip_version = "ipv4" - } - } - - attached_target_group { - target_group_id = yandex_compute_instance_group.ig-1.load_balancer.0.target_group_id - - healthcheck { - name = "http" - http_options { - port = 80 - path = "/index.html" - } - } - } - } - - resource "yandex_vpc_network" "network-1" { - name = "network1" - } - - resource "yandex_vpc_subnet" "subnet-1" { - name = "subnet1" - zone = "{{ region-id }}-a" - network_id = "${yandex_vpc_network.network-1.id}" - v4_cidr_blocks = ["192.168.10.0/24"] - } - ``` - - Where: - * `yandex_iam_service_account`: Description of the [service account](../../../iam/concepts/users/service-accounts.md). All operations with VM groups are performed on behalf of the service account. + * `description`: Instance group description. + * [Instance template](../../concepts/instance-groups/instance-template.md), such as: + + ```yaml + instance_template: + platform_id: standard-v3 + resources_spec: + memory: 2g + cores: 2 + boot_disk_spec: + mode: READ_WRITE + disk_spec: + image_id: fdvk34al8k5n******** + type_id: network-hdd + size: 32g + network_interface_specs: + - network_id: c64mknqgnd8a******** + primary_v4_address_spec: {} + security_group_ids: + - enps0ar5s3ti******** + scheduling_policy: + preemptible: false + placement_policy: + placement_group_id: rmppvhrgm77g******** + ``` + + {% include [default-unit-size](../../../_includes/instance-groups/default-unit-size.md) %} + + Where: + * `platform_id`: [Platform](../../concepts/vm-platforms.md) ID. + * `memory`: Amount of memory (RAM). + * `cores`: Number of processor cores (vCPUs). + * `mode`: [Disk](../../concepts/disk.md) access mode. + * `READ_ONLY`: Read-only access. + * `READ_WRITE`: Read/write access. + * `image_id`: Public image ID. You can view image IDs in the [management console]({{ link-console-main }}) when creating a VM or in [{{ marketplace-name }}](/marketplace) on the image page under **Product IDs**. + * `type_id`: Disk type. + * `size`: Disk size. + * `network_id`: `default-net` network ID. + * `primary_v4_address_spec`: IPv4 specification. You can allow public access to the group's instances by specifying the IP version for the [public IP address](../../../vpc/concepts/address.md#public-addresses). For more information, see [{#T}](../../concepts/instance-groups/instance-template.md#instance-template). + * `security_group_ids`: List of [security group](../../../vpc/concepts/security-groups.md) IDs. + * `scheduling_policy`: Scheduling policy configuration. + * `preemptible`: Flag for creating [preemptible VMs](../../concepts/preemptible-vm.md). + * `true`: Create a preemptible VM. + * `false` (default): Create a regular VM. + + When creating a preemptible instance group, keep in mind that the VM instances will terminate after 24 hours of continuous operation or earlier. VMs may not be able to restart immediately due to insufficient resources. This may occur in the event of a sharp increase in the use of {{ yandex-cloud }} computing resources. + * `placement_policy`: (Optional) [Instance placement group](../../concepts/placement-groups.md) parameters: + * `placement_group_id`: Placement group ID. + * [Policies](../../concepts/instance-groups/policies/index.md): + + ```yaml + deploy_policy: + max_unavailable: 1 + max_expansion: 0 + scale_policy: + fixed_scale: + size: 3 + allocation_policy: + zones: + - zone_id: {{ region-id }}-a + instance_tags_pool: + - first + - second + - third + ``` + + Where: + * `deploy_policy`: Instance [deployment policy](../../concepts/instance-groups/policies/deploy-policy.md) for the group. + * `scale_policy`: Instance [scaling policy](../../concepts/instance-groups/policies/scale-policy.md) for the group. + * `allocation_policy`: Instance [allocation policy](../../concepts/instance-groups/policies/allocation-policy.md) between [availability zones](../../../overview/concepts/geo-scope.md). + * {{ network-load-balancer-name }} [target group](../../../network-load-balancer/concepts/target-resources.md): + + ```yaml + load_balancer_spec: + target_group_spec: + name: first-target-group + ``` + + Where: + * `target_group_spec`: Specification of the {{ network-load-balancer-name }} target group linked with the instance group. + * `name`: Name for the {{ network-load-balancer-name }} target group. The name must be unique within the folder. The name may contain lowercase Latin letters, numbers, and hyphens. The first character must be a letter. The last character cannot be a hyphen. The name may be up to 63 characters long. + + For more information about target group settings, see [{#T}](../../concepts/instance-groups/balancers.md#settings-nlb). + + Full code for the `specification.yaml` file: + + ```yaml + name: first-fixed-group-with-balancer + service_account_id: + description: "This instance group was created using a YAML configuration file." + instance_template: + platform_id: standard-v3 + resources_spec: + memory: 2g + cores: 2 + boot_disk_spec: + mode: READ_WRITE + disk_spec: + image_id: fdvk34al8k5n******** + type_id: network-hdd + size: 32g + network_interface_specs: + - network_id: c64mknqgnd8a******** + primary_v4_address_spec: {} + security_group_ids: + - enps0ar5s3ti******** + placement_policy: + placement_group_id: rmppvhrgm77g******** + deploy_policy: + max_unavailable: 1 + max_expansion: 0 + scale_policy: + fixed_scale: + size: 3 + allocation_policy: + zones: + - zone_id: {{ region-id }}-a + instance_tags_pool: + - first + - second + - third + load_balancer_spec: + target_group_spec: + name: first-target-group + ``` + + 1. Create an instance group in the default folder: + + ```bash + {{ yc-compute-ig }} create --file specification.yaml + ``` + + This command creates a group of three same-type VMs with the following configuration: + * Name: `first-fixed-group-with-balancer` + * OS: CentOS 7 + * Network: `default-net` + * Availability zone: `{{ region-id }}-a` + * vCPUs: 2; RAM: 2 GB + * Network HDD: 32 GB + * Target group: `first-target-group` + 1. [Create a network load balancer](../../../network-load-balancer/operations/load-balancer-create.md) and add `first-target-group` to it. - {% include [sa-dependence-brief](../../../_includes/instance-groups/sa-dependence-brief.md) %} +- {{ TF }} {#tf} - * `yandex_resourcemanager_folder_iam_member`: Description of access permissions to the [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder) the service account belongs to. To be able to create, update, and delete instances in the instance group, assign the `editor` [role](../../../iam/concepts/access-control/roles.md) to the service account. - * `yandex_compute_instance_group`: Description of the instance group: - * General information about the instance group: - * `name`: Name of the instance group. - * `folder_id`: Folder ID. - * `service_account_id`: Service account ID. - * `deletion_protection`: Instance group deletion protection, `true` or `false`. You cannot delete an instance group with this option enabled. The default value is `false`. - * [Instance template](../../concepts/instance-groups/instance-template.md): - * `platform_id`: [Platform](../../concepts/vm-platforms.md). - * `resources`: Number of vCPU cores and the amount of RAM available to the VM. The values must match the selected [platform](../../concepts/vm-platforms.md). - * `boot_disk`: Boot [disk](../../concepts/disk.md) settings. - * ID of the selected image. You can get the image ID from the [list of public images](../images-with-pre-installed-software/get-list.md). - * Disk access mode: `READ_ONLY` (read) or `READ_WRITE` (read and write). - * `network_interface`: [Network](../../../vpc/concepts/network.md#network) settings. Specify the IDs of your network, [subnet](../../../vpc/concepts/network.md#subnet), and [security groups](../../../vpc/concepts/security-groups.md). - * `metadata`: In the [metadata](../../concepts/vm-metadata.md), provide the public key for VM access via SSH. For more information, see [{#T}](../../concepts/vm-metadata.md). - * [Policies](../../concepts/instance-groups/policies/index.md): - * `deploy_policy`: [Deployment policy](../../concepts/instance-groups/policies/deploy-policy.md) for instances in the group. - * `scale_policy`: [Scaling policy](../../concepts/instance-groups/policies/scale-policy.md) for instances in the group. - * `allocation_policy`: [Policy for allocating](../../concepts/instance-groups/policies/allocation-policy.md) VM instances across [availability zones](../../../overview/concepts/geo-scope.md). - * {{ network-load-balancer-name }} [target group](../../../network-load-balancer/concepts/target-resources.md): - * `target_group_name`: {{ network-load-balancer-name }} target group name. - * `target_group_description`: {{ network-load-balancer-name }} target group description. - For more information about the target group settings, see [{#T}](../../concepts/instance-groups/balancers.md#settings-nlb). - * `yandex_vpc_network`: Description of the cloud network. - * `yandex_vpc_subnet`: Description of the subnet the instance group will connect to. - * `yandex_lb_network_load_balancer`: Description of the [{{ network-load-balancer-name }} network load balancer](../../../network-load-balancer/concepts/index.md) to attach the target group to. - - {% note info %} - - If you already have suitable resources, such as a service account, cloud network, subnet, and network load balancer, you do not need to describe them again. Use their names and IDs in the appropriate parameters. - - {% endnote %} - - For more information about the resources you can create with {{ TF }}, see the [provider documentation]({{ tf-provider-link }}). - 1. Create resources: - - {% include [terraform-validate-plan-apply](../../../_tutorials/_tutorials_includes/terraform-validate-plan-apply.md) %} - - All the resources you need will then be created in the specified folder. You can check the new resources and their configuration using the [management console]({{ link-console-main }}). + {% include [terraform-install](../../../_includes/terraform-install.md) %} + + 1. In the configuration file, describe the parameters of the resources you want to create: + + ```hcl + resource "yandex_iam_service_account" "ig-sa" { + name = "ig-sa" + description = "Service account for managing the instance group." + } + + resource "yandex_resourcemanager_folder_iam_member" "editor" { + folder_id = "" + role = "editor" + member = "serviceAccount:${yandex_iam_service_account.ig-sa.id}" + } + + resource "yandex_compute_instance_group" "ig-1" { + name = "fixed-ig-with-balancer" + folder_id = "" + service_account_id = "${yandex_iam_service_account.ig-sa.id}" + deletion_protection = "" + instance_template { + platform_id = "standard-v3" + resources { + memory = + cores = + } + + boot_disk { + mode = "READ_WRITE" + initialize_params { + image_id = "" + } + } + + network_interface { + network_id = "${yandex_vpc_network.network-1.id}" + subnet_ids = ["${yandex_vpc_subnet.subnet-1.id}"] + security_group_ids = [""] + } + + metadata = { + ssh-keys = ":" + } + } + + scale_policy { + fixed_scale { + size = + } + } + + allocation_policy { + zones = ["{{ region-id }}-a"] + } + + deploy_policy { + max_unavailable = 1 + max_expansion = 0 + } + + load_balancer { + target_group_name = "target-group" + target_group_description = "{{ network-load-balancer-name }} target group" + } + } + + resource "yandex_lb_network_load_balancer" "lb-1" { + name = "network-load-balancer-1" + + listener { + name = "network-load-balancer-1-listener" + port = 80 + external_address_spec { + ip_version = "ipv4" + } + } + + attached_target_group { + target_group_id = yandex_compute_instance_group.ig-1.load_balancer.0.target_group_id + + healthcheck { + name = "http" + http_options { + port = 80 + path = "/index.html" + } + } + } + } + + resource "yandex_vpc_network" "network-1" { + name = "network1" + } + + resource "yandex_vpc_subnet" "subnet-1" { + name = "subnet1" + zone = "{{ region-id }}-a" + network_id = "${yandex_vpc_network.network-1.id}" + v4_cidr_blocks = ["192.168.10.0/24"] + } + ``` + + Where: + * `yandex_iam_service_account`: [Service account](../../../iam/concepts/users/service-accounts.md) description. All operations with instance groups are performed on behalf of the service account. + + {% include [sa-dependence-brief](../../../_includes/instance-groups/sa-dependence-brief.md) %} + + * `yandex_resourcemanager_folder_iam_member`: Description of access permissions to the [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder) the service account belongs to. To be able to create, update, and delete VM instances in the instance group, assign the `editor` [role](../../../iam/concepts/access-control/roles.md) to the service account. + * `yandex_compute_instance_group`: Instance group description: + * General information about the instance group: + * `name`: Instance group name. + * `folder_id`: Folder ID. + * `service_account_id`: Service account ID. + * `deletion_protection`: Instance group deletion protection, `true` or `false`. You cannot delete an instance group with this option enabled. The default value is `false`. + * [Instance template](../../concepts/instance-groups/instance-template.md): + * `platform_id`: [Platform](../../concepts/vm-platforms.md). + * `resources`: Number of vCPU cores and RAM available to the VM. The values must match the selected [platform](../../concepts/vm-platforms.md). + * `boot_disk`: Boot [disk](../../concepts/disk.md) settings. + * ID of the selected image. You can get the image ID from the [list of public images](../images-with-pre-installed-software/get-list.md). + * Disk access mode: `READ_ONLY` or `READ_WRITE`. + * `network_interface`: [Network](../../../vpc/concepts/network.md#network) configurations. Specify the IDs of your network, [subnet](../../../vpc/concepts/network.md#subnet), and [security groups](../../../vpc/concepts/security-groups.md). + * `metadata`: In [metadata](../../concepts/vm-metadata.md), provide the public key for SSH access to the VM. For more information, see [{#T}](../../concepts/vm-metadata.md). + * [Policies](../../concepts/instance-groups/policies/index.md): + * `deploy_policy`: [Deployment policy](../../concepts/instance-groups/policies/deploy-policy.md) for VMs in the group. + * `scale_policy`: [Scaling policy](../../concepts/instance-groups/policies/scale-policy.md) for VMs in the group. + * `allocation_policy`: VM [allocation policy](../../concepts/instance-groups/policies/allocation-policy.md) between [availability zones](../../../overview/concepts/geo-scope.md). + * {{ network-load-balancer-name }} [target group](../../../network-load-balancer/concepts/target-resources.md): + * `target_group_name`: Name of the {{ network-load-balancer-name }} target group. + * `target_group_description`: Description of the {{ network-load-balancer-name }} target group. + For more information about target group settings, see [{#T}](../../concepts/instance-groups/balancers.md#settings-nlb). + * `yandex_vpc_network`: Description of the cloud network. + * `yandex_vpc_subnet`: Description of the subnet the instance group will connect to. + * `yandex_lb_network_load_balancer`: Description of the [{{ network-load-balancer-name }} network load balancer](../../../network-load-balancer/concepts/index.md) the target group will connect to. + + {% note info %} + + If you already have suitable resources, such as a service account, cloud network, subnet, and network load balancer, you do not need to describe them again. Use their names and IDs in the appropriate parameters. + + {% endnote %} + + For more information about the resources you can create with {{ TF }}, see the [provider documentation]({{ tf-provider-link }}). + 1. Create resources: + + {% include [terraform-validate-plan-apply](../../../_tutorials/_tutorials_includes/terraform-validate-plan-apply.md) %} + + All the resources you need will then be created in the specified folder. You can check the new resources and their configuration using the [management console]({{ link-console-main }}). - API {#api} - Use the [create](../../instancegroup/api-ref/InstanceGroup/create.md) REST API method for the [InstanceGroup](../../instancegroup/api-ref/InstanceGroup/index.md) resource or the [InstanceGroupService/Create](../../instancegroup/api-ref/grpc/InstanceGroup/create.md) gRPC API call. + Use the [create](../../instancegroup/api-ref/InstanceGroup/create.md) REST API method for the [InstanceGroup](../../instancegroup/api-ref/InstanceGroup/index.md) resource or the [InstanceGroupService/Create](../../instancegroup/api-ref/grpc/InstanceGroup/create.md) gRPC API call. {% endlist %} \ No newline at end of file diff --git a/en/compute/operations/instance-groups/create-with-load-balancer.md b/en/compute/operations/instance-groups/create-with-load-balancer.md index 68ebeda1c51..3fc69dd3741 100644 --- a/en/compute/operations/instance-groups/create-with-load-balancer.md +++ b/en/compute/operations/instance-groups/create-with-load-balancer.md @@ -15,379 +15,381 @@ To create an instance group with an L7 load balancer: - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder) to create your instance group in. - 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. - 1. In the left-hand panel, select ![image](../../../_assets/console-icons/layers-3-diagonal.svg) **{{ ui-key.yacloud.compute.switch_groups }}**. - 1. Click **{{ ui-key.yacloud.compute.groups.button_create }}**. - 1. Under **{{ ui-key.yacloud.compute.groups.create.section_base }}**: - * Enter a name and description of the instance group. The naming requirements are as follows: - - {% include [name-format](../../../_includes/name-format.md) %} - - {% include [name-fqdn](../../../_includes/compute/name-fqdn.md) %} - - * Select a [service account](../../../iam/concepts/users/service-accounts.md) from the list or create a new one. To be able to create, update, and delete instances in the instance group, assign the `editor` [role](../../../iam/concepts/access-control/roles.md) to the service account. By default, all operations with instance groups are performed on behalf of the service account. - - {% include [sa-dependence-brief](../../../_includes/instance-groups/sa-dependence-brief.md) %} - - * Enable the **{{ ui-key.yacloud.compute.groups.create.field_deletion-protection }}** option, if needed. You cannot delete a group with this option enabled. - 1. Under **{{ ui-key.yacloud.compute.groups.create.section_allocation }}**, select the required ones in the **{{ ui-key.yacloud.compute.groups.create.field_zone }}** field. Instances of a group may reside in [different availability zones](../../../overview/concepts/geo-scope.md). - 1. Under **{{ ui-key.yacloud.compute.groups.create.section_instance }}**, click **{{ ui-key.yacloud.compute.groups.create.button_instance_empty-create }}** to configure a basic instance: - * Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**, enter a description for the [template](../../concepts/instance-groups/instance-template.md). - * Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, select a system to be deployed on the VM instance's boot [disk](../../concepts/disk.md). - * Under **{{ ui-key.yacloud.compute.instances.create.section_disk }}**: - * Select the [disk type](../../../compute/concepts/disk.md#disks_types). - * Specify the disk size. - * To add more disks, click **{{ ui-key.yacloud.compute.component.instance-storage-dialog.button_add-disk }}**. - * Under **{{ ui-key.yacloud.compute.instances.create.section_platform }}**: - * Choose a [platform](../../../compute/concepts/vm-platforms.md). - * Enter the required number of vCPUs, [guaranteed vCPU performance](../../concepts/performance-levels.md), and the amount of RAM. - * {% include [include](../../../_includes/instance-groups/specify-preemptible-vm.md) %} - * (Optional) Enable a [software-accelerated network](../../concepts/software-accelerated-network.md). - * Under **{{ ui-key.yacloud.compute.instances.create.section_network }}**: - - {% include [network-settings-group](../../../_includes/compute/network-settings-group.md) %} - - * Under **{{ ui-key.yacloud.compute.instances.create.section_access }}**, specify the information required to access the instance: - * Select a service account to link to the instance. - * If you selected a Linux [image](../../concepts/image.md), fill out the fields **{{ ui-key.yacloud.compute.instances.create.field_user }}** and **{{ ui-key.yacloud.compute.instances.create.field_key }}**. For a key, use the contents of the [public key](../../../compute/operations/vm-connect/ssh.md#creating-ssh-keys) file. - * Select `{{ ui-key.yacloud.compute.instances.create.field_serial-port-enable }}`, if needed. - * Click **{{ ui-key.yacloud.compute.groups.create.button_edit }}**. - 1. Under **{{ ui-key.yacloud.compute.groups.create.section_deploy }}**: + 1. In the [management console]({{ link-console-main }}), select the [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder) to create your instance group in. + 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. + 1. In the left-hand panel, select ![image](../../../_assets/console-icons/layers-3-diagonal.svg) **{{ ui-key.yacloud.compute.switch_groups }}**. + 1. Click **{{ ui-key.yacloud.compute.groups.button_create }}**. + 1. Under **{{ ui-key.yacloud.compute.groups.create.section_base }}**: + * Enter a name and description of the instance group. The naming requirements are as follows: + + {% include [name-format](../../../_includes/name-format.md) %} + + {% include [name-fqdn](../../../_includes/compute/name-fqdn.md) %} + + * Select a [service account](../../../iam/concepts/users/service-accounts.md) from the list or create a new one. To be able to create, update, and delete VM instances in the instance group, assign the `editor` [role](../../../iam/concepts/access-control/roles.md) to the service account. By default, all operations with instance groups are performed on behalf of the service account. + + {% include [sa-dependence-brief](../../../_includes/instance-groups/sa-dependence-brief.md) %} + + * Enable the **{{ ui-key.yacloud.compute.groups.create.field_deletion-protection }}** option, if needed. You cannot delete a group with this option enabled. + 1. Under **{{ ui-key.yacloud.compute.groups.create.section_allocation }}**, select the required ones in the **{{ ui-key.yacloud.compute.groups.create.field_zone }}** field. Instances of a group may reside in [different availability zones](../../../overview/concepts/geo-scope.md). + 1. Under **{{ ui-key.yacloud.compute.groups.create.section_instance }}**, click **{{ ui-key.yacloud.compute.groups.create.button_instance_empty-create }}** to configure a basic instance: + * Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**, enter a description for the [template](../../concepts/instance-groups/instance-template.md). + * Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, select a system to be deployed on the VM instance's boot [disk](../../concepts/disk.md). + * Under **{{ ui-key.yacloud.compute.instances.create.section_disk }}**: + * Select the [disk type](../../../compute/concepts/disk.md#disks_types). + * Specify the disk size. + * To add more disks, click **{{ ui-key.yacloud.compute.component.instance-storage-dialog.button_add-disk }}**. + * Under **{{ ui-key.yacloud.compute.instances.create.section_platform }}**: + * Choose a [platform](../../../compute/concepts/vm-platforms.md). + * Enter the required number of vCPUs, [guaranteed vCPU performance](../../concepts/performance-levels.md), and the amount of RAM. + * {% include [include](../../../_includes/instance-groups/specify-preemptible-vm.md) %} + * (Optional) Enable a [software-accelerated network](../../concepts/software-accelerated-network.md). + * Under **{{ ui-key.yacloud.compute.instances.create.section_network }}**: + + {% include [network-settings-group](../../../_includes/compute/network-settings-group.md) %} + + * Under **{{ ui-key.yacloud.compute.instances.create.section_access }}**, specify the data for access to the instance: + * Select a service account to link to the instance. + * If you selected a Linux [image](../../concepts/image.md), fill out the fields **{{ ui-key.yacloud.compute.instances.create.field_user }}** and **{{ ui-key.yacloud.compute.instances.create.field_key }}**. For a key, use the contents of the [public key](../../../compute/operations/vm-connect/ssh.md#creating-ssh-keys) file. + * Select `{{ ui-key.yacloud.compute.instances.create.field_serial-port-enable }}`, if needed. + * Click **{{ ui-key.yacloud.compute.groups.create.button_edit }}**. + 1. Under **{{ ui-key.yacloud.compute.groups.create.section_deploy }}**: * In the **{{ ui-key.yacloud.compute.groups.create.field_deploy-max-expansion }}** field, specify the number of instances you can exceed the group size by. + + {% include [max-expansion-notice](../../../_includes/instance-groups/max-expansion-notice.md) %} * In the field **{{ ui-key.yacloud.compute.groups.create.field_deploy-max-unavailable }}**, specify the number of instances you can decrease the group size by. * In the **{{ ui-key.yacloud.compute.groups.create.field_deploy-max-creating }}** field, specify how many instances can be created at the same time. * In **{{ ui-key.yacloud.compute.groups.create.field_deploy-startup-duration }}**, specify the period after which the VM instance will start receiving the load. * In the **{{ ui-key.yacloud.compute.groups.create.field_deploy-max-deleting }}** field, specify how many instances can be stopped at the same time. * In the **{{ ui-key.yacloud.compute.groups.create.field_deploy-strategy }}** field, specify one of the [strategies](../../../compute/concepts/instance-groups/policies/deploy-policy.md#strategy): - * `{{ ui-key.yacloud.compute.groups.create.value_strategy-proactive }}`: {{ ig-name }} itself chooses which instances to stop when updating or scaling down the group. - * `{{ ui-key.yacloud.compute.groups.create.value_strategy-opportunistic }}`: {{ ig-name }} waits for the instances to stop on their own or be stopped by the user. - 1. Under **{{ ui-key.yacloud.compute.groups.create.section_scale }}**: - * Select the `{{ ui-key.yacloud.compute.groups.create.value_scale-fixed }}` [scaling type](../../../compute/concepts/instance-groups/scale.md). - * Specify the instance group size. - 1. Under **{{ ui-key.yacloud.compute.groups.create.section_alb }}**, enable the **{{ ui-key.yacloud.compute.groups.create.field_target-group-attached }}** option. - 1. Specify the target group settings. For more information, see [{#T}](../../concepts/instance-groups/balancers.md#settings-alb). - 1. If needed, enable the **{{ ui-key.yacloud.compute.groups.create.section_health-check }}** to get information about the state of instances and their automatic recovery on failure. - * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-protocol }}** field, select the protocol for the health checks: `{{ ui-key.yacloud.common.label_http }}` or `{{ ui-key.yacloud.common.label_tcp }}`. - * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-path }}** field (for the HTTP type), specify the URL path for the HTTP check requests sent from {{ ig-name }}. - * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-port }}** field, specify the port number from 1 to 32767 for {{ ig-name }} to send the health check requests to. - * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-timeout }}** field, specify the response waiting time from 1 to 60 seconds. - * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-interval }}** field, specify the interval between the repeat checks from 1 to 60 seconds. The interval must be at least 1 second longer than the waiting time. - * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-healthy-threshold }}** field, specify the number of successful health checks required for the instance to be considered healthy. - * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-unhealthy-threshold }}** field, specify the number of failed health checks for the instance to be considered unhealthy. - 1. Under **{{ ui-key.yacloud.compute.groups.create.section_variables }}**, enter the `{{ ui-key.yacloud.common.label_key }}`-`{{ ui-key.yacloud.common.value }}` pairs, if needed. - 1. Click **{{ ui-key.yacloud.common.create }}**. + * `{{ ui-key.yacloud.compute.groups.create.value_strategy-proactive }}`: {{ ig-name }} itself chooses which instances to stop when updating or scaling down the group. + * `{{ ui-key.yacloud.compute.groups.create.value_strategy-opportunistic }}`: {{ ig-name }} waits for the instances to stop on their own or be stopped by the user. + 1. Under **{{ ui-key.yacloud.compute.groups.create.section_scale }}**: + * Select the `{{ ui-key.yacloud.compute.groups.create.value_scale-fixed }}` [scaling type](../../../compute/concepts/instance-groups/scale.md). + * Specify the instance group size. + 1. Under **{{ ui-key.yacloud.compute.groups.create.section_alb }}**, enable the **{{ ui-key.yacloud.compute.groups.create.field_target-group-attached }}** option. + 1. Specify the target group settings. For more information, see [{#T}](../../concepts/instance-groups/balancers.md#settings-alb). + 1. If needed, enable the **{{ ui-key.yacloud.compute.groups.create.section_health-check }}** to get information about the state of instances and their automatic recovery on failure. + * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-protocol }}** field, select the protocol for the health checks: `{{ ui-key.yacloud.common.label_http }}` or `{{ ui-key.yacloud.common.label_tcp }}`. + * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-path }}** field (for the HTTP type), specify the URL path for the HTTP check requests sent from {{ ig-name }}. + * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-port }}** field, specify the port number from 1 to 32767 for {{ ig-name }} to send the health check requests to. + * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-timeout }}** field, specify the response waiting time from 1 to 60 seconds. + * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-interval }}** field, specify the interval between the repeat checks from 1 to 60 seconds. The interval must be at least 1 second longer than the waiting time. + * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-healthy-threshold }}** field, specify the number of successful health checks required for the instance to be considered healthy. + * In the **{{ ui-key.yacloud.load-balancer.network-load-balancer.label_health-check-unhealthy-threshold }}** field, specify the number of failed health checks for the instance to be considered unhealthy. + 1. Under **{{ ui-key.yacloud.compute.groups.create.section_variables }}**, enter the `{{ ui-key.yacloud.common.label_key }}`-`{{ ui-key.yacloud.common.value }}` pairs, if needed. + 1. Click **{{ ui-key.yacloud.common.create }}**. - CLI {#cli} - {% include [cli-install.md](../../../_includes/cli-install.md) %} + {% include [cli-install.md](../../../_includes/cli-install.md) %} - {% include [default-catalogue.md](../../../_includes/default-catalogue.md) %} + {% include [default-catalogue.md](../../../_includes/default-catalogue.md) %} - 1. View a description of the CLI command to create an instance group: + 1. View the description of the CLI command to create an instance group: - ```bash - {{ yc-compute-ig }} create --help - ``` + ```bash + {{ yc-compute-ig }} create --help + ``` - 1. Check if there are any [networks](../../../vpc/concepts/network.md#network) in the [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder): + 1. Check whether the [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder) contains any [networks](../../../vpc/concepts/network.md#network): - ```bash - yc vpc network list - ``` + ```bash + yc vpc network list + ``` - If there are none, [create a network](../../../vpc/operations/network-create.md). - 1. Select one of the {{ marketplace-full-name }} public [images](../../concepts/image.md), e.g., [CentOS 7](/marketplace/products/yc/centos-7). + If there are none, [create a network](../../../vpc/operations/network-create.md). + 1. Select one of the {{ marketplace-full-name }} public [images](../../concepts/image.md), e.g., [CentOS 7](/marketplace/products/yc/centos-7). - {% include [standard-images.md](../../../_includes/standard-images.md) %} + {% include [standard-images.md](../../../_includes/standard-images.md) %} - 1. Create a YAML file with any name, e.g., `specification.yaml`. - 1. In the created file, indicate the following: - * General information about the instance group: + 1. Create a YAML file with any name, e.g., `specification.yaml`. + 1. In the created file, indicate the following: + * General information about the instance group: - ```yaml - name: first-fixed-group-with-l7-balancer - service_account_id: - description: "This instance group was created from YAML config." - ``` + ```yaml + name: first-fixed-group-with-l7-balancer + service_account_id: + description: "This instance group was created using a YAML configuration file." + ``` - Where: - * `name`: Name of the instance group. The name must be unique within the folder. The name may contain lowercase Latin letters, numbers, and hyphens. The first character must be a letter. The last character cannot be a hyphen. The name may be up to 63 characters long. - * `service_account_id`: [Service account](../../../iam/concepts/users/service-accounts.md) ID. - - {% include [sa-dependence-brief](../../../_includes/instance-groups/sa-dependence-brief.md) %} - - * `description`: Description of the instance group. - * [Instance template](../../concepts/instance-groups/instance-template.md), such as: - - ```yaml - instance_template: - platform_id: standard-v3 - resources_spec: - memory: 2g - cores: 2 - boot_disk_spec: - mode: READ_WRITE - disk_spec: - image_id: fdvk34al8k5n******** - type_id: network-hdd - size: 32g - network_interface_specs: - - network_id: c64mknqgnd8a******** - primary_v4_address_spec: {} - security_group_ids: - - enps0ar5s3ti******** - placement_policy: - placement_group_id: rmppvhrgm77g******** - scheduling_policy: - preemptible: false + Where: + * `name`: Instance group name. The name must be unique within the folder. The name may contain lowercase Latin letters, numbers, and hyphens. The first character must be a letter. The last character cannot be a hyphen. The name may be up to 63 characters long. + * `service_account_id`: [Service account](../../../iam/concepts/users/service-accounts.md) ID. + + {% include [sa-dependence-brief](../../../_includes/instance-groups/sa-dependence-brief.md) %} + + * `description`: Instance group description. + * [Instance template](../../concepts/instance-groups/instance-template.md), such as: + + ```yaml + instance_template: + platform_id: standard-v3 + resources_spec: + memory: 2g + cores: 2 + boot_disk_spec: + mode: READ_WRITE + disk_spec: + image_id: fdvk34al8k5n******** + type_id: network-hdd + size: 32g + network_interface_specs: + - network_id: c64mknqgnd8a******** + primary_v4_address_spec: {} + security_group_ids: + - enps0ar5s3ti******** + placement_policy: + placement_group_id: rmppvhrgm77g******** + scheduling_policy: + preemptible: false ``` {% include [default-unit-size](../../../_includes/instance-groups/default-unit-size.md) %} Where: * `platform_id`: [Platform](../../concepts/vm-platforms.md) ID. - * `memory`: Amount of RAM. + * `memory`: Amount of memory (RAM). * `cores`: Number of processor cores (vCPUs). * `mode`: [Disk](../../concepts/disk.md) access mode. - * `READ_ONLY`: Read-only access. - * `READ_WRITE`: Read/write access. - * `image_id`: ID of the public image. You can view image IDs in the [management console]({{ link-console-main }}) when creating a VM or in [{{ marketplace-name }}](/marketplace) on the image page under **Product IDs**. + * `READ_ONLY`: Read-only access. + * `READ_WRITE`: Read/write access. + * `image_id`: Public image ID. You can view image IDs in the [management console]({{ link-console-main }}) when creating an instance or in [{{ marketplace-name }}](/marketplace) on the image page under **Product IDs**. * `type_id`: [Disk type](../../../compute/concepts/disk.md#disks_types). * `size`: Disk size. - * `network_id`: ID of the `default-net` network. + * `network_id`: `default-net` network ID. * `primary_v4_address_spec`: IPv4 specification. You can allow public access to the group's instances by specifying the IP version for the [public IP address](../../../vpc/concepts/address.md#public-addresses). For more information, see [{#T}](../../concepts/instance-groups/instance-template.md#instance-template). * `security_group_ids`: List of [security group](../../../vpc/concepts/security-groups.md) IDs. * `scheduling_policy`: Scheduling policy configuration. - * `preemptible`: Flag for creating [preemptible VMs](../../concepts/preemptible-vm.md). - * `true`: Create a preemptible VM. - * `false` (default): Create a regular VM. - - When creating a preemptible instance group, keep in mind that the VM instances will terminate after 24 hours of continuous operation or earlier. {{ ig-name }} may not be able to restart them immediately due to insufficient resources. This may occur in the event of a sharp increase in the use of {{ yandex-cloud }} computing resources. - * `placement_policy`: (Optional) [VM placement group](../../concepts/placement-groups.md) parameters: - * `placement_group_id`: Placement group ID. - * [Policies](../../concepts/instance-groups/policies/index.md): - - ```yaml - deploy_policy: - max_unavailable: 1 - max_expansion: 0 - scale_policy: - fixed_scale: - size: 3 - allocation_policy: - zones: - - zone_id: {{ region-id }}-a - instance_tags_pool: - - first - - second - - third - ``` + * `preemptible`: Flag for creating [preemptible instances](../../concepts/preemptible-vm.md). + * `true`: Create a preemptible instance. + * `false` (default): Create a regular instance. + + When creating a preemptible instance group, keep in mind that the VM instances will terminate after 24 hours of continuous operation or earlier. {{ ig-name }} may not be able to restart them immediately due to insufficient resources. This may occur in the event of a sharp increase in the use of {{ yandex-cloud }} computing resources. + * `placement_policy`: (Optional) [Instance placement group](../../concepts/placement-groups.md) parameters: + * `placement_group_id`: Placement group ID. + * [Policies](../../concepts/instance-groups/policies/index.md): + + ```yaml + deploy_policy: + max_unavailable: 1 + max_expansion: 0 + scale_policy: + fixed_scale: + size: 3 + allocation_policy: + zones: + - zone_id: {{ region-id }}-a + instance_tags_pool: + - first + - second + - third + ``` + + Where: + * `deploy_policy`: Instance [deployment policy](../../concepts/instance-groups/policies/deploy-policy.md) for the group. + * `scale_policy`: Instance [scaling policy](../../concepts/instance-groups/policies/scale-policy.md) for the group. + * `allocation_policy`: Instance [allocation policy](../../concepts/instance-groups/policies/allocation-policy.md) between [availability zones](../../../overview/concepts/geo-scope.md). + * {{ alb-full-name }} [target group](../../../application-load-balancer/concepts/target-group.md): + + ```yaml + application_load_balancer_spec: + target_group_spec: + name: first-target-group + ``` + + Where: + * `target_group_spec`: Specification of the {{ alb-name }} target group associated with the instance group. + * `name`: Name for the {{ alb-name }} target group. The name must be unique within the folder. The name may contain lowercase Latin letters, numbers, and hyphens. The first character must be a letter. The last character cannot be a hyphen. The name may be up to 63 characters long. + + For more information about target group settings, see [{#T}](../../concepts/instance-groups/balancers.md#settings-alb). + + Full code for the `specification.yaml` file: + + ```yaml + name: first-fixed-group-with-l7-balancer + service_account_id: + description: "This instance group was created using a YAML configuration file." + instance_template: + platform_id: standard-v3 + resources_spec: + memory: 2g + cores: 2 + boot_disk_spec: + mode: READ_WRITE + disk_spec: + image_id: fdvk34al8k5n******** + type_id: network-hdd + size: 32g + network_interface_specs: + - network_id: c64mknqgnd8a******** + primary_v4_address_spec: {} + security_group_ids: + - enps0ar5s3ti******** + placement_policy: + placement_group_id: rmppvhrgm77g******** + deploy_policy: + max_unavailable: 1 + max_expansion: 0 + scale_policy: + fixed_scale: + size: 3 + allocation_policy: + zones: + - zone_id: {{ region-id }}-a + instance_tags_pool: + - first + - second + - third + application_load_balancer_spec: + target_group_spec: + name: first-target-group + ``` + + 1. Create an instance group in the default folder: + + ```bash + {{ yc-compute-ig }} create --file specification.yaml + ``` + + This command creates a group of three similar instances with the following configuration: + * Name: `first-fixed-group-with-l7-balancer` + * OS: CentOS 7 + * Network: `default-net` + * Availability zone: `{{ region-id }}-a` + * vCPUs: 2; RAM: 2 GB + * Network HDD: 32 GB + * Target group: `first-target-group` + + After that, you can add the `first-target-group` target group to a [new](../../../application-load-balancer/operations/backend-group-create.md) or [existing group of {{ alb-name }} backends](../../../application-load-balancer/operations/backend-group-update.md), a backend group to a [new](../../../application-load-balancer/operations/http-router-create.md) or [existing HTTP router](../../../application-load-balancer/operations/http-router-update.md), and a router to a [new](../../../application-load-balancer/operations/application-load-balancer-create.md) or [existing L7 load balancer](../../../application-load-balancer/operations/application-load-balancer-update.md). - Where: +- {{ TF }} {#tf} + + {% include [terraform-install](../../../_includes/terraform-install.md) %} + + 1. In the configuration file, describe the parameters of the resources you want to create: + + ```hcl + resource "yandex_iam_service_account" "ig-sa" { + name = "ig-sa" + description = "Service account for managing an instance group." + } + + resource "yandex_resourcemanager_folder_iam_member" "editor" { + folder_id = "" + role = "editor" + member = "serviceAccount:${yandex_iam_service_account.ig-sa.id}" + } + + resource "yandex_compute_instance_group" "ig-1" { + name = "fixed-ig-with-balancer" + folder_id = "" + service_account_id = "${yandex_iam_service_account.ig-sa.id}" + deletion_protection = "" + instance_template { + platform_id = "standard-v3" + resources { + memory = + cores = + } + + boot_disk { + mode = "READ_WRITE" + initialize_params { + image_id = "" + } + } + + network_interface { + network_id = "${yandex_vpc_network.network-1.id}" + subnet_ids = ["${yandex_vpc_subnet.subnet-1.id}"] + security_group_ids = [""] + } + + metadata = { + ssh-keys = ":" + } + } + + scale_policy { + fixed_scale { + size = + } + } + + allocation_policy { + zones = ["{{ region-id }}-a"] + } + + deploy_policy { + max_unavailable = 1 + max_expansion = 0 + } + + application_load_balancer { + target_group_name = "target-group" + target_group_description = "{{ network-load-balancer-name }} target group" + } + } + + resource "yandex_vpc_network" "network-1" { + name = "network1" + } + + resource "yandex_vpc_subnet" "subnet-1" { + name = "subnet1" + zone = "{{ region-id }}-a" + network_id = "${yandex_vpc_network.network-1.id}" + v4_cidr_blocks = ["192.168.10.0/24"] + } + ``` + + Where: + * `yandex_iam_service_account`: [Service account](../../../iam/concepts/users/service-accounts.md) description. All operations in {{ ig-name }} are performed on behalf of the service account. + + {% include [sa-dependence-brief](../../../_includes/instance-groups/sa-dependence-brief.md) %} + + * `yandex_resourcemanager_folder_iam_member`: Description of access permissions to the [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder) the service account belongs to. To be able to create, update, and delete VM instances in the instance group, assign the `editor` [role](../../../iam/concepts/access-control/roles.md) to the service account. + * `yandex_compute_instance_group`: Description of the instance group: + * General information about the instance group: + * `name`: Instance group name. + * `folder_id`: Folder ID. + * `service_account_id`: Service account ID. + * `deletion_protection`: Instance group protection against deletion, `true` or `false`. You cannot delete an instance group with this option enabled. The default value is `false`. + * [Instance template](../../concepts/instance-groups/instance-template.md): + * `platform_id`: [Platform](../../concepts/vm-platforms.md). + * `resources`: Number of vCPU cores and RAM available to the VM. The values must match the selected platform. + * `boot_disk`: Boot [disk](../../concepts/disk.md) settings. + * ID of the selected [image](../../concepts/image.md). You can get the image ID from the [list of public images](../images-with-pre-installed-software/get-list.md). + * Disk access mode: `READ_ONLY` or `READ_WRITE`. + * `network_interface`: [Network](../../../vpc/concepts/network.md#network) configurations. Specify the IDs of your network, [subnet](../../../vpc/concepts/network.md#subnet), and [security groups](../../../vpc/concepts/security-groups.md). + * `metadata`: In [metadata](../../concepts/vm-metadata.md), provide the [public key](../../../compute/operations/vm-connect/ssh.md#creating-ssh-keys) for SSH access to the instance. For more information, see [{#T}](../../concepts/vm-metadata.md). + * [Policies](../../concepts/instance-groups/policies/index.md): * `deploy_policy`: [Deployment policy](../../concepts/instance-groups/policies/deploy-policy.md) for instances in the group. * `scale_policy`: [Scaling policy](../../concepts/instance-groups/policies/scale-policy.md) for instances in the group. - * `allocation_policy`: [Policy for allocating](../../concepts/instance-groups/policies/allocation-policy.md) VM instances across [availability zones](../../../overview/concepts/geo-scope.md). - * {{ alb-full-name }} [target group](../../../application-load-balancer/concepts/target-group.md): + * `allocation_policy`: Instance [allocation policy](../../concepts/instance-groups/policies/allocation-policy.md) between [availability zones](../../../overview/concepts/geo-scope.md). + * {{ alb-full-name }} [target group](../../../application-load-balancer/concepts/target-group.md): + * `target_group_name`: Target group name. + * `target_group_description`: Description of the target group. + For more information about target group settings, see [{#T}](../../concepts/instance-groups/balancers.md#settings-alb). + * `yandex_vpc_network`: Description of the cloud network. + * `yandex_vpc_subnet`: Description of the subnet the instance group will connect to. - ```yaml - application_load_balancer_spec: - target_group_spec: - name: first-target-group - ``` + {% note info %} - Where: - * `target_group_spec`: Specification of the {{ alb-name }} target group associated with the instance group. - * `name`: Any name of the {{ alb-name }} target group. The name must be unique within the folder. The name may contain lowercase Latin letters, numbers, and hyphens. The first character must be a letter. The last character cannot be a hyphen. The name may be up to 63 characters long. - - For more information about the target group settings, see [{#T}](../../concepts/instance-groups/balancers.md#settings-alb). - - Full code for the `specification.yaml` file: - - ```yaml - name: first-fixed-group-with-l7-balancer - service_account_id: - description: "This instance group was created from YAML config." - instance_template: - platform_id: standard-v3 - resources_spec: - memory: 2g - cores: 2 - boot_disk_spec: - mode: READ_WRITE - disk_spec: - image_id: fdvk34al8k5n******** - type_id: network-hdd - size: 32g - network_interface_specs: - - network_id: c64mknqgnd8a******** - primary_v4_address_spec: {} - security_group_ids: - - enps0ar5s3ti******** - placement_policy: - placement_group_id: rmppvhrgm77g******** - deploy_policy: - max_unavailable: 1 - max_expansion: 0 - scale_policy: - fixed_scale: - size: 3 - allocation_policy: - zones: - - zone_id: {{ region-id }}-a - instance_tags_pool: - - first - - second - - third - application_load_balancer_spec: - target_group_spec: - name: first-target-group - ``` - - 1. Create an instance group in the default folder: - - ```bash - {{ yc-compute-ig }} create --file specification.yaml - ``` - - This command creates a group of three similar instances with the following configuration: - * Name: `first-fixed-group-with-l7-balancer` - * OS: CentOS 7 - * Network: `default-net` - * Availability zone: `{{ region-id }}-a` - * vCPUs: 2; RAM: 2 GB - * Network HDD: 32 GB - * Target group: `first-target-group` - - After that, you can add `first-target-group` to a [new](../../../application-load-balancer/operations/backend-group-create.md) or [existing group of {{ alb-name }} backends](../../../application-load-balancer/operations/backend-group-update.md), a backend group to a [new](../../../application-load-balancer/operations/http-router-create.md) or [existing HTTP router](../../../application-load-balancer/operations/http-router-update.md), and a router to a [new](../../../application-load-balancer/operations/application-load-balancer-create.md) or [existing L7 load balancer](../../../application-load-balancer/operations/application-load-balancer-update.md). + If you already have suitable resources, such as a service account, cloud network, and subnet, you do not need to describe them again. Use their names and IDs in the appropriate parameters. -- {{ TF }} {#tf} + {% endnote %} - {% include [terraform-install](../../../_includes/terraform-install.md) %} - - 1. In the configuration file, describe the parameters of the resources you want to create: - - ```hcl - resource "yandex_iam_service_account" "ig-sa" { - name = "ig-sa" - description = "Service account for managing the instance group." - } - - resource "yandex_resourcemanager_folder_iam_member" "editor" { - folder_id = "" - role = "editor" - member = "serviceAccount:${yandex_iam_service_account.ig-sa.id}" - } - - resource "yandex_compute_instance_group" "ig-1" { - name = "fixed-ig-with-balancer" - folder_id = "" - service_account_id = "${yandex_iam_service_account.ig-sa.id}" - deletion_protection = "" - instance_template { - platform_id = "standard-v3" - resources { - memory = - cores = - } - - boot_disk { - mode = "READ_WRITE" - initialize_params { - image_id = "" - } - } - - network_interface { - network_id = "${yandex_vpc_network.network-1.id}" - subnet_ids = ["${yandex_vpc_subnet.subnet-1.id}"] - security_group_ids = [""] - } - - metadata = { - ssh-keys = ":" - } - } - - scale_policy { - fixed_scale { - size = - } - } - - allocation_policy { - zones = ["{{ region-id }}-a"] - } - - deploy_policy { - max_unavailable = 1 - max_expansion = 0 - } - - application_load_balancer { - target_group_name = "target-group" - target_group_description = "{{ network-load-balancer-name }} target group" - } - } - - resource "yandex_vpc_network" "network-1" { - name = "network1" - } - - resource "yandex_vpc_subnet" "subnet-1" { - name = "subnet1" - zone = "{{ region-id }}-a" - network_id = "${yandex_vpc_network.network-1.id}" - v4_cidr_blocks = ["192.168.10.0/24"] - } - ``` - - Where: - * `yandex_iam_service_account`: Description of the [service account](../../../iam/concepts/users/service-accounts.md). All operations in {{ ig-name }} are performed on behalf of the service account. + For more information about the resources you can create with {{ TF }}, see the [provider documentation]({{ tf-provider-link }}). + 1. Create resources: - {% include [sa-dependence-brief](../../../_includes/instance-groups/sa-dependence-brief.md) %} + {% include [terraform-validate-plan-apply](../../../_tutorials/_tutorials_includes/terraform-validate-plan-apply.md) %} - * `yandex_resourcemanager_folder_iam_member`: Description of access permissions to the [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder) the service account belongs to. To be able to create, update, and delete instances in the instance group, assign the `editor` [role](../../../iam/concepts/access-control/roles.md) to the service account. - * `yandex_compute_instance_group`: Description of the instance group: - * General information about the instance group: - * `name`: Name of the instance group. - * `folder_id`: Folder ID. - * `service_account_id`: Service account ID. - * `deletion_protection`: Instance group deletion protection, `true` or `false`. You cannot delete an instance group with this option enabled. The default value is `false`. - * [Instance template](../../concepts/instance-groups/instance-template.md): - * `platform_id`: [Platform](../../concepts/vm-platforms.md). - * `resources`: Number of vCPU cores and the amount of RAM available to the VM. The values must match the selected platform. - * `boot_disk`: Boot [disk](../../concepts/disk.md) settings. - * ID of the selected [image](../../concepts/image.md). You can get the image ID from the [list of public images](../images-with-pre-installed-software/get-list.md). - * Disk access mode: `READ_ONLY` (read) or `READ_WRITE` (read and write). - * `network_interface`: [Network](../../../vpc/concepts/network.md#network) settings. Specify the IDs of your network, [subnet](../../../vpc/concepts/network.md#subnet), and [security groups](../../../vpc/concepts/security-groups.md). - * `metadata`: In [metadata](../../concepts/vm-metadata.md), provide the [public key](../../../compute/operations/vm-connect/ssh.md#creating-ssh-keys) for accessing the VM via SSH. For more information, see [{#T}](../../concepts/vm-metadata.md). - * [Policies](../../concepts/instance-groups/policies/index.md): - * `deploy_policy`: [Deployment policy](../../concepts/instance-groups/policies/deploy-policy.md) for instances in the group. - * `scale_policy`: [Scaling policy](../../concepts/instance-groups/policies/scale-policy.md) for instances in the group. - * `allocation_policy`: [Policy for allocating](../../concepts/instance-groups/policies/allocation-policy.md) VM instances across [availability zones](../../../overview/concepts/geo-scope.md). - * {{ alb-full-name }} [target group](../../../application-load-balancer/concepts/target-group.md): - * `target_group_name`: Name of the target group. - * `target_group_description`: Description of the target group. - For more information about target group settings, see [{#T}](../../concepts/instance-groups/balancers.md#settings-alb). - * `yandex_vpc_network`: Description of the cloud network. - * `yandex_vpc_subnet`: Description of the subnet the instance group will connect to. - - {% note info %} - - If you already have suitable resources, such as a service account, cloud network, and subnet, you do not need to describe them again. Use their names and IDs in the appropriate parameters. - - {% endnote %} - - For more information about the resources you can create with {{ TF }}, see the [provider documentation]({{ tf-provider-link }}). - 1. Create resources: - - {% include [terraform-validate-plan-apply](../../../_tutorials/_tutorials_includes/terraform-validate-plan-apply.md) %} - - All the resources you need will then be created in the specified folder. You can check the new resources and their configuration using the [management console]({{ link-console-main }}). + All the resources you need will then be created in the specified folder. You can check the new resources and their configuration using the [management console]({{ link-console-main }}). - API {#api} - Use the [create](../../instancegroup/api-ref/InstanceGroup/create.md) REST API method for the [InstanceGroup](../../instancegroup/api-ref/InstanceGroup/index.md) resource or the [InstanceGroupService/Create](../../instancegroup/api-ref/grpc/InstanceGroup/create.md) gRPC API call. + Use the [create](../../instancegroup/api-ref/InstanceGroup/create.md) REST API method for the [InstanceGroup](../../instancegroup/api-ref/InstanceGroup/index.md) resource or the [InstanceGroupService/Create](../../instancegroup/api-ref/grpc/InstanceGroup/create.md) gRPC API call. {% endlist %} \ No newline at end of file diff --git a/en/compute/operations/instance-groups/get-list.md b/en/compute/operations/instance-groups/get-list.md index 76be625547b..85469c450ef 100644 --- a/en/compute/operations/instance-groups/get-list.md +++ b/en/compute/operations/instance-groups/get-list.md @@ -11,7 +11,7 @@ To get a list of instance groups: - Management console {#console} - 1. In the [management console]({{ link-console-main }}), open the folder containing the VM group you need. + 1. In the [management console]({{ link-console-main }}), open the folder containing the instance group you need. 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. 1. In the left-hand panel, select ![image](../../../_assets/console-icons/layers-3-diagonal.svg) **{{ ui-key.yacloud.compute.switch_groups }}**. @@ -21,7 +21,7 @@ To get a list of instance groups: {% include [default-catalogue](../../../_includes/default-catalogue.md) %} - 1. See the description of the CLI command for work with an instance group: + 1. See the description of the CLI command to use an instance group: ```bash {{ yc-compute-ig }} --help diff --git a/en/compute/operations/instance-groups/update.md b/en/compute/operations/instance-groups/update.md index cd4bdb892c9..754cdbd5289 100644 --- a/en/compute/operations/instance-groups/update.md +++ b/en/compute/operations/instance-groups/update.md @@ -1,5 +1,5 @@ --- -title: How to update a VM group in {{ compute-full-name }} +title: How to update an instance group in {{ compute-full-name }} description: Follow this guide to update an instance group. --- @@ -19,7 +19,7 @@ To change the name and description of an instance group: - Management console {#console} - 1. In the [management console]({{ link-console-main }}), open the folder the VM group is in. + 1. In the [management console]({{ link-console-main }}), open the folder containing the instance group you need. 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. 1. In the left-hand panel, select ![image](../../../_assets/console-icons/layers-3-diagonal.svg) **{{ ui-key.yacloud.compute.switch_groups }}**. 1. Select the group to update. @@ -43,12 +43,12 @@ To change the name and description of an instance group: {% include [instance-group-list.md](../../../_includes/instance-groups/instance-group-list.md) %} - 1. Select the `ID` of the VM group you need. + 1. Select the `ID` of the instance group. 1. Specify the name and description you need in the YAML file that was used to create the group, e.g., `specification.yaml`. If the YAML file was not saved, [get information](get-info.md) about the instance group and create a new file. For more information, see [{#T}](create-fixed-group.md). 1. Update the instance group in the default folder: ```bash - {{ yc-compute-ig }} update --id --file specification.yaml + {{ yc-compute-ig }} update --id --file specification.yaml ``` {{ ig-name }} will launch the instance group update process. @@ -76,13 +76,13 @@ To change the computing resources of an instance group: - Management console {#console} - 1. In the [management console]({{ link-console-main }}), open the folder the VM group is in. + 1. In the [management console]({{ link-console-main }}), open the folder containing the instance group you need. 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. 1. In the left-hand panel, select ![image](../../../_assets/console-icons/layers-3-diagonal.svg) **{{ ui-key.yacloud.compute.switch_groups }}**. 1. Select the group to update. 1. In the top-right corner of the page, click **{{ ui-key.yacloud.common.edit }}**. 1. Under **{{ ui-key.yacloud.compute.groups.create.section_instance }}**: - * In the upper-right corner, click ![image](../../../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud.common.delete }}** to delete the current VM template. + * Click ![image](../../../_assets/console-icons/ellipsis.svg) in the top-right corner and select **{{ ui-key.yacloud.common.delete }}** to delete the current instance template. * Click **{{ ui-key.yacloud.compute.groups.create.button_instance_empty-create }}** to create a new template with required instance parameters. * Click **{{ ui-key.yacloud.compute.groups.create.button_edit }}**. 1. Click **{{ ui-key.yacloud.common.save }}** on the **{{ ui-key.yacloud.compute.group.edit.label_title }}** page. @@ -103,12 +103,12 @@ To change the computing resources of an instance group: {% include [instance-group-list.md](../../../_includes/instance-groups/instance-group-list.md) %} - 1. Select the `ID` of the VM group you need. - 1. Specify the required VM parameters in the `resources_spec` key in the YAML file that was used to create the group, e.g., `specification.yaml`. If the YAML file was not saved, [get information](get-info.md) about the instance group and create a new file. For more information, see [{#T}](create-fixed-group.md). + 1. Select the `ID` of the instance group. + 1. Specify the required instance parameters in the `resources_spec` key in the YAML file that was used to create the group, e.g., `specification.yaml`. If the YAML file was not saved, [get information](get-info.md) about the instance group and create a new file. For more information, see [{#T}](create-fixed-group.md). 1. Update the instance group in the default folder: ```bash - {{ yc-compute-ig }} update --id --file specification.yaml + {{ yc-compute-ig }} update --id --file specification.yaml ``` {{ ig-name }} will launch the instance group update process. @@ -131,7 +131,7 @@ To increase the disk size of an instance group: - Management console {#console} - 1. In the [management console]({{ link-console-main }}), open the folder the VM group is in. + 1. In the [management console]({{ link-console-main }}), open the folder containing the instance group you need. 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. 1. In the left-hand panel, select ![image](../../../_assets/console-icons/layers-3-diagonal.svg) **{{ ui-key.yacloud.compute.switch_groups }}**. 1. Select the group to update. @@ -157,12 +157,12 @@ To increase the disk size of an instance group: {% include [instance-group-list.md](../../../_includes/instance-groups/instance-group-list.md) %} - 1. Select the `ID` of the VM group you need. + 1. Select the `ID` of the instance group. 1. Specify the required storage size in the `boot_disk_spec` key in the YAML file that was used to create the group, e.g., `specification.yaml`. If the YAML file was not saved, [get information](get-info.md) about the instance group and create a new file. For more information, see [{#T}](create-fixed-group.md). 1. Update the instance group in the default folder: ```bash - {{ yc-compute-ig }} update --id --file specification.yaml + {{ yc-compute-ig }} update --id --file specification.yaml ``` {{ ig-name }} will launch the instance group update process. diff --git a/en/compute/operations/operation-logs.md b/en/compute/operations/operation-logs.md index e0e6ec53b95..05f59fce16a 100644 --- a/en/compute/operations/operation-logs.md +++ b/en/compute/operations/operation-logs.md @@ -14,7 +14,7 @@ All actions with {{ compute-name }} resources are logged as a list of operations - Management console {#console} - To view operations with all {{ compute-name }} resources, in the left-hand panel, select ![image](../../_assets/operations.svg) **{{ ui-key.yacloud.compute.switch_operations }}**. In the list that opens, you will also see operations with the resources that were deleted. + To view all operations with the resources, in the left-hand panel, select ![image](../../_assets/operations.svg) **{{ ui-key.yacloud.compute.switch_operations }}**. In the list that opens, you will also see operations with the resources that were deleted. You can get a list of operations for a specific resource. The steps below describe how you can do this for a VM. The same steps apply to other service resources. @@ -32,7 +32,7 @@ All actions with {{ compute-name }} resources are logged as a list of operations {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To get a list of operations for a {{ compute-name }} resource, run this command: + To get a list of operations for an {{ compute-name }} resource, run this command: ```bash yc compute list-operations @@ -105,7 +105,7 @@ All actions with {{ compute-name }} resources are logged as a list of operations - API {#api} - Use the `listOperations` REST API method for the relevant resource or the gRPC API call `/ListOperations`. + Use the `listOperations` REST API method for the relevant resource or the `/ListOperations` gRPC API call. For example, to obtain a list of operations for a VM, use either the [listOperations](../api-ref/Instance/listOperations.md) REST API method for the [Instance](../api-ref/Instance/index.md) resource or the [InstanceService/ListOperations](../api-ref/grpc/Instance/listOperations.md) gRPC API call. diff --git a/en/compute/operations/placement-groups/access.md b/en/compute/operations/placement-groups/access.md index 3107cb8afe2..095523efd56 100644 --- a/en/compute/operations/placement-groups/access.md +++ b/en/compute/operations/placement-groups/access.md @@ -98,7 +98,7 @@ To grant a user, group, or [service account](../../../iam/concepts/users/service * `placement_group_id`: VM placement group ID. * `role`: [Role](../../security/index.md#roles-list) to assign. - * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) getting the role. Specify it as `userAccount:` or `serviceAccount:`. + * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) the roles are assigned to. Specify it as `userAccount:` or `serviceAccount:`. For more information about the `yandex_compute_placement_group_iam_binding` resource parameters, see the [provider documentation]({{ tf-provider-resources-link }}/compute_placement_group_iam_binding). @@ -207,11 +207,11 @@ To grant a user, group, or [service account](../../../iam/concepts/users/service } ``` - Where: + Where: * `placement_group_id`: VM placement group ID. * `role`: [Role](../../security/index.md#roles-list) to assign. - * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) getting the role. Specify it as `userAccount:` or `serviceAccount:`. + * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) the roles are assigned to. Specify it as `userAccount:` or `serviceAccount:`. For more information about the `yandex_compute_placement_group_iam_binding` resource parameters, see the [provider documentation]({{ tf-provider-resources-link }}/compute_placement_group_iam_binding). @@ -231,7 +231,7 @@ To grant a user, group, or [service account](../../../iam/concepts/users/service {% note alert %} - The `setAccessBindings` method and the `PlacementGroupService/SetAccessBindings` call completely rewrite the resource access permissions. All current resource roles will be deleted. + The `setAccessBindings` method and the `PlacementGroupService/SetAccessBindings` call completely overwrite access permissions for the resource. All current resource roles will be deleted. {% endnote %} diff --git a/en/compute/operations/placement-groups/create-vm-in-pg.md b/en/compute/operations/placement-groups/create-vm-in-pg.md index 42578ed8123..b04c326e03f 100644 --- a/en/compute/operations/placement-groups/create-vm-in-pg.md +++ b/en/compute/operations/placement-groups/create-vm-in-pg.md @@ -23,7 +23,7 @@ Create a [VM](../../concepts/vm.md) in a [placement group](../../concepts/placem {% include [pg-create](../../../_includes/compute/placement-groups-create.md) %} - 1. See the description of the CLI command to create a VM: + 1. View the description of the CLI command to create a VM: ```bash yc compute instance create --help @@ -134,7 +134,7 @@ Create a [VM](../../concepts/vm.md) in a [placement group](../../concepts/placem terraform apply ``` - 1. Confirm the changes: type `yes` into the terminal and click **Enter**. + 1. Confirm the changes: type `yes` into the terminal and press **Enter**. All the resources you need will then be created in the specified [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder). You can check that the VM has been created and added to the placement group using the [management console]({{ link-console-main }}). diff --git a/en/compute/operations/placement-groups/placement-groups-get-info.md b/en/compute/operations/placement-groups/placement-groups-get-info.md index 412ca7b4531..057742e8b9c 100644 --- a/en/compute/operations/placement-groups/placement-groups-get-info.md +++ b/en/compute/operations/placement-groups/placement-groups-get-info.md @@ -69,7 +69,7 @@ title: How to get information about a placement group in {{ compute-full-name }} * `output "placement_group"`: Output variable containing information about the placement group creation time: * `value`: Returned value. - You can replace `created_at` with any other parameter to get the information you need. For more information about the `yandex_compute_placement_group` data source parameters, see the [provider documentation]({{ tf-provider-datasources-link }}/datasource_compute_placement_group). + You can replace `created_at` with any other parameter to get the information you need. For more information about the `yandex_compute_placement_group` data source parameters, see the [relevant provider documentation]({{ tf-provider-datasources-link }}/datasource_compute_placement_group). 1. Create resources: diff --git a/en/compute/operations/snapshot-control/snapshot-access.md b/en/compute/operations/snapshot-control/snapshot-access.md index 8c7c0bf00c2..3714338b5e4 100644 --- a/en/compute/operations/snapshot-control/snapshot-access.md +++ b/en/compute/operations/snapshot-control/snapshot-access.md @@ -95,7 +95,7 @@ To grant a user, group, or [service account](../../../iam/concepts/users/service * `snapshot_id`: Snapshot ID. * `role`: [Role](../../security/index.md#roles-list) to assign. - * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) getting the role. Specify it as `userAccount:` or `serviceAccount:`. + * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) the roles are assigned to. Specify it as `userAccount:` or `serviceAccount:`. For more information about the `yandex_compute_snapshot_iam_binding` resource parameters, see the [provider documentation]({{ tf-provider-resources-link }}/compute_snapshot_iam_binding). @@ -163,7 +163,7 @@ To grant a user, group, or [service account](../../../iam/concepts/users/service Where: - * `--access-binding`: Role you want to assign: + * `--access-binding`: Role to assign: * `role`: ID of the role to assign. * `subject`: Type and ID of the [subject](../../../iam/concepts/access-control/index.md#subject) getting the role. @@ -203,7 +203,7 @@ To grant a user, group, or [service account](../../../iam/concepts/users/service * `snapshot_id`: Snapshot ID. * `role`: [Role](../../security/index.md#roles-list) to assign. - * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) getting the role. Specify it as `userAccount:` or `serviceAccount:`. + * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) the roles are assigned to. Specify it as `userAccount:` or `serviceAccount:`. For more information about the `yandex_compute_snapshot_iam_binding` resource parameters, see the [provider documentation]({{ tf-provider-resources-link }}/compute_snapshot_iam_binding). diff --git a/en/compute/operations/snapshot-control/snapshot-schedule-access.md b/en/compute/operations/snapshot-control/snapshot-schedule-access.md index 61332a67132..facc5002fe6 100644 --- a/en/compute/operations/snapshot-control/snapshot-schedule-access.md +++ b/en/compute/operations/snapshot-control/snapshot-schedule-access.md @@ -96,7 +96,7 @@ To grant a user, group, or [service account](../../../iam/concepts/users/service * `snapshot_schedule_id`: Schedule ID. * `role`: [Role](../../security/index.md#roles-list) to assign. - * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) the role is assigned to. Specify it as `userAccount:` or `serviceAccount:`. + * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) the roles are assigned to. Specify it as `userAccount:` or `serviceAccount:`. For more information about the `yandex_compute_snapshot_schedule_iam_binding` resource parameters, see the [provider documentation]({{ tf-provider-resources-link }}/compute_snapshot_schedule_iam_binding). @@ -104,7 +104,7 @@ To grant a user, group, or [service account](../../../iam/concepts/users/service {% include [terraform-validate-plan-apply](../../../_tutorials/_tutorials_includes/terraform-validate-plan-apply.md) %} - {{ TF }} will create all the required resources. You can check the new resources using the [management console]({{ link-console-main }}) and this [CLI](../../../cli/) command: + {{ TF }} will create all the required resources. You can check the new resources using the [management console]({{ link-console-main }}) or this [CLI](../../../cli/) command: ```bash yc compute snapshot-schedule list-access-bindings @@ -165,7 +165,7 @@ To grant a user, group, or [service account](../../../iam/concepts/users/service Where: - * `--access-binding`: Role you want to assign: + * `--access-binding`: Role to assign: * `role`: ID of the role to assign. * `subject`: Type and ID of the [subject](../../../iam/concepts/access-control/index.md#subject) getting the role. @@ -205,7 +205,7 @@ To grant a user, group, or [service account](../../../iam/concepts/users/service * `snapshot_schedule_id`: Schedule ID. * `role`: [Role](../../security/index.md#roles-list) to assign. - * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) the role is assigned to. Specify it as `userAccount:` or `serviceAccount:`. + * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) the roles are assigned to. Specify it as `userAccount:` or `serviceAccount:`. For more information about the `yandex_compute_snapshot_schedule_iam_binding` resource parameters, see the [provider documentation]({{ tf-provider-resources-link }}/compute_snapshot_schedule_iam_binding). diff --git a/en/compute/operations/vm-connect/auth-inside-vm.md b/en/compute/operations/vm-connect/auth-inside-vm.md index 2867598cdff..f64b49f8cba 100644 --- a/en/compute/operations/vm-connect/auth-inside-vm.md +++ b/en/compute/operations/vm-connect/auth-inside-vm.md @@ -13,7 +13,7 @@ To automate operations with {{ yandex-cloud }} from inside a VM, we recommend us Link your service account to an existing or new VM. You can only link one service account. -To link a service account to a VM, you must have permission to use this account. This permission is included in the [iam.serviceAccounts.user](../../../iam/security/index.md#iam-serviceAccounts-user) and [editor](../../../iam/roles-reference.md#editor) roles and higher. +To link a service account to a VM, you must have permission to use this account. This permission comes with the [iam.serviceAccounts.user](../../../iam/security/index.md#iam-serviceAccounts-user) and [editor](../../../iam/roles-reference.md#editor) roles or higher. ### Linking to an existing VM {#link-with-exist-instance} @@ -21,28 +21,28 @@ To link a service account to a VM, you must have permission to use this account. - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the folder the VM belongs to. - 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. - 1. Click the VM name. - 1. Click ![image](../../../_assets/console-icons/pencil.svg) **{{ ui-key.yacloud.compute.instance.overview.button_action-edit }}** in the top-right corner of the page. - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_access }}**, select an existing service account or create a new one. - 1. Click **{{ ui-key.yacloud.compute.instance.edit.button_update }}**. + 1. In the [management console]({{ link-console-main }}), select the [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder) the VM belongs to. + 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. + 1. Click the VM name. + 1. In the top-right corner of the page, click ![image](../../../_assets/console-icons/pencil.svg) **{{ ui-key.yacloud.compute.instance.overview.button_action-edit }}**. + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_additional }}**, select an existing service account or create a new one. + 1. Click **{{ ui-key.yacloud.compute.instance.edit.button_update }}**. - CLI {#cli} - {% include [cli-install](../../../_includes/cli-install.md) %} + {% include [cli-install](../../../_includes/cli-install.md) %} - {% include [default-catalogue](../../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../../_includes/default-catalogue.md) %} - Update the VM parameters by specifying the service account via the `--service-account-name` or `--service-account-id` option: + Update the VM parameters by specifying the service account in `--service-account-name` or `--service-account-id`: - ```bash - yc compute instance update my-instance --service-account-name test - ``` + ```bash + yc compute instance update my-instance --service-account-name test + ``` - API {#api} - Use the [update](../../api-ref/Instance/update.md) REST API method for the [Instance](../../api-ref/Instance/) resource or the [InstanceService/Update](../../api-ref/grpc/Instance/update.md) gRPC API call. Specify the service account ID in your request. + Use the [update](../../api-ref/Instance/update.md) REST API method for the [Instance](../../api-ref/Instance/) resource or the [InstanceService/Update](../../api-ref/grpc/Instance/update.md) gRPC API call. Specify the service account ID in your request. {% endlist %} @@ -52,31 +52,29 @@ To link a service account to a VM, you must have permission to use this account. - Management console {#console} - In the management console, you can link a service account that is in the same [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder) as the new VM. If the service account is in a different folder, use the CLI or API. + In the management console, you can link your VM to service account located in the same [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder) with the VM you are creating. If the service account is in a different folder, use the CLI or API. - To link your service account to a VM, specify it when [creating the VM](../index.md#vm-create). You can select an existing service account or create a new one: - - ![image](../../../_assets/compute/connect-sa.png) + To link a service account to a VM, select it in the **{{ ui-key.yacloud.compute.instances.create.field_service-account }}** field of the **{{ ui-key.yacloud.compute.instances.create.section_additional }}** section when [creating the VM](../index.md#vm-create). You can select an existing service account or create a new one. - CLI {#cli} - {% include [cli-install](../../../_includes/cli-install.md) %} + {% include [cli-install](../../../_includes/cli-install.md) %} - {% include [default-catalogue](../../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../../_includes/default-catalogue.md) %} - Create a VM and specify the service account using the `--service-account-name` or `--service-account-id` option: + Create a VM by specifying the service account in `--service-account-name` or `--service-account-id`: - ```bash - yc compute instance create \ - --name my-instance \ - --network-interface subnet-name=default,nat-ip-version=ipv4 \ - --ssh-key ~/.ssh/id_ed25519.pub \ - --service-account-name my-robot - ``` + ```bash + yc compute instance create \ + --name my-instance \ + --network-interface subnet-name=default,nat-ip-version=ipv4 \ + --ssh-key ~/.ssh/id_ed25519.pub \ + --service-account-name my-robot + ``` - API {#api} - Use the [create](../../api-ref/Instance/create.md) REST API method for the [Instance](../../api-ref/Instance/) resource or the [InstanceService/Create](../../api-ref/grpc/Instance/create.md) gRPC API call. Specify the service account ID in your request. + Use the [create](../../api-ref/Instance/create.md) REST API method for the [Instance](../../api-ref/Instance/) resource or the [InstanceService/Create](../../api-ref/grpc/Instance/create.md) gRPC API call. Specify the service account ID in your request. {% endlist %} @@ -88,44 +86,44 @@ To authenticate from inside a VM on behalf of the linked service account: - CLI {#cli} - 1. [Connect](../vm-connect/ssh.md) to your VM over SSH. + 1. [Connect](../vm-connect/ssh.md) to your VM over SSH. - 1. {% include [cli-install](../../../_includes/cli-install.md) %} + 1. {% include [cli-install](../../../_includes/cli-install.md) %} - 1. Create a new profile: + 1. Create a new profile: - ```bash - yc config profile create my-robot-profile - ``` + ```bash + yc config profile create my-robot-profile + ``` - 1. Configure your profile to run commands. + 1. Configure your profile to run commands. - {% include [add-folder](../../../_includes/cli-add-folder.md) %} + {% include [add-folder](../../../_includes/cli-add-folder.md) %} - You can also get a [{{ iam-full-name }} token](../../../iam/concepts/authorization/iam-token.md), for example, to authenticate with the API: + You can also get a [{{ iam-full-name }} token](../../../iam/concepts/authorization/iam-token.md), for example, to authenticate with the API: - ```bash - yc iam create-token - ``` + ```bash + yc iam create-token + ``` - The [lifetime of an {{ iam-name }} token](../../../iam/concepts/authorization/iam-token.md#lifetime) in this case will be less than {{ iam-token-lifetime }}. Request an {{ iam-name }} token more often, e.g., every hour. To learn the remaining token lifetime, use the API instructions. + The [lifetime of an {{ iam-name }} token](../../../iam/concepts/authorization/iam-token.md#lifetime) in this case will be less than {{ iam-token-lifetime }}. Request an {{ iam-name }} token more often, e.g., every hour. To learn the remaining token lifetime, use the API instructions. - API {#api} - 1. Connect to the VM via [SSH](../vm-connect/ssh.md). - 1. Get an {{ iam-name }} token from metadata in Google Compute Engine format: + 1. Connect to the VM via [SSH](../vm-connect/ssh.md). + 1. Get an {{ iam-name }} token from metadata in Google Compute Engine format: - ```bash - curl -H Metadata-Flavor:Google http://169.254.169.254/computeMetadata/v1/instance/service-accounts/default/token + ```bash + curl -H Metadata-Flavor:Google http://169.254.169.254/computeMetadata/v1/instance/service-accounts/default/token - {"access_token":"CggVAgAAA...","expires_in":39944,"token_type":"Bearer"} - ``` + {"access_token":"CggVAgAAA...","expires_in":39944,"token_type":"Bearer"} + ``` - The {{ iam-name }} token will be returned in the `access_token` field of the response. The remaining lifetime of the {{ iam-name }} token is specified in the `expires_in` field. + You can find the {{ iam-name }} token in the `access_token` field of the response. The remaining lifetime of the {{ iam-name }} token is specified in the `expires_in` field. - 1. {% include [iam-token-usage](../../../_includes/iam-token-usage.md) %} + 1. {% include [iam-token-usage](../../../_includes/iam-token-usage.md) %} - Keep track of the {{ iam-name }} token lifetime or request a new token more often, e.g., every hour. + Keep track of the {{ iam-name }} token lifetime or request a new token more often, e.g., every hour. {% endlist %} \ No newline at end of file diff --git a/en/compute/operations/vm-connect/enable-os-login.md b/en/compute/operations/vm-connect/enable-os-login.md index 86d7dc2a394..d64328b6303 100644 --- a/en/compute/operations/vm-connect/enable-os-login.md +++ b/en/compute/operations/vm-connect/enable-os-login.md @@ -53,7 +53,7 @@ To set up OS Login access to an existing VM: 1. [Enable](../vm-control/vm-update.md#enable-oslogin-access) access via OS Login on the VM. -Now you can connect to your VM via OS Login using an SSH certificate [over the YC CLI](os-login.md#connect-via-cli) or a [standard SSH client](os-login.md#connect-via-exported-certificate), as well as over the YC CLI [using an SSH key](os-login.md#connect-via-key) previously added to the organization user profile in {{ org-full-name }}. +You can now connect to the VM via OS Login using either the [YC CLI](os-login.md#connect-with-yc-cli) or a [standard SSH client](os-login.md#connect-with-ssh-client). For connection, you can use an SSH certificate or SSH key, which you first need to [add](../../../organization/operations/add-ssh.md) to the OS Login profile of a {{ org-full-name }} user or service account. ## Disabling access via OS Login {#disable-os-login} @@ -63,7 +63,16 @@ To be able to [connect](ssh.md) to the VM over SSH without using OS Login: 1. Disable access via OS Login. - {% list tabs %} + {% list tabs group=instructions %} + + - Management console {#console} + + 1. In the [management console]({{ link-console-main }}), select the folder the VM belongs to. + 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. + 1. In the left-hand panel, select ![image](../../../_assets/console-icons/server.svg) **{{ ui-key.yacloud.compute.switch_instances }}** and click the name of the VM. + 1. In the top-right corner, click ![image](../../../_assets/console-icons/pencil.svg) **{{ ui-key.yacloud.compute.instance.overview.button_action-edit }}**. + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_access }}**, enable **Access via OS Login**. + 1. Click **{{ ui-key.yacloud.compute.instance.edit.button_update }}**. - CLI {#cli} diff --git a/en/compute/operations/vm-connect/os-login-create-vm.md b/en/compute/operations/vm-connect/os-login-create-vm.md index 8ce70d9642c..3284b34e316 100644 --- a/en/compute/operations/vm-connect/os-login-create-vm.md +++ b/en/compute/operations/vm-connect/os-login-create-vm.md @@ -5,11 +5,13 @@ description: Follow this guide to create a VM that can be accessed via OS Login. # Creating a VM with OS Login -[OS Login](../../../organization/concepts/os-login.md) is used to provide users with SSH access to VMs through {{ iam-short-name }}. To grant access to a VM that supports OS Login at the OS level, [assign](../../../iam/operations/roles/grant.md) a user the `compute.osLogin` or `compute.osAdminLogin` role. +[OS Login](../../../organization/concepts/os-login.md) is used to provide users and service accounts with SSH access to VMs via SSH using {{ iam-short-name }}. To grant access to a VM that supports OS Login at the OS level, [assign](../../../iam/operations/roles/grant.md) the following roles to a user: -You can connect to a VM with OS Login access enabled using an SSH certificate [over the YC CLI](os-login.md#connect-via-cli) or a [standard SSH client](os-login.md#connect-via-exported-certificate), as well as over the YC CLI [using an SSH key](os-login.md#connect-via-key) previously added to the organization user profile in {{ org-full-name }}. +{% include [os-login-roles-needed-for-vm-access](../../../_includes/organization/os-login-roles-needed-for-vm-access.md) %} -However, we recommend specifying SSH keys when creating a VM: this way, you can [connect to a VM over SSH](./ssh.md#vm-connect) if you disable OS Login access for it. You can provide SSH keys to a VM using [metadata](../../concepts/vm-metadata.md#how-to-send-metadata). +You can use either the [YC CLI](os-login.md#connect-with-yc-cli) or a [standard SSH client](os-login.md#connect-with-ssh-client) to connect to VMs with enabled OS Login access. For connection, you can use an SSH certificate or SSH key, which you first need to [add](../../../organization/operations/add-ssh.md) to the OS Login profile of a {{ org-full-name }} user or service account. + +However, we recommend creating a local user on the new VM and providing a separate SSH key for that user: this way, you will be able to [connect to the VM over SSH](./ssh.md#vm-connect) even if you disable OS Login access for it. You can create a local user and provide an SSH key for them using [metadata](../../concepts/vm-metadata.md#how-to-send-metadata): {% include [metadata-keys](../../../_includes/compute/metadata-keys.md) %} @@ -19,33 +21,33 @@ To create a VM with OS Login: - Management console {#console} - 1. Enable [access via OS Login](../../../organization/operations/os-login-access.md) at the organization level. + 1. Enable [access via OS Login](../../../organization/operations/os-login-access.md) at the organization level. - 1. [Create a VM](../images-with-pre-installed-software/create.md) from the prepared image supporting access via OS Login. These images are available on [{{ marketplace-full-name }}](/marketplace) and contain `OS Login` in their names. + 1. [Create a VM](../images-with-pre-installed-software/create.md) from the prepared image supporting access via OS Login. These images are available on [{{ marketplace-full-name }}](/marketplace). - Enable **{{ ui-key.yacloud.compute.instance.access-method.field_os-login-access-method }}** when creating a VM. + When creating the VM, under **{{ ui-key.yacloud.compute.instances.create.section_access }}**, enable **Access via OS Login**. - To be able to [connect](./ssh.md#vm-connect) to the VM over SSH without using OS Login, [update](../vm-control/vm-update.md) the VM settings by disabling **{{ ui-key.yacloud.compute.instance.access-method.field_os-login-access-method }}**. + To be able to [connect](./ssh.md#vm-connect) to the VM over SSH without OS Login, [update](../vm-control/vm-update.md) the VM settings by disabling this option. - CLI {#cli} - 1. Enable [access via OS Login](../../../organization/operations/os-login-access.md) at the organization level. + 1. Enable [access via OS Login](../../../organization/operations/os-login-access.md) at the organization level. - 1. [Create a VM](../images-with-pre-installed-software/create.md) from the prepared image supporting access via OS Login. + 1. [Create a VM](../images-with-pre-installed-software/create.md) from the prepared image supporting access via OS Login. - When creating a VM, add a flag to enable access via OS Login: + When creating a VM, add a flag to enable access via OS Login: - ```bash - --metadata enable-oslogin=true - ``` + ```bash + --metadata enable-oslogin=true + ``` - API {#api} - 1. Enable [access via OS Login](../../../organization/operations/os-login-access.md) at the organization level. + 1. Enable [access via OS Login](../../../organization/operations/os-login-access.md) at the organization level. - 1. [Create a VM](../vm-create/create-linux-vm.md) using the [create](../../api-ref/Instance/create.md) REST API method for the [Instance](../../api-ref/Instance/) resource from a public image with OS Login access support: + 1. [Create a VM](../vm-create/create-linux-vm.md) using the [create](../../api-ref/Instance/create.md) REST API method for the [Instance](../../api-ref/Instance/) resource from a public image with OS Login access support: - When creating a VM, provide the `enable-oslogin=true` pair in the `metadata` field. + When creating the VM, provide the `enable-oslogin=true` pair in the `metadata` field. {% endlist %} diff --git a/en/compute/operations/vm-connect/os-login-export-certificate.md b/en/compute/operations/vm-connect/os-login-export-certificate.md index 33074ab5623..f358fae24ad 100644 --- a/en/compute/operations/vm-connect/os-login-export-certificate.md +++ b/en/compute/operations/vm-connect/os-login-export-certificate.md @@ -1,19 +1,20 @@ --- -title: How to export an OS Login certificate -description: Follow this guide to locally export an OS Login certificate so it can be used to connect over SSH to VMs with OS Login access configured. +title: How to export an SSH certificate +description: Follow this guide to locally export an SSH certificate so you can use it to connect over OS Login to VMs with configured OS Login access. --- -# Exporting an OS Login certificate +# Exporting an SSH certificate -You can use a certificate to enable a user or a third-party tool, such as [Terraform](https://www.terraform.io/) or [Ansible](https://www.ansible.com/), to use SSH to connect to a VM with OS Login access enabled. To do this, locally export an OS Login certificate and use it to access a VM using a standard SSH client. The exported certificate is valid for one hour. +You can use an SSH certificate of an [organization user](../../../organization/concepts/membership.md) or service account to enable a user or a third-party tool, such as [Terraform](https://www.terraform.io/) or [Ansible](https://www.ansible.com/), to use SSH to connect to a VM with enabled OS Login access. To do this, locally export an SSH certificate and use it to access the VM via a standard SSH client. The exported certificate is valid for one hour. {% include [oslogin-export-certificate](../../../_includes/compute/oslogin-export-certificate.md) %} -You can use the exported OS Login certificate to [connect](./os-login.md#connect-via-exported-certificate) to a VM with OS Login access [configured](../vm-control/vm-update.md#enable-oslogin-access). +You can use the exported SSH certificate to [connect](./os-login.md#connect-with-ssh-client) to a VM with [configured](../vm-control/vm-update.md#enable-oslogin-access) OS Login access. #### See also {#see-also} * [{#T}](../../../organization/operations/os-login-access.md) * [{#T}](../../../organization/operations/add-ssh.md) * [{#T}](./os-login.md) -* [Connecting to a {{ k8s }} node via OS Login](../../../managed-kubernetes/operations/node-connect-oslogin.md) \ No newline at end of file +* [Connecting to a {{ k8s }} node via OS Login](../../../managed-kubernetes/operations/node-connect-oslogin.md) +* [Using a service account with an OS Login profile for VM management via Ansible](../../../tutorials/security/sa-oslogin-ansible.md) \ No newline at end of file diff --git a/en/compute/operations/vm-connect/os-login.md b/en/compute/operations/vm-connect/os-login.md index 43df94f62c8..3f616d91273 100644 --- a/en/compute/operations/vm-connect/os-login.md +++ b/en/compute/operations/vm-connect/os-login.md @@ -5,7 +5,7 @@ description: Follow this guide to connect to a VM via OS Login. # Connecting to a virtual machine via OS Login -[OS Login](../../../organization/concepts/os-login.md) is used to provide users and [service accounts](../../../iam/concepts/users/service-accounts.md) with SSH access to VMs using {{ iam-short-name }}. +[OS Login](../../../organization/concepts/os-login.md) is used to provide users and [service accounts](../../../iam/concepts/users/service-accounts.md) with SSH access to VMs via SSH using {{ iam-short-name }}. ## Getting started {#before-you-begin} @@ -15,27 +15,51 @@ description: Follow this guide to connect to a VM via OS Login. [Create](./os-login-create-vm.md) a new virtual machine with OS Login support or [set up](./enable-os-login.md) access via OS Login for an existing VM as needed. -## Connecting to a VM via OS Login using an SSH certificate over the YC CLI {#connect-via-cli} +{% note info %} -{% include [os-login-yc-cli-roles-needed](../../../_includes/organization/os-login-yc-cli-roles-needed.md) %} +Required roles: -{% include [oslogin-connect-with-cli](../../../_includes/compute/oslogin-connect-with-cli.md) %} +{% include [os-login-roles-needed-for-vm-access](../../../_includes/organization/os-login-roles-needed-for-vm-access.md) %} -## Connecting to a VM via OS Login using an SSH certificate over a standard SSH client {#connect-via-exported-certificate} +{% endnote %} -{% include [oslogin-connect-with-exported-cert](../../../_includes/compute/oslogin-connect-with-exported-cert.md) %} +## Connecting using a standard SSH client {#connect-with-ssh-client} -{% note info %} +To connect to a VM with OS Login access enabled, you can use a standard SSH client and provide either the SSH key [saved](../../../organization/operations/add-ssh.md) in the user or service account OS Login profile or a short-lived SSH certificate you export for a user or service account. -The certificate is valid for one hour. After this time has elapsed, you will need to [export](./os-login-export-certificate.md) a new certificate to connect to the VM. +{% list tabs group=os_login_type %} -{% endnote %} +- Connecting with an SSH key {#ssh-key} + + {% include [oslogin-ssh-connect-with-ssh-key](../../../_includes/compute/oslogin-ssh-connect-with-ssh-key.md) %} + +- Connecting with an SSH certificate {#ssh-cert} + + {% include [oslogin-connect-with-exported-cert](../../../_includes/compute/oslogin-connect-with-exported-cert.md) %} + + {% include [os-login-certificate-short-lived](../../../_includes/compute/os-login-certificate-short-lived.md) %} + +{% endlist %} + +You will connect to the specified VM. If this is your first time connecting to this VM, a new user profile will be created in the VM's operating system. + +## Connecting using the YC CLI {#connect-with-yc-cli} + +To connect to a VM with OS Login access enabled, you can use the [YC CLI](../../../cli/quickstart.md) and provide either the SSH key [saved](../../../organization/operations/add-ssh.md) in the user or service account OS Login profile or SSH certificate of a user or service account. + +{% list tabs group=os_login_type %} + +- Connecting with an SSH key {#ssh-key} + + {% include [oslogin-connect-with-key](../../../_includes/compute/oslogin-connect-with-key.md) %} + +- Connecting with an SSH certificate {#ssh-cert} -## Connecting to a VM via OS Login using an SSH key over the YC CLI {#connect-via-key} + {% include [oslogin-connect-with-cli](../../../_includes/compute/oslogin-connect-with-cli.md) %} -{% include [os-login-yc-cli-roles-needed](../../../_includes/organization/os-login-yc-cli-roles-needed.md) %} +{% endlist %} -{% include [oslogin-connect-with-key](../../../_includes/compute/oslogin-connect-with-key.md) %} +You will connect to the specified VM. If this is your first time connecting to this VM, a new user profile will be created in the VM's operating system. #### See also {#see-also} @@ -43,4 +67,4 @@ The certificate is valid for one hour. After this time has elapsed, you will nee * [{#T}](../../../organization/operations/add-ssh.md) * [{#T}](./os-login-export-certificate.md) * [Connecting to a {{ k8s }} node via OS Login](../../../managed-kubernetes/operations/node-connect-oslogin.md) -* [Using a service account with an OS Login profile for VM management via Ansible](../../../tutorials/security/sa-oslogin-ansible.md) \ No newline at end of file +* [Using a service account with an OS Login profile for VM management via Ansible](../../../tutorials/security/sa-oslogin-ansible.md) diff --git a/en/compute/operations/vm-connect/recovery-access.md b/en/compute/operations/vm-connect/recovery-access.md index 2c16bb0f370..848cc24fe99 100644 --- a/en/compute/operations/vm-connect/recovery-access.md +++ b/en/compute/operations/vm-connect/recovery-access.md @@ -6,10 +6,10 @@ description: Follow this guide to restore access to a VM. # Restoring access to a VM You may need to restore access to a [VM](../../concepts/vm.md) in the following cases: -* [{#T}](#cloud-init) -* [{#T}](#ssh-recovery) -* [{#T}](#serial-console) -* [{#T}](#os-recovery) +* [{#T}](#cloud-init). +* [{#T}](#ssh-recovery). +* [{#T}](#serial-console). +* [{#T}](#os-recovery). ## VM user credentials are lost {#cloud-init} @@ -27,7 +27,7 @@ You may have problems accessing a Linux-based VM over SSH if the public part of You can restore access to a Linux-based VM over SSH using the [serial console](#serial-console) if you have a valid pair of SSH keys. If you can't access the serial console, do the following to recover the public part of your SSH key: -1. [Stop](../vm-control/vm-stop-and-start.md) the VM. +1. [Stop the VM](../vm-control/vm-stop-and-start.md). 1. [Take a snaphost](../disk-control/create-snapshot.md) of the VM's boot disk. 1. [Create](../vm-create/create-from-snapshots.md) an auxiliary Linux-based VM. Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, choose the OS for the boot disk. To attach a data disk to an auxiliary VM, select the previously created snapshot in the **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}** section. 1. [Connect over SSH](../vm-connect/ssh.md) to the auxiliary VM and [mount the disk](../vm-control/vm-attach-disk.md#mount-disk-and-fix-uuid) you created from the snapshot. @@ -38,8 +38,8 @@ If you can't access the serial console, do the following to recover the public p cd /mnt/home//.ssh ``` - By default, a user's SSH keys are stored in the `~/.ssh` directory of this user. - 1. Open the `authorized_keys` file, for example, using the `nano` text editor: + By default, user SSH keys are stored in the user's `~/.ssh` folder. + 1. Open the `authorized_keys` file, e.g., using the `nano` text editor: ```bash nano authorized_keys @@ -73,16 +73,16 @@ The problem may occur due to an error in the SSH, [security group](../../../vpc/ - Linux {#linux} - {% note info %} + {% note info %} - You may use the serial console only if the user password is set. Otherwise, see [{#T}](#os-recovery). + You may use the serial console only if the user password is set; otherwise, see [{#T}](#os-recovery). - {% endnote %} + {% endnote %} - 1. [Enable access](../serial-console/index.md#turn-on-for-current-instance) to the VM serial console. - 1. [Connect](../serial-console/connect-cli.md#connect-to-serial-console) to the VM serial console. - 1. Change the SSH or network settings. If you have security groups set up, make sure that their rules allow incoming TCP traffic to port 22. - 1. Connect to the VM via SSH. + 1. [Enable access](../serial-console/index.md#turn-on-for-current-instance) to the VM serial console. + 1. [Connect](../serial-console/connect-cli.md#connect-to-serial-console) to the VM serial console. + 1. Change the SSH or network settings. If you have security groups set up, make sure that their rules allow incoming TCP traffic to port 22. + 1. Connect to the VM via SSH. {% endlist %} diff --git a/en/compute/operations/vm-control/vm-access.md b/en/compute/operations/vm-control/vm-access.md index 522224ab57a..b9d963430d3 100644 --- a/en/compute/operations/vm-control/vm-access.md +++ b/en/compute/operations/vm-control/vm-access.md @@ -94,7 +94,7 @@ To grant a user, group, or [service account](../../../iam/concepts/users/service * `instance_id`: VM ID. * `role`: [Role](../../security/index.md#roles-list) to assign. - * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) getting the role. Specify it as `userAccount:` or `serviceAccount:`. + * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) the roles are assigned to. Specify it as `userAccount:` or `serviceAccount:`. For more information about the `yandex_compute_instance_iam_binding` resource parameters, see the [provider documentation]({{ tf-provider-resources-link }}/compute_instance_iam_binding). @@ -161,7 +161,7 @@ To grant a user, group, or [service account](../../../iam/concepts/users/service Where: - * `--access-binding`: Role you want to assign: + * `--access-binding`: Role to assign: * `role`: ID of the role to assign. * `subject`: Type and ID of the [subject](../../../iam/concepts/access-control/index.md#subject) getting the role. @@ -201,7 +201,7 @@ To grant a user, group, or [service account](../../../iam/concepts/users/service * `instance_id`: VM ID. * `role`: [Role](../../security/index.md#roles-list) to assign. - * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) getting the role. Specify it as `userAccount:` or `serviceAccount:`. + * `members`: List of types and IDs of [subjects](../../../iam/concepts/access-control/index.md#subject) the roles are assigned to. Specify it as `userAccount:` or `serviceAccount:`. For more information about the `yandex_compute_instance_iam_binding` resource parameters, see the [provider documentation]({{ tf-provider-resources-link }}/compute_instance_iam_binding). diff --git a/en/compute/operations/vm-control/vm-change-cloud.md b/en/compute/operations/vm-control/vm-change-cloud.md index d341c8bc310..a3e20bf9fe4 100644 --- a/en/compute/operations/vm-control/vm-change-cloud.md +++ b/en/compute/operations/vm-control/vm-change-cloud.md @@ -88,8 +88,8 @@ You cannot move a VM to another cloud; however, you can create an image from its yc compute image create \ --name \ --source-image-id \ - --cloud-id \ - --folder-id + --cloud-id \ + --folder-id ``` - API {#api} diff --git a/en/compute/operations/vm-control/vm-change-zone.md b/en/compute/operations/vm-control/vm-change-zone.md index 1d6a52f9dbc..7d0a4f975fc 100644 --- a/en/compute/operations/vm-control/vm-change-zone.md +++ b/en/compute/operations/vm-control/vm-change-zone.md @@ -213,7 +213,7 @@ In some cases, the migration may take longer if you are moving it to the `{{ reg For more information about the `yc compute instance relocate` command, see the [CLI reference](../../../cli/cli-ref/managed-services/compute/instance/relocate.md). - Example: + Examples: ```bash yc compute instance relocate a7lh48f5jvlk******** \ @@ -288,7 +288,7 @@ In some cases, the migration may take longer if you are moving it to the `{{ reg For more information about the `yc compute instance relocate` command, see the [CLI reference](../../../cli/cli-ref/managed-services/compute/instance/relocate.md). - Please note that connecting VM's [network interfaces](../../concepts/network.md) to new subnets changes their IP addressing. If you need to specify internal IP addresses for the VM's network interfaces, use the `ipv4-address=` property in `network-interface`; for public IP addresses, use `nat-address=`. Other than that, setting up network interface parameters when moving a VM to a different availability zone is similar to setting up the same parameters when creating a VM. + Please note that connecting VM's [network interfaces](../../concepts/network.md) to new subnets changes their IP addressing. If you need to specify internal IP addresses for the VM's network interfaces, use the `ipv4-address=` property of the `network-interface` parameter; for public IP addresses, use the `nat-address=` property. Other than that, setting up network interface parameters when moving a VM to a different availability zone is similar to setting up the same parameters when creating a VM. {% endlist %} diff --git a/en/compute/operations/vm-control/vm-update-resources.md b/en/compute/operations/vm-control/vm-update-resources.md index 0b4a8d0f9dd..5fe70113dec 100644 --- a/en/compute/operations/vm-control/vm-update-resources.md +++ b/en/compute/operations/vm-control/vm-update-resources.md @@ -1,7 +1,7 @@ # Changing VM computing resources -After you create a VM, you can change its computing resources. For more information about how to change a VM name, description, and tags, see [{#T}](vm-update.md). +After you create a VM, you can change its computing resources. For more information on how to change a VM name, description, and tags, see [{#T}](vm-update.md). ## Changing the vCPU and RAM configuration {#update-vcpu-ram} @@ -11,52 +11,55 @@ This section provides guidelines for changing the number and performance of vCPU - Management console {#console} - To change vCPU and RAM of a VM: - 1. In the [management console]({{ link-console-main }}), select the folder the VM belongs to. - 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. - 1. Click the VM name. - 1. Click **{{ ui-key.yacloud.common.stop }}** in the top-right corner of the page. - 1. In the window that opens, click **{{ ui-key.yacloud.compute.instance.stop-dialog.button_stop }}**. - 1. Wait until the VM status changes to `Stopped`, then click ![image](../../../_assets/console-icons/pencil.svg) **{{ ui-key.yacloud.compute.instance.overview.button_action-edit }}** in the top-right corner of the page. - 1. Change the [configuration](../../concepts/performance-levels.md) of the VM in the **{{ ui-key.yacloud.compute.instances.create.section_platform }}** section: + To change vCPU and RAM of a VM: + + 1. In the [management console]({{ link-console-main }}), select the [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder) the VM belongs to. + 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. + 1. Click the VM name. + 1. Click **{{ ui-key.yacloud.common.stop }}** in the top-right corner of the page. + 1. In the window that opens, click **{{ ui-key.yacloud.compute.instance.stop-dialog.button_stop }}**. + 1. Wait until the VM status changes to `Stopped`, then click ![image](../../../_assets/console-icons/pencil.svg) **{{ ui-key.yacloud.compute.instance.overview.button_action-edit }}** in the top-right corner of the page. + 1. Change the [configuration](../../concepts/performance-levels.md) of the VM in the **{{ ui-key.yacloud.compute.instances.create.section_platform }}** section. To do this: + + * Go to the **{{ ui-key.yacloud.component.compute.resources.label_tab-custom }}** tab. * Choose a [platform](../../concepts/vm-platforms.md). - * Specify the required number of vCPUs. - * Choose a guaranteed vCPU performance. - * Specify the RAM size. - 1. Click **{{ ui-key.yacloud.compute.instance.edit.button_update }}**. - 1. Click **{{ ui-key.yacloud.common.start }}** in the top-right corner. - 1. In the window that opens, click **{{ ui-key.yacloud.compute.instances.popup-confirm_button_start }}**. + * Specify the [guaranteed share](../../concepts/performance-levels.md) and required number of vCPUs, as well as RAM size. + * If required, make your VM [preemptible](../../concepts/preemptible-vm.md). + + 1. Click **{{ ui-key.yacloud.compute.instance.edit.button_update }}**. + 1. Click **{{ ui-key.yacloud.common.start }}** in the top-right corner. + 1. In the window that opens, click **{{ ui-key.yacloud.compute.instances.popup-confirm_button_start }}**. - CLI {#cli} - {% include [cli-install](../../../_includes/cli-install.md) %} + {% include [cli-install](../../../_includes/cli-install.md) %} - {% include [default-catalogue](../../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../../_includes/default-catalogue.md) %} - 1. View a description of the CLI command for updating VM parameters: + 1. View a description of the CLI command for updating VM parameters: ```bash yc compute instance update --help ``` - 1. Get a list of VMs in the default folder: + 1. Get a list of VMs in the default folder: {% include [compute-instance-list](../../_includes_service/compute-instance-list.md) %} - 1. Select the `ID` or `NAME` of the VM, e.g., `first-instance`. - 1. Stop the VM: + 1. Select the `ID` or `NAME` of the VM, e.g., `first-instance`. + 1. Stop the VM: ```bash yc compute instance stop first-instance ``` - 1. Get the current VM [configuration](../../concepts/performance-levels.md) with [metadata](../../concepts/vm-metadata.md): + 1. Get the current VM [configuration](../../concepts/performance-levels.md) with [metadata](../../concepts/vm-metadata.md): ```bash yc compute instance get --full first-instance ``` - 1. Change the VM configuration: + 1. Change the VM configuration: ```bash yc compute instance update first-instance \ @@ -70,7 +73,7 @@ This section provides guidelines for changing the number and performance of vCPU * **Number of vCPUs** to 4. * **RAM** to 32 GB. - 1. Run the VM: + 1. Run the VM: ```bash yc compute instance start first-instance @@ -96,52 +99,60 @@ To add a [GPU](../../concepts/gpus.md) to an existing VM, change the platform an - Management console {#console} - To change the number of GPUs on the VM: - 1. In the [management console]({{ link-console-main }}), select the folder the VM belongs to. - 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. - 1. Click the VM name. - 1. Click **{{ ui-key.yacloud.common.stop }}** in the top-right corner of the page. - 1. In the window that opens, click **{{ ui-key.yacloud.compute.instance.stop-dialog.button_stop }}**. - 1. Wait until the VM status changes to `Stopped`, then click ![image](../../../_assets/console-icons/pencil.svg) **{{ ui-key.yacloud.compute.instance.overview.button_action-edit }}** in the top-right corner of the page. - 1. Change the [configuration](../../concepts/performance-levels.md) of the VM in the **{{ ui-key.yacloud.compute.instances.create.section_platform }}** section: - * Choose a [platform](../../concepts/vm-platforms.md#gpu-platforms). + To change the number of GPUs on the VM: + + 1. In the [management console]({{ link-console-main }}), select the [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder) the VM belongs to. + 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. + 1. Click the VM name. + 1. Click **{{ ui-key.yacloud.common.stop }}** in the top-right corner of the page. + 1. In the window that opens, click **{{ ui-key.yacloud.compute.instance.stop-dialog.button_stop }}**. + 1. Wait until the VM status changes to `Stopped`, then click ![image](../../../_assets/console-icons/pencil.svg) **{{ ui-key.yacloud.compute.instance.overview.button_action-edit }}** in the top-right corner of the page. + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_platform }}**: + * Go to the **{{ ui-key.yacloud.component.compute.resources.label_tab-gpu }}** tab. + * Choose a [platform](../../concepts/vm-platforms.md#gpu-platforms): - * Specify the required number of GPUs. - 1. Click **{{ ui-key.yacloud.compute.instance.edit.button_update }}**. - 1. Click **{{ ui-key.yacloud.common.start }}** in the top-right corner of the page. - 1. In the window that opens, click **{{ ui-key.yacloud.compute.instances.popup-confirm_button_start }}**. + * {{ v100-broadwell }} + * {{ v100-cascade-lake }} + * {{ a100-epyc }} + * {{ t4-ice-lake }} + + * Select one of the available configurations with the required GPUs, vCPUs, and amount of RAM. + + 1. Click **{{ ui-key.yacloud.compute.instance.edit.button_update }}**. + 1. Click **{{ ui-key.yacloud.common.start }}** in the top-right corner of the page. + 1. In the window that opens, click **{{ ui-key.yacloud.compute.instances.popup-confirm_button_start }}**. - CLI {#cli} - {% include [cli-install](../../../_includes/cli-install.md) %} + {% include [cli-install](../../../_includes/cli-install.md) %} - {% include [default-catalogue](../../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../../_includes/default-catalogue.md) %} - 1. View a description of the CLI command for updating VM parameters: + 1. View a description of the CLI command for updating VM parameters: ```bash yc compute instance update --help ``` - 1. Get a list of VMs in the default folder: + 1. Get a list of VMs in the default folder: {% include [compute-instance-list](../../_includes_service/compute-instance-list.md) %} - 1. Select the `ID` or `NAME` of the VM, e.g., `first-instance`. - 1. Stop the VM: + 1. Select the `ID` or `NAME` of the VM, e.g., `first-instance`. + 1. Stop the VM: ```bash yc compute instance stop first-instance ``` - 1. Get the current VM [configuration](../../concepts/performance-levels.md) with [metadata](../../concepts/vm-metadata.md): + 1. Get the current VM [configuration](../../concepts/performance-levels.md) with [metadata](../../concepts/vm-metadata.md): ```bash yc compute instance get --full first-instance ``` - 1. Change the VM configuration: + 1. Change the VM configuration: ```bash yc compute instance update first-instance \ @@ -152,14 +163,13 @@ To add a [GPU](../../concepts/gpus.md) to an existing VM, change the platform an ``` This command changes the following VM specs: - * **Platform** to {{ t4-ice-lake }}. - + * **Platform** to {{ t4-ice-lake }}. * **Number of vCPUs** to 8. * **RAM** to 32 GB. * **GPU** to 1. - 1. Run the VM: + 1. Run the VM: ```bash yc compute instance start first-instance @@ -167,7 +177,7 @@ To add a [GPU](../../concepts/gpus.md) to an existing VM, change the platform an - API {#api} - To change a VM's platform and configuration, use the [update](../../api-ref/Instance/update.md) REST API method for the [Instance](../../api-ref/Instance/) resource or the [InstanceService/Update](../../api-ref/grpc/Instance/update.md) gRPC API call. + To change a VM's platform and configuration, use the [update](../../api-ref/Instance/update.md) REST API method for the [Instance](../../api-ref/Instance/) resource or the [InstanceService/Update](../../api-ref/grpc/Instance/update.md) gRPC API call. {% endlist %} @@ -177,48 +187,60 @@ To add a [GPU](../../concepts/gpus.md) to an existing VM, change the platform an - Management console {#console} - To change the number of [GPUs](../../concepts/gpus.md) on an existing VM: - 1. In the [management console]({{ link-console-main }}), select the folder the VM belongs to. - 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. - 1. Click the VM name. - 1. Click **{{ ui-key.yacloud.common.stop }}** in the top-right corner of the page. - 1. In the window that opens, click **{{ ui-key.yacloud.compute.instance.stop-dialog.button_stop }}**. - 1. Wait until the VM status changes to `Stopped`, then click ![image](../../../_assets/console-icons/pencil.svg) **{{ ui-key.yacloud.compute.instance.overview.button_action-edit }}** in the top-right corner of the page. - 1. Change the VM [configuration](../../concepts/performance-levels.md) Under **{{ ui-key.yacloud.compute.instances.create.section_platform }}**, specify the required number of GPUs. - 1. Click **{{ ui-key.yacloud.compute.instance.edit.button_update }}**. - 1. Click **{{ ui-key.yacloud.common.start }}** in the top-right corner of the page. - 1. In the window that opens, click **{{ ui-key.yacloud.compute.instances.popup-confirm_button_start }}**. + To change the number of [GPUs](../../concepts/gpus.md) on an existing VM: + + 1. In the [management console]({{ link-console-main }}), select the [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder) the VM belongs to. + 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. + 1. Click the VM name. + 1. Click **{{ ui-key.yacloud.common.stop }}** in the top-right corner of the page. + 1. In the window that opens, click **{{ ui-key.yacloud.compute.instance.stop-dialog.button_stop }}**. + 1. Wait until the VM status changes to `Stopped`, then click ![image](../../../_assets/console-icons/pencil.svg) **{{ ui-key.yacloud.compute.instance.overview.button_action-edit }}** in the top-right corner of the page. + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_platform }}**: + + * Go to the **{{ ui-key.yacloud.component.compute.resources.label_tab-gpu }}** tab. + * Choose a [platform](../../concepts/vm-platforms.md#gpu-platforms): + + * {{ v100-broadwell }} + * {{ v100-cascade-lake }} + * {{ a100-epyc }} + * {{ t4-ice-lake }} + + * Select one of the available configurations with the required GPUs, vCPUs, and amount of RAM. + + 1. Click **{{ ui-key.yacloud.compute.instance.edit.button_update }}**. + 1. Click **{{ ui-key.yacloud.common.start }}** in the top-right corner of the page. + 1. In the window that opens, click **{{ ui-key.yacloud.compute.instances.popup-confirm_button_start }}**. - CLI {#cli} - {% include [cli-install](../../../_includes/cli-install.md) %} + {% include [cli-install](../../../_includes/cli-install.md) %} - {% include [default-catalogue](../../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../../_includes/default-catalogue.md) %} - 1. View a description of the CLI command for updating VM parameters: + 1. View a description of the CLI command for updating VM parameters: ```bash yc compute instance update --help ``` - 1. Get a list of VMs in the default folder: + 1. Get a list of VMs in the default folder: {% include [compute-instance-list](../../_includes_service/compute-instance-list.md) %} - 1. Select the `ID` or `NAME` of the VM, e.g., `first-instance`. - 1. Stop the VM: + 1. Select the `ID` or `NAME` of the VM, e.g., `first-instance`. + 1. Stop the VM: ```bash yc compute instance stop first-instance ``` - 1. Get the current VM [configuration](../../concepts/performance-levels.md) with [metadata](../../concepts/vm-metadata.md): + 1. Get the current VM [configuration](../../concepts/performance-levels.md) with [metadata](../../concepts/vm-metadata.md): ```bash yc compute instance get --full first-instancegit ``` - 1. Change the VM configuration: + 1. Change the VM configuration: ```bash yc compute instance update first-instance \ @@ -229,9 +251,9 @@ To add a [GPU](../../concepts/gpus.md) to an existing VM, change the platform an This command changes the number of GPUs to 2. - The values of `--cores` (number of vCPUs) and `--memory` (amount of RAM in GB) parameters depend on the platform and the number of GPUs. See [List of available configurations](../../concepts/gpus.md#config). + The values of the `--cores` (number of vCPUs) and `--memory` (RAM size in GB) parameters depend on the platform and the number of GPUs. For more information, see the [list of available configurations](../../concepts/gpus.md#config). - 1. Run the VM: + 1. Run the VM: ```bash yc compute instance start first-instance @@ -239,7 +261,7 @@ To add a [GPU](../../concepts/gpus.md) to an existing VM, change the platform an - API {#api} - To change the number of GPUs, use the [update](../../api-ref/Instance/update.md) REST API method for the [Instance](../../api-ref/Instance/) resource or the [InstanceService/Update](../../api-ref/grpc/Instance/update.md) gRPC API call. + To change the number of GPUs, use the [update](../../api-ref/Instance/update.md) REST API method for the [Instance](../../api-ref/Instance/) resource or the [InstanceService/Update](../../api-ref/grpc/Instance/update.md) gRPC API call. {% endlist %} @@ -255,16 +277,17 @@ This feature is only available upon agreement with your account manager. - Management console {#console} - To enable a [software-accelerated network](../../concepts/software-accelerated-network.md) on an existing VM: - 1. In the [management console]({{ link-console-main }}), select the folder the VM belongs to. - 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. - 1. Click the VM name. - 1. Click **{{ ui-key.yacloud.common.stop }}** in the top-right corner of the page. - 1. In the window that opens, click **{{ ui-key.yacloud.compute.instance.stop-dialog.button_stop }}**. - 1. Wait until the VM status changes to `Stopped`, then click ![image](../../../_assets/console-icons/pencil.svg) **{{ ui-key.yacloud.compute.instance.overview.button_action-edit }}** in the top-right corner of the page. - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_platform }}**, enable the **{{ ui-key.yacloud.component.compute.resources.label_sw-accelerated-net }}** option. - 1. Click **{{ ui-key.yacloud.compute.instance.edit.button_update }}**. - 1. Click **{{ ui-key.yacloud.common.start }}** in the top-right corner of the page. - 1. In the window that opens, click **{{ ui-key.yacloud.compute.instances.popup-confirm_button_start }}**. + To enable a [software-accelerated network](../../concepts/software-accelerated-network.md) on an existing VM: + + 1. In the [management console]({{ link-console-main }}), select the [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder) the VM belongs to. + 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. + 1. Click the VM name. + 1. Click **{{ ui-key.yacloud.common.stop }}** in the top-right corner of the page. + 1. In the window that opens, click **{{ ui-key.yacloud.compute.instance.stop-dialog.button_stop }}**. + 1. Wait until the VM status changes to `Stopped`, then click ![image](../../../_assets/console-icons/pencil.svg) **{{ ui-key.yacloud.compute.instance.overview.button_action-edit }}** in the top-right corner of the page. + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_platform }}**, open the **{{ ui-key.yacloud.component.compute.resources.label_tab-custom }}** tab and enable the **{{ ui-key.yacloud.component.compute.resources.field_sw-accelerated-net }}** option. + 1. Click **{{ ui-key.yacloud.compute.instance.edit.button_update }}**. + 1. Click **{{ ui-key.yacloud.common.start }}** in the top-right corner of the page. + 1. In the window that opens, click **{{ ui-key.yacloud.compute.instances.popup-confirm_button_start }}**. {% endlist %} \ No newline at end of file diff --git a/en/compute/operations/vm-control/vm-update.md b/en/compute/operations/vm-control/vm-update.md index 0fcdb58d98d..496ed6fa973 100644 --- a/en/compute/operations/vm-control/vm-update.md +++ b/en/compute/operations/vm-control/vm-update.md @@ -8,47 +8,47 @@ For information about editing a VM configuration, see [{#T}](vm-update-resources - Management console {#console} - To update a VM: - 1. In the [management console]({{ link-console-main }}), select the folder the VM belongs to. - 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. - 1. In the left-hand panel, select ![image](../../../_assets/console-icons/server.svg) **{{ ui-key.yacloud.compute.switch_instances }}** and click the name of the VM you need. - 1. Click ![image](../../../_assets/pencil.svg) **{{ ui-key.yacloud.compute.instance.overview.button_action-edit }}**. - 1. Edit the VM parameters, e.g., rename it by editing the **{{ ui-key.yacloud.common.name }}** field. - 1. Click **{{ ui-key.yacloud.compute.instance.edit.button_update }}**. + To update a VM: + 1. In the [management console]({{ link-console-main }}), select the folder the VM belongs to. + 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. + 1. In the left-hand panel, select ![image](../../../_assets/console-icons/server.svg) **{{ ui-key.yacloud.compute.switch_instances }}** and click the name of the VM you need. + 1. Click ![image](../../../_assets/pencil.svg) **{{ ui-key.yacloud.compute.instance.overview.button_action-edit }}**. + 1. Edit the VM parameters, e.g., rename it by editing the **{{ ui-key.yacloud.common.name }}** field. + 1. Click **{{ ui-key.yacloud.compute.instance.edit.button_update }}**. - CLI {#cli} - {% include [cli-install](../../../_includes/cli-install.md) %} + {% include [cli-install](../../../_includes/cli-install.md) %} - {% include [default-catalogue](../../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../../_includes/default-catalogue.md) %} - 1. View a description of the CLI command for updating VM parameters: + 1. View a description of the CLI command for updating VM parameters: - ```bash - yc compute instance update --help - ``` + ```bash + yc compute instance update --help + ``` - 1. Get a list of VMs in the default folder: + 1. Get a list of VMs in the default folder: - {% include [compute-instance-list](../../_includes_service/compute-instance-list.md) %} + {% include [compute-instance-list](../../_includes_service/compute-instance-list.md) %} - 1. Select the `ID` or `NAME` of the VM, e.g., `first-instance`. - 1. Change the VM parameters, e.g., rename it: + 1. Select the `ID` or `NAME` of the VM, e.g., `first-instance`. + 1. Change the VM parameters, e.g., rename it: - ```bash - yc compute instance update first-instance \ - --new-name windows-vm - ``` + ```bash + yc compute instance update first-instance \ + --new-name windows-vm + ``` - API {#api} - To update a VM, use the [update](../../api-ref/Instance/update.md) REST API method for the [Instance](../../api-ref/Instance/) resource or the [InstanceService/Update](../../api-ref/grpc/Instance/update.md) gRPC API call. + To update a VM, use the [update](../../api-ref/Instance/update.md) REST API method for the [Instance](../../api-ref/Instance/) resource or the [InstanceService/Update](../../api-ref/grpc/Instance/update.md) gRPC API call. {% endlist %} {% note info %} -Changing the VM name does not change the host name or the FQDN. For more information about generating FQDN names, see [{#T}](../../concepts/network.md#hostname). +Changing the VM name does not change the host name or the FQDN. For more information about generating the FQDN, see [{#T}](../../concepts/network.md#hostname). {% endnote %} @@ -62,9 +62,9 @@ To view the list of configurable parameters, run the command: - CLI {#cli} - ```bash - yc compute instance update --help - ``` + ```bash + yc compute instance update --help + ``` {% endlist %} @@ -76,26 +76,26 @@ To change the name and description of a VM, follow these steps: - CLI {#cli} - {% include [cli-install](../../../_includes/cli-install.md) %} + {% include [cli-install](../../../_includes/cli-install.md) %} - {% include [default-catalogue](../../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../../_includes/default-catalogue.md) %} - 1. Get a list of VMs in the default folder: + 1. Get a list of VMs in the default folder: - {% include [compute-instance-list](../../_includes_service/compute-instance-list.md) %} + {% include [compute-instance-list](../../_includes_service/compute-instance-list.md) %} - 1. Select the `ID` or `NAME` of the VM, e.g., `first-instance`. - 1. Update the VM name and description: + 1. Select the `ID` or `NAME` of the VM, e.g., `first-instance`. + 1. Update the VM name and description: - ```bash - yc compute instance update first-instance \ - --new-name first-vm \ - --description "changed description vm via CLI" - ``` + ```bash + yc compute instance update first-instance \ + --new-name first-vm \ + --description "changed description vm via CLI" + ``` - API {#api} - Use the [update](../../api-ref/Instance/update.md) REST API method for the [Instance](../../api-ref/Instance/) resource or the [InstanceService/Update](../../api-ref/grpc/Instance/update.md) gRPC API call. + Use the [update](../../api-ref/Instance/update.md) REST API method for the [Instance](../../api-ref/Instance/) resource or the [InstanceService/Update](../../api-ref/grpc/Instance/update.md) gRPC API call. {% endlist %} @@ -115,24 +115,24 @@ To update VM metadata, follow these steps: - CLI {#cli} - {% include [cli-install](../../../_includes/cli-install.md) %} + {% include [cli-install](../../../_includes/cli-install.md) %} - {% include [default-catalogue](../../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../../_includes/default-catalogue.md) %} - 1. Get a list of VMs in the default folder: + 1. Get a list of VMs in the default folder: - {% include [compute-instance-list](../../_includes_service/compute-instance-list.md) %} + {% include [compute-instance-list](../../_includes_service/compute-instance-list.md) %} - 1. Select the `ID` or `NAME` of the VM, e.g., `first-instance`. - 1. Retrieve VM information with its metadata. All user-defined metadata is specified in the `user-data` key. + 1. Select the `ID` or `NAME` of the VM you need, e.g., `first-instance`. + 1. Retrieve VM information with its metadata. All user-defined metadata is specified in the `user-data` key. - ```bash - yc compute instance get --full first-instance - ``` + ```bash + yc compute instance get --full first-instance + ``` - 1. Update the VM metadata. You can change the metadata using the flags: - * `--metadata`: To change a value from a single string. - * `--metadata-from-file`: To change a value from multiple strings. + 1. Update the VM metadata. You can change the metadata using the flags: + * `--metadata`: To change a value from a single string. + * `--metadata-from-file`: To change a value from multiple strings. {% endlist %} @@ -148,41 +148,41 @@ To make sure users can [connect](../vm-connect/os-login.md) to the VM via [OS Lo - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the folder the VM belongs to. - 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. - 1. In the left-hand panel, select ![image](../../../_assets/console-icons/server.svg) **{{ ui-key.yacloud.compute.switch_instances }}** and click the name of the VM you need. - 1. Click ![image](../../../_assets/pencil.svg) **{{ ui-key.yacloud.compute.instance.overview.button_action-edit }}**. - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_access }}**, enable the **{{ ui-key.yacloud.compute.instance.access-method.field_os-login-access-method }}** option. - 1. Click **{{ ui-key.yacloud.compute.instance.edit.button_update }}**. + 1. In the [management console]({{ link-console-main }}), select the folder the VM belongs to. + 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. + 1. In the left-hand panel, select ![image](../../../_assets/console-icons/server.svg) **{{ ui-key.yacloud.compute.switch_instances }}** and click the name of the VM. + 1. In the top-right corner, click ![image](../../../_assets/console-icons/pencil.svg) **{{ ui-key.yacloud.compute.instance.overview.button_action-edit }}**. + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_access }}**, enable **Access via OS Login**. + 1. Click **{{ ui-key.yacloud.compute.instance.edit.button_update }}**. - CLI {#cli} - {% include [cli-install](../../../_includes/cli-install.md) %} + {% include [cli-install](../../../_includes/cli-install.md) %} - {% include [default-catalogue](../../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../../_includes/default-catalogue.md) %} - 1. View a description of the CLI command for updating VM parameters: + 1. View a description of the CLI command for updating VM parameters: - ```bash - yc compute instance update --help - ``` + ```bash + yc compute instance update --help + ``` - 1. Get a list of VMs in the default folder: + 1. Get a list of VMs in the default folder: - {% include [compute-instance-list](../../_includes_service/compute-instance-list.md) %} + {% include [compute-instance-list](../../_includes_service/compute-instance-list.md) %} - 1. Select the `ID` or `NAME` of the VM, e.g., `first-instance`. + 1. Select the `ID` or `NAME` of the VM, e.g., `first-instance`. - 1. Enable access via OS Login: + 1. Enable access via OS Login: - ```bash - yc compute instance update first-instance \ - --metadata enable-oslogin=true - ``` + ```bash + yc compute instance update first-instance \ + --metadata enable-oslogin=true + ``` - API {#api} - In the `metadata` field, set `enable-oslogin=true` in the [update](../../api-ref/Instance/update.md) REST API method for the [Instance](../../api-ref/Instance/) resource or in the [InstanceService/Update](../../api-ref/grpc/Instance/update.md) gRPC API call. + Use the `metadata` field to provide the `enable-oslogin=true` pair in the [update](../../api-ref/Instance/update.md) REST API method for the [Instance](../../api-ref/Instance/) resource or in the [InstanceService/Update](../../api-ref/grpc/Instance/update.md) gRPC API call. {% endlist %} diff --git a/en/compute/operations/vm-create/create-from-disks.md b/en/compute/operations/vm-create/create-from-disks.md index d1754bdda38..01a41b766ab 100644 --- a/en/compute/operations/vm-create/create-from-disks.md +++ b/en/compute/operations/vm-create/create-from-disks.md @@ -1,9 +1,9 @@ --- -title: How to create a VM from a set of disks -description: Use this guide to create a VM from a set of existing disks. +title: How to create a VM from existing disks +description: Follow this guide to create a VM from existing disks. --- -# Creating a VM from a set of disks +# Creating a VM from existing disks You can create a [VM](../../concepts/vm.md) from existing [disks](../../concepts/disk.md). Make sure the disks reside in one of the [availability zones](../../../overview/concepts/geo-scope.md) and are not added to other VMs. @@ -15,214 +15,182 @@ You can create a [VM](../../concepts/vm.md) from existing [disks](../../concepts - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder) to create your VM in. - 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. - 1. At the top right, click **{{ ui-key.yacloud.compute.instances.button_create }}**. - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**: - * Enter a name and description for the VM. The naming requirements are as follows: + 1. In the [management console]({{ link-console-main }}), select the folder to create your VM in. + 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. + 1. In the left-hand panel, select ![image](../../../_assets/console-icons/server.svg) **{{ ui-key.yacloud.compute.switch_instances }}**. + 1. Click **{{ ui-key.yacloud.compute.instances.button_create }}**. + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, select an [image](../../concepts/image.md). + 1. Under **{{ ui-key.yacloud.k8s.node-groups.create.section_allocation-policy }}**, select an [availability zone](../../../overview/concepts/geo-scope.md) to place your VM in. + 1. Add a [disk](../../concepts/disk.md): - {% include [name-format](../../../_includes/name-format.md) %} - - {% include [name-fqdn](../../../_includes/compute/name-fqdn.md) %} - - * Select an availability zone to place your VM in. - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, select an [image](../../concepts/image.md). - 1. {% include [encryption-section-boot](../../../_includes/compute/encryption-section-boot.md) %} - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}**, [add a disk](create-from-disks.md): + * Under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}**, click **{{ ui-key.yacloud.compute.instances.create-disk.button_create }}** + * In the window that opens, select **{{ ui-key.yacloud.compute.instances.create-disk.value_source-disk }}** → `Connect existing disk`. + * Select the disk you need. + * (Optional) In the **{{ ui-key.yacloud.compute.field_additional }}** field, enable **{{ ui-key.yacloud.compute.field_disk-autodelete }}** if you need to automatically delete this disk when deleting the VM. * Click **{{ ui-key.yacloud.compute.component.instance-storage-dialog.button_add-disk }}**. - * Enter the disk name. - * Select the [disk type](../../concepts/disk.md#disks_types). - * Specify the required block size. - * Specify the required disk size. - * {% include [encryption-section-secondary](../../../_includes/compute/encryption-section-secondary.md) %} - * (Optional) Enable the **{{ ui-key.yacloud.compute.field_disk-autodelete }}** option if you need to automatically delete the disk when deleting the VM it will be attached to. - * Select `{{ ui-key.yacloud.compute.instances.create-disk.value_source-disk }}` as content. - * Click **{{ ui-key.yacloud.compute.instances.create-disk.button_create }}**. - 1. (Optional) Under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}**, select the **{{ ui-key.yacloud.compute.nfs.label_filesystems }}** tab and attach the [file storage](../../concepts/filesystem.md): - * Click **{{ ui-key.yacloud.compute.nfs.button_attach-filesystem-to-the-instance }}**. - * In the window that opens, select the file storage. - * Enter the device name. - * Click **{{ ui-key.yacloud.compute.nfs.button_attach-filesystem-to-the-instance }}**. - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_platform }}**: - * Choose a [platform](../../concepts/vm-platforms.md). - * Specify the [guaranteed share](../../../compute/concepts/performance-levels.md) and the required number of vCPUs, as well as the amount of RAM. - * If required, make your VM [preemptible](../../concepts/preemptible-vm.md). - * (Optional) Enable a [software-accelerated network](../../concepts/software-accelerated-network.md). - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_network }}**: - - {% include [network-settings](../../../_includes/compute/network-settings.md) %} - - 1. {% include [backup-info](../../../_includes/compute/backup-info.md) %} - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_access }}**, specify the information required to access the instance: - * (Optional) Select or create a [service account](../../../iam/concepts/users/service-accounts.md). With a service account, you can flexibly configure access rights for your resources. - * Enter the username in the **{{ ui-key.yacloud.compute.instances.create.field_user }}** field. - - {% note alert %} - Do not use the `root` username or other names reserved by the operating system. To perform operations that require superuser permissions, use the `sudo` command. + 1. {% include [encryption-section-secondary](../../../_includes/compute/encryption-section-secondary.md) %} + 1. {% include [section-storages-filesystem](../../../_includes/compute/create/section-storages-filesystem.md) %} + 1. {% include [section-platform](../../../_includes/compute/create/section-platform.md) %} + 1. {% include [network-settings](../../../_includes/compute/create/section-network.md) %} + 1. {% include [section-access](../../../_includes/compute/create/section-access.md) %} + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**, specify the VM name: - {% endnote %} + {% include [name-format](../../../_includes/name-format.md) %} - * In the **{{ ui-key.yacloud.compute.instances.create.field_key }}** field, paste the contents of the [public key](../../operations/vm-connect/ssh.md#creating-ssh-keys) file. - * If required, grant access to the [serial console](../../operations/serial-console/index.md). - - {% include [vm-connect-linux](../../../_includes/vm-connect-linux.md) %} - - 1. (Optional) Under **{{ ui-key.yacloud.compute.instances.create.section_placement }}**, select a VM [placement group](../../concepts/placement-groups.md). - 1. Click **{{ ui-key.yacloud.compute.instances.create.button_create }}**. - - The VM appears in the list. Once created, the VM is assigned an [IP address](../../../vpc/concepts/address.md) and a [host name (FQDN)](../../../vpc/concepts/address.md#fqdn). + {% include [name-fqdn](../../../_includes/compute/name-fqdn.md) %} + 1. {% include [section-additional](../../../_includes/compute/create/section-additional.md) %} + 1. Click **{{ ui-key.yacloud.compute.instances.create.button_create }}**. - CLI {#cli} - {% include [cli-install](../../../_includes/cli-install.md) %} + {% include [cli-install](../../../_includes/cli-install.md) %} - {% include [default-catalogue](../../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../../_includes/default-catalogue.md) %} - 1. View the description of the [CLI](../../../cli/) command to create a VM: + 1. View the description of the [CLI](../../../cli/) command to create a VM: - ```bash - yc compute instance create --help - ``` + ```bash + yc compute instance create --help + ``` - 1. Get a list of disks in the default [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder): + 1. Get a list of disks in the default [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder): - {% include [compute-disk-list](../../../_includes/compute/disk-list.md) %} + {% include [compute-disk-list](../../../_includes/compute/disk-list.md) %} - 1. Select the disks you intend to use by `ID` or `NAME`. - 1. Create a VM in the default folder: + 1. Select the IDs (`ID`) or names (`NAME`) of the disks you need. + 1. Create a VM in the default folder: - ```bash - yc compute instance create \ - --name first-instance \ - --zone {{ region-id }}-a \ - --network-interface subnet-name=default-a,nat-ip-version=ipv4 \ - --use-boot-disk disk-name=first-disk \ - --attach-disk disk-name=second-disk \ - --ssh-key ~/.ssh/id_ed25519.pub - ``` + ```bash + yc compute instance create \ + --name first-instance \ + --zone {{ region-id }}-a \ + --network-interface subnet-name=default-a,nat-ip-version=ipv4 \ + --use-boot-disk disk-name=first-disk \ + --attach-disk disk-name=second-disk \ + --ssh-key ~/.ssh/id_ed25519.pub + ``` - This command creates the VM: - * Name: `first-instance` + This command creates a VM with the following parameters: + * Name: `first-instance` - {% include [name-fqdn](../../../_includes/compute/name-fqdn.md) %} + {% include [name-fqdn](../../../_includes/compute/name-fqdn.md) %} - * Availability zone: `{{ region-id }}-a` - * [Subnet](../../../vpc/concepts/network.md#network): `default-a` - * With a [public IP address](../../../vpc/concepts/address.md#public-addresses) and two disks + * Availability zone: `{{ region-id }}-a` + * [Subnet](../../../vpc/concepts/network.md#network): `default-a` + * [Public IP address](../../../vpc/concepts/address.md#public-addresses) and two disks - To specify whether to delete the disk when deleting the VM, set the `--auto-delete` flag: + To specify whether to delete the disk when deleting the VM, set the `--auto-delete` flag: - ```bash - yc compute instance create \ - --name first-instance \ - --zone {{ region-id }}-a \ - --network-interface subnet-name=default-a,nat-ip-version=ipv4 \ - --use-boot-disk disk-name=first-disk,auto-delete=yes \ - --attach-disk disk-name=second-disk,auto-delete=yes \ - --ssh-key ~/.ssh/id_ed25519.pub - ``` + ```bash + yc compute instance create \ + --name first-instance \ + --zone {{ region-id }}-a \ + --network-interface subnet-name=default-a,nat-ip-version=ipv4 \ + --use-boot-disk disk-name=first-disk,auto-delete=yes \ + --attach-disk disk-name=second-disk,auto-delete=yes \ + --ssh-key ~/.ssh/id_ed25519.pub + ``` - {% include [add-several-net-interfaces-notice-cli](../../../_includes/compute/add-several-net-interfaces-notice-cli.md) %} + {% include [add-several-net-interfaces-notice-cli](../../../_includes/compute/add-several-net-interfaces-notice-cli.md) %} - {{ TF }} {#tf} - {% include [terraform-install](../../../_includes/terraform-install.md) %} - - To create a VM from a set of disks: - 1. In the configuration file, describe the parameters of the resources you want to create: + {% include [terraform-install](../../../_includes/terraform-install.md) %} - ```hcl - resource "yandex_compute_disk" "boot-disk" { - name = "" - type = "" - zone = "" - size = "" - image_id = "" - } + To create a VM from a set of disks: + 1. In the configuration file, describe the parameters of the resources you want to create: - resource "yandex_compute_instance" "vm-1" { - name = "vm-from-disks" - allow_stopping_for_update = true - platform_id = "standard-v3" - zone = "" + ```hcl + resource "yandex_compute_disk" "boot-disk" { + name = "" + type = "" + zone = "" + size = "" + image_id = "" + } - resources { - cores = - memory = - } + resource "yandex_compute_instance" "vm-1" { + name = "vm-from-disks" + allow_stopping_for_update = true + platform_id = "standard-v3" + zone = "" - boot_disk { - disk_id = - } + resources { + cores = + memory = + } - secondary_disk { - disk_id = "" - } + boot_disk { + disk_id = + } - network_interface { - subnet_id = "${yandex_vpc_subnet.subnet-1.id}" - nat = true - } + secondary_disk { + disk_id = "" + } - metadata = { - ssh-keys = ":" - } - } + network_interface { + subnet_id = "${yandex_vpc_subnet.subnet-1.id}" + nat = true + } - resource "yandex_vpc_network" "network-1" { - name = "network1" - } + metadata = { + ssh-keys = ":" + } + } - resource "yandex_vpc_subnet" "subnet-1" { - name = "subnet1" - zone = "" - network_id = "${yandex_vpc_network.network-1.id}" - } - ``` + resource "yandex_vpc_network" "network-1" { + name = "network1" + } - Where: + resource "yandex_vpc_subnet" "subnet-1" { + name = "subnet1" + zone = "" + network_id = "${yandex_vpc_network.network-1.id}" + } + ``` - * `yandex_compute_disk`: Boot [disk](../../concepts/disk.md) description: - * `name`: Disk name. - * `type`: Disk [type](../../concepts/disk.md#disks_types). - * `zone`: [Availability zone](../../../overview/concepts/geo-scope.md) to host the disk. - * `size`: Disk size in GB. - * `image_id`: ID of the [image](../../concepts/image.md) to create the VM from. You can get the image ID from the [list of public images](../images-with-pre-installed-software/get-list.md). + Where: + * `yandex_compute_disk`: Boot [disk](../../concepts/disk.md) description: + * `name`: Disk name. + * `type`: Disk [type](../../concepts/disk.md#disks_types). + * `zone`: [Availability zone](../../../overview/concepts/geo-scope.md) the disk will be in. + * `size`: Disk size in GB. + * `image_id`: ID of the [image](../../concepts/image.md) to create the VM from. You can get the image ID from the [list of public images](../images-with-pre-installed-software/get-list.md). - {% include [id-info](../../../_includes/compute/id-info.md) %} + {% include [id-info](../../../_includes/compute/id-info.md) %} - * `yandex_compute_instance`: Description of the [VM](../../concepts/vm.md): - * `name`: VM name. - * {% include [terraform-allow-stopping](../../../_includes/compute/terraform-allow-stopping.md) %} - * `platform_id`: [Platform](../../concepts/vm-platforms.md). - * `zone`: Availability zone to host the VM. - * `resources`: Number of vCPU cores and the amount of RAM available to the VM. The values must match the selected platform. - * `boot_disk`: Boot disk settings. Specify the disk ID. - * `secondary_disk`: Secondary disk to attach to the VM. Specify the ID of the secondary disk. If you do not have a disk, [create](../disk-create/empty.md) one. - * `network_interface`: VM's [network interface](../../concepts/network.md) settings. Specify the ID of the selected [subnet](../../../vpc/concepts/network.md#subnet). To automatically assign a [public IP address](../../../vpc/concepts/address.md#public-addresses) to the VM, set `nat = true`. + * `yandex_compute_instance`: [VM](../../concepts/vm.md) description: + * `name`: VM name. + * {% include [terraform-allow-stopping](../../../_includes/compute/terraform-allow-stopping.md) %} + * `platform_id`: [Platform](../../concepts/vm-platforms.md). + * `zone`: Availability zone the VM will be in. + * `resources`: Number of vCPU cores and RAM available to the VM. The values must match the selected platform. + * `boot_disk`: Boot disk settings. Specify the disk ID. + * `secondary_disk`: Secondary disk to connect to the VM. Specify the ID of the secondary disk. If you do not have a disk, [create](../disk-create/empty.md) one. + * `network_interface`: VM's [network interface](../../concepts/network.md) settings. Specify the ID of the selected [subnet](../../../vpc/concepts/network.md#subnet). To automatically assign a [public IP address](../../../vpc/concepts/address.md#public-addresses) to the VM, set `nat = true`. - {% include [add-several-net-interfaces-notice-tf](../../../_includes/compute/add-several-net-interfaces-notice-tf.md) %} + {% include [add-several-net-interfaces-notice-tf](../../../_includes/compute/add-several-net-interfaces-notice-tf.md) %} - * `metadata`: In metadata, provide the public key for accessing the VM via SSH. For more information, see [{#T}](../../concepts/vm-metadata.md). - * `yandex_vpc_network`: Description of the cloud network. - * `yandex_vpc_subnet`: Description of the subnet your VM will connect to. + * `metadata`: In metadata, provide the public key for SSH access to the VM. For more information, see [{#T}](../../concepts/vm-metadata.md). + * `yandex_vpc_network`: Description of the cloud network. + * `yandex_vpc_subnet`: Description of the subnet your VM will be connected to. - {% note info %} + {% note info %} - If you already have suitable resources, such as a cloud network and subnet, you do not need to describe them again. Use their names and IDs in the appropriate parameters. + If you already have suitable resources, such as a cloud network and subnet, you do not need to describe them again. Use their names and IDs in the appropriate parameters. - {% endnote %} + {% endnote %} - For more information about the resources you can create with {{ TF }}, see the [provider documentation]({{ tf-provider-link }}). - 1. Create resources: + For more information about the resources you can create with {{ TF }}, see the [provider documentation]({{ tf-provider-link }}). + 1. Create resources: - {% include [terraform-validate-plan-apply](../../../_tutorials/_tutorials_includes/terraform-validate-plan-apply.md) %} + {% include [terraform-validate-plan-apply](../../../_tutorials/_tutorials_includes/terraform-validate-plan-apply.md) %} - All the resources you need will then be created in the specified [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder). You can check the new resources and their configuration using the [management console]({{ link-console-main }}). + All the resources you need will then be created in the specified [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder). You can check the new resources and their configuration using the [management console]({{ link-console-main }}). - API {#api} - Use the [create](../../api-ref/Instance/create.md) REST API method for the [Instance](../../api-ref/Instance/) resource or the [InstanceService/Create](../../api-ref/grpc/Instance/create.md) gRPC API call. + Use the [create](../../api-ref/Instance/create.md) REST API method for the [Instance](../../api-ref/Instance/) resource or the [InstanceService/Create](../../api-ref/grpc/Instance/create.md) gRPC API call. {% endlist %} \ No newline at end of file diff --git a/en/compute/operations/vm-create/create-from-user-image.md b/en/compute/operations/vm-create/create-from-user-image.md index c484f53e181..d04d06f5663 100644 --- a/en/compute/operations/vm-create/create-from-user-image.md +++ b/en/compute/operations/vm-create/create-from-user-image.md @@ -20,86 +20,39 @@ Make sure the image you upload has the `READY` status. 1. In the [management console]({{ link-console-main }}), select the folder to create your VM in. 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. - 1. At the top right, click **{{ ui-key.yacloud.compute.instances.button_create }}**. - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**: - - * Enter a name and description for the VM. The naming requirements are as follows: - - {% include [name-format](../../../_includes/name-format.md) %} - - {% include [name-fqdn](../../../_includes/compute/name-fqdn.md) %} - - * Select an [availability zone](../../../overview/concepts/geo-scope.md) to place your VM in. - - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, select an image: - - * Go to the **{{ ui-key.yacloud.compute.instances.create.image_value_custom_new }}** tab and click **{{ ui-key.yacloud.common.select }}**. - * In the window that opens, go to the **{{ ui-key.yacloud.compute.instances.create-disk.value_source-image }}** tab. - * Select an image from the list and click **{{ ui-key.yacloud.common.apply }}**. - - - 1. {% include [encryption-section-boot](../../../_includes/compute/encryption-section-boot.md) %} - - - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}**, [add a disk](create-from-disks.md): - + 1. In the left-hand panel, select ![image](../../../_assets/console-icons/server.svg) **{{ ui-key.yacloud.compute.switch_instances }}**. + 1. Click **{{ ui-key.yacloud.compute.instances.button_create }}**. + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**: + + * Go to the **{{ ui-key.yacloud.compute.instances.create.image_value_custom_new }}** tab. + * Click **{{ ui-key.yacloud.common.select }}** and select **{{ ui-key.yacloud.common.create-new }}** in the window that opens. + * In the **{{ ui-key.yacloud.compute.instances.create-disk.field_source }}** field, select `{{ ui-key.yacloud.compute.instances.create-disk.value_source-image }}` and then select the image you need from the list below. + * (Optional) Enable the **{{ ui-key.yacloud.compute.field_additional }}** option in the **{{ ui-key.yacloud.compute.field_disk-autodelete }}** field if you need to automatically delete this disk when deleting the VM. * Click **{{ ui-key.yacloud.compute.component.instance-storage-dialog.button_add-disk }}**. - * Enter the disk name. - * Select the [disk type](../../concepts/disk.md#disks_types). - * Specify the required block size. - * Specify the required disk size. - - - * {% include [encryption-section-secondary](../../../_includes/compute/encryption-section-secondary.md) %} - - - * (Optional) Enable the **{{ ui-key.yacloud.compute.field_disk-autodelete }}** option if you need to automatically delete the disk when deleting the VM it will be attached to. - * Select `{{ ui-key.yacloud.compute.instances.create-disk.value_source-image }}` as content. - * Select the image you need. - * Click **{{ ui-key.yacloud.compute.instances.create-disk.button_create }}**. + 1. Under **{{ ui-key.yacloud.k8s.node-groups.create.section_allocation-policy }}**, select an [availability zone](../../../overview/concepts/geo-scope.md) to place your VM in. + 1. Add a [disk](../../concepts/disk.md). - 1. (Optional) Under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}**, select the **{{ ui-key.yacloud.compute.nfs.label_filesystems }}** tab and attach the [file storage](../../concepts/filesystem.md): - - * Click **{{ ui-key.yacloud.compute.nfs.button_attach-filesystem-to-the-instance }}**. - * In the window that opens, select the file storage. - * Enter the device name. - * Click **{{ ui-key.yacloud.compute.nfs.button_attach-filesystem-to-the-instance }}**. - - - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_platform }}**: - - * Choose a [platform](../../concepts/vm-platforms.md). - * Specify the [guaranteed share](../../../compute/concepts/performance-levels.md) and required number of vCPUs, as well as RAM size. - * If required, make your VM [preemptible](../../concepts/preemptible-vm.md). - * (Optional) Enable a [software-accelerated network](../../concepts/software-accelerated-network.md). - - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_network }}**: - - {% include [network-settings](../../../_includes/compute/network-settings.md) %} - - - 1. {% include [backup-info](../../../_includes/compute/backup-info.md) %} - - - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_access }}**, specify the data for access to the VM: - - * (Optional) Select or create a [service account](../../../iam/concepts/users/service-accounts.md). With a service account, you can flexibly configure access rights for your resources. - * (Optional) [Enable VM access via OS Login](../vm-connect/os-login.md). This option is only available for Linux images. - * Enter the username into the **{{ ui-key.yacloud.compute.instances.create.field_user }}** field. - - {% note alert %} - - Do not use `root` or other usernames reserved by the operating system. To perform operations requiring superuser permissions, use the `sudo` command. - - {% endnote %} + * Under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}**, click **{{ ui-key.yacloud.compute.instances.create-disk.button_create }}** + * In the window that opens, select **{{ ui-key.yacloud.compute.instances.create-disk.value_source-disk }}** → `Create new`. + * In the **{{ ui-key.yacloud.compute.instances.create-disk.field_source }}** field, select `{{ ui-key.yacloud.compute.instances.create-disk.value_source-image }}` and then select the image you need from the list below. + * Specify the disk name. + * Select the [disk type](../../concepts/disk.md#disks_types). + * Specify the required disk size and block size. + * (Optional) Enable the **{{ ui-key.yacloud.compute.field_additional }}** option in the **{{ ui-key.yacloud.compute.field_disk-autodelete }}** field if you need to automatically delete this disk when deleting the VM. + * Click **{{ ui-key.yacloud.compute.component.instance-storage-dialog.button_add-disk }}**. - * In the **{{ ui-key.yacloud.compute.instances.create.field_key }}** field, paste the contents of the [public key](../../operations/vm-connect/ssh.md#creating-ssh-keys) file. - * If required, grant access to the [serial console](../../operations/serial-console/index.md). + 1. {% include [encryption-section-secondary](../../../_includes/compute/encryption-section-secondary.md) %} + 1. {% include [section-storages-filesystem](../../../_includes/compute/create/section-storages-filesystem.md) %} + 1. {% include [section-platform](../../../_includes/compute/create/section-platform.md) %} + 1. {% include [network-settings](../../../_includes/compute/create/section-network.md) %} + 1. {% include [section-access](../../../_includes/compute/create/section-access.md) %} + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**, specify the VM name: - {% include [vm-connect-linux](../../../_includes/vm-connect-linux.md) %} + {% include [name-format](../../../_includes/name-format.md) %} - 1. (Optional) Under **{{ ui-key.yacloud.compute.instances.create.section_placement }}**, select a VM [placement group](../../concepts/placement-groups.md). + {% include [name-fqdn](../../../_includes/compute/name-fqdn.md) %} + 1. {% include [section-additional](../../../_includes/compute/create/section-additional.md) %} 1. Click **{{ ui-key.yacloud.compute.instances.create.button_create }}**. The VM appears in the list. Once created, the VM is assigned an [IP address](../../../vpc/concepts/address.md) and a [host name (FQDN)](../../../vpc/concepts/address.md#fqdn). @@ -112,7 +65,7 @@ Make sure the image you upload has the `READY` status. {% include [default-catalogue](../../../_includes/default-catalogue.md) %} - 1. See the description of the CLI command to create a VM: + 1. View the description of the CLI command to create a VM: ```bash yc compute instance create --help @@ -185,7 +138,7 @@ Make sure the image you upload has the `READY` status. {% include [name-format](../../../_includes/name-format.md) %} * `size`: Disk size in GB. - * `image-id`: ID of the custom image to create the VM from. Specify the ID of the [uploaded](../image-create/upload.md) image. + * `image-id`: ID of the custom image for the VM. Specify the ID of the [uploaded](../image-create/upload.md) image. * `--ssh-key`: Path to the file with the [public SSH key](../vm-connect/ssh.md#creating-ssh-keys). The VM will automatically create a user named `yc-user` for this key. {% include [ssh-note](../../../_includes/compute/ssh-note.md) %} @@ -259,7 +212,7 @@ Make sure the image you upload has the `READY` status. resources { cores = - memory = + memory = } boot_disk { @@ -324,7 +277,7 @@ Make sure the image you upload has the `READY` status. {% endnote %} - For more information about the resources that you can create with {{ TF }}, see the [provider documentation]({{ tf-provider-link }}). + For more information about the resources you can create with {{ TF }}, see the [provider documentation]({{ tf-provider-link }}). 1. Create resources: diff --git a/en/compute/operations/vm-create/create-preemptible-vm.md b/en/compute/operations/vm-create/create-preemptible-vm.md index 77232657ed4..66eb9010eeb 100644 --- a/en/compute/operations/vm-create/create-preemptible-vm.md +++ b/en/compute/operations/vm-create/create-preemptible-vm.md @@ -11,218 +11,195 @@ To create a [preemptible VM](../../concepts/preemptible-vm.md): - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder) where you want to create your preemptible VM. - 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. - 1. At the top right, click **{{ ui-key.yacloud.compute.instances.button_create }}**. - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**: - * Enter a name and description for the preemptible VM. The naming requirements are as follows: + 1. In the [management console]({{ link-console-main }}), select the [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder) where you want to create your preemptible VM. + 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. + 1. In the left-hand panel, select ![image](../../../_assets/console-icons/server.svg) **{{ ui-key.yacloud.compute.switch_instances }}**. + 1. Click **{{ ui-key.yacloud.compute.instances.button_create }}**. + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, select an [image](../../concepts/image.md) and OS version. - {% include [name-format](../../../_includes/name-format.md) %} + {% include [change-custom-disk-settings-image](../../../_includes/compute/create/change-custom-disk-settings-image.md) %} - {% include [name-fqdn](../../../_includes/compute/name-fqdn.md) %} + 1. Under **{{ ui-key.yacloud.k8s.node-groups.create.section_allocation-policy }}**, select an [availability zone](../../../overview/concepts/geo-scope.md) to host your preemptible VM. + 1. (Optional) Configure the boot [disk](../../concepts/disk.md) under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}**: - * Select the [availability zone](../../../overview/concepts/geo-scope.md) that will host your preemptible VM. - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, select one of the [images](../../concepts/image.md). - 1. (Optional) Under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}**, select the **{{ ui-key.yacloud.compute.instances.create.section_storages }}** tab and configure a boot [disk](../../concepts/disk.md): * Select the [disk type](../../concepts/disk.md#disks_types). * Specify the required disk size. - * {% include [encryption-section-boot](../../../_includes/compute/encryption-section-boot.md) %} - - If you want to create a preemptible VM from an existing disk, under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}**, [add a disk](create-from-disks.md). - * Click **{{ ui-key.yacloud.compute.component.instance-storage-dialog.button_add-disk }}**. - * Enter the disk name. - * Select the disk type. - * Specify the required block size. - * Specify the required disk size. - * {% include [encryption-section-secondary](../../../_includes/compute/encryption-section-secondary.md) %} - * (Optional) Enable **{{ ui-key.yacloud.compute.field_disk-autodelete }}** if you need to automatically delete the disk when deleting the preemptible VM it is attached to. - * Select `{{ ui-key.yacloud.compute.instances.create-disk.value_source-disk }}` as content. - * Click **{{ ui-key.yacloud.compute.instances.create-disk.button_create }}**. - 1. (Optional) Under **{{ ui-key.yacloud.compute.instances.create.section_storages_ru }}**, select the **{{ ui-key.yacloud.compute.nfs.label_filesystems }}** tab and attach the [file storage](../../concepts/filesystem.md): - * Click **{{ ui-key.yacloud.compute.nfs.button_attach-filesystem-to-the-instance }}**. - * In the window that opens, select the file storage. - * Enter the device name. - * Click **{{ ui-key.yacloud.compute.nfs.button_attach-filesystem-to-the-instance }}**. - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_platform }}**: - * Choose a [platform](../../concepts/vm-platforms.md). - * Specify the [guaranteed share](../../../compute/concepts/performance-levels.md) and required number of vCPUs, as well as the amount of RAM. - * Enable **{{ ui-key.yacloud.component.compute.resources.field_preemptible }}**. - * (Optional) Enable a [software-accelerated network](../../concepts/software-accelerated-network.md). - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_network }}**: - - {% include [network-settings](../../../_includes/compute/network-settings.md) %} + * {% include [encryption-section-secondary](../../../_includes/compute/encryption-section-secondary.md) %} - 1. {% include [backup-info](../../../_includes/compute/backup-info.md) %} - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_access }}**, specify the information required to access the preemptible VM: - * (Optional) Select or create a [service account](../../../iam/concepts/users/service-accounts.md). With a service account, you can flexibly configure access rights for your resources. - * Enter the username in the **{{ ui-key.yacloud.compute.instances.create.field_user }}** field. + {% include [change-custom-disk-settings-storages](../../../_includes/compute/create/change-custom-disk-settings-storages.md) %} + 1. {% include [section-storages-secondary-disk](../../../_includes/compute/create/section-storages-secondary-disk.md) %} + 1. {% include [section-storages-filesystem](../../../_includes/compute/create/section-storages-filesystem.md) %} + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_platform }}**: - {% note alert %} - - Do not use the `root` username or other names reserved by the operating system. To perform operations that require superuser permissions, use the `sudo` command. + * Go to the **{{ ui-key.yacloud.component.compute.resources.label_tab-custom }}** tab. + * Choose a [platform](../../../compute/concepts/vm-platforms.md). + * Specify the [guaranteed share](../../../compute/concepts/performance-levels.md) and required number of vCPUs, as well as RAM size. + * In the **{{ ui-key.yacloud.component.compute.resources.field_advanced }}** field, enable the **{{ ui-key.yacloud.component.compute.resources.field_preemptible }}** option. + * (Optional) Enable a [software-accelerated network](../../concepts/software-accelerated-network.md). + 1. {% include [network-settings](../../../_includes/compute/create/section-network.md) %} + 1. {% include [section-access](../../../_includes/compute/create/section-access.md) %} - {% endnote %} + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**, specify the preemptible VM name: - * In the **{{ ui-key.yacloud.compute.instances.create.field_key }}** field, paste the contents of the [public key](../../operations/vm-connect/ssh.md#creating-ssh-keys) file. - * If required, grant access to the [serial console](../../operations/serial-console/index.md). + {% include [name-format](../../../_includes/name-format.md) %} - {% include [vm-connect-linux](../../../_includes/vm-connect-linux.md) %} + {% include [name-fqdn](../../../_includes/compute/name-fqdn.md) %} - 1. (Optional) Under **{{ ui-key.yacloud.compute.instances.create.section_placement }}**, select a preemptible VM [placement group](../../concepts/placement-groups.md). - 1. Click **{{ ui-key.yacloud.compute.instances.create.button_create }}**. + 1. {% include [section-additional](../../../_includes/compute/create/section-additional.md) %} + 1. Click **{{ ui-key.yacloud.compute.instances.create.button_create }}**. - The preemptible VM will appear in the list. + The preemptible VM will appear in the list. - CLI {#cli} - {% include [cli-install](../../../_includes/cli-install.md) %} + {% include [cli-install](../../../_includes/cli-install.md) %} - {% include [default-catalogue](../../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../../_includes/default-catalogue.md) %} - 1. View the description of the CLI command to create a preemptible VM: + 1. View the description of the CLI command to create a preemptible VM: - ```bash - yc compute instance create --help - ``` + ```bash + yc compute instance create --help + ``` - 1. [Prepare](../vm-connect/ssh.md#creating-ssh-keys) a key pair (public and private keys) for SSH access to the preemptible VM. - 1. Select a Linux-based public [image](../images-with-pre-installed-software/get-list.md) from [{{ marketplace-full-name }}](../../../marketplace/), e.g., [CentOS 7](/marketplace/products/yc/centos-7). + 1. [Prepare](../vm-connect/ssh.md#creating-ssh-keys) a key pair (public and private keys) for SSH access to the preemptible VM. + 1. Select a Linux-based public [image](../images-with-pre-installed-software/get-list.md) from [{{ marketplace-full-name }}](../../../marketplace/), e.g., [CentOS 7](/marketplace/products/yc/centos-7). - {% include [standard-images](../../../_includes/standard-images.md) %} + {% include [standard-images](../../../_includes/standard-images.md) %} - 1. Create a preemptible VM in the default [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder): + 1. Create a preemptible VM in the default [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder): - ```bash - yc compute instance create \ - --name first-preemptible-instance \ - --zone {{ region-id }}-a \ - --network-interface subnet-name=default-a,nat-ip-version=ipv4 \ - --preemptible \ - --create-boot-disk image-folder-id=standard-images,image-family=centos-7 \ - --ssh-key ~/.ssh/id_ed25519.pub - ``` + ```bash + yc compute instance create \ + --name first-preemptible-instance \ + --zone {{ region-id }}-a \ + --network-interface subnet-name=default-a,nat-ip-version=ipv4 \ + --preemptible \ + --create-boot-disk image-folder-id=standard-images,image-family=centos-7 \ + --ssh-key ~/.ssh/id_ed25519.pub + ``` - {% include [vm-platform-cli](../../../_includes/compute/vm-platform-cli.md) %} + {% include [vm-platform-cli](../../../_includes/compute/vm-platform-cli.md) %} - Where: - * `--name`: Name of the preemptible VM. The naming requirements are as follows: + Where: + * `--name`: Name of the preemptible VM. The naming requirements are as follows: - {% include [name-format](../../../_includes/name-format.md) %} + {% include [name-format](../../../_includes/name-format.md) %} - {% include [name-fqdn](../../../_includes/compute/name-fqdn.md) %} + {% include [name-fqdn](../../../_includes/compute/name-fqdn.md) %} - * `--zone`: [Availability zone](../../../overview/concepts/geo-scope.md) that corresponds to the selected [subnet](../../../vpc/concepts/network.md#subnet). - * `--network-interface`: VM's [network interface](../../concepts/network.md) settings: + * `--zone`: [Availability zone](../../../overview/concepts/geo-scope.md) matching the selected [subnet](../../../vpc/concepts/network.md#subnet). + * `--network-interface`: VM [network interface](../../concepts/network.md) settings: * `subnet-name`: Name of the selected subnet. * `nat-ip-version=ipv4`: [Public IP address](../../../vpc/concepts/address.md#public-addresses). To create a VM without a public IP address, disable this parameter. {% include [add-several-net-interfaces-notice-cli](../../../_includes/compute/add-several-net-interfaces-notice-cli.md) %} - * `--preemptible`: Select to create a preemptible VM. - * `--create-boot-disk`: VM boot disk settings: - * `image-family`: [Image family](../../concepts/image.md#family), such as `centos-7`. This option allows you to install the latest version of the OS from the specified family. + * `--preemptible`: Select to create a preemptible VM. + * `--create-boot-disk`: VM boot disk settings: + * `image-family`: [Image family](../../concepts/image.md#family), e.g., `centos-7`. This option allows you to install the latest version of the OS from the specified family. - * `--ssh-key`: Path to the file with the [public SSH key](../vm-connect/ssh.md#creating-ssh-keys). The preemptible VM will automatically create a user named `yc-user` for this key. + * `--ssh-key`: Path to the file with the [public SSH key](../vm-connect/ssh.md#creating-ssh-keys). The preemptible VM will automatically create a user named `yc-user` for this key. {% include [ssh-note](../../../_includes/compute/ssh-note.md) %} - {{ TF }} {#tf} - {% include [terraform-install](../../../_includes/terraform-install.md) %} + {% include [terraform-install](../../../_includes/terraform-install.md) %} - 1. In the configuration file, describe the parameters of the resources you want to create: + 1. In the configuration file, describe the parameters of the resources you want to create: - ```hcl - resource "yandex_compute_disk" "boot-disk" { - name = "" - type = "" - zone = "" - size = "" - image_id = "" - } + ```hcl + resource "yandex_compute_disk" "boot-disk" { + name = "" + type = "" + zone = "" + size = "" + image_id = "" + } - resource "yandex_compute_instance" "vm-1" { - name = "preemptible-vm" - allow_stopping_for_update = true - platform_id = "standard-v3" - zone = "" + resource "yandex_compute_instance" "vm-1" { + name = "preemptible-vm" + allow_stopping_for_update = true + platform_id = "standard-v3" + zone = "" - resources { - cores = - memory = - } + resources { + cores = + memory = + } - boot_disk { - disk_id = yandex_compute_disk.boot-disk.id - } + boot_disk { + disk_id = yandex_compute_disk.boot-disk.id + } - network_interface { - subnet_id = "${yandex_vpc_subnet.subnet-1.id}" - nat = true - } + network_interface { + subnet_id = "${yandex_vpc_subnet.subnet-1.id}" + nat = true + } - metadata = { - ssh-keys = ":" - } + metadata = { + ssh-keys = ":" + } - scheduling_policy { - preemptible = true - } - } + scheduling_policy { + preemptible = true + } + } - resource "yandex_vpc_network" "network-1" { - name = "network1" - } + resource "yandex_vpc_network" "network-1" { + name = "network1" + } - resource "yandex_vpc_subnet" "subnet-1" { - name = "subnet1" - zone = "" - network_id = "${yandex_vpc_network.network-1.id}" - } - ``` + resource "yandex_vpc_subnet" "subnet-1" { + name = "subnet1" + zone = "" + network_id = "${yandex_vpc_network.network-1.id}" + } + ``` - Where: - * `yandex_compute_disk`: Boot [disk](../../concepts/disk.md) description: - * `name`: Disk name. - * `type`: Disk [type](../../concepts/disk.md#disks_types). - * `zone`: [Availability zone](../../../overview/concepts/geo-scope.md) to host the disk. - * `size`: Disk size in GB. - * `image_id`: ID of the [image](../../concepts/image.md) to create the preemptible VM from. You can get the image ID from the [list of public images](../images-with-pre-installed-software/get-list.md). + Where: + * `yandex_compute_disk`: Boot [disk](../../concepts/disk.md) description: + * `name`: Disk name. + * `type`: Disk [type](../../concepts/disk.md#disks_types). + * `zone`: [Availability zone](../../../overview/concepts/geo-scope.md) the disk will be in. + * `size`: Disk size in GB. + * `image_id`: ID of the [image](../../concepts/image.md) to create the preemptible VM from. You can get the image ID from the [list of public images](../images-with-pre-installed-software/get-list.md). - {% include [id-info](../../../_includes/compute/id-info.md) %} + {% include [id-info](../../../_includes/compute/id-info.md) %} - * `yandex_compute_instance`: Description of the preemptible VM: - * `name`: Name of the preemptible VM. - * {% include [terraform-allow-stopping](../../../_includes/compute/terraform-allow-stopping.md) %} - * `platform_id`: [Platform](../../concepts/vm-platforms.md). - * `zone`: Availability zone to host the preemptible VM. - * `resources`: Number of vCPU cores and the amount of RAM available to the preemptible VM. The values must match the selected platform. - * `boot_disk`: Boot disk settings. Specify the disk ID. - * `network_interface`: VM's [network interface](../../concepts/network.md) settings. Specify the ID of the selected [subnet](../../../vpc/concepts/network.md#subnet). To automatically assign a [public IP address](../../../vpc/concepts/address.md#public-addresses) to the VM, set `nat = true`. + * `yandex_compute_instance`: Description of the preemptible VM: + * `name`: Name of the preemptible VM. + * {% include [terraform-allow-stopping](../../../_includes/compute/terraform-allow-stopping.md) %} + * `platform_id`: [Platform](../../concepts/vm-platforms.md). + * `zone`: Availability zone to host the preemptible VM. + * `resources`: Number of vCPU cores and the amount of RAM available to the preemptible VM. The values must match the selected platform. + * `boot_disk`: Boot disk settings. Specify the disk ID. + * `network_interface`: VM's [network interface](../../concepts/network.md) settings. Specify the ID of the selected [subnet](../../../vpc/concepts/network.md#subnet). To automatically assign a [public IP address](../../../vpc/concepts/address.md#public-addresses) to the VM, set `nat = true`. - {% include [add-several-net-interfaces-notice-tf](../../../_includes/compute/add-several-net-interfaces-notice-tf.md) %} + {% include [add-several-net-interfaces-notice-tf](../../../_includes/compute/add-several-net-interfaces-notice-tf.md) %} - * `metadata`: In metadata, provide the public key for accessing the preemptible VM via SSH. For more information, see [{#T}](../../concepts/vm-metadata.md). - * `scheduling_policy`: Scheduling policy. To create a preemptible VM, set `preemptible = true`. - * `yandex_vpc_network`: Description of the cloud network. - * `yandex_vpc_subnet`: Description of the subnet to connect your preemptible VM to. + * `metadata`: In metadata, provide the public key for SSH access to the preemptible VM. For more information, see [{#T}](../../concepts/vm-metadata.md). + * `scheduling_policy`: Scheduling policy. To create a preemptible VM, select `preemptible = true`. + * `yandex_vpc_network`: Description of the cloud network. + * `yandex_vpc_subnet`: Description of the subnet to connect your preemptible VM to. - {% note info %} + {% note info %} - If you already have suitable resources, such as a cloud network and subnet, you do not need to describe them again. Use their names and IDs in the appropriate parameters. + If you already have suitable resources, such as a cloud network and subnet, you do not need to describe them again. Use their names and IDs in the appropriate parameters. - {% endnote %} + {% endnote %} - For more information about the resources you can create with {{ TF }}, see the [provider documentation]({{ tf-provider-link }}). - 1. Create resources: + For more information about the resources you can create with {{ TF }}, see the [provider documentation]({{ tf-provider-link }}). + 1. Create resources: - {% include [terraform-validate-plan-apply](../../../_tutorials/_tutorials_includes/terraform-validate-plan-apply.md) %} + {% include [terraform-validate-plan-apply](../../../_tutorials/_tutorials_includes/terraform-validate-plan-apply.md) %} - All the resources you need will then be created in the specified folder. You can check the new resources and their configuration using the [management console]({{ link-console-main }}). + All the resources you need will then be created in the specified folder. You can check the new resources and their configuration using the [management console]({{ link-console-main }}). - API {#api} - Use the [create](../../api-ref/Instance/create.md) REST API method for the [Instance](../../api-ref/Instance/) resource or the [InstanceService/Create](../../api-ref/grpc/Instance/create.md) gRPC API call. + Use the [create](../../api-ref/Instance/create.md) REST API method for the [Instance](../../api-ref/Instance/) resource or the [InstanceService/Create](../../api-ref/grpc/Instance/create.md) gRPC API call. {% endlist %} @@ -236,120 +213,121 @@ To change the type of a VM, for example, make it preemptible: - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the folder where the VM is located. - 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. - 1. In the line with the appropriate VM, click ![image](../../../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud.common.stop }}**. - 1. In the window that opens, click **{{ ui-key.yacloud.compute.instances.popup-confirm_button_stop }}**. The VM status will change to `Stopped`. - 1. In the line with the appropriate VM, click ![image](../../../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud.common.edit }}**. - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_platform }}**, disable the **{{ ui-key.yacloud.component.compute.resources.field_preemptible }}** option. - 1. Click **{{ ui-key.yacloud.compute.instance.edit.button_update }}**. - 1. At the top right, click ![image](../../../_assets/console-icons/play-fill.svg) **{{ ui-key.yacloud.common.start }}**. - 1. In the window that opens, click **{{ ui-key.yacloud.compute.instances.popup-confirm_button_start }}**. + 1. In the [management console]({{ link-console-main }}), select the [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder) where the preemptible VM is located. + 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. + 1. In the left-hand panel, select ![image](../../../_assets/console-icons/server.svg) **{{ ui-key.yacloud.compute.switch_instances }}**. + 1. In the line with the appropriate VM, click ![image](../../../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud.common.stop }}**. + 1. In the window that opens, click **{{ ui-key.yacloud.compute.instances.popup-confirm_button_stop }}**. The VM status will change to `Stopped`. + 1. In the line with the appropriate VM, click ![image](../../../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud.common.edit }}**. + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_platform }}**, disable the **{{ ui-key.yacloud.component.compute.resources.field_preemptible }}** option. + 1. Click **{{ ui-key.yacloud.compute.instance.edit.button_update }}**. + 1. At the top right, click ![image](../../../_assets/console-icons/play-fill.svg) **{{ ui-key.yacloud.common.start }}**. + 1. In the window that opens, click **{{ ui-key.yacloud.compute.instances.popup-confirm_button_start }}**. - CLI {#cli} - {% include [cli-install](../../../_includes/cli-install.md) %} + {% include [cli-install](../../../_includes/cli-install.md) %} - {% include [default-catalogue](../../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../../_includes/default-catalogue.md) %} - 1. View a description of the CLI command to stop a VM: + 1. See the description of the CLI command to stop a VM: - ```bash - yc compute instance stop --help - ``` + ```bash + yc compute instance stop --help + ``` - 1. Get a list of all VMs in the default folder: + 1. Get a list of all VMs in the default folder: - {% include [compute-instance-list](../../_includes_service/compute-instance-list.md) %} + {% include [compute-instance-list](../../_includes_service/compute-instance-list.md) %} - 1. Select the `ID` or `NAME` of the VM, e.g., `first-instance`. - 1. Stop the VM: + 1. Select the `ID` or `NAME` of the VM, e.g., `first-instance`. + 1. Stop the VM: - ```bash - yc compute instance stop - ``` + ```bash + yc compute instance stop + ``` - Result: + Result: - ```text - done (15s) - ``` + ```text + done (15s) + ``` - 1. Edit the VM parameters: + 1. Edit the VM parameters: - ```bash - yc compute instance update \ - --preemptible=false - ``` + ```bash + yc compute instance update \ + --preemptible=false + ``` - Result: + Result: - ```text - done (1s) - id: fhm0b28lgfp4******** - folder_id: b1ghgf288nvg******** - ... - network_settings: - type: STANDARD - placement_policy: {} - ``` + ```text + done (1s) + id: fhm0b28lgfp4******** + folder_id: b1ghgf288nvg******** + ... + network_settings: + type: STANDARD + placement_policy: {} + ``` - 1. Start the VM again: + 1. Start the VM again: - ```bash - yc compute instance start - ``` + ```bash + yc compute instance start + ``` - Result: + Result: - ```text - done (11s) - id: fhm0b28lgfp4******** - folder_id: b1ghgf288nvg******** - ... - network_settings: - type: STANDARD - placement_policy: {} - ``` + ```text + done (11s) + id: fhm0b28lgfp4******** + folder_id: b1ghgf288nvg******** + ... + network_settings: + type: STANDARD + placement_policy: {} + ``` - {{ TF }} {#tf} - {% include [terraform-install](../../../_includes/terraform-install.md) %} + {% include [terraform-install](../../../_includes/terraform-install.md) %} - 1. In the configuration file, find a description of the scheduling policy of the VM you want to make preemptible: + 1. In the configuration file, find a description of the scheduling policy of the VM you want to make preemptible: - ```hcl - scheduling_policy { - preemptible = true - } - ``` + ```hcl + scheduling_policy { + preemptible = true + } + ``` - 1. Delete the `scheduling_policy` field set to `preemptible = true`: + 1. Delete the `scheduling_policy` field with the `preemptible = true` value. - For more information about resources you can create with {{ TF }}, see the [provider documentation]({{ tf-provider-link }}/). - 1. Make sure the configuration files are correct. - 1. In the command line, go to the directory where you created the configuration file. - 1. Run a check using this command: + For more information about the resources you can create with {{ TF }}, see the [provider documentation]({{ tf-provider-link }}/). + 1. Make sure the configuration files are correct. + 1. In the command line, go to the folder where you created the configuration file. + 1. Run a check using this command: - ```bash - terraform plan - ``` + ```bash + terraform plan + ``` - If the configuration is described correctly, the terminal will display a list of created resources and their parameters. If the configuration contains any errors, {{ TF }} will point them out. - 1. Deploy cloud resources. - 1. If the configuration does not contain any errors, run this command: + If the configuration is described correctly, the terminal will display a list of created resources and their parameters. If the configuration contains any errors, {{ TF }} will point them out. + 1. Deploy cloud resources. + 1. If the configuration does not contain any errors, run this command: - ```bash - terraform apply - ``` + ```bash + terraform apply + ``` - 1. Confirm that you want to create the resources. + 1. Confirm that you want to create the resources. - All the resources you need will then be created in the specified folder. You can check the new resources and their configuration using the [management console]({{ link-console-main }}). + All the resources you need will then be created in the specified folder. You can check the new resources and their configuration using the [management console]({{ link-console-main }}). - API {#api} - Use the [update](../../api-ref/Instance/update.md) REST API method for the [Instance](../../api-ref/Instance/) resource or the [InstanceService/Update](../../api-ref/grpc/Instance/update.md) gRPC API call. In the request body, set `"preemptible": false` in `schedulingPolicy`. + Use the [update](../../api-ref/Instance/update.md) REST API method for the [Instance](../../api-ref/Instance/) resource or the [InstanceService/Update](../../api-ref/grpc/Instance/update.md) gRPC API call. Under `schedulingPolicy` in the request body, specify `"preemptible": false`. {% endlist %} diff --git a/en/compute/operations/vm-create/create-with-cloud-init-scripts.md b/en/compute/operations/vm-create/create-with-cloud-init-scripts.md index 6143c294483..075ae79b9b2 100644 --- a/en/compute/operations/vm-create/create-with-cloud-init-scripts.md +++ b/en/compute/operations/vm-create/create-with-cloud-init-scripts.md @@ -27,7 +27,7 @@ To create a VM with a custom configuration script: 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. 1. In the left-hand panel, select ![image](../../../_assets/console-icons/server.svg) **{{ ui-key.yacloud.compute.switch_instances }}**. 1. Click **{{ ui-key.yacloud.compute.instances.button_create }}**. - 1. Set the required VM parameters. + 1. [Set](create-linux-vm.md) the required VM parameters. 1. Expand the **{{ ui-key.yacloud.common.metadata }}** section and specify: * **{{ ui-key.yacloud_billing.component.key-values-input.label_key }}**: `user-data`. @@ -83,7 +83,7 @@ To create a VM with a custom configuration script: - API {#api} - Create a VM using the [create](../../api-ref/Instance/create.md) REST API method for the [Instance](../../api-ref/Instance/) resource and provide the object with the `cloud-config` YAML configuration under `metadata` in the request body. For a multiline configuration, use `\n` as a separator. For example: + Create a VM using the [create](../../api-ref/Instance/create.md) REST API method for the [Instance](../../api-ref/Instance/) resource and provide the object with the `cloud-config` YAML configuration under `metadata` in the request body. For a multiline configuration, use `\n` as a separator. Here is an example: ```json { diff --git a/en/compute/pricing.md b/en/compute/pricing.md index 2e5900de16a..a9d38b6d656 100644 --- a/en/compute/pricing.md +++ b/en/compute/pricing.md @@ -15,15 +15,15 @@ editable: false The {{ compute-name }} usage cost is based on: * VM computing resources: * Type and number of cores (vCPUs). - * Number of graphics processing units ([GPUs](concepts/gpus.md)). + * Number of graphics accelerators ([GPUs](concepts/gpus.md)). * Amount of memory (RAM). -* Operating systems +* Operating systems. * Type and size of storage: * Disks * Images * Snapshots -* Amount of outgoing traffic -* Public IP address +* Amount of outgoing traffic. +* Public IP address. {% include [pricing-gb-size](../_includes/pricing-gb-size.md) %} @@ -54,8 +54,8 @@ The basic level of vCPU performance depends on the [platform](concepts/vm-platfo Let's compare the cost of running VMs on the Intel Ice Lake [platform](concepts/vm-platforms.md) with different [vCPU performance levels](concepts/performance-levels.md). Two VMs were created running Linux OS: -* With 2 x 20% vCPUs and 2 GB of RAM. -* With 2 x 100% vCPUs and 2 GB of RAM. +* 2 x 20% vCPUs and 2 GB of RAM. +* 2 x 100% vCPUs and 2 GB of RAM. Both VMs were running for 30 days. @@ -143,7 +143,7 @@ An `intel-6338-c108-m704-n3200x6` dedicated host running for an hour is charged {% note info %} -CVoS discount is only available for certain types of resources. For non-supported types, CVoS columns feature dashes under [Prices for the Russia region](#prices). Currently, you cannot order storage or web traffic this way. +CVoS discount is only available for certain types of resources. A dash in the relevant CVoS columns under [Prices for the Russia region](#prices) means the resource is not supported. Currently, you cannot order storage or web traffic this way. {% endnote %} diff --git a/en/compute/quickstart/ig.md b/en/compute/quickstart/ig.md index 773b0b14abb..4e998cefb04 100644 --- a/en/compute/quickstart/ig.md +++ b/en/compute/quickstart/ig.md @@ -20,13 +20,13 @@ To create an instance group: 1. In the left-hand panel, select ![image](../../_assets/console-icons/layers-3-diagonal.svg) **{{ ui-key.yacloud.compute.switch_groups }}**. 1. Click **{{ ui-key.yacloud.compute.groups.button_create }}**. 1. Under **{{ ui-key.yacloud.compute.groups.create.section_base }}**: - * Enter a name and description of the instance group. The naming requirements are as follows: + * Enter a name and description of the instance group. The naming requirements are as follows: {% include [name-format](../../_includes/name-format.md) %} {% include [name-fqdn](../../_includes/compute/name-fqdn.md) %} - * Select a [service account](../../iam/concepts/users/service-accounts.md) from the list or create a new one. To be able to create, update, and delete instances in the instance group, assign the `editor` [role](../../iam/concepts/access-control/roles.md) to the service account. By default, all operations in {{ ig-name }} are performed on behalf of a service account. + * Select a [service account](../../iam/concepts/users/service-accounts.md) from the list or create a new one. To be able to create, update, and delete VM instances in the instance group, assign the `editor` [role](../../iam/concepts/access-control/roles.md) to the service account. By default, all operations in {{ ig-name }} are performed on behalf of a service account. {% include [sa-dependence-brief](../../_includes/instance-groups/sa-dependence-brief.md) %} @@ -35,37 +35,39 @@ To create an instance group: * Under **{{ ui-key.yacloud.compute.instances.create.section_base }}**, enter a description for the base instance. * Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, select a public image. * Under **{{ ui-key.yacloud.compute.instances.create.section_disk }}**: - * Select the [disk type](../../compute/concepts/disk.md#disks_types). - * Specify the disk size. - * (Optional) Click **{{ ui-key.yacloud.compute.component.instance-storage-dialog.button_add-disk }}** to add more disks. + * Select the [disk type](../../compute/concepts/disk.md#disks_types). + * Specify the disk size. + * (Optional) Click **{{ ui-key.yacloud.compute.component.instance-storage-dialog.button_add-disk }}** to add more disks. * Under **{{ ui-key.yacloud.compute.instances.create.section_platform }}**: - * Choose a [platform](../../compute/concepts/vm-platforms.md). - * Specify the [guaranteed share](../../compute/concepts/performance-levels.md) and the required number of vCPUs, as well as the amount of RAM. - * (Optional) Specify that the VM must be [preemptible](../../compute/concepts/preemptible-vm.md). + * Choose a [platform](../../compute/concepts/vm-platforms.md). + * Specify the [guaranteed share](../../compute/concepts/performance-levels.md) and required number of vCPUs, as well as RAM size. + * (Optional) Specify that the VM must be [preemptible](../../compute/concepts/preemptible-vm.md). * Under **{{ ui-key.yacloud.compute.instances.create.section_network }}**: - * Select a [cloud network](../../compute/concepts/vm.md#network) and [subnet](../../compute/concepts/network.md#subnet). If there is no subnet, create one: - * Click **{{ ui-key.yacloud.compute.instances.create.button_create-subnetwork-new }}**. - * Enter a name and a description for the new subnet. Specify an availability zone and a CIDR. - * Click **{{ ui-key.yacloud.vpc.subnetworks.create.button_create }}**. - * In the **{{ ui-key.yacloud.compute.instances.create.field_instance-group-address }}** field, choose a method for assigning an IP address: - * `{{ ui-key.yacloud.compute.instances.create.value_address-auto }}`: Assign a random IP address from the {{ yandex-cloud }} IP pool. - * `{{ ui-key.yacloud.compute.instances.create.value_address-none }}`: Do not assign a public IP address. - * (Optional) Select a [security group](../../vpc/concepts/security-groups.md). If there is no security group, create one: - * Click ![image](../../_assets/console-icons/plus.svg) **{{ ui-key.yacloud.component.vpc-security-group-select.label_add-security-group }}**. - * Enter a name and description for the security group. You will be able to add rules to the security group at a later stage using **{{ vpc-name }}**. - * Click **{{ ui-key.yacloud.common.create }}**. + * Select a [cloud network](../../compute/concepts/vm.md#network) and [subnet](../../compute/concepts/network.md#subnet). If there is no subnet, create one: + * Click **{{ ui-key.yacloud.compute.instances.create.button_create-subnetwork-new }}**. + * Enter a name and a description for the new subnet. Specify an availability zone and a CIDR. + * Click **{{ ui-key.yacloud.vpc.subnetworks.create.button_create }}**. + * In the **{{ ui-key.yacloud.compute.instances.create.field_instance-group-address }}** field, choose a method for assigning an IP address: + * `{{ ui-key.yacloud.compute.instances.create.value_address-auto }}`: Assign a random IP address from the {{ yandex-cloud }} IP address pool. + * `{{ ui-key.yacloud.compute.instances.create.value_address-none }}`: Do not assign a public IP address. + * (Optional) Select a [security group](../../vpc/concepts/security-groups.md). If there is no security group, create one: + * Click ![image](../../_assets/console-icons/plus.svg) **{{ ui-key.yacloud.component.vpc-security-group-select.label_add-security-group }}**. + * Enter a name and description for the security group. You will be able to add rules to the security group at a later stage using **{{ vpc-name }}**. + * Click **{{ ui-key.yacloud.common.create }}**. * Under **{{ ui-key.yacloud.compute.instances.create.section_access }}**: - * Select a [service account](../../iam/concepts/users/service-accounts.md) from the list or create a new one. - * If you selected a Linux-based public image: - * Enter the username in the **{{ ui-key.yacloud.compute.instances.create.field_user }}** field. - * In the **{{ ui-key.yacloud.compute.instances.create.field_key }}** field, paste the contents of the public key file. You need to [create](../../compute/operations/vm-connect/ssh.md#creating-ssh-keys) a key pair for the SSH connection yourself. - * If you selected a Windows-based public image: - * In the **{{ ui-key.yacloud.common.password }}** field, set a password for the `Administrator` user. The `Administrator` user is created automatically. - * Click **{{ ui-key.yacloud.common.add }}**. - * If required, grant access to the [serial console](../operations/serial-console/index.md). + * Select a [service account](../../iam/concepts/users/service-accounts.md) from the list or create a new one. + * If you selected a Linux-based public image: + * Enter the username into the **{{ ui-key.yacloud.compute.instances.create.field_user }}** field. + * In the **{{ ui-key.yacloud.compute.instances.create.field_key }}** field, paste the contents of the public key file. You need to [create](../../compute/operations/vm-connect/ssh.md#creating-ssh-keys) a key pair for the SSH connection yourself. + * If you selected a Windows-based public image: + * In the **{{ ui-key.yacloud.common.password }}** field, set a password for the `Administrator` user. A user named `Administrator` is created automatically. + * Click **{{ ui-key.yacloud.common.add }}**. + * If required, grant access to the [serial console](../operations/serial-console/index.md). * Click **{{ ui-key.yacloud.compute.groups.create.button_edit }}**. 1. Under **{{ ui-key.yacloud.compute.groups.create.section_deploy }}**, specify: * **{{ ui-key.yacloud.compute.groups.create.field_deploy-max-expansion }}**: Number of instances by which you can exceed the group size. + + {% include [max-expansion-notice](../../_includes/instance-groups/max-expansion-notice.md) %} * **{{ ui-key.yacloud.compute.groups.create.field_deploy-max-unavailable }}**: Number of instances by which you can reduce the group size. * **{{ ui-key.yacloud.compute.groups.create.field_deploy-max-creating }}**: Number of instances that can be created simultaneously. * **{{ ui-key.yacloud.compute.groups.create.field_deploy-startup-duration }}**: Initialization interval after which the instance will begin to receive load. @@ -77,26 +79,26 @@ To create an instance group: * Select the [scaling type](../../compute/concepts/instance-groups/scale.md). * If you selected the `{{ ui-key.yacloud.compute.groups.create.value_scale-fixed }}` type, specify the size of the group. * If you selected `{{ ui-key.yacloud.compute.groups.create.value_scale-auto }}`, specify: - * The minimum number of instances per availability zone. - * Maximum group size. - * Utilization measurement period: The period for which utilization measurements should be averaged for each instance in the group. - * Instance warmup period: The period during which the created instance is not taken into account when measuring the average load on the group. - * Stabilization period: The interval during which the required number of instances in the group can't be reduced. - * Initial group size: The number of instances created with the group. + * The minimum number of instances per availability zone. + * Maximum group size. + * Utilization measurement period: The period for which utilization measurements should be averaged for each instance in the group. + * Instance warmup period: The period during which the created instance is not taken into account when measuring the average load on the group. + * Stabilization period: The interval during which the required number of instances in the group can't be reduced. + * Initial group size: The number of instances created with the group. * If you selected `{{ ui-key.yacloud.compute.groups.create.value_scale-fixed-test-auto }}`, enter group size and autoscaling parameters. For this type, autoscaling works in test mode. 1. If you previously selected `{{ ui-key.yacloud.compute.groups.create.value_scale-auto }}` as your scaling type, under **{{ ui-key.yacloud.compute.groups.create.label_custom-metrics }}**, specify the target CPU load as a percentage. 1. Under **{{ ui-key.yacloud.compute.groups.create.section_ylb }}**: * (Optional) Click the **{{ ui-key.yacloud.compute.groups.create.field_target-group-attached }}** toggle. [Target groups](../../network-load-balancer/concepts/target-resources.md) are required for the [network load balancer](../../network-load-balancer/concepts/index.md) to perform its function. - * Enter a name and description for the target group. + * Enter a name and description for the target group. 1. Under **{{ ui-key.yacloud.compute.groups.create.section_health-check }}**: * (Optional) Click the **{{ ui-key.yacloud.compute.groups.create.field_enable-health-check }}** toggle. - * Select the check type: `HTTP` or `TCP`. - * Specify the path for the checks. - * Specify a port number from the range 1-32767. - * Specify the response timeout in seconds. - * Specify the interval, in seconds, for sending health check requests. - * Set the healthy threshold, which is the number of successful checks required in order to consider the VM ready to receive traffic. - * Set the unhealthy threshold, which is the number of failed checks after which no traffic will be routed to the VM. + * Select the check type: `HTTP` or `TCP`. + * Specify the path for the checks. + * Specify a port number from the range 1-32767. + * Specify the response timeout in seconds. + * Specify the interval, in seconds, for sending health check requests. + * Specify the healthy threshold: number of successful checks required to consider the VM ready to receive traffic. + * Specify the unhealthy threshold: number of failed checks after which no traffic will be routed to the VM. 1. Click **{{ ui-key.yacloud.common.create }}**. The instance group will appear in the list. diff --git a/en/compute/toc.yaml b/en/compute/toc.yaml index b0ad3fcbcbf..4aa19e2ae69 100644 --- a/en/compute/toc.yaml +++ b/en/compute/toc.yaml @@ -3,7 +3,7 @@ href: index.yaml items: - name: Getting started items: - - name: Summary + - name: Overview href: quickstart/index.md - name: Creating a Linux VM href: quickstart/quick-create-linux.md @@ -31,7 +31,7 @@ items: href: operations/vm-create/create-preemptible-vm.md - name: DSVM items: - - name: Summary + - name: Overview href: operations/dsvm/index.md - name: Creating a VM from a public DSVM image href: operations/dsvm/quickstart.md @@ -129,7 +129,7 @@ items: href: operations/vm-connect/os-login-create-vm.md - name: Setting up OS Login on an existing VM href: operations/vm-connect/enable-os-login.md - - name: Exporting an OS Login certificate + - name: Exporting an SSH certificate href: operations/vm-connect/os-login-export-certificate.md - name: Connecting to a VM via OS Login href: operations/vm-connect/os-login.md @@ -401,7 +401,7 @@ items: href: tutorials/hystax-migration.md - name: Fault protection with Hystax Acura href: tutorials/hystax-disaster-recovery.md - - name: Creating a VM backup with Hystax Acura Backup + - name: Backing up a VM with Hystax Acura Backup href: tutorials/hystax-backup.md - name: Deploying a fault-tolerant architecture with preemptible VMs href: tutorials/nodejs-cron-restart-vm.md @@ -427,7 +427,7 @@ items: href: tutorials/serverless-trigger-budget-queue-vm-tg.md - name: OpenCart online store items: - - name: Summary + - name: Overview href: tutorials/opencart/index.md - name: Management console href: tutorials/opencart/console.md @@ -446,7 +446,13 @@ items: - name: High-performance computing on preemptible VMs href: tutorials/hpc-on-preemptible.md - name: Single-node file server - href: tutorials/single-node-file-server.md + items: + - name: Overview + href: tutorials/single-node-file-server/index.md + - name: Management console + href: tutorials/single-node-file-server/console.md + - name: '{{ TF }}' + href: tutorials/single-node-file-server/terraform.md - name: Configuring an SFTP server based on CentOS 7 href: tutorials/backup-and-archive-to-sftp.md - name: Deploying the GlusterFS parallel file system in high availability mode @@ -469,7 +475,7 @@ items: href: concepts/index.md - name: Virtual machines items: - - name: Summary + - name: Overview href: concepts/vm.md - name: Platforms href: concepts/vm-platforms.md @@ -497,7 +503,7 @@ items: href: concepts/gpus.md - name: Disks and file storages items: - - name: Summary + - name: Overview href: concepts/storage-overview.md - name: Disks href: concepts/disk.md @@ -515,7 +521,7 @@ items: href: concepts/image.md - name: Instance groups items: - - name: Summary + - name: Overview href: concepts/instance-groups/index.md - name: Access href: concepts/instance-groups/access.md @@ -527,7 +533,7 @@ items: href: concepts/instance-groups/variables-in-the-template.md - name: Policies items: - - name: Summary + - name: Overview href: concepts/instance-groups/policies/index.md - name: Allocation policy href: concepts/instance-groups/policies/allocation-policy.md @@ -543,7 +549,7 @@ items: href: concepts/instance-groups/autohealing.md - name: Updating items: - - name: Summary + - name: Overview href: concepts/instance-groups/deploy/index.md - name: Allocating instances across zones href: concepts/instance-groups/deploy/zones.md diff --git a/en/compute/tutorials/index.md b/en/compute/tutorials/index.md index 75653984aae..f9a071e9a73 100644 --- a/en/compute/tutorials/index.md +++ b/en/compute/tutorials/index.md @@ -31,7 +31,7 @@ description: Various {{ compute-full-name }} use cases in {{ yandex-cloud }}. * [{#T}](jenkins.md) * [{#T}](test-vms-creation-via-gitlab-ci.md) * [{#T}](hpc-on-preemptible.md) -* [{#T}](single-node-file-server.md) +* [{#T}](single-node-file-server/index.md) * [{#T}](backup-and-archive-to-sftp.md) * [{#T}](ha-regional-glusterfs.md) * [{#T}](ha-regional-glusterfs-high-performance.md) diff --git a/en/compute/tutorials/single-node-file-server.md b/en/compute/tutorials/single-node-file-server.md deleted file mode 100644 index e3d01d57fa8..00000000000 --- a/en/compute/tutorials/single-node-file-server.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -canonical: '{{ link-docs }}/tutorials/archive/single-node-file-server' ---- - -{% include [single-node-file-server](../../_tutorials/archive/single-node-file-server.md) %} diff --git a/en/compute/tutorials/single-node-file-server/console.md b/en/compute/tutorials/single-node-file-server/console.md new file mode 100644 index 00000000000..b48f95c5134 --- /dev/null +++ b/en/compute/tutorials/single-node-file-server/console.md @@ -0,0 +1,13 @@ +--- +canonical: '{{ link-docs }}/tutorials/archive/single-node-file-server/console' +--- + +# Creating a single-node file server using the management console + +To create an infrastructure for a [single-node file server](index.md) using the {{ yandex-cloud }} management console: + +{% include [single-node-file-server-console](../../../_tutorials/archive/single-node-file-server-console.md) %} + +#### See also {#see-also} + +* [{#T}](terraform.md). \ No newline at end of file diff --git a/en/compute/tutorials/single-node-file-server/index.md b/en/compute/tutorials/single-node-file-server/index.md new file mode 100644 index 00000000000..8a9635cdcf7 --- /dev/null +++ b/en/compute/tutorials/single-node-file-server/index.md @@ -0,0 +1,8 @@ +--- +canonical: '{{ link-docs }}/tutorials/archive/single-node-file-server/' +--- + +{% include [single-node-file-server](../../../_tutorials/archive/single-node-file-server.md) %} + +* [Management console](console.md): Create your infrastructure step by step from the {{ yandex-cloud }} management console. +* [{{ TF }}](terraform.md): Streamline creating and managing your resources using the _infrastructure as code_ (IaC) approach. Download a {{ TF }} configuration example and then deploy the infrastructure using the {{ yandex-cloud }} [{{ TF }} provider]({{ tf-docs-link }}). \ No newline at end of file diff --git a/en/compute/tutorials/single-node-file-server/terraform.md b/en/compute/tutorials/single-node-file-server/terraform.md new file mode 100644 index 00000000000..55bdcf38be4 --- /dev/null +++ b/en/compute/tutorials/single-node-file-server/terraform.md @@ -0,0 +1,13 @@ +--- +canonical: '{{ link-docs }}/tutorials/archive/single-node-file-server/terraform' +--- + +# Creating a single-node file server using {{ TF }} + +To create an infrastructure for a [single-node file server](index.md) using {{ TF }}: + +{% include [tls-termination-terraform](../../../_tutorials/archive/single-node-file-server-terraform.md) %} + +#### See also {#see-also} + +* [{#T}](console.md). \ No newline at end of file diff --git a/en/cos/error/index.md b/en/cos/error/index.md index 2ced761747b..e7ca9c73bcc 100644 --- a/en/cos/error/index.md +++ b/en/cos/error/index.md @@ -1,5 +1,5 @@ --- -title: Troubleshooting for {{ coi }} in {{ cos-full-name }} +title: Troubleshooting {{ coi }} issues in {{ cos-full-name }} description: This guide describes how you can fix issues with a {{ coi }}. --- @@ -26,7 +26,7 @@ Mar 25 12:07:41 instance-name yc-container-daemon[516]: {"level":"ERROR","ts":"2021-03-25T12:07:41.005Z","caller":"container/image.go:78","msg":"error pulling image: Error response from daemon: pull access denied for {{ registry }}/crpgruern********/ngin> ``` -**How to fix it**: [Assign to the service account](../../iam/operations/sa/set-access-bindings.md) the `viewer` or `container-registry.images.puller` role for a repository, registry, or folder. For more information about the roles available in the service, see our [documentation](../../container-registry/security/index.md). +**How to fix it**: [Assign to the service account](../../iam/operations/sa/set-access-bindings.md) the `viewer` or `container-registry.images.puller` role for a repository, registry, or folder. For more information about the roles available in the service, see our [documentation](../../container-registry/security/index.md). ## No network access to {{ container-registry-name }} {#connection-to-cr} diff --git a/en/cos/quickstart.md b/en/cos/quickstart.md index bfe397ce348..75c8872edd0 100644 --- a/en/cos/quickstart.md +++ b/en/cos/quickstart.md @@ -1,4 +1,4 @@ -# Creating a VM with {{ coi }} +# Creating a VM from a {{ coi }} Create a VM from a [{{ coi }}](concepts/index.md) and run a Docker container on it. @@ -6,87 +6,89 @@ Create a VM from a [{{ coi }}](concepts/index.md) and run a Docker container on If the required Docker image is pushed to {{ container-registry-name }}, create a [service account](../iam/operations/sa/create.md) with the [{{ roles-cr-puller }}](../container-registry/security/index.md#choosing-roles) role for the registry in use. A {{ coi }} VM will pull the Docker image from the registry on behalf of this account. -## Create a VM with a Docker container from a {{ coi }} image {#create-vm} +## Create a VM with a Docker container from a {{ coi }} {#create-vm} {% list tabs group=instructions %} - - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the folder to create your VM in. - 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. - 1. Click **{{ ui-key.yacloud.compute.instances.button_create }}**. - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, go to the **{{ ui-key.yacloud.compute.instances.create.image_value_coi }}** tab. - 1. Click **{{ ui-key.yacloud.compute.instances.create.image_coi_label_empty-button }}**. - 1. In the **{{ ui-key.yacloud.compute.instances.create.section_coi }}** window that opens, set the parameters using suggestions: - * Specify the **{{ ui-key.yacloud.compute.instances.create.field_coi-image }}** to be used to run the Docker container on the VM. - * Select the **{{ ui-key.yacloud.compute.instances.create.field_coi-restart-policy }}** field value for the Docker container: - * **{{ ui-key.yacloud.compute.instances.create.value_coi-restart-always }}**: Always restart the Docker container when it stops. - * **{{ ui-key.yacloud.compute.instances.create.value_coi-restart-never }}**: Do not restart the Docker container automatically. - * **{{ ui-key.yacloud.compute.instances.create.value_coi-restart-on-failure }}**: Restart the Docker container only if it shuts down with a non-zero return code. - * Fill out the remaining fields, if required. + 1. In the [management console]({{ link-console-main }}), select the [folder](../resource-manager/concepts/resources-hierarchy.md#folder) to create your VM in. + 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. + 1. In the left-hand panel, select ![image](../_assets/console-icons/server.svg) **{{ ui-key.yacloud.compute.switch_instances }}**. + 1. Click **{{ ui-key.yacloud.compute.instances.button_create }}**. + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, go to the **{{ ui-key.yacloud.compute.instances.create.image_value_coi }}** tab. + 1. Click **{{ ui-key.yacloud.compute.instances.create.image_coi_label_empty-button }}**. + 1. In the **{{ ui-key.yacloud.compute.instances.create.section_coi }}** window that opens, set the parameters using suggestions: + + 1. Specify the **{{ ui-key.yacloud.compute.instances.create.field_coi-image }}** to be used to run the Docker container on the VM. + 1. Select the **{{ ui-key.yacloud.compute.instances.create.field_coi-restart-policy }}** field value for the Docker container: + + * `{{ ui-key.yacloud.compute.instances.create.value_coi-restart-always }}`: Always restart the Docker container when it stops. + * `{{ ui-key.yacloud.compute.instances.create.value_coi-restart-on-failure }}`: Restart the Docker container only if it shuts down with a non-zero return code. + * `{{ ui-key.yacloud.compute.instances.create.value_coi-restart-never }}`: Do not restart the Docker container automatically. - Click **{{ ui-key.yacloud.common.apply }}**. - 1. Set the remaining VM parameters by following [this guide](../compute/operations/vm-create/create-linux-vm.md). + 1. Fill in the remaining fields, if required. + 1. Click **{{ ui-key.yacloud.common.apply }}**. + 1. Follow [this guide](../compute/operations/vm-create/create-linux-vm.md) to configure the remaining VM parameters. - CLI {#cli} - {% include [cli-install](../_includes/cli-install.md) %} - - {% include [default-catalogue](../_includes/default-catalogue.md) %} - - 1. View a description of the CLI command to create a VM from a {{ coi }}: - - ```bash - yc compute instance create-with-container --help - ``` - - 1. Create a VM from a {{ coi }}: - - ```bash - yc compute instance create-with-container \ - --name my-vm \ - --zone {{ region-id }}-b \ - --ssh-key ssh-key.pub \ - --service-account-name my-robot \ - --platform standard-v3 \ - --create-boot-disk size=30 \ - --public-ip \ - --container-name=my-app \ - --container-image={{ registry }}/mirror/ubuntu:16.04 \ - --container-command=sleep \ - --container-arg="1000" \ - --container-env=KEY1=VAL1,KEY2=VAL2 \ - --container-privileged - ``` - - Where: - * `--name`: VM name. - * `--zone`: Availability zone. - * `--ssh-key`: Contents of the [public key](../compute/quickstart/quick-create-linux.md#create-ssh) file. - * `--service-account-name`: Name of the service account. - * `--create-boot-disk size`: Boot disk size. It must be at least 30 GB. - * `--public-ip`: Public IP address allocated to the VM. - * `--container-name`: Name of the Docker container. - * `--container-image`: Name of the Docker image used to launch the Docker container. - * `--container-command`: Command to run upon Docker container launch. - * `--container-arg`: Parameters for the command specified in `--container-command`. - * `--container-env`: Environment variables available in the Docker container. - * `--container-privileged`: Launching the Docker container in privileged mode. - - Result: - - ```text - done (17s) - id: epdbf646ge5q******** - folder_id: b1g88tflru0e******** - created_at: "2023-03-13T09:44:03Z" - name: my-vm - ... - ``` - - Once created, the VM will appear in the VM list under **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}** in the [management console]({{ link-console-main }}). For more information about working with VMs, see our [step-by-step guides](../compute/operations/index.md). + {% include [cli-install](../_includes/cli-install.md) %} + + {% include [default-catalogue](../_includes/default-catalogue.md) %} + + 1. View the description of the CLI command to create a VM from a {{ coi }}: + + ```bash + yc compute instance create-with-container --help + ``` + + 1. Create a VM from a {{ coi }}: + + ```bash + yc compute instance create-with-container \ + --name my-vm \ + --zone {{ region-id }}-b \ + --ssh-key ssh-key.pub \ + --service-account-name my-robot \ + --platform standard-v3 \ + --create-boot-disk size=30 \ + --public-ip \ + --container-name=my-app \ + --container-image={{ registry }}/mirror/ubuntu:16.04 \ + --container-command=sleep \ + --container-arg="1000" \ + --container-env=KEY1=VAL1,KEY2=VAL2 \ + --container-privileged + ``` + + Where: + * `--name`: VM name. + * `--zone`: Availability zone. + * `--ssh-key`: Contents of the [public key](../compute/quickstart/quick-create-linux.md#create-ssh) file. + * `--service-account-name`: Service account name. + * `--create-boot-disk`: Boot disk size. It must be at least 30 GB. + * `--public-ip`: Public IP address allocated to the VM. + * `--container-name`: Docker container name. + * `--container-image`: Name of the Docker image used to run the Docker container. + * `--container-command`: Command to run when you start the Docker container. + * `--container-arg`: Parameters for the command specified in `--container-command`. + * `--container-env`: Environment variables available in the Docker container. + * `--container-privileged`: Run the Docker container in privileged mode. + + Result: + + ```text + done (17s) + id: epdbf646ge5q******** + folder_id: b1g88tflru0e******** + created_at: "2023-03-13T09:44:03Z" + name: my-vm + ... + ``` + + Once created, the VM will appear in the VM list under **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}** in the [management console]({{ link-console-main }}). For more information about working with VMs, see our [step-by-step guides](../compute/operations/index.md). {% endlist %} diff --git a/en/cos/toc.yaml b/en/cos/toc.yaml index f13301a9273..e36bddd6143 100644 --- a/en/cos/toc.yaml +++ b/en/cos/toc.yaml @@ -12,24 +12,24 @@ items: - name: Creating a VM from a {{ coi }} href: tutorials/vm-create.md - name: >- - "Creating a VM from a {{ coi }} and an additional volume for a Docker - container" + Creating a VM from a {{ coi }} with additional volume for a Docker + container href: tutorials/vm-create-with-second-disk.md - - name: '"Creating a VM from a {{ coi }} with multiple Docker containers"' + - name: Creating a VM from a {{ coi }} with multiple Docker containers href: tutorials/docker-compose.md - name: Creating an instance group from a {{ coi }} href: tutorials/ig-create.md - name: >- - "Creating an instance group from a {{ coi }} with multiple Docker - containers" + Creating an instance group from a {{ coi }} with multiple Docker + containers href: tutorials/ig-with-containers.md - - name: Updating a VM from a {{ coi }} + - name: Updating a VM with a {{ coi }} href: tutorials/vm-update.md - name: Configuring data output from a Docker container to a serial port href: tutorials/serial-port.md - name: Creating a VM and an instance group from a {{ coi }} using {{ TF }} href: tutorials/coi-with-terraform.md - - name: Transferring logs from a {{ coi }} to {{ cloud-logging-name }} + - name: Transferring logs from {{ coi }} to {{ cloud-logging-name }} href: tutorials/coi-fluent-bit-logging.md - name: Concepts items: diff --git a/en/cos/tutorials/vm-create.md b/en/cos/tutorials/vm-create.md index 2b5ff0f0684..85f281e920f 100644 --- a/en/cos/tutorials/vm-create.md +++ b/en/cos/tutorials/vm-create.md @@ -10,156 +10,161 @@ If the required Docker image is pushed to {{ container-registry-full-name }}, cr {% list tabs group=instructions %} - - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the folder to create your VM in. - 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. - 1. Click **{{ ui-key.yacloud.compute.instances.button_create }}**. - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, go to the **{{ ui-key.yacloud.compute.instances.create.image_value_coi }}** tab. - 1. Click **{{ ui-key.yacloud.compute.instances.create.image_coi_label_empty-button }}**. - 1. In the **{{ ui-key.yacloud.compute.instances.create.section_coi }}** window that opens, set the parameters using suggestions: + 1. In the [management console]({{ link-console-main }}), select the [folder](../../resource-manager/concepts/resources-hierarchy.md#folder) to create your VM in. + 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. + 1. In the left-hand panel, select ![image](../../_assets/console-icons/server.svg) **{{ ui-key.yacloud.compute.switch_instances }}**. + 1. Click **{{ ui-key.yacloud.compute.instances.button_create }}**. + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_image }}**, go to the **{{ ui-key.yacloud.compute.instances.create.image_value_coi }}** tab. + 1. Click **{{ ui-key.yacloud.compute.instances.create.image_coi_label_empty-button }}**. + 1. In the **{{ ui-key.yacloud.compute.instances.create.section_coi }}** window that opens, set the parameters using suggestions: + * (Optional) Enter the **{{ ui-key.yacloud.compute.instances.create.field_coi-name }}** of the Docker container to run on the VM. The naming requirements are as follows: - * The name must be from 3 to 63 characters long. - * It may contain Latin letters, numbers, and hyphens. - * Use a letter for the first character. Do not use a hyphen for the last character. + + {% include [name-format](../../_includes/name-format.md) %} + * Specify the [**{{ ui-key.yacloud.compute.instances.create.field_coi-image }}**](../concepts/docker-image.md) to be used to run the Docker container on the VM. You can do this in one of the following ways: - * By selecting one of the available images. To do this, start typing the image name in the search bar. The image search reads all the available cloud folders. - * By specifying the image name manually. To do this, click **{{ ui-key.yacloud.component.image-field.button_custom-image }}** and enter the image name. You can specify an image from {{ container-registry-name }} or any publicly available Docker image library (such as [Docker Hub](https://hub.docker.com)). + + * By selecting one of the available images. To do this, start typing the image name in the search bar. The image search reads all the available cloud folders. + * By specifying the image name manually. To do this, click **{{ ui-key.yacloud.component.image-field.button_custom-image }}** and enter the image name. You can specify an image from {{ container-registry-name }} or any publicly available Docker image library (such as [Docker Hub](https://hub.docker.com)). + * (Optional) In the **{{ ui-key.yacloud.compute.instances.create.field_coi-command }}** field, specify the executable file to run when the Docker container starts. * (Optional) Set **{{ ui-key.yacloud.compute.instances.create.field_coi-arguments }}**. - * (Optional) Specify **{{ ui-key.yacloud.compute.instances.create.field_coi-env }}** in `key:value` format, which are available in the Docker container. + * (Optional) Specify **{{ ui-key.yacloud.compute.instances.create.field_coi-env }}** you want to make available in the Docker container in `key:value` format. * Select the [**{{ ui-key.yacloud.compute.instances.create.field_coi-restart-policy }}**](../concepts/restart-policy.md) field value for the Docker container: - * **{{ ui-key.yacloud.compute.instances.create.value_coi-restart-always }}**: Always restart the Docker container when it stops. - * **{{ ui-key.yacloud.compute.instances.create.value_coi-restart-never }}**: Do not restart the Docker container automatically. - * **{{ ui-key.yacloud.compute.instances.create.value_coi-restart-on-failure }}**: Restart the Docker container only if it shuts down with a non-zero return code. + + * `{{ ui-key.yacloud.compute.instances.create.value_coi-restart-always }}`: Always restart the Docker container when it stops. + * `{{ ui-key.yacloud.compute.instances.create.value_coi-restart-on-failure }}`: Restart the Docker container only if it shuts down with a non-zero return code. + * `{{ ui-key.yacloud.compute.instances.create.value_coi-restart-never }}`: Do not restart the Docker container automatically. + * (Optional) Enable **{{ ui-key.yacloud.compute.instances.create.field_coi-tty }}** to use the command shell in the Docker container. * (Optional) Enable **{{ ui-key.yacloud.compute.instances.create.field_coi-stdin }}** to link the input stream to the running Docker container. * (Optional) Enable **{{ ui-key.yacloud.compute.instances.create.field_coi-privileged }}** to allow the Docker container processes to access all VM resources. - Click **{{ ui-key.yacloud.common.apply }}**. - 1. Set the remaining VM parameters by following [this guide](../../compute/operations/vm-create/create-linux-vm.md). + 1. Click **{{ ui-key.yacloud.common.apply }}**. + 1. Use [this guide](../../compute/operations/vm-create/create-linux-vm.md) to configure the remaining VM parameters. - CLI using flags {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} - - {% include [default-catalogue](../../_includes/default-catalogue.md) %} - - To create a VM and set Docker container parameters via the YC CLI: - 1. View a description of the command: - - ```bash - yc compute instance create-with-container --help + {% include [cli-install](../../_includes/cli-install.md) %} + + {% include [default-catalogue](../../_includes/default-catalogue.md) %} + + To create a VM and set Docker container parameters via the YC CLI: + 1. View a description of the command: + + ```bash + yc compute instance create-with-container --help + ``` + + 1. Run this command: + + ```bash + yc compute instance create-with-container \ + --name my-vm \ + --zone {{ region-id }}-b \ + --ssh-key ssh-key.pub \ + --service-account-name my-robot \ + --create-boot-disk size=30 \ + --public-ip \ + --platform standard-v3 \ + --container-name=my-app \ + --container-image={{ registry }}/mirror/ubuntu:20.04 \ + --container-command=sleep \ + --container-arg="1000" \ + --container-env=KEY1=VAL1,KEY2=VAL2 \ + --container-privileged ``` - 1. Run this command: - - ```bash - yc compute instance create-with-container \ - --name my-vm \ - --zone {{ region-id }}-b \ - --ssh-key ssh-key.pub \ - --service-account-name my-robot \ - --create-boot-disk size=30 \ - --public-ip \ - --platform standard-v3 \ - --container-name=my-app \ - --container-image={{ registry }}/mirror/ubuntu:20.04 \ - --container-command=sleep \ - --container-arg="1000" \ - --container-env=KEY1=VAL1,KEY2=VAL2 \ - --container-privileged - ``` - - Where: - * `--name`: VM name. - * `--zone`: Availability zone. - * `--ssh-key`: Contents of the [public key](../../compute/operations/vm-connect/ssh.md#creating-ssh-keys) file. - * `--service-account-name`: Name of the service account. - * `--create-boot-disk size`: Boot disk size. It must be at least 30 GB. - * `--public-ip`: Public IP address allocated to the VM. - * `--container-name`: Name of the Docker container. - * `--container-image`: Name of the Docker image used to launch the Docker container. - * `--container-command`: Command to run upon Docker container launch. - * `--container-arg`: Parameters for the command specified in `--container-command`. - * `--container-env`: Environment variables available in the Docker container. - * `--container-privileged`: Launching the Docker container in privileged mode. - - Result: - - ```text - done (17s) - id: epdbf646ge5q******** - folder_id: b1g88tflru0e******** - created_at: "2023-03-13T09:44:03Z" - name: my-vm - ... - ``` - - Once created, the VM will appear in the VM list under **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}** in the [management console]({{ link-console-main }}). For more information about working with VMs, see our [step-by-step guides](../../compute/operations/index.md). + Where: + * `--name`: VM name. + * `--zone`: Availability zone. + * `--ssh-key`: Contents of the [public key](../../compute/operations/vm-connect/ssh.md#creating-ssh-keys) file. + * `--service-account-name`: Service account name. + * `--create-boot-disk`: Boot disk size. It must be at least 30 GB. + * `--public-ip`: Public IP address allocated to the VM. + * `--container-name`: Docker container name. + * `--container-image`: Name of the Docker image used to run the Docker container. + * `--container-command`: Command to run when you start the Docker container. + * `--container-arg`: Parameters for the command specified in `--container-command`. + * `--container-env`: Environment variables available in the Docker container. + * `--container-privileged`: Run the Docker container in privileged mode. + + Result: + + ```text + done (17s) + id: epdbf646ge5q******** + folder_id: b1g88tflru0e******** + created_at: "2023-03-13T09:44:03Z" + name: my-vm + ... + ``` + + Once created, the VM will appear in the VM list under **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}** in the [management console]({{ link-console-main }}). For more information about working with VMs, see our [step-by-step guides](../../compute/operations/index.md). - CLI using a specification file {#spec-cli} - {% include [cli-install](../../_includes/cli-install.md) %} - - {% include [default-catalogue](../../_includes/default-catalogue.md) %} - - To create a VM and set Docker container parameters using a [specification file](../concepts/coi-specifications.md#coi-spec): - 1. View a description of the command: - - ```bash - yc compute instance create-with-container --help - ``` - - 1. Create a Docker container specification file. Save the following data to a file named `docker-spec.yaml`: - - ```yaml - spec: - containers: - - command: - - sleep - args: - - 100000 - image: {{ registry }}/mirror/ubuntu:20.04 - name: my-container - securityContext: - privileged: true - ``` - - 1. Run this command: - - ```bash - yc compute instance create-with-container \ - --coi-spec-file docker-spec.yaml \ - --name my-vm \ - --zone {{ region-id }}-b \ - --ssh-key ssh-key.pub \ - --create-boot-disk size=30 \ - --service-account-name my-service-account \ - --public-ip - ``` - - Where: - * `--coi-spec-file`: Path to the Docker container [specification file](../concepts/coi-specifications.md#coi-spec). - * `--name`: VM name. - * `--zone`: Availability zone. - * `--ssh-key`: Contents of the [public key](../../compute/operations/vm-connect/ssh.md#creating-ssh-keys) file. - * `--create-boot-disk size`: Boot disk size. It must be at least 30 GB. - * `--service-account-name`: Name of the service account. - * `--public-ip`: Public IP address allocated to the VM. - - Result: - - ```text - done (1m40s) - id: epde18u4mahl******** - folder_id: b1g7gvsi89m3******** - created_at: "2023-03-13T13:50:17Z" - name: my-vm - ... - ``` + {% include [cli-install](../../_includes/cli-install.md) %} + + {% include [default-catalogue](../../_includes/default-catalogue.md) %} + + To create a VM and set Docker container parameters using a [specification file](../concepts/coi-specifications.md#coi-spec): + 1. View a description of the command: + + ```bash + yc compute instance create-with-container --help + ``` + + 1. Create a Docker container specification file. Save the following data to the `docker-spec.yaml` file: + + ```yaml + spec: + containers: + - command: + - sleep + args: + - 100000 + image: {{ registry }}/mirror/ubuntu:20.04 + name: my-container + securityContext: + privileged: true + ``` + + 1. Run this command: + + ```bash + yc compute instance create-with-container \ + --coi-spec-file docker-spec.yaml \ + --name my-vm \ + --zone {{ region-id }}-b \ + --ssh-key ssh-key.pub \ + --create-boot-disk size=30 \ + --service-account-name my-service-account \ + --public-ip + ``` + + Where: + * `--coi-spec-file`: Path to the Docker container [specification file](../concepts/coi-specifications.md#coi-spec). + * `--name`: VM name. + * `--zone`: Availability zone. + * `--ssh-key`: Contents of the [public key](../../compute/operations/vm-connect/ssh.md#creating-ssh-keys) file. + * `--create-boot-disk size`: Boot disk size. It must be at least 30 GB. + * `--service-account-name`: Service account name. + * `--public-ip`: Public IP address allocated to the VM. + + Result: + + ```text + done (1m40s) + id: epde18u4mahl******** + folder_id: b1g7gvsi89m3******** + created_at: "2023-03-13T13:50:17Z" + name: my-vm + ... + ``` - Once created, the VM will appear in the VM list under **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}** in the [management console]({{ link-console-main }}). For more information about working with VMs, see our [step-by-step guides](../../compute/operations/index.md). + Once created, the VM will appear in the VM list under **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}** in the [management console]({{ link-console-main }}). For more information about working with VMs, see our [step-by-step guides](../../compute/operations/index.md). {% endlist %} \ No newline at end of file diff --git a/en/data-proc/operations/cluster-create.md b/en/data-proc/operations/cluster-create.md index 44789cc01bc..89c1025bd43 100644 --- a/en/data-proc/operations/cluster-create.md +++ b/en/data-proc/operations/cluster-create.md @@ -83,63 +83,82 @@ If you want to create a {{ dataproc-name }} cluster copy, [import its configurat 1. In the [management console]({{ link-console-main }}), select the [folder](../../resource-manager/concepts/resources-hierarchy.md#folder) where you want to create a {{ dataproc-name }} cluster. 1. Click **{{ ui-key.yacloud.iam.folder.dashboard.button_add }}** and select ![image](../../_assets/data-proc/data-proc.svg) **{{ ui-key.yacloud.iam.folder.dashboard.value_data-proc }}** in the drop-down list. - 1. Enter a name for the {{ dataproc-name }} cluster in the **{{ ui-key.yacloud.mdb.forms.base_field_name }}** field. The naming requirements are as follows: + 1. Enter a name for the {{ dataproc-name }} cluster. Optionally, add cluster description. + + The naming requirements are as follows: + * It must be unique within the folder. {% include [name-format.md](../../_includes/name-format.md) %} - 1. Select a suitable [image version](../concepts/environment.md) and the services you want to use in the {{ dataproc-name }} cluster. + 1. Add or delete cluster [labels](../../resource-manager/concepts/labels.md). You can use them to split or join resources into logical groups. + 1. Specify the following cluster settings: - {% include [note-light-weight-cluster](../../_includes/data-proc/note-light-weight-cluster.md) %} + * [Image version](../concepts/environment.md) and services you want to use in the {{ dataproc-name }} cluster. - {% note tip %} + {% include [note-light-weight-cluster](../../_includes/data-proc/note-light-weight-cluster.md) %} - To use the most recent image version, specify `2.0`. + {% note tip %} - {% endnote %} + To use the most recent image version, specify `2.0`. - 1. Enter the public part of your SSH key in the **{{ ui-key.yacloud.mdb.forms.config_field_public-keys }}** field. For information about how to generate and use SSH keys, see the [{{ compute-full-name }} documentation](../../compute/operations/vm-connect/ssh.md). - 1. Select or create a service account to grant {{ dataproc-name }} cluster access. Make sure to [assign](../../iam/operations/sa/assign-role-for-sa.md) the following roles to the {{ dataproc-name }} cluster service account: + {% endnote %} - {% include [sa-roles](../../_includes/data-proc/sa-roles.md) %} + * Public part of the SSH key in the **{{ ui-key.yacloud.mdb.forms.config_field_public-keys }}** field. For information on how to generate and use SSH keys, see the [{{ compute-full-name }} documentation](../../compute/operations/vm-connect/ssh.md#creating-ssh-keys). - 1. Select the availability zone for the {{ dataproc-name }} cluster. - 1. If required, configure the [properties of {{ dataproc-name }} cluster components, jobs, and the environment](../concepts/settings-list.md). - 1. If necessary, specify custom [initialization scripts](../concepts/init-action.md) for {{ dataproc-name }} cluster hosts. For each script, specify: - * **{{ ui-key.yacloud.mdb.forms.field_initialization-action-uri }}**: Link to the initialization script in the `https://`, `http://`, `hdfs://`, or `s3a://` scheme. - * (Optional) **{{ ui-key.yacloud.mdb.forms.field_initialization-action-timeout }}**: Script execution timeout, in seconds. If your initialization script runs longer than this time period, it will be terminated. - * (Optional) **{{ ui-key.yacloud.mdb.forms.field_initialization-action-args }}**: List of arguments for your initialization script, enclosed in square brackets (`[]`) and separated by commas, e.g.: + * Service account to which you need to grant access to the {{ dataproc-name }} cluster. Make sure to [assign](../../iam/operations/sa/assign-role-for-sa.md) the following roles to the {{ dataproc-name }} cluster service account: - ```text - ["arg1","arg2",...,"argN"] - ``` + {% include [sa-roles](../../_includes/data-proc/sa-roles.md) %} - 1. Select the name of a bucket in {{ objstorage-name }} to store job dependencies and results. - 1. Select a network for the {{ dataproc-name }} cluster. - 1. Select security groups that have the required permissions. + * Availability zone for the {{ dataproc-name }} cluster. + * (Optional) [Cluster component properties](../concepts/settings-list.md). + * (Optional) Custom [initialization scripts](../concepts/init-action.md) for cluster hosts. For each script, specify the following information: - {% note warning %} + * URI link to the initialization script in the `https://`, `http://`, `hdfs://`, or `s3a://` schema. + * (Optional) Script timeout (in seconds). If your initialization script runs longer than the specified time period, it will be terminated. + * (Optional) Arguments enclosed in square brackets and separated by commas. The initialization script will use these arguments when it runs. Example of arguments: - When you create a {{ dataproc-name }} cluster, security group settings are verified. If the {{ dataproc-name }} cluster cannot operate properly with these settings, a warning will appear. A sample functional configuration is provided [above](#change-security-groups). + ```text + ["arg1","arg2",...,"argN"] + ``` - {% endnote %} + * [{{ objstorage-full-name }} bucket](../../storage/concepts/bucket.md) name selection format, **{{ ui-key.yacloud.forms.label_form-list }}** or **{{ ui-key.yacloud.forms.label_form-id }}**. + * Bucket to use by the cluster. + + Depending on the format you selected, either pick a name from the list or specify it manually. You can get it with a [list of buckets in the folder](../../storage/operations/buckets/get-info.md#get-information). + + * Format in which to specify a network for the {{ dataproc-name }} cluster. + * Network for the cluster. + * Security groups with the required permissions. - 1. Enable **{{ ui-key.yacloud.mdb.forms.config_field_ui_proxy }}** to access the [web interfaces of {{ dataproc-name }} components](../concepts/interfaces.md). - 1. [{{ cloud-logging-full-name }}](../../logging/) stores {{ dataproc-name }} cluster logs. Select a log group from the list or [create a new one](../../logging/operations/create-group.md). + {% note warning %} - For the function to work, [assign](../../iam/operations/sa/assign-role-for-sa.md) the `logging.writer` role to the service account of the {{ dataproc-name }} cluster. For more information, see the [{{ cloud-logging-name }} documentation](../../logging/security/index.md). - 1. Configure {{ dataproc-name }} subclusters: maximum one subcluster with a master host (**Master**) and subclusters for data storage or processing. + When you create a {{ dataproc-name }} cluster, security group settings are verified. If the {{ dataproc-name }} cluster cannot operate properly with these settings, you will get a warning. A sample functional configuration is provided [above](#change-security-groups). - Roles of {{ dataproc-name }} subclusters for data storage and processing are different: you can deploy data storage components on data storage subclusters and computing components on data processing subclusters. You can use a [storage](../concepts/storage.md) on a {{ dataproc-name }} subcluster for data processing only to temporarily store the files being processed. + {% endnote %} - For each {{ dataproc-name }} subcluster, you can configure: - * Number of hosts. - * [Host class](../concepts/instance-types.md): Platform and computing resources available to the host. + * [UI Proxy](./connect-interfaces.md#ui-proxy). If the **{{ ui-key.yacloud.mdb.forms.config_field_ui_proxy }}** option is enabled, {{ dataproc-name }} [component web interfaces](../concepts/interfaces.md) will be available. + * {{ cloud-logging-full-name }} [log group](../../logging/concepts/log-group.md) the cluster will send logs to. + + To save logs in a log group, [assign](../../iam/operations/sa/assign-role-for-sa.md) the `logging.writer` [role](../../logging/security/index.md#logging-writer) to the cluster service account. + + 1. Configure the {{ dataproc-name }} subclusters. The following types are available: + + * Subcluster with a master host (`{{ ui-key.yacloud.mdb.forms.label_master-subcluster }}`). There can only be one such subcluster. + * Data storage subclusters (`{{ ui-key.yacloud.mdb.forms.label_data-subcluster }}`). These are used to deploy storage components. + * Data processing subclusters (`{{ ui-key.yacloud.mdb.forms.label_compute-subcluster }}`). These are used to deploy computing components. The [storage](../concepts/storage.md) of such a subcluster can only be used to temporarily store processed files. + + For each {{ dataproc-name }} subcluster, specify: + + * Subcluster name. + * Number of hosts (there can only be one master host). + * [Host class](../concepts/instance-types.md), i.e., the platform and computing resources available to the host. * Storage size and type. - * Subnet of the network where the {{ dataproc-name }} cluster resides. + * Subnet. + + In the subnet, you need to set up a NAT gateway for the {{ dataproc-name }} subcluster with a master host. For more information, see [{#T}](#setup-network). - In the subnet, you need to [set up a NAT gateway](../../vpc/operations/create-nat-gateway.md) for the {{ dataproc-name }} subcluster with a master host. For more information, see [{#T}](#setup-network). - * To access {{ dataproc-name }} subcluster hosts from the internet, select **{{ ui-key.yacloud.mdb.forms.field_assign-public-ip }}**. In this case, you can only connect to {{ dataproc-name }} subcluster hosts using SSL. For more information, see [{#T}](connect.md). + * Access to {{ dataproc-name }} subcluster hosts from the internet. Select the **{{ ui-key.yacloud.mdb.forms.field_assign-public-ip }}** option to enable access. In this case, you can only connect to {{ dataproc-name }} subcluster hosts using SSL. For more information, see [{#T}](connect.md). {% note warning %} @@ -147,18 +166,18 @@ If you want to create a {{ dataproc-name }} cluster copy, [import its configurat {% endnote %} - 1. In {{ dataproc-name }} subclusters for data processing, you can specify [autoscaling](../concepts/autoscaling.md) parameters. + 1. (Optional) Set up [automatic scaling](../concepts/autoscaling.md) for data processing subclusters. - 1. Under **{{ ui-key.yacloud.mdb.forms.label_create-subcluster }}**, click **{{ ui-key.yacloud.mdb.forms.button_configure }}**. - 1. In the **{{ ui-key.yacloud.mdb.forms.base_field_roles }}** field, select `COMPUTENODE`. - 1. Under **{{ ui-key.yacloud.mdb.forms.section_scaling }}**, enable the **{{ ui-key.yacloud.mdb.forms.label_autoscaling-activated }}** setting. + 1. In the `{{ ui-key.yacloud.mdb.forms.label_compute-subcluster }}` subcluster settings, enable **{{ ui-key.yacloud.mdb.forms.label_autoscaling-activated }}**. 1. Set autoscaling parameters. 1. The default metric used for autoscaling is `yarn.cluster.containersPending`. To enable scaling based on CPU utilization, disable the **{{ ui-key.yacloud.compute.groups.create.field_default-utilization-target }}** setting and specify the target CPU utilization level. 1. Click **{{ ui-key.yacloud.mdb.forms.button_add-subcluster }}**. - 1. Configure additional {{ dataproc-name }} cluster settings, if required: - **{{ ui-key.yacloud.mdb.forms.label_deletion-protection }}**: Manages {{ dataproc-name }} cluster protection against accidental deletion by a user. - Enabled protection will not prevent a manual connection to the {{ dataproc-name }} cluster and data deletion. + 1. (Optional) Add and set up additional subclusters for data storage or processing. + 1. (Optional) Use additional settongs to enable protection against accidental cluster deletion. + + With the protection enabled, one can still connect to the {{ dataproc-name }} cluster manually and delete the data. + 1. Click **{{ ui-key.yacloud.mdb.forms.button_create }}**. - CLI {#cli} @@ -247,7 +266,7 @@ If you want to create a {{ dataproc-name }} cluster copy, [import its configurat * `resource-preset`: [Host class](../concepts/instance-types.md). * `disk-type`: [Storage type](../concepts/storage.md), which can be `network-ssd`, `network-hdd`, or `network-ssd-nonreplicated`. * `disk-size`: Storage size in GB. - * `subnet-name`: [Subnet name](../../vpc/concepts/network.md#subnet). + * `subnet-name`: Subnet name. * `hosts-count`: Number of hosts in the {{ dataproc-name }} subclusters for data storage or processing. The minimum value is `1`, and the maximum value is `32`. * `assign-public-ip`: Access to {{ dataproc-name }} subcluster hosts from the internet. It can either be `true` or `false`. If access is enabled, you can only connect to the {{ dataproc-name }} cluster using SSL. For more information, see [{#T}](connect.md). @@ -297,7 +316,7 @@ If you want to create a {{ dataproc-name }} cluster copy, [import its configurat * `hosts-count`: Minimum number of hosts (VMs) in the {{ dataproc-name }} subcluster. The minimum value is `1`, and the maximum value is `32`. * `max-hosts-count`: Maximum number of hosts (VMs) in the {{ dataproc-name }} subcluster. The minimum value is `1`, and the maximum value is `100`. * `preemptible`: Indicates if [preemptible VMs](../../compute/concepts/preemptible-vm.md) are used. Its possible values are `true` or `false`. - * `warmup-duration`: Time required to warm up a VM instance, in `s` format. The minimum value is `0s`, and the maximum value is `600s`. + * `warmup-duration`: Time required to warm up a VM instance, in `s`. The minimum value is `0s`, and the maximum value is `600s`. * `stabilization-duration`: Period, in seconds, during which the required number of VMs cannot be decreased, in `s` format. The minimum value is `60s` and the maximum value is `1800s`. * `measurement-duration`: Period, in seconds, for which the average utilization is calculated for each instance, in `s` format. The minimum value is `60s` (1 minute), and the maximum value is `600s` (10 minutes). * `cpu-utilization-target`: Target CPU utilization level, in %. Use this setting to enable [scaling](../concepts/autoscaling.md) based on CPU utilization. Otherwise, `yarn.cluster.containersPending` will be used for scaling based on the number of pending resources. The minimum value is `10`, and the maximum value is `100`. diff --git a/en/data-proc/operations/cluster-list.md b/en/data-proc/operations/cluster-list.md index 9921f17f2e2..be5c6bfd920 100644 --- a/en/data-proc/operations/cluster-list.md +++ b/en/data-proc/operations/cluster-list.md @@ -8,23 +8,23 @@ You can get detailed information about each {{ dataproc-name }} cluster. - Management console {#console} - Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_data-proc }}**. + Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_data-proc }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To request a list of {{ dataproc-name }} clusters in the default folder, run the command: + To request a list of {{ dataproc-name }} clusters in the default folder, run the command: - ```bash - {{ yc-dp }} cluster list - ``` + ```bash + {{ yc-dp }} cluster list + ``` - API {#api} - Use the [list](../api-ref/Cluster/list.md) API method. + Use the [list](../api-ref/Cluster/list.md) API method. {% endlist %} @@ -34,58 +34,150 @@ You can get detailed information about each {{ dataproc-name }} cluster. - Management console {#console} - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_data-proc }}**. - 1. Click the cluster name. + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_data-proc }}**. + 1. Click the cluster name. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To get {{ dataproc-name }} cluster details, run the command: + To get {{ dataproc-name }} cluster details, run the command: - ```bash - {{ yc-dp }} cluster get - ``` + ```bash + {{ yc-dp }} cluster get + ``` - You can get the cluster ID and name with a [list of clusters in the folder](#list). + You can get the cluster ID and name with a [list of clusters in the folder](#list). - API {#api} - Use the [get](../api-ref/Cluster/get.md) API method and include the cluster ID in the `clusterId` request parameter. + Use the [get](../api-ref/Cluster/get.md) API method and provide the cluster ID in the `clusterId` request parameter. - You can get the cluster ID with a [list of clusters in the folder](#list). + You can get the cluster ID with a [list of clusters in the folder](#list). {% endlist %} -## Viewing a list of operations in a cluster {#operations} +## Viewing operations with clusters {#operations} + +All actions with {{ dataproc-name }} clusters are logged as a list of operations. Each operation is assigned a unique ID. + +### Getting a list of operations {#get-operations} {% list tabs group=instructions %} - Management console {#console} - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_data-proc }}**. - 1. Click the cluster name and open the **{{ ui-key.yacloud.dataproc.switch_operations }}** tab. + To view operations with all {{ dataproc-name }} clusters, in the left-hand panel, select ![image](../../_assets/console-icons/list-check.svg) **{{ ui-key.yacloud.dataproc.switch_operations }}**. The list that opens also includes operations with the clusters that were deleted. + + You can get a list of operations for a specific resource. The steps below describe how you can do this for a {{ dataproc-name }} cluster. + + 1. In the [management console]({{ link-console-main }}), open the folder with the cluster. + 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_data-proc }}**. + 1. Select the cluster you need. + 1. Go to the ![image](../../_assets/console-icons/list-check.svg) **{{ ui-key.yacloud.dataproc.switch_operations }}** panel for the selected cluster. + + You will see a list of operations with the selected cluster. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} + + {% include [default-catalogue](../../_includes/default-catalogue.md) %} + + To get a list of operations for a {{ dataproc-name }} cluster, run this command: - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + ```bash + yc dataproc cluster list-operations + ``` - To get a list of operations, run the following command: + Result: - ```bash - {{ yc-dp }} cluster list-operations - ``` + ```text + +----------------------+---------------------+----------------------+---------------------+--------+--------------------------+ + | ID | CREATED AT | CREATED BY | MODIFIED AT | STATUS | DESCRIPTION | + +----------------------+---------------------+----------------------+---------------------+--------+--------------------------+ + | c9q2n4s13p5v******** | 2024-08-06 06:19:47 | ajej2i98kcjd******** | 2024-08-06 06:21:36 | DONE | Create Data Proc cluster | + +----------------------+---------------------+----------------------+---------------------+--------+--------------------------+ + ``` - You can get the cluster ID and name with a [list of clusters in the folder](#list). + You can get the cluster ID and name with a [list of clusters in the folder](#list). + + By default, information about operations is provided as text. To get detailed information, specify the `yaml` or `json` output data format using the `--format` flag: + + ```bash + yc dataproc cluster list-operations epdplu8jn7sr******** --format yaml + ``` + + Result: + + ```text + - id: c9q2n4s13p5v******** + description: Create Data Proc cluster + created_at: "2024-08-06T06:19:47.755364Z" + created_by: ajej2i98kcjd******** + modified_at: "2024-08-06T06:21:36.095300Z" + done: true + metadata: + '@type': type.googleapis.com/yandex.cloud.dataproc.v1.CreateClusterMetadata + cluster_id: c9q77tr1aq3g******** + response: + '@type': type.googleapis.com/yandex.cloud.dataproc.v1.Cluster + ... + ``` - API {#api} - Use the [listOperations](../api-ref/Cluster/listOperations.md) API method and provide the cluster ID in the `clusterId` request parameter. + Use the [listOperations](../api-ref/Cluster/listOperations.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/ListOperations](../api-ref/grpc/Cluster/listOperations.md) gRPC API call and provide the cluster ID in the request. - You can get the cluster ID with a [list of clusters in the folder](#list). + You can get the cluster ID with a [list of clusters in the folder](#list). {% endlist %} + +### Getting detailed information about an operation {#get-operations-info} + +1. [Get a list of operations](#get-operations) for a cluster. +1. Copy the operation ID. +1. Get detailed information about the operation: + + {% list tabs group=instructions %} + + - CLI {#cli} + + {% include [cli-install](../../_includes/cli-install.md) %} + + {% include [default-catalogue](../../_includes/default-catalogue.md) %} + + Run this command: + + ```bash + yc operation get + ``` + + Result: + + ```text + id: c9q2n4s13p5v******** + description: Create Data Proc cluster + created_at: "2024-08-06T06:19:47.755364Z" + created_by: ajej2i98kcjd******** + modified_at: "2024-08-06T06:21:36.095300Z" + done: true + metadata: + '@type': type.googleapis.com/yandex.cloud.dataproc.v1.CreateClusterMetadata + cluster_id: c9q77tr1aq3g******** + response: + '@type': type.googleapis.com/yandex.cloud.dataproc.v1.Cluster + ... + ``` + + - API {#api} + + Use the [OperationService/Get](../api-ref/grpc/Operation/get.md) gRPC API call and provide the operation ID in the request. + + {% endlist %} + +### See also {#see-also} + +* [{#T}](../../api-design-guide/concepts/about-async.md) \ No newline at end of file diff --git a/en/data-proc/operations/connect-interfaces.md b/en/data-proc/operations/connect-interfaces.md index d747ff5e44a..c8d2a66c017 100644 --- a/en/data-proc/operations/connect-interfaces.md +++ b/en/data-proc/operations/connect-interfaces.md @@ -37,7 +37,7 @@ You can connect to {{ dataproc-name }} component interfaces either using [UI Pro Use the [update](../api-ref/Cluster/update.md) API method and include the following in the request: * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md#list). - * `uiProxy` parameter set to `true`. + * `true` in the `uiProxy` parameter. * List of updatable cluster configuration fields in the `updateMask` parameter (in this case, `uiProxy`). {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} diff --git a/en/data-proc/release-notes/images.md b/en/data-proc/release-notes/images.md index a2851555a3a..bc723381491 100644 --- a/en/data-proc/release-notes/images.md +++ b/en/data-proc/release-notes/images.md @@ -189,7 +189,7 @@ For a complete list of current and deprecated {{ dataproc-name }} images, see [{ * Tez to 0.10.0 * Zeppelin to 0.9.0 -* Deprecated components were removed: +* Deprecated components have been removed: * Flume * Sqoop diff --git a/en/data-streams/concepts/glossary.md b/en/data-streams/concepts/glossary.md index 68c79934902..b61a081ad43 100644 --- a/en/data-streams/concepts/glossary.md +++ b/en/data-streams/concepts/glossary.md @@ -19,6 +19,8 @@ As for now, you can only reduce the number of shards in a stream by deleting and {% endnote %} +You can configure a data stream to increase the number of shards as the write speed into the stream increases. For more information, see [autopartitioning in the {{ ydb-short-name }} documentation](https://ydb.tech/docs/en/concepts/topic#partitioning). + ### Shard key {#partition-key} A shard key is specified for each [message](#message) while writing it to a stream. Using the key hash, the message is mapped to a certain shard inside the stream. @@ -31,7 +33,7 @@ When updating the number of stream shards, their distribution across the key has ### Shard throughput {#shard-thoughput} -Each shard has a limited user-defined throughput. The maximum data input per shard is 1 MB/sec and the maximum data output is 2 MB/sec. +Each shard has a limited user-defined throughput. The maximum data write speed per shard is 1 MB/sec and the maximum data read speed is 2 MB/sec. ## Message {#message} @@ -41,7 +43,7 @@ It consists of a [body](#message-body) and additional system properties. ### Message body {#message-body} -The message body is a set of bytes. {{ yds-name }} doesn't interpret the message body in any way. +The body of a message is a set of bytes. {{ yds-name }} does not interpret the message body in any way. ### Message sequence number {#sequence-number} @@ -57,4 +59,4 @@ Consumers are applications that get data from {{ yds-name }} and process it. All ## Consumer groups {#extended-consumers} -In some cases, a [quota]({{ link-console-quotas }}) model that is common for all consumers is too restrictive, so each consumer is provided a guaranteed read speed. Consumers with a guaranteed read speed are called _consumer groups_. \ No newline at end of file +In some cases, the common [quota]({{ link-console-quotas }}) model for all consumers is too restrictive, so each consumer gets a guaranteed read speed. Consumers with a guaranteed read speed are called _consumer groups_. diff --git a/en/data-streams/concepts/topic-table-transactions.md b/en/data-streams/concepts/topic-table-transactions.md new file mode 100644 index 00000000000..3fa88c070d2 --- /dev/null +++ b/en/data-streams/concepts/topic-table-transactions.md @@ -0,0 +1,5 @@ +# Transactions involving data streams and tables + +{{ yds-name }} supports transactions that involve {{ ydb-short-name }} data streams and tables. Any data stream or table involved in such a transaction must be located in the same {{ ydb-short-name }} DB. In this way, you can employ transactions to move data from tables to data streams and vice versa. Also, you can do so between data streams to avoid your data beings lost or duplicated even under unforeseen circumstances. + +To learn more about transactional operations involving data streams, see [the YDB documentation]({{ ydb.docs }}/concepts/transactions#topic-table-transactions). diff --git a/en/data-streams/quickstart/fluentd.md b/en/data-streams/quickstart/fluentd.md index e75565be91b..7b2eb4fece7 100644 --- a/en/data-streams/quickstart/fluentd.md +++ b/en/data-streams/quickstart/fluentd.md @@ -1,6 +1,6 @@ --- -title: Tutorial on collecting and delivering data to {{ ydb-full-name }} using Fluentd -description: In this tutorial, you'll learn how to collect and deliver data to {{ ydb-full-name }} using Fluentd. +title: Tutorial on collecting and delivering {{ ydb-full-name }} data using Fluentd +description: In this tutorial, you will learn how to collect and deliver {{ ydb-full-name }} data using Fluentd. --- # Fluentd @@ -18,9 +18,9 @@ description: In this tutorial, you'll learn how to collect and deliver data to { 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_data-streams }}**. 1. Select the data stream. 1. Click **{{ ui-key.yacloud.data-streams.button_connect }}** and go to the **Fluentd** tab. -1. Copy a sample configuration file and paste it into the `/etc/td-agent/td-agent.conf` file. +1. Copy the configuration file example and paste it into the `/etc/td-agent/td-agent.conf` file. - Sample configuration file: + Example of the configuration file: ```xml @@ -62,7 +62,10 @@ description: In this tutorial, you'll learn how to collect and deliver data to { 1. Send the test data to Fluentd: ```bash - curl -X POST -d 'json={"user_id":"user1", "score": 100}' http://localhost:8888/kinesis + curl \ + --request POST \ + --data 'json={"user_id":"user1", "score": 100}' \ + http://localhost:8888/kinesis ``` If the setup is successful, the Fluentd `/var/log/td-agent/td-agent.log` operation log will include a message about receiving the data and sending it to {{ yds-full-name }} over the AWS Kinesis Data Streams protocol: diff --git a/en/data-streams/quickstart/logstash.md b/en/data-streams/quickstart/logstash.md index 13892ae7e3c..8fcbe9efd55 100644 --- a/en/data-streams/quickstart/logstash.md +++ b/en/data-streams/quickstart/logstash.md @@ -1,6 +1,6 @@ --- -title: Tutorial on collecting and delivering data to {{ ydb-full-name }} using Logstash -description: In this tutorial, you'll learn how to collect and deliver data to {{ ydb-full-name }} using Logstash. +title: Tutorial on collecting and delivering {{ ydb-full-name }} data using Logstash +description: In this tutorial, you will learn how to collect and deliver {{ ydb-full-name }} data using Logstash. --- # Logstash @@ -24,7 +24,7 @@ description: In this tutorial, you'll learn how to collect and deliver data to { 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_data-streams }}**. 1. Select the data stream. 1. Click **{{ ui-key.yacloud.data-streams.button_connect }}** and go to the **Logstash** tab. -1. Copy the sample configuration file and paste it into the `/usr/share/logstash/bin/mypipeline.conf` file. +1. Copy the configuration file example and paste it into the `/usr/share/logstash/bin/mypipeline.conf` file. Sample configuration file: @@ -61,7 +61,10 @@ description: In this tutorial, you'll learn how to collect and deliver data to { 1. Send test data to Logstash: ```bash - curl -H "content-type: application/json" -XPUT 'http://127.0.0.1:8888/kinesis' -d '{"user_id":"user1", "score": 100}' + curl \ + --request PUT 'http://127.0.0.1:8888/kinesis' \ + --header "content-type: application/json" \ + --data '{"user_id":"user1", "score": 100}' ``` If the setup was a success, a message will appear in the Logstash console about receiving data and sending it to {{ yds-name }} over the AWS Kinesis Data Streams protocol: diff --git a/en/data-streams/toc.yaml b/en/data-streams/toc.yaml index 86355be0b55..2ece3c2d8e4 100644 --- a/en/data-streams/toc.yaml +++ b/en/data-streams/toc.yaml @@ -59,6 +59,8 @@ items: href: concepts/limits.md - name: Comparison with Yandex Message Queue href: concepts/yds-ymq-comparison.md + - name: Transactions involving data streams and YDB tables + href: concepts/topic-table-transactions.md - name: Tutorials items: - name: Entering data into storage systems @@ -87,7 +89,7 @@ items: href: tutorials/static-key-in-lockbox.md - name: >- Streaming {{ postbox-full-name }} events to {{ yds-full-name }} and - analyzing them using {{ datalens-full-name }} + analyzing them with {{ datalens-full-name }} href: tutorials/events-from-postbox-to-yds.md - name: Access management href: security/index.md diff --git a/en/data-transfer/concepts/data-transformation.md b/en/data-transfer/concepts/data-transformation.md index 5ece2ebb55e..a8c7da726ab 100644 --- a/en/data-transfer/concepts/data-transformation.md +++ b/en/data-transfer/concepts/data-transformation.md @@ -36,7 +36,7 @@ You can hash data as follows: A transfer splits the `X` table into multiple tables (`X_1`, `X_2`, …, `X_n`) based on data. If a row was located in the `X` table before it was split, it is now in the `X_i` table, where `i` is decided by the following: column list and split string. -> Example: +> Examples: > If the column list features two columns – `month of birth` and `gender` – and the split string states `@`, the information about the employee John, born February 11, 1984, will get from the `Employees` table into the `Employees@February@male` table, which is the new table name. To partition tables: diff --git a/en/data-transfer/operations/endpoint/source/mongodb.md b/en/data-transfer/operations/endpoint/source/mongodb.md index a028a74534f..861680667d7 100644 --- a/en/data-transfer/operations/endpoint/source/mongodb.md +++ b/en/data-transfer/operations/endpoint/source/mongodb.md @@ -24,7 +24,7 @@ description: In this tutorial, you will learn how to configure a {{ MG }} source 1. {% include [storage](../../../../_includes/data-transfer/scenario-captions/storage.md) %} -For a detailed description of possible {{ data-transfer-full-name }} data transfer scenarios, see [Tutorials](../../../tutorials/index.md). +For a detailed description of possible {{ data-transfer-full-name }} scenarios, see [Tutorials](../../../tutorials/index.md). ## Preparing the source database {#prepare} @@ -232,10 +232,10 @@ If a source workload is high (over 10,000 write transactions per second), we rec Configure one of the supported data targets: -* [{{ objstorage-full-name }}](../target/object-storage.md). -* [{{ MG }}](../target/mongodb.md). +* [{{ objstorage-full-name }}](../target/object-storage.md) +* [{{ MG }}](../target/mongodb.md) -For a complete list of supported sources and targets in {{ data-transfer-full-name }}, see [Available Transfers](../../../transfer-matrix.md). +For a complete list of supported sources and targets in {{ data-transfer-full-name }}, see [Available transfers](../../../transfer-matrix.md). After configuring the data source and target, [create and start the transfer](../../transfer.md#create). diff --git a/en/data-transfer/operations/endpoint/source/mysql.md b/en/data-transfer/operations/endpoint/source/mysql.md index 50141fa3ff4..dd08e6e63e1 100644 --- a/en/data-transfer/operations/endpoint/source/mysql.md +++ b/en/data-transfer/operations/endpoint/source/mysql.md @@ -25,8 +25,8 @@ description: In this tutorial, you will learn how to configure a {{ MY }} source 1. {% include [cdc](../../../../_includes/data-transfer/scenario-captions/cdc.md) %} - * [{{ MY }} change data capture and delivery to {{ DS }}](../../../tutorials/mmy-to-yds.md). - * [{{ MY }} change data capture and delivery to {{ KF }}](../../../tutorials/cdc-mmy.md). + * [Capturing changes from {{ MY }} and delivering to {{ DS }}](../../../tutorials/mmy-to-yds.md). + * [Capturing changes from {{ MY }} and delivering to {{ KF }}](../../../tutorials/cdc-mmy.md). 1. {% include [data-mart](../../../../_includes/data-transfer/scenario-captions/data-mart.md) %} @@ -36,7 +36,7 @@ description: In this tutorial, you will learn how to configure a {{ MY }} source * [Loading {{ MY }} data to the {{ objstorage-name }} scalable storage](../../../tutorials/mmy-objs-migration.md). -For a detailed description of possible {{ data-transfer-full-name }} data transfer scenarios, see [Tutorials](../../../tutorials/index.md). +For a detailed description of possible {{ data-transfer-full-name }} scenarios, see [Tutorials](../../../tutorials/index.md). ## Preparing the source database {#prepare} @@ -145,7 +145,7 @@ For OnPremise, all fields are filled in manually. connection { on_premise { hosts = [""] - port = + port = } } database = "" @@ -280,7 +280,7 @@ Configure one of the supported data targets: * [{{ ES }}](../target/elasticsearch.md) * [{{ OS }}](../target/opensearch.md) -For a complete list of supported sources and targets in {{ data-transfer-full-name }}, see [Available Transfers](../../../transfer-matrix.md). +For a complete list of supported sources and targets in {{ data-transfer-full-name }}, see [Available transfers](../../../transfer-matrix.md). After configuring the data source and target, [create and start the transfer](../../transfer.md#create). @@ -293,7 +293,7 @@ After configuring the data source and target, [create and start the transfer](.. Known issues when using a {{ MY }} endpoint: * [Single transaction log size exceeds 4 GB](#binlog-size). -* [New tables are not added](#no-new-tables). +* [New tables cannot be added](#no-new-tables). * [Error when transferring from AWS RDS for {{ MY }}](#aws-binlog-time). * [Error when transferring tables without primary keys](#primary-keys). * [Binary log access error](#binlog-bytes). diff --git a/en/data-transfer/operations/transfer.md b/en/data-transfer/operations/transfer.md index 8766f249ec8..abd43cbab64 100644 --- a/en/data-transfer/operations/transfer.md +++ b/en/data-transfer/operations/transfer.md @@ -87,7 +87,7 @@ To move a transfer and [endpoints](../concepts/index.md#endpoint) to a different 1. In the left-hand panel, select ![image](../../_assets/console-icons/arrow-right-arrow-left.svg) **{{ ui-key.yacloud.data-transfer.label_connectors }}**. 1. Click **{{ ui-key.yacloud.data-transfer.button_create-transfer }}**. 1. Select the source endpoint or [create](./endpoint/index.md#create) a new one. - 1. Select the target endpoint or [create](./endpoint/index.md#create) a new one. Make sure the [subnet](../concepts/network.md) specified for the target endpoint belongs to the same availability zone as the subnet for the source enpoint. + 1. Select the target endpoint or [create](./endpoint/index.md#create) a new one. Make sure the [subnet](../concepts/network.md) specified for the target endpoint belongs to the same availability zone as the subnet for the source endpoint. 1. Specify the transfer parameters: * **{{ ui-key.yacloud.common.name }}**. * (Optional) **{{ ui-key.yacloud.common.description }}**. @@ -104,7 +104,7 @@ To move a transfer and [endpoints](../concepts/index.md#endpoint) to a different * For [billable](../pricing.md) source-target pairs at the [GA](../../overview/concepts/launch-stages.md) stage, you can configure the amount of computing resources per VM in the **Runtime environment** settings section. Select one of the three suggested configurations. The VM resource configuration determines the performance of the data transfer [workers](../concepts/index.md#worker). A separate VM is allocated for each worker. For vCPU and RAM pricing policy, calculation examples, and cost optimization recommendations, see [Pricing policy](../pricing.md). - * (Optional) **{{ ui-key.yc-data-transfer.data-transfer.console.form.transfer.console.form.transfer.Transfer.data_objects.title }}**: Specify the full path to each object to transfer. Only objects from this list will be transferred. If you have listed included tables or collections in the source endpoint settings, only objects that are on both these lists will be transfered. If you specify objects not listed among included tables or collections in the source endpoint settings, transfer activation will end with the `$table not found in source` error. This setting is not available for such sources as {{ KF }} and {{ DS }}. + * (Optional) **{{ ui-key.yc-data-transfer.data-transfer.console.form.transfer.console.form.transfer.Transfer.data_objects.title }}**: Specify the full path to each object to transfer. Only objects from this list will be transferred. If you have listed included tables or collections in the source endpoint settings, only objects that are on both these lists will be transfered. If you specify objects not listed among included tables or collections in the source endpoint settings, transfer activation will end with the `$table not found in source` error. This setting is not available for such sources as {{ KF }}, and {{ DS }}. Enter the full name of the object. Depending on the source type, use the appropriate naming convention: @@ -118,7 +118,7 @@ To move a transfer and [endpoints](../concepts/index.md#endpoint) to a different If the specified object is on the excluded table or collection list in the source endpoint settings, or the object name was entered incorrectly, the transfer will end with an error. A running {{ dt-type-repl }} or {{ dt-type-copy-repl }} transfer will terminate immediately; an inactive one will terminate as soon as activated. - * (Optional) **{{ ui-key.yc-data-transfer.data-transfer.console.form.transfer.console.form.transfer.Transfer.transformation.title }}**: Rules for [transforming data](../concepts/data-transformation.md). This setting only appears when the source and target are of different types. + * (Optional) **{{ ui-key.yc-data-transfer.data-transfer.console.form.transfer.console.form.transfer.Transfer.transformation.title }}**: [Data transformation](../concepts/data-transformation.md) rules. This setting only appears when the source and target are of different types. {% include [list-of-transformers](../../_includes/data-transfer/list-of-transformers.md) %} @@ -256,7 +256,7 @@ To move a transfer and [endpoints](../concepts/index.md#endpoint) to a different * For the [billable](../pricing.md) source-target pairs at the [GA](../../overview/concepts/launch-stages.md) stage, you can edit the amount of computing resources per VM in the **{{ ui-key.yc-data-transfer.data-transfer.console.form.transfer.console.form.transfer.Transfer.runtime.title }}** settings section. Select one of the three suggested configurations. The VM resource configuration determines the performance of the data transfer [workers](../concepts/index.md#worker). A separate VM is allocated for each worker. For vCPU and RAM pricing policy, calculation examples, and cost optimization recommendations, see [Pricing policy](../pricing.md). - * **{{ ui-key.yc-data-transfer.data-transfer.console.form.transfer.console.form.transfer.Transfer.data_objects.title }}**: Specify the full path to each object to transfer. Only objects from this list will be transferred. If you have listed included tables or collections in the source endpoint settings, only objects that are on both these lists will be transfered. If you specify objects not listed among included tables or collections in the source endpoint settings, transfer activation will end with the `$table not found in source` error. This setting is not available for such sources as {{ KF }} and {{ DS }}. + * **{{ ui-key.yc-data-transfer.data-transfer.console.form.transfer.console.form.transfer.Transfer.data_objects.title }}**: Specify the full path to each object to transfer. Only objects from this list will be transferred. If you have listed included tables or collections in the source endpoint settings, only objects that are on both these lists will be transfered. If you specify objects not listed among included tables or collections in the source endpoint settings, transfer activation will end with the `$table not found in source` error. This setting is not available for such sources as {{ KF }}, and {{ DS }}. Adding new objects to {{ dt-type-copy-repl }} or {{ dt-type-repl }} transfers in the {{ dt-status-repl }} status will result in uploading data history for these objects or tables. If a table is large, uploading the history may take a long time. You cannot edit the list of objects for transfers in the {{ dt-status-copy }} status. @@ -272,7 +272,7 @@ To move a transfer and [endpoints](../concepts/index.md#endpoint) to a different If the specified object is on the excluded table or collection list in the source endpoint settings, or the object name was entered incorrectly, the transfer will end with an error. A running {{ dt-type-repl }} or {{ dt-type-copy-repl }} transfer will terminate immediately; an inactive one will terminate as soon as activated. - * (Optional) **{{ ui-key.yc-data-transfer.data-transfer.console.form.transfer.console.form.transfer.Transfer.transformation.title }}**: Rules for [transforming data](../concepts/data-transformation.md). This setting only appears when the source and target are of different types. + * (Optional) **{{ ui-key.yc-data-transfer.data-transfer.console.form.transfer.console.form.transfer.Transfer.transformation.title }}**: [Data transformation](../concepts/data-transformation.md) rules. This setting only appears when the source and target are of different types. {% include [list-of-transformers](../../_includes/data-transfer/list-of-transformers.md) %} diff --git a/en/data-transfer/release-notes/2408.md b/en/data-transfer/release-notes/2408.md index 3b3a5444c49..42c75a16b11 100644 --- a/en/data-transfer/release-notes/2408.md +++ b/en/data-transfer/release-notes/2408.md @@ -15,4 +15,6 @@ description: This section outlines the changes made to {{ data-transfer-name }} ## Fixed issues {#problems-solved} -1. Refined the target cleanup policy in [{{ mch-name }}](../operations/endpoint/target/clickhouse.md) to fully support clusters without ZooKeeper. \ No newline at end of file +1. Refined the target cleanup policy in [{{ mch-name }}](../operations/endpoint/target/clickhouse.md) to fully support clusters without ZooKeeper. + +{% include [clickhouse-disclaimer](../../_includes/clickhouse-disclaimer.md) %} \ No newline at end of file diff --git a/en/data-transfer/release-notes/2409.md b/en/data-transfer/release-notes/2409.md new file mode 100644 index 00000000000..9b41160fcfc --- /dev/null +++ b/en/data-transfer/release-notes/2409.md @@ -0,0 +1,27 @@ +--- +title: '{{ data-transfer-full-name }} release notes: September 2024' +description: This section outlines the changes made to {{ data-transfer-name }} in September 2024. +--- + +# {{ data-transfer-name }} release notes: September 2024 + +## New features {#new-features} + + +1. Added the ability to specify a {{ connection-manager-name }} connection ID to configure [{{ mpg-short-name }}](../operations/endpoint/source/postgresql.md) endpoint authorization. + + +1. Added support for the `tombstones.on.delete` setting in the [Debezium serializer](https://debezium.io/documentation/reference/stable/transformations/applying-transformations-selectively.html#ignoring-tombstone-events). + +1. Added support for [shard groups](../../managed-clickhouse/operations/shard-groups.md) in [{{ CH }}](../operations/endpoint/source/clickhouse.md) endpoints. + +## Fixed issues {#problems-solved} + +1. In {{ PG }}, fixed the issue of duplicate data during the `UPDATE` replication in tables without a primary key. + +1. Improved activation error messages: now they display the actual error instead of `context canceled`. + +1. Improved the behavior of data transfers to a [{{ CH }} target](../operations/endpoint/target/clickhouse.md) for cases when a table is not available on some of the hosts in a single shard. + + +{% include [clickhouse-disclaimer](../../_includes/clickhouse-disclaimer.md) %} \ No newline at end of file diff --git a/en/data-transfer/release-notes/index.md b/en/data-transfer/release-notes/index.md index 47f944f3139..bf5c048cc39 100644 --- a/en/data-transfer/release-notes/index.md +++ b/en/data-transfer/release-notes/index.md @@ -5,6 +5,7 @@ description: This section contains {{ data-transfer-name }} release notes. # {{ data-transfer-name }} release notes +- [September 2024](2409.md) - [August 2024](2408.md) - [July 2024](2407.md) - [June 2024](2406.md) diff --git a/en/data-transfer/toc.yaml b/en/data-transfer/toc.yaml index 95c33de810b..d27819e9b62 100644 --- a/en/data-transfer/toc.yaml +++ b/en/data-transfer/toc.yaml @@ -3,7 +3,7 @@ href: index.yaml items: - name: Available transfers href: transfer-matrix.md - - name: Get started + - name: Getting started href: quickstart.md - name: Step-by-step guides items: @@ -393,6 +393,8 @@ items: items: - name: All release notes href: release-notes/index.md + - name: September 2024 + href: release-notes/2409.md - name: August 2024 href: release-notes/2408.md - name: July 2024 diff --git a/en/data-transfer/troubleshooting/index.md b/en/data-transfer/troubleshooting/index.md index 869e5167804..5fa84b9c8a8 100644 --- a/en/data-transfer/troubleshooting/index.md +++ b/en/data-transfer/troubleshooting/index.md @@ -28,12 +28,12 @@ To detect a problem in time: If {{ data-transfer-name }} operation was disrupted during data transfer, try to localize and analyze the problem. You may find certain solutions in this article or other sections of our documentation. -| Issue source | Issue | Solution | +| Issue source | Issue | Solution | |-----------------------|-------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Endpoint | Lack of network accessibility or endpoint access permissions | Check source reading using the following charts: [Maximum data transfer delay](../operations/monitoring.md#sinker.pusher.time.row_max_lag_sec), [Number of source events](../operations/monitoring.md#publisher.data.changeitems), and [Reads](../operations/monitoring.md#publisher.data.bytes).
Check writing to the target using the following charts: [Maximum data transfer delay](../operations/monitoring.md#sinker.pusher.time.row_max_lag_sec), [Number of source events](../operations/monitoring.md#publisher.data.changeitems), [Number of target events](../operations/monitoring.md#sinker.pusher.data.changeitems), and [Reads](../operations/monitoring.md#publisher.data.bytes).
If the data can be read and written, check if there are any [DBMS-related restrictions](../operations/transfer.md).
Check the requirements for [preparing](../operations/prepare.md) and [setting up](../operations/index.md) the endpoint.
Check our [suggested solutions](#common). | -| Endpoint or transfer | Lack of physical resources for the transfer or endpoints | If the data can be read and written, check if there are enough physical resources on these charts: [CPU](../operations/monitoring.md#proc.cpu%7Cproc.guarantee.cpu) and [RAM](../operations/monitoring.md#proc.ram%7Cproc.guarantee.mem).
Read the guidelines for DBMS diagnostics. For example, [{{ MY }}](../../managed-mysql/operations/performance-diagnostics.md), [{{ MG }}](../../managed-mongodb/operations/performance-diagnostics.md), or [{{ PG }}](../../managed-postgresql/operations/performance-diagnostics.md). | -| Data | Outdated data due to changes in the data schema | See the different data transfer scenarios in the [{{ data-transfer-name }} tutorials](../tutorials/index.md) section. | -| Data | Outdated data due to large data volume | Allocate more workers for [parallel copying](../concepts/sharded.md) or [replication](../operations/transfer.md#create).
Split the tables into multiple transfers. | +| Endpoint | Lack of network accessibility or endpoint access permissions | Check source reading using the following charts: [Maximum data transfer delay](../operations/monitoring.md#sinker.pusher.time.row_max_lag_sec), [Number of source events](../operations/monitoring.md#publisher.data.changeitems), and [Reads](../operations/monitoring.md#publisher.data.bytes).
Check writing to the target using the following charts: [Maximum data transfer delay](../operations/monitoring.md#sinker.pusher.time.row_max_lag_sec), [Number of source events](../operations/monitoring.md#publisher.data.changeitems), [Number of target events](../operations/monitoring.md#sinker.pusher.data.changeitems), and [Reads](../operations/monitoring.md#publisher.data.bytes).
If the data can be read and written, check if there are any [DBMS-related restrictions](../operations/transfer.md).
Check the requirements for [preparing](../operations/prepare.md) and [setting up](../operations/index.md) the endpoint.
Check our [suggested solutions](#common). | +| Endpoint or transfer | Lack of physical resources for the transfer or endpoints | If the data can be read and written, check if there are enough physical resources on these charts: [CPU](../operations/monitoring.md#proc.cpu%7Cproc.guarantee.cpu) and [RAM](../operations/monitoring.md#proc.ram%7Cproc.guarantee.mem).
Read the guidelines for DBMS diagnostics. For example, [{{ MY }}](../../managed-mysql/operations/performance-diagnostics.md), [{{ MG }}](../../managed-mongodb/operations/performance-diagnostics.md), or [{{ PG }}](../../managed-postgresql/operations/performance-diagnostics.md). | +| Data | Outdated data due to changes in the data schema | See the different data transfer scenarios in the [{{ data-transfer-name }} tutorials](../tutorials/index.md) section. | +| Data | Outdated data due to large data volume | Allocate more workers for [parallel copying](../concepts/sharded.md) or [replication](../operations/transfer.md#create).
Split the tables into multiple transfers. | After solving the problem, depending on the status of the transfer, activate it or change the data transfer limits of the running transfer. @@ -205,7 +205,7 @@ Error example: -## Who to report the problem to {#support} +## Who to report your problem to {#support} If you tried the above suggestions but the problem persists, contact [support]({{ link-console-support }}). diff --git a/en/data-transfer/tutorials/mmy-to-mgp.md b/en/data-transfer/tutorials/mmy-to-mgp.md index 7af058fa9eb..21c7489ed83 100644 --- a/en/data-transfer/tutorials/mmy-to-mgp.md +++ b/en/data-transfer/tutorials/mmy-to-mgp.md @@ -1,3 +1,7 @@ +--- +canonical: '{{ link-docs }}/tutorials/dataplatform/mmy-to-mgp' +--- + # Migrating data from {{ mmy-full-name }} to {{ mgp-full-name }} {% include notitle [article-body](../../_tutorials/dataplatform/mmy-to-mgp.md) %} diff --git a/en/data-transfer/tutorials/mongodb-versions.md b/en/data-transfer/tutorials/mongodb-versions.md index dec709f0b59..e72ca76e8b1 100644 --- a/en/data-transfer/tutorials/mongodb-versions.md +++ b/en/data-transfer/tutorials/mongodb-versions.md @@ -1,3 +1,7 @@ +--- +canonical: '{{ link-docs }}/tutorials/dataplatform/mongodb-versions' +--- + # Migrating {{ mmg-full-name }} cluster from 4.4 to 6.0 {% include notitle [article-body](../../_tutorials/dataplatform/datatransfer/mongodb-versions.md) %} diff --git a/en/data-transfer/tutorials/object-storage-to-greenplum.md b/en/data-transfer/tutorials/object-storage-to-greenplum.md index 14509b7a905..d679f938f96 100644 --- a/en/data-transfer/tutorials/object-storage-to-greenplum.md +++ b/en/data-transfer/tutorials/object-storage-to-greenplum.md @@ -1,3 +1,7 @@ +--- +canonical: '{{ link-docs }}/tutorials/dataplatform/object-storage-to-greenplum' +--- + # Loading data from {{ objstorage-name }} to a {{ GP }} data mart {% include notitle [article-body](../../_tutorials/dataplatform/object-storage-to-greenplum.md) %} diff --git a/en/datalens/concepts/chart/settings.md b/en/datalens/concepts/chart/settings.md index 6d6f7d27d34..a6108b9a8b4 100644 --- a/en/datalens/concepts/chart/settings.md +++ b/en/datalens/concepts/chart/settings.md @@ -29,16 +29,16 @@ The settings specified below may not be available for some chart types. * **On**: Displays a sum in a tooltip. * **Off**: Hides a sum in a tooltip. || -|| Navigator | Displays an additional element below the chart, the navigator. It helps to reduce a selection of data displayed in the chart.

Possible values: +|| Navigator | Displays an additional element below the chart, the navigator. Allows reducing a data selection displayed in the chart.

Possible values: * **On**: Shows the navigator. * **Off**: Hides the navigator. For more information, see [this guide](../../operations/chart/config-chart-navigator.md). || -|| Pagination | Splits a table into pages.

Possible values: +|| Pagination | Breaks a table into pages.

Possible values: -* **On**: Displays the table in parts across pages. -* **Off**: Displays the entire table. || +* **On**: Displays the table part by part across a number of pages. +* **Off**: Displays the whole table. || || Limit | Sets the number of rows to export. This is also the number of rows displayed per page. Available if **Pagination** is enabled. || || Grouping | Displays unique field values.

Possible values: @@ -61,7 +61,7 @@ To open settings of a dimension or a measure, click the icon to the left of its {% note info %} -If you apply aggregation to a dimension, it will work as a measure, and the measure settings will become available. +If you apply an aggregation to the dimension, it will become a measure and the relevant settings will become available for it. {% endnote %} @@ -69,33 +69,36 @@ If you apply aggregation to a dimension, it will work as a measure, and the meas #| || **Name** | **Description** || -|| Name | Sets a dimension name. || -|| Type | Sets the type of dimension data. || -|| Grouping | Sets the type of grouping or rounding. The setting is only available for dimensions of the `Date` and `Date and time` type. || -|| Format | Sets the format of how the values are displayed. || -|| Date mode | Sets the date display mode. This setting is only available for dimensions of the `Date` and `Date and time` type.>
Possible values: +|| Parameter | Sets dimension name. || +|| Type | Sets dimension data type. || +|| Grouping | Sets grouping or rounding type. The setting is only available for dimensions of the `Date` and `Date and time` type. || +|| Format | Sets value display format. || +|| Date mode | Sets date display mode. This setting is only available for dimensions of the `Date` and `Date and time` type.>
Possible values: * **Continuous**: Displays all dates continuously. * **Discrete**: Displays dates that contain values. || -|| Aggregation | Sets the aggregation type. Aggregation functions are available according to the [{#T}](../../dataset/data-model.md#aggregation) table. || +|| Aggregation | Sets aggregation type. Aggregation functions are available according to the [{#T}](../../dataset/data-model.md#aggregation) table. || +|| Markdown | The field value will be formatted according to [{#T}](../../dashboard/markdown.md). Only available for `String` type fields. || +|| Sub-totals | Shows columns and/or rows with subtotals. This setting is only available for [Pivot table](../../visualization-ref/pivot-table-chart.md) charts. || |# ### Measures {#indicator-settings} #| || **Name** | **Description** || -|| Name | Sets the measure name. || -|| Type | Sets the type of measure data. Not available for [QL charts](./ql-charts.md). || -|| Aggregation | Sets the aggregation type. Aggregation functions are available according to the [{#T}](../../dataset/data-model.md#aggregation) table. Not available for [QL charts](./ql-charts.md). || -|| Format | Sets the format of how the values are displayed. || -|| Decimal places | Sets the number of characters displayed after the decimal point in a value. Not available for [QL charts](./ql-charts.md). || +|| Parameter | Sets measure name. || +|| Type | Sets measure data type. Not available for [QL charts](./ql-charts.md). || +|| Aggregation | Sets aggregation type. Aggregation functions are available according to the [{#T}](../../dataset/data-model.md#aggregation) table. Not available for [QL charts](./ql-charts.md). || +|| Markdown | The field value will be formatted according to [{#T}](../../dashboard/markdown.md). Only available for `String` type fields. || +|| Format | Sets value display format. || +|| Decimal places | Sets the number of characters displayed after the decimal point. Not available for [QL charts](./ql-charts.md). || || Display groups of thousands | Enables displaying groups of thousands for numeric values.

Possible values: * **With separator**: Displays spaces between groups of thousands. * **Merged**: Hide spaces between groups of thousands. || -|| Prefix | Sets a text displayed before a value. || -|| Postfix | Sets a text displayed after a value. || -|| Dimension | Sets a rounding scale of values. || +|| Prefix | Sets the text displayed before a value. || +|| Postfix | Sets the text displayed after a value. || +|| Dimension | Sets the rounding scale for values. || |# ## Section settings {#section-settings} @@ -122,29 +125,29 @@ Some of these settings may not be available for some axes. #| || **Name** | **Description** || -|| Axis name | Sets an axis label.

Possible values: +|| Axis name | Sets axis label.

Possible values: -* **On**: Uses the field name. If the section contains multiple fields, {{ datalens-short-name }} uses the name of the field listed first. +* **On**: Use the field name. If the section contains multiple fields, {{ datalens-short-name }} uses the name of the field listed first. * **Off**: No axis label displayed. -* **Manually**: Allows you to set an axis name manually in a text field. || -|| Axis type | Defines the axis type. This setting is available if fields in the axis section are of the `Fractional number` type.

Possible values: +* **Manually**: Allows setting an axis name manually in a text field. || +|| Axis type | Defines axis type. This setting is available if fields in the axis section are of the `Fractional number` type.

Possible values: -* **Linear**: Sets a linear axis. -* **Logarithmic**: Sets a logarithmic axis. Use it for charts with a large range of values. A logarithmic axis allows you to display a fast-growing graph in a convenient form for analysis, reducing values by an order of magnitude. || +* **Linear**: Use linear axis. +* **Logarithmic**: Use logarithmic axis. Suitable for charts with a large spread of values. The logarithmic axis allows you to display a fast-growing graph in a convenient form for analysis, reducing values by an order of magnitude. || || Display mode | Enables configuring continuous chart display.

Possible values: * **Discrete**: Plots the chart only for non-null values. -* **Continuous**: Plots the chart all values continuously. You can only use continuous mode for the `Integer`, `Decimal`, `Date`, or `Date and time` data types. || +* **Continuous**: Plots the chart for all values continuously. You can only use continuous mode for the `Integer`, `Decimal`, `Date`, or `Date and time` data types. || || Axis formatting | Sets the formatting of numerical axis labels.

Possible values: * **Auto**: Default formatting. -* **By first field on the X axis**: Displays the X axis labels with formatting as specified in the **Format** setting for the first field in the **X** section. Available in the X axis settings. -* **By first field on the Y axis**: Displays the Y axis labels with formatting as specified in the **Format** setting for the first field in the **Y** section. Available in the Y axis settings. || -|| Grid | Enables or disables grid display in a chart.

Possible values: +* **By first field on the X axis**: Displays the X axis labels with the formatting specified in the **Format** setting for the first field in the **X** section. Available in the X axis settings. +* **By first field on the Y axis**: Displays the Y axis labels with the formatting specified in the **Format** setting for the first field in the **Y** section. Available in the Y axis settings. || +|| Grid | Enables/disables grid display in a chart.

Possible values: * **On**: Shows the grid. * **Off**: Hides the grid. || -|| Grid increments, px | Sets the grid increment in pixels. Available if **Grid** is enabled.

Possible values: +|| Grid increments, px | Sets grid increment in pixels. Available if **Grid** is enabled.

Possible values: * **Auto**: Calculates grid size automatically. * **Manually**: Requires manual input of grid size in pixels. || @@ -158,7 +161,7 @@ Some of these settings may not be available for some axes. * **Horizontal**: Displays axis labels horizontally. * **Vertical**: Displays axis labels vertically. * **Angled**: Displays axis labels at a 45-degree angle. || -|| Null values | Allows you to select a method for handling null values.

Possible values: +|| Null values | Allows selecting a null value handling method.

Possible values: * **Hide**: Hides null values in charts. * **Connect**: Connects field values where there are null values in between. @@ -177,12 +180,12 @@ The following settings are available for a tree diagram, a table (including a pi #| || **Name** | **Description** || -|| Gradient type | Sets the number of colors used in the gradient.

Possible values: +|| Gradient type | Sets the number of colors in the gradient.

Possible values: * **Two-color**: Sets two colors for the gradient. * **Tree-color**: Sets three colors for the gradient. || || Color | Sets a color for a value. Available colors depend on the gradient type. || -|| Set threshold values | Allows you to set threshold values that will refer to each color. || +|| Set threshold values | Allows setting threshold values for each color. || || Borders | Sets borders for geopolygons.

Possible values: * **Show**: Displays geopolygon borders. @@ -193,7 +196,8 @@ You can [create color palettes](../../operations/chart/create-palette.md) and us ### Labels {#sign} -This setting displays a measure value on the chart. +Labels display measure values on the chart. [Markup functions](../../function-ref/markup-functions.md) are supported. For `String` type fields, you can configure using basic [{#T}](../../dashboard/markdown.md) syntax: click the icon before the field name and enable **Markdown**. + Labels are available for the following charts types: @@ -219,7 +223,7 @@ Sorting is available for the following chart types: ### Filters {#filter} -These allow making a selection of values by dimension or measure. +Filters allow you to make a selection of values by dimension or measure. Filters are available for all chart types. @@ -236,9 +240,9 @@ Depending on the visualization type, different settings are available. #| || **Name** | **Description** || -|| Size | Sets point size depending on the measure value. || -|| Colors | Set a color for geopoints and geopolygons depending on the measure value. || -|| Tooltips | Create a tooltip displayed when you hover over a point. The tooltip contains dimension and measure values. || +|| Disk | Sets point size depending on the measure value. || +|| Colors | These set a color for geopoints and geopolygons depending on the measure value. || +|| Tooltips | These create a tooltip displayed when you hover over a point. The tooltip contains dimension and measure values. For `String` type fields, you can configure using basic [{#T}](../../dashboard/markdown.md) syntax: click the icon before the field name and enable **Markdown**. || || Layer filters | Create a selection by dimension or measure for the current layer. || || General filters | Create a selection by dimension or measure for the whole chart. || |# @@ -265,7 +269,7 @@ You can set a color for geopoints and geopolygons, which will depend on the meas #| || **Name** | **Description** || -|| Gradient type | Sets the number of colors used in the gradient.

Possible values: +|| Gradient type | Sets the number of colors in the gradient.

Possible values: * **Two-color**: Sets two colors for the gradient. * **Tree-color**: Sets three colors for the gradient. || @@ -274,7 +278,7 @@ You can set a color for geopoints and geopolygons, which will depend on the meas * **Show**: Displays geopolygon borders. * **Hide**: Hides geopolygon borders. || || Color | Sets a color for geopoints and geopolygons. Available colors depend on the gradient type. || -|| Set threshold values | Allows you to set threshold values that will refer to each color. || +|| Set threshold values | It allows you to set threshold values that will refer to each color. || |# You can [create color palettes](../../operations/chart/create-palette.md) and use them in your charts. diff --git a/en/datalens/reports/report-operations.md b/en/datalens/reports/report-operations.md index 5b49f6db07e..bc640b7adf6 100644 --- a/en/datalens/reports/report-operations.md +++ b/en/datalens/reports/report-operations.md @@ -17,7 +17,7 @@ In this section, you will learn how to work with a report: -There is a number of ways to create a report: +You can create a report in one of the following ways: {% list tabs %} @@ -27,7 +27,7 @@ There is a number of ways to create a report: 1. Open the [workbook](../workbooks-collections/index.md) to create a report in. 1. In the top-right corner, click **Create** and select **Report**. 1. [Add pages](#report-pages) to your report. - 1. [Add](#add-widget) the required [widgets](../dashboard/widget.md) to the pages. + 1. [Add](#add-widget) the [widgets](../dashboard/widget.md) you need to the pages. 1. [Configure your report](#report-settings) and its individual [pages](#page-settings). 1. In the top-right corner, click **Save**. 1. In the window that opens, enter a name for the report and click **Create**. @@ -37,7 +37,7 @@ There is a number of ways to create a report: 1. Go to the {{ datalens-short-name }} [home page]({{ link-datalens-main }}). 1. In the left-hand panel, select ![image](../../_assets/console-icons/display-pulse.svg) **Reports** and click **Create report**. 1. [Add pages](#report-pages) to your report. - 1. [Add](#add-widget) the required [widgets](../dashboard/widget.md) to the pages. + 1. [Add](#add-widget) the [widgets](../dashboard/widget.md) you need to the pages. 1. [Configure your report](#report-settings) and its individual [pages](#page-settings). 1. In the top-right corner, click **Save**. 1. In the window that opens, enter a name for the report and click **Create**. @@ -48,44 +48,44 @@ There is a number of ways to create a report: -You can [export](#report-export) the report you created. +You can [export](#report-export) the created report. ## Adding, moving, or deleting pages {#report-pages} -You can add multiple pages to a report, reorder, or delete them: +You can add multiple pages to a report, change their order, or delete them: * To add a page, click ![image](../../_assets/console-icons/plus.svg) **Add Page** at the bottom left. -* To duplicate a page, click the ![image](../../_assets/console-icons/ellipsis.svg) icon next to the page in the preview area and select ![icon](../../_assets/console-icons/copy.svg) **Duplicate**. +* To duplicate a page, in the preview area, click the ![image](../../_assets/console-icons/ellipsis.svg) icon next to the page and select ![icon](../../_assets/console-icons/copy.svg) **Duplicate**. * To change the order of pages, drag them to a new location using your mouse. * To delete a page, in the preview area, click the ![image](../../_assets/console-icons/ellipsis.svg) icon next the page and select ![icon](../../_assets/console-icons/trash-bin.svg) **Delete**. ## Configuring widgets {#report-widget-settings} -You can add, copy, or delete widgets in your report. If your widgets overlap, you can move them to the foreground or background. +You can add, copy, or delete widgets in your report. When overlapping widgets, you can move them to the foreground or background. ### Adding a widget {#add-widget} 1. Select the report page you want to add the widget to. -1. Select a widget: [Chart](../concepts/chart/index.md), [Text](../dashboard/widget.md#text), [Title](../dashboard/widget.md#title), or Image. To properly position your widget right away, drag it with the left mouse button held down. +1. Select a widget: [Chart](../concepts/chart/index.md), [Text](../dashboard/widget.md#text), [Title](../dashboard/widget.md#title), or Image. To immediately place the widget in the required location on the page, drag it with the left mouse button held down. 1. Configure your widget: - {% list tabs %} + {% list tabs group=widgets %} - - Chart + - Chart {#chart} - * **Name**: Widget name. If the **Show** option is enabled (default), the name is displayed at the top of the widget. + * **Name**: Widget name. If the **Show** option is enabled (by default), the name is displayed at the top of the widget. * **Chart**: Select a chart from the list of items or provide a link to your chart. * (Optional) **Description**: Text displayed at the bottom of the widget. * (Optional) Under **Parameters**, list [chart parameters](../dashboard/dashboard_parameters.md#params-chart) and set their default values. If no default values are set, the report will display an error. * (Optional) Set a background. - - Text + - Text {#text} * Enter the text of your link, clarifying caption, etc. The widget supports the [Markdown](../dashboard/markdown.md) markup language. {% note warning %} - If inserting an image from a {{ objstorage-full-name }} storage into your widget, configure the [CORS](../../storage/operations/buckets/cors.md) settings for the bucket containing the image: + If you are inserting an image hosted in the {{ objstorage-full-name }} storage into a widget, set the [CORS](../../storage/operations/buckets/cors.md) settings for the bucket containing the image: {% include [datalens-cors-settings-note](../../_includes/datalens/datalens-cors-settings-note.md) %} @@ -93,26 +93,26 @@ You can add, copy, or delete widgets in your report. If your widgets overlap, yo * (Optional) Set a background. - - Title + - Title {#header} * Enter title text. * Select size. * (Optional) Set a background. - - Image + - Image {#image} - * Add a link to an [image](../dashboard/markdown.md#image) from a [{{ objstorage-full-name }}](../../storage/quickstart.md) storage. + * Add a link to an [image](../dashboard/markdown.md#image) hosted in the [{{ objstorage-full-name }}](../../storage/quickstart.md) storage. {% note warning %} - In {{ objstorage-full-name }}, you must configure the [CORS](../../storage/operations/buckets/cors.md) settings for the bucket with the image: + In {{ objstorage-full-name }} you must set the [CORS](../../storage/operations/buckets/cors.md) settings for the bucket with the image: {% include [datalens-cors-settings-note](../../_includes/datalens/datalens-cors-settings-note.md) %} {% endnote %} * (Optional) Specify an alternative text to display if the image fails to load. - * (Optional) Disable maintaining the aspect ratio when resizing the widget. This option is enabled by default. + * (Optional) Disable the option to save the aspect ratio when resizing the widget. This option is enabled by default. * (Optional) Set a background. {% endlist %} @@ -121,7 +121,7 @@ You can add, copy, or delete widgets in your report. If your widgets overlap, yo 1. Resize the widget and move it to a convenient location on the page. 1. In the top-right corner, click **Save**. -You can copy and paste an existing widget onto the page: +You can copy and paste an already created widget onto the page: * From any page of the current report. @@ -130,25 +130,25 @@ You can copy and paste an existing widget onto the page: -To insert a copied widget onto a page: +To paste a copied widget onto a page: 1. Click the ![image](../../_assets/console-icons/ellipsis.svg) icon next to the widget you want to copy and select ![icon](../../_assets/console-icons/copy.svg) **Copy**. You can copy a widget from a dashboard in edit mode. -1. Select the report page you want to insert the widget onto. +1. Select the report page you want to paste the widget into. 1. On the widget panel at the top, click ![icon](../../_assets/console-icons/copy-plus.svg) **Insert**. 1. Resize the widget and move it to a convenient location on the page. 1. In the top-right corner, click **Save**. ### Deleting a widget {#delete-widget} -1. Select the report page the widget is on. +1. Select the report page the widget is located on. 1. Click the ![image](../../_assets/console-icons/ellipsis.svg) icon next to the widget and select ![icon](../../_assets/console-icons/trash-bin.svg) **Delete**. 1. In the top-right corner, click **Save**. ### Moving a widget to the foreground or background {#move-widget-front-or-back} -Widgets are arranged in layers overlapping each other. You can set the order of widgets on the page manually: +Widgets on the page are arranged in layers that overlap each other. You can set the order of widgets on the page manually: -1. Select the report page the widget is on. +1. Select the report page the widget is located on. 1. Click the ![image](../../_assets/console-icons/ellipsis.svg) icon next to the widget and select: * ![icon](../../_assets/console-icons/arrow-up-to-line.svg) **Foreground** to move the widget to the foreground. @@ -156,46 +156,46 @@ Widgets are arranged in layers overlapping each other. You can set the order of 1. In the top-right corner, click **Save**. -When you select or move a widget around the page, it is automatically overlaid on top of other widgets. As soon as you stop interacting with the widget, it returns to its layer. +When you select or move a widget around the page, it is automatically overlaid on top of other widgets. Once you stop working with the widget, it will return to its layer. ## Configuring a report {#report-settings} -Report settings are valid for all its pages: +Report settings apply to all its pages: 1. At the top right, click ![icon](../../_assets/console-icons/gear.svg) **Report settings**. 1. Customize the appearance: - * **Theme**: Select a page design theme, ![icon](../../_assets/console-icons/sun.svg) light or ![icon](../../_assets/console-icons/moon.svg) dark. - * **Background color**: Specify a color in hexadecimal format or select one from the color palette. - * **Format**: `A4` or `A3`. - * **Orientation**: `Album` or `Portrait`. + * **Theme**: Select a page design theme: ![icon](../../_assets/console-icons/sun.svg) light or ![icon](../../_assets/console-icons/moon.svg) dark. + * **Background color**: Specify a color in hexadecimal format or select a color from the color palette. + * **Format**: Select a format: `A4` or `A3`. + * **Orientation**: Select an orientation: `Album` or `Portrait`. -1. Configure footer settings: +1. Set footer settings: - * **{{ datalens-short-name }} standard footer** adds a footer: `Built in {{ datalens-full-name }}`. - * **First page footer**: Repeats the footer on the first page. By default, no footer is displayed on the first page. + * **{{ datalens-short-name }}** standard footer: Adds a footer: `Built in {{ datalens-full-name }}`. + * **First page footer**: Repeats the footer on the first page. By default, the footer is not displayed on the first page. * **Page numbering**: Adds a page number to the footer. ## Configuring pages {#page-settings} -You can use individual settings for each page, different from the general report settings. By default, all pages are subject to [report settings](#report-settings). +You can set individual settings for each page that differ from the general report settings. By default, the page is set to [report settings](#report-settings). {% note info %} -Page settings have a higher priority than the same report settings. If page settings are different from the same report settings, the former will override the latter. +Page settings have a higher priority than the same report settings. If the appropriate settings in the page settings have other values, they will be applied. {% endnote %} 1. Select the report page you need to configure. -1. At the top right, click ![icon](../../_assets/console-icons/gear.svg) **Page settings** and configure the settings as needed: +1. At the top right, click ![icon](../../_assets/console-icons/gear.svg) **Page settings** and enable the required settings: - * **Theme**: Page design theme, ![icon](../../_assets/console-icons/sun.svg) light or ![icon](../../_assets/console-icons/moon.svg) dark. - * **Background color**: Specify a color in hexadecimal format or select one from the color palette. - * **Format**: `A4` or `A3`. - * **Orientation**: `Album` or `Portrait`. + * **Theme**: Page design theme: ![icon](../../_assets/console-icons/sun.svg) light or ![icon](../../_assets/console-icons/moon.svg) dark. + * **Background color**: Specify a color in hexadecimal format or select a color from the color palette. + * **Format**: Page format: `A4` or `A3`. + * **Orientation**: Page orientation: `Album` or `Portrait`. 1. In the top-right corner, click **Save**. ## Exporting a report {#report-export} -To export a report, click **Export**. The report will be exported to a `.pdf` file. +To export a report, click **Export**. The report is exported to a file in `.pdf`. diff --git a/en/datalens/toc.yaml b/en/datalens/toc.yaml index 64ade778bbf..cdc02779ff1 100644 --- a/en/datalens/toc.yaml +++ b/en/datalens/toc.yaml @@ -48,7 +48,7 @@ items: Geocoding with the Yandex Maps API for data visualization in {{ datalens-short-name }} href: tutorials/data-from-ch-geocoder.md - - name: Visualizing data using heat maps + - name: Visualizing data using Heat Maps hidden: true href: tutorials/data-on-heat-map-dashboard.md - name: Status monitoring of geographically distributed devices @@ -1027,6 +1027,9 @@ items: - name: Failed to create hidden: true href: troubleshooting/errors/ERR-DS_API-DB-DB_OPERATIONAL_ERROR.md + - name: Invalid file format + hidden: true + href: troubleshooting/errors/ERR-FILE-PARSE_FAILED-INVALID_EXCEL.md - name: Cannot update data hidden: true href: troubleshooting/errors/ERR-FILE-CANNOT_UPDATE_DATA.md diff --git a/en/datalens/troubleshooting/errors/ERR-FILE-PARSE_FAILED-INVALID_EXCEL.md b/en/datalens/troubleshooting/errors/ERR-FILE-PARSE_FAILED-INVALID_EXCEL.md new file mode 100644 index 00000000000..7a21b650b2d --- /dev/null +++ b/en/datalens/troubleshooting/errors/ERR-FILE-PARSE_FAILED-INVALID_EXCEL.md @@ -0,0 +1,7 @@ +# Invalid file format + +`ERR.FILE.PARSE_FAILED.INVALID_EXCEL` + +This error occurs when attempting to upload an `.xlsx` file with incorrect metadata as a source for a [file](../../operations/connection/create-file.md) connection. For example, you may get this error if the file was obtained as a result of exporting from a database. + +To fix it, save the file in a spreadsheet editor such as Microsoft Excel. \ No newline at end of file diff --git a/en/datalens/troubleshooting/errors/all.md b/en/datalens/troubleshooting/errors/all.md index 55f71bad016..ac69fa37684 100644 --- a/en/datalens/troubleshooting/errors/all.md +++ b/en/datalens/troubleshooting/errors/all.md @@ -57,5 +57,6 @@ Error code | Description | [ERR.DS_API.US.BAD_REQUEST](ERR-DS_API-US-BAD_REQUEST.md) | Object request error | [ERR.FILE.CANNOT_UPDATE_DATA](ERR-FILE-CANNOT_UPDATE_DATA.md) | Cannot update data | [ERR.FILE.INVALID_LINK.YADOCS_INVALID_PUBLIC_LINK_PREFIX](ERR-FILE-INVALID_LINK-YADOCS_INVALID_PUBLIC_LINK_PREFIX.md) | Incorrect Yandex Documents link format | +[ERR.FILE.PARSE_FAILED.INVALID_EXCEL](ERR-FILE-PARSE_FAILED-INVALID_EXCEL.md) | Invalid file format | [ERR.FILE.UNSUPPORTED_DOCUMENT](ERR-FILE-UNSUPPORTED_DOCUMENT.md) | File check failed | [ERR.US.BAD_REQUEST.ALREADY_EXISTS](ERR-US-BAD_REQUEST-ALREADY_EXISTS.md) | Failed to create | diff --git a/en/datalens/visualization-ref/area-chart.md b/en/datalens/visualization-ref/area-chart.md index c27fc72bfa8..0b68994ce5a 100644 --- a/en/datalens/visualization-ref/area-chart.md +++ b/en/datalens/visualization-ref/area-chart.md @@ -8,36 +8,36 @@ It is handy to use this type of chart when it is important to see totals by cate {% cut "Source table" %} -| Year | Home appliances | Household goods | Household cleaners | ------ | ---------| ---------- | ---------- -| January 2019 | 128K | 55K | 26K | -| February 2019 | 97K | 79K | 18K | -| March 2019 | 187K | 105K | 41K | -| April 2019 | 188K | 137K | 34K | -| May 2019 | 230K | 121K | 43K | -| June 2019 | 256K | 162K | 59K | -| July 2019 | 284K | 206K | 67K | -| August 2019 | 409K | 204K | 72K | -| September 2019 | 314K | 209K | 86K | -| October 2019 | 324K | 262K | 79K | -| November 2019 | 385K | 238K | 101K | -| December 2019 | 451K | 307K | 111K | +Year | Home appliances | Household goods | Household cleaners +----- | ---------| ---------- | ---------- +January 2019| 128К | 55К | 26К +February 2019| 97К | 79К | 18К +March 2019| 187К | 105К | 41К +April 2019| 188К | 137К | 34К +May 2019| 230К | 121К | 43К +June 2019| 256К | 162К | 59К +July 2019| 284К | 206К | 67К +August 2019| 409К | 204К | 72К +September 2019| 314К | 209К | 86К +October 2019| 324К | 262К | 79К +November 2019| 385К | 238К | 101К +December 2019| 451К | 307К | 111К {% endcut %} -When building a chart, make sure to select measures carefully. For example, do not add the number of customers to the sales amount, or the purchase amount to the sales amount. +Be careful selecting the measures when building your chart. For example, do not add the number of customers to the sales amount, or the purchase amount to the sales amount. -## Sections in the wizard {#wizard-sections} +## Wizard sections {#wizard-sections} -| Wizard
section | Description | +Wizard
section| Description ----- | ---- -| X | Dimension. You can only specify one field here. This dimension is usually a date. If this is the case, make sure to specify the `Date` data type for this field in the dataset. This is required for correct sorting and signature display. For better visualization, you can group dates into weeks, months, and years. For more information, see [{#T}](../concepts/chart/settings.md#field-settings). | -| Y | Measure. You can specify multiple measures. If you add more than one measure to a section, the **Colors** section will contain a dimension named [Measure Names](../concepts/chart/measure-values.md). | -| Colors | [Measure Names](../concepts/chart/measure-values.md) dimension or field that affects the color of lines. To remove [Measure Names](../concepts/chart/measure-values.md), delete measures from the Y axis. | -| Sorting | Dimension or measure. You can use a dimension from the **X** and **Color** sections or a measure from the Y axis. This section affects the sorting of values on the X axis or areas along the Y axis. The sorting direction is marked with an icon next to the field: ![image](../../_assets/console-icons/bars-ascending-align-left.svg) ascending or ![image](../../_assets/console-icons/bars-descending-align-left.svg) descending. To change the sorting direction, click the icon. | -| Labels | Measure. Displays measure values on the chart. If multiple measures are added to the **Y** section, drag [Measure Values](../concepts/chart/measure-values.md) to this section. | -| Split | Dimension. Splits a chart horizontally by the selected dimension's values. The maximum number of splits per chart is 25. | -| Filters | Dimension or measure. Used as a filter. | +X | Dimension. You can only specify one field here. This dimension is usually a date. If this is the case, make sure to specify the `Date` data type for this field in the dataset. This is required for correct sorting and signature display. For better visualization, you can group dates into weeks, months, and years. For more information, see [{#T}](../concepts/chart/settings.md#field-settings). +Y | Measure. You can specify multiple measures. If you add more than one measure to a section, the **Colors** section will contain a dimension named [Measure Names](../concepts/chart/measure-values.md). +Colors | [Measure Names](../concepts/chart/measure-values.md) dimension or field. Affects the color of lines. To remove [Measure Names](../concepts/chart/measure-values.md), delete measures from the Y axis. +Sorting | Dimension or measure. You can use a dimension from the **X** and **Color** sections or a measure from the Y axis. This section affects the sorting of values on the X axis or areas along the Y axis. The sorting direction is marked with an icon next to the field: ![image](../../_assets/console-icons/bars-ascending-align-left.svg) for ascending or ![image](../../_assets/console-icons/bars-descending-align-left.svg) for descending. To change the sorting direction, click the icon. +Labels | Measure. Displays measure values on the chart. If multiple measures are added to the **Y** section, drag [Measure Values](../concepts/chart/measure-values.md) to this section. [Markup functions](../function-ref/markup-functions.md) are supported. For `String` type fields, you can configure using basic [{#T}](../dashboard/markdown.md) syntax: click the icon before the field name and enable **Markdown**. +Split | Dimension. Splits a chart horizontally by the selected dimension's values. The maximum number of splits per chart is 25. +Filters | Dimension or measure. Used as a filter. ## Creating an area chart {#create-diagram} @@ -55,7 +55,7 @@ To create an area chart: 1. Drag a dimension from the dataset to the **X** section. The values will be displayed in the lower part of the chart on the X axis. 1. Drag one or more measures from the dataset to the **Y** section. The values will be displayed as areas along the Y axis. -### Configuring the display of `null` values {#null-settings} +### Configuring display of `null` values {#null-settings} {% include [datalens-chart-null-settings](../../_includes/datalens/datalens-chart-null-settings.md) %} @@ -64,17 +64,17 @@ To create an area chart: * {% include [category-text](../../_includes/datalens/datalens-category-text.md) %} * Do not display more than three to five areas on the chart. * To make it easier to track the dynamics, place the largest or most important categories closer to the chart base. To do this, drag the measure to the **Sorting** section or set up their order in the **Y** section. For example, you can do so to track sales dynamics in the `Household cleaners` category. + + {% cut "Chart example" %} + + ![area-chart-sort](../../_assets/datalens/visualization-ref/area-chart/area-chart-sort.png) - {% cut "Chart example" %} - - ![area-chart-sort](../../_assets/datalens/visualization-ref/area-chart/area-chart-sort.png) - - {% endcut %} + {% endcut %} * You can split a chart by dimension into a number of small charts that are convenient to compare to one another. To do this, drag a dimension from the dataset to the **Split** section. - {% cut "Chart example" %} + {% cut "Chart example" %} - ![area-chart-split](../../_assets/datalens/visualization-ref/area-chart/area-chart-split.png) + ![area-chart-split](../../_assets/datalens/visualization-ref/area-chart/area-chart-split.png) - {% endcut %} + {% endcut %} diff --git a/en/datalens/visualization-ref/bar-chart.md b/en/datalens/visualization-ref/bar-chart.md index 15dfd5813d7..7eb6eb369fb 100644 --- a/en/datalens/visualization-ref/bar-chart.md +++ b/en/datalens/visualization-ref/bar-chart.md @@ -6,15 +6,15 @@ This chart displays the values of one or more measures by each category, using h {% cut "Source table" %} -| Subcategory | Sales | --------------|--------- -| Beauty and health products | 44K | -| Kitchenware | 1392K | -| Kitchen products | 1120K | -| Detergents | 405K | -| Health and beauty equipment | 1760K | -| Non-essential goods | 827K | -| Cleaners | 304K | +Subcategory | Sales +-------------|--------- +Beauty and health products | 44К +Kitchenware | 1392К +Kitchen products | 1120К +Detergents | 405К +Health and beauty equipment | 1760К +Non-essential goods | 827К +Cleaners | 304К {% endcut %} @@ -23,7 +23,7 @@ This chart displays the values of one or more measures by each category, using h * [Grouped](#groupped) * [Stacked](#stacked) -### With grouping {#groupped} +### Grouped {#groupped} A chart with grouping by dimension lets you compare two or more categories by a single measure. For example, grouping by delivery type allows you to compare the cost of products delivered by courier and picked up. Categories are highlighted in different colors and the length of the bar indicates the measure value. @@ -31,14 +31,14 @@ A chart with grouping by dimension lets you compare two or more categories by a {% cut "Source table" %} -| Subcategory | Delivery | Pickup | +Subcategory | Delivery | Pickup -------------|---------| ----------| -| Beauty and health products | 12K | 32K | -| Kitchenware | 394K | 998K | -| Kitchen products | 371K | 749K | -| Detergents | 127K | 278K | -| Health and beauty equipment | 497K | 1263K | -| Non-essential goods | 268K | 560K | +Beauty and health products | 12К | 32К +Kitchenware | 394К | 998К +Kitchen products | 371К | 749К +Detergents | 127К | 278К +Health and beauty equipment | 497К | 1,263К +Non-essential goods | 268К | 560К {% endcut %} @@ -48,15 +48,15 @@ Use a chart with grouping to compare two or more measures, such as the number of {% cut "Source table" %} -| Subcategory | Orders | Number of products | +Subcategory | Orders | Number of products -------------|---------| ----------| -| Beauty and health products | 481 | 1470 | -| Kitchenware | 758 | 2402 | -| Kitchen products | 480 | 1371 | -| Detergents | 835 | 2551 | -| Health and beauty equipment | 863 | 2705 | -| Non-essential goods | 705 | 2152 | -| Cleaners | 770 | 2460 | +Beauty and health products | 481 | 1,470 +Kitchenware | 758 | 2,402 +Kitchen products | 480 | 1,371 +Detergents | 835 | 2,551 +Health and beauty equipment | 863 | 2,705 +Non-essential goods | 705 | 2,152 +Cleaners | 770 | 2,460 {% endcut %} @@ -69,33 +69,33 @@ This type of chart is used to see the contribution of each measure to the total {% cut "Source table" %} -| Month | Gasoline | Rent | Food | Utility bills | ------ | ---------| ---------- | ---------- | ---------- -| January 2019 | 100 | 600 | 300 | 500 | -| February 2019 | 150 | 600 | 250 | 700 | -| March 2019 | 100 | 600 | 450 | 400 | -| April 2019 | 120 | 600 | 370 | 510 | -| May 2019 | 100 | 600 | 300 | 530 | -| June 2019 | 130 | 600 | 310 | 600 | -| July 2019 | 150 | 600 | 330 | 510 | -| August 2019 | 120 | 600 | 250 | 550 | -| September 2019 | 110 | 650 | 380 | 500 | -| October 2019 | 120 | 650 | 300 | 550 | -| November 2019 | 130 | 650 | 310 | 540 | -| December 2019 | 100 | 650 | 400 | 550 | +Month | Gasoline | Rent | Food | Utility bills +----- | ---------| ---------- | ---------- | ---------- +January 2019 | 100 | 600 | 300 | 500 +February 2019 | 150 | 600 | 250 | 700 +March 2019 | 100 | 600 | 450 | 400 +April 2019 | 120 | 600 | 370 | 510 +May 2019 | 100 | 600 | 300 | 530 +June 2019 | 130 | 600 | 310 | 600 +July 2019 | 150 | 600 | 330 | 510 +August 2019 | 120 | 600 | 250 | 550 +September 2019 | 110 | 650 | 380 | 500 +October 2019 | 120 | 650 | 300 | 550 +November 2019 | 130 | 650 | 310 | 540 +December 2019 | 100 | 650 | 400 | 550 {% endcut %} -## Sections in the wizard {#wizard-sections} +## Wizard sections {#wizard-sections} -| Wizard
section | Description | +Wizard
section| Description ----- | ---- -| Y | Dimensions. You can specify one or two dimensions. | -| X | Measure. You can specify multiple measures. If you add more than one measure to a section, the **Colors** section will contain a dimension named [Measure Names](../concepts/chart/measure-values.md). You can move [Measure Names](../concepts/chart/measure-values.md) to the Y axis. | -| Colors | [Measure Names](../concepts/chart/measure-values.md) dimension or field. Affects the column color. To delete [Measure Names](../concepts/chart/measure-values.md), click the cross icon or remove measures from the X axis. | -| Sorting | Dimension or measure. Affects the column sorting. The sorting direction is marked with an icon next to the field: ![image](../../_assets/console-icons/bars-ascending-align-left.svg) for ascending or ![image](../../_assets/console-icons/bars-descending-align-left.svg) for descending. To change the sorting direction, click the icon. | -| Labels | Measure. Displays measure values on the chart. If multiple measures are added to the **Y** section, drag [Measure Values](../concepts/chart/measure-values.md) to this section. | -| Filters | Dimension or measure. Used as a filter. | +Y | Dimensions. You can specify one or two dimensions. +X | Measure. You can specify multiple measures. If you add more than one measure to a section, the **Colors** section will contain a dimension named [Measure Names](../concepts/chart/measure-values.md). You can move [Measure Names](../concepts/chart/measure-values.md) to the Y axis. +Colors | [Measure Names](../concepts/chart/measure-values.md) dimension or field. Affects the column color. To delete [Measure Names](../concepts/chart/measure-values.md), click the cross icon or remove measures from the X axis. +Sorting | Dimension or measure. Affects the column sorting. The sorting direction is marked with an icon next to the field: ![image](../../_assets/console-icons/bars-ascending-align-left.svg) for ascending or ![image](../../_assets/console-icons/bars-descending-align-left.svg) for descending. To change the sorting direction, click the icon. +Labels | Measure. Displays measure values on the chart. If multiple measures are added to the **Y** section, drag [Measure Values](../concepts/chart/measure-values.md) to this section. [Markup functions](../function-ref/markup-functions.md) are supported. For `String` type fields, you can configure using basic [{#T}](../dashboard/markdown.md) syntax: click the icon before the field name and enable **Markdown**. +Filters | Dimension or measure. Used as a filter. ## Creating a bar chart {#create-diagram} @@ -122,22 +122,22 @@ To display an Y-axis grouped bar chart: 1. Go to the bar chart that you created. 1. Depending on the number of measures in the **X** section, follow these steps: - + {% list tabs group=indicators_number %} - + - Single measure {#one} - - 1. Check if there is a dimension in the **Colors** section. - 1. Duplicate this dimension in the **Y** section. The sequence of dimensions affects the grouping order. - + + 1. Check if there is a dimension in the **Colors** section. + 1. Duplicate this dimension in the **Y** section. The sequence of dimensions affects the grouping order. + - Two or more measures {#more} - - 1. Drag the [Measure Names](../concepts/chart/measure-values.md) dimension to the **Colors** section. - 1. Drag the [Measure Names](../concepts/chart/measure-values.md) dimension to the **Y** section. The sequence of dimensions affects the grouping order. + + 1. Drag the [Measure Names](../concepts/chart/measure-values.md) dimension to the **Colors** section. + 1. Drag the [Measure Names](../concepts/chart/measure-values.md) dimension to the **Y** section. The sequence of dimensions affects the grouping order. {% endlist %} -### Adding a bar color based on a measure {#column-colors} +### Adding a column color based on a measure {#column-colors} To color columns in a chart based on the value of a measure: @@ -146,7 +146,7 @@ To color columns in a chart based on the value of a measure: {% list tabs group=indicators_number %} - - Single measure {#one} + - Single measure {#one} Copy the measure from the **X** section to the **Colors** section. @@ -154,17 +154,17 @@ To color columns in a chart based on the value of a measure: ![image](../../_assets/datalens/operations/chart/bar-colors-1.png) - - Two or more measures {#more} + - Two or more measures {#more} Drag the [Measure Values](../concepts/chart/measure-values.md) measure to the **Colors** section. - The columns on the chart will take on colors depending on the values of all the measures listed in section **X**. + The chart columns will be colored based on the values of all measures listed in section **X**. ![image](../../_assets/datalens/operations/chart/bar-colors-2.png) {% endlist %} -1. Configure a color gradient for the measure as well. To do this, in the top right-hand corner of the **Colors** section, click ![image](../../_assets/console-icons/gear.svg) (the icon is displayed when you mouse over the section). +1. Configure a color gradient for the measure as well. To do this, in the top-right corner of the **Colors** section, click ![image](../../_assets/console-icons/gear.svg) (the icon appears when you hover over the section). 1. In the color settings, specify: * **Gradient type**: Select two or three colors. @@ -172,7 +172,7 @@ To color columns in a chart based on the value of a measure: * Gradient direction: Change the gradient direction using the ![image](../../_assets/console-icons/arrow-right-arrow-left.svg) icon. * **Set threshold values**: Set numeric thresholds for each color. Works if the **X** section contains a single value. -### Configuring the display of `null` values {#null-settings} +### Configuring display of `null` values {#null-settings} {% include [datalens-chart-null-settings](../../_includes/datalens/datalens-chart-null-settings.md) %} diff --git a/en/datalens/visualization-ref/choropleth-map-chart.md b/en/datalens/visualization-ref/choropleth-map-chart.md index 527af899024..173c7fe1cfb 100644 --- a/en/datalens/visualization-ref/choropleth-map-chart.md +++ b/en/datalens/visualization-ref/choropleth-map-chart.md @@ -21,7 +21,7 @@ Wizard
section| Description ----- | ---- Polygons (Geopolygons) | Measure of the [Geopolygon](../dataset/data-types.md#geopolygon) type Colors | Dimension or measure. Affects the color and intensity of area fill. -Tooltips | Dimension or measure. A tooltip that appears when you hover over an area. +Tooltips | Dimension or measure. A tooltip that appears when you hover over an area. For `String` type fields, you can configure using basic [{#T}](../dashboard/markdown.md) syntax: click the icon before the field name and enable **Markdown**. Layer filters | Dimension or measure. Used as a filter for the current layer. Filters | Dimension or measure. Used as a filter for the entire chart. @@ -35,7 +35,7 @@ Filters | Dimension or measure. Used as a filter for the entire chart. 1. In the left-hand panel, select ![chart](../../_assets/console-icons/chart-column.svg) **Charts**. 1. Click **Create chart** → **Chart**. 1. At the top left, click ![image](../../_assets/console-icons/circles-intersection.svg) **Select dataset** and specify the dataset to visualize. If you do not have a dataset, [create one](../dataset/create-dataset.md#create). -1. Select the **Map** chart type. +1. Select **Map** for chart type. 1. Select **Polygons (Geopolygons)** as the layer type. 1. Drag a dimension of the [Geopolygon](../dataset/data-types.md#geopolygon) type from the dataset to the layer type selection section. 1. Color the polygons on the map. Move the measure or dimension to the **Colors** section. diff --git a/en/datalens/visualization-ref/cluster-point-map-chart.md b/en/datalens/visualization-ref/cluster-point-map-chart.md index 6f3a1f8ca79..2a67be72607 100644 --- a/en/datalens/visualization-ref/cluster-point-map-chart.md +++ b/en/datalens/visualization-ref/cluster-point-map-chart.md @@ -30,10 +30,10 @@ Limitations: Wizard
section| Description ----- | ---- Points with clusters (Geopoints) | Measure of the [Geopoint](../dataset/data-types#geopoint) type -Point size | Measure. Sets a point size depending on the measure value. +Point size | Measure. Sets point size depending on the measure value. Colors | Dimension. Sets cluster chart segmentation. Labels | Measure. Displayed as text on a point. When used, point size control is blocked. -Tooltips | Dimension or measure. A tooltip that appears when you hover over a point. +Tooltips | Dimension or measure. A tooltip that appears when you hover over a point. For `String` type fields, you can configure using basic [{#T}](../dashboard/markdown.md) syntax: click the icon before the field name and enable **Markdown**. Layer filters | Dimension or measure. Used as a filter for the current layer. Filters | Dimension or measure. Used as a filter for the entire chart. @@ -47,7 +47,7 @@ Filters | Dimension or measure. Used as a filter for the entire chart. 1. In the left-hand panel, select ![chart](../../_assets/console-icons/chart-column.svg) **Charts**. 1. Click **Create chart** → **Chart**. 1. At the top left, click ![image](../../_assets/console-icons/circles-intersection.svg) **Select dataset** and specify the dataset to visualize. If you do not have a dataset, [create one](../dataset/create-dataset.md#create). -1. Select the **Map** chart type. +1. Select **Map** for chart type. 1. Select the **Points with clusters (Geopoints)** layer type. 1. Drag a dimension of the [Geopoint](../dataset/data-types#geopoint) type from the dataset to the layer type selection section. 1. Set the size of the points displayed on the point map. Drag a measure to the **Point size** section or click ![image](../../_assets/console-icons/gear.svg) in the line with the section name. diff --git a/en/datalens/visualization-ref/column-chart.md b/en/datalens/visualization-ref/column-chart.md index 92c7078fe59..6f888cb773f 100644 --- a/en/datalens/visualization-ref/column-chart.md +++ b/en/datalens/visualization-ref/column-chart.md @@ -7,13 +7,13 @@ Unlike line charts, this type of chart assumes that different periods are compar {% cut "Source table" %} -| Year | Sales | ------|---------| -| 2022 | 6M | -| 2021 | 28M | -| 2020 | 18M | -| 2019 | 9M | -| 2018 | 1M | +Year | Sales| +-----|---------| +2022| 6М| +2021| 28М| +2020| 18М| +2019| 9М| +2018| 1М| {% endcut %} @@ -22,7 +22,7 @@ Unlike line charts, this type of chart assumes that different periods are compar * [Grouped](#groupped) * [Stacked](#stacked) -### With grouping {#groupped} +### Grouped {#groupped} A chart with grouping lets you compare two or more measures: for example, the number of products delivered and the number picked up. The column height corresponds to the measure value. @@ -30,13 +30,13 @@ A chart with grouping lets you compare two or more measures: for example, the nu {% cut "Source table" %} -| Year | Delivery | Pickup | +Year | Delivery| Pickup -----|---------| ----------| -| 2022 | 2M | 4M | -| 2021 | 8M | 19M | -| 2020 | 5M | 13M | -| 2019 | 3M | 6M | -| 2018 | 331K | 918K | +2022| 2М| 4М +2021| 8М| 19М +2020| 5М| 13М +2019| 3М| 6М +2018| 331К| 918К {% endcut %} @@ -49,27 +49,27 @@ Since the sum of all segments is equal to the total length of a column, when col {% cut "Source table" %} -| Year | Delivery | Pickup | +Year | Delivery| Pickup -----|---------| ----------| -| 2022 | 2M | 4M | -| 2021 | 8M | 19M | -| 2020 | 5M | 13M | -| 2019 | 3M | 6M | -| 2018 | 331K | 918K | +2022| 2М| 4М +2021| 8М| 19М +2020| 5М| 13М +2019| 3М| 6М +2018| 331К| 918К {% endcut %} ## Wizard sections {#wizard-sections} -| Wizard
section | Description | +Wizard
section| Description ----- | ---- -| X | Dimensions. You can specify one or two dimensions. Affects X-axis value grouping. The order of specified dimensions affects the order of value grouping on the X-axis. For the `Date` and `Date and time` types, you can set grouping by time: minutes, hours, weeks, and so on. | -| Y | Measure. You can specify multiple measures. If you add more than one measure to a section, the **Colors** section will contain a dimension named [Measure Names](../concepts/chart/measure-values.md). | -| Colors | [Measure Names](../concepts/chart/measure-values.md) dimension or field. Affects the column color. To delete [Measure Names](../concepts/chart/measure-values.md), click the cross icon or remove measures from the Y axis. | -| Sorting | Dimension or measure. Affects the column sorting. Sorting only applies to dimensions used when building a chart. The sorting direction is marked with an icon next to the field: ![image](../../_assets/console-icons/bars-ascending-align-left.svg) for ascending or ![image](../../_assets/console-icons/bars-descending-align-left.svg) for descending. To change the sorting direction, click the icon. | -| Labels | Measure. Displays measure values on the chart. When using multiple measures for a signature, add [Measure Values](../concepts/chart/measure-values.md). | -| Split | Dimension. Splits a chart horizontally by the selected dimension's values. The maximum number of splits per chart is 25. | -| Filters | Dimension or measure. Used as a filter. A filter can be overridden by a dashboard selector if the selector is based on the same field. | +X | Dimensions You can specify one or two dimensions. Affects X-axis value grouping. The order of specified dimensions affects the order of value grouping on the X-axis. For the `Date` and `Date and time` types, you can set grouping by time: minutes, hours, weeks, and so on. +Y | Measure. You can specify multiple measures. If you add more than one measure to a section, the **Colors** section will contain a dimension named [Measure Names](../concepts/chart/measure-values.md). +Colors | [Measure Names](../concepts/chart/measure-values.md) dimension or field. Affects the column color. To delete [Measure Names](../concepts/chart/measure-values.md), click the cross icon or remove measures from the Y axis. +Sorting | Dimension or measure. Affects the column sorting. Sorting only applies to dimensions used when building a chart. The sorting direction is marked with an icon next to the field: ![image](../../_assets/console-icons/bars-ascending-align-left.svg) for ascending or ![image](../../_assets/console-icons/bars-descending-align-left.svg) for descending. To change the sorting direction, click the icon. +Labels | Measure. Displays measure values on the chart. When using multiple measures for a signature, add [Measure Values](../concepts/chart/measure-values.md). [Markup functions](../function-ref/markup-functions.md) are supported. For `String` type fields, you can configure using basic [{#T}](../dashboard/markdown.md) syntax: click the icon before the field name and enable **Markdown**. +Split | Dimension. Splits a chart horizontally by the selected dimension's values. The maximum number of splits per chart is 25. +Filters | Dimension or measure. Used as a filter. A filter can be overridden by a dashboard selector if the selector is based on the same field. ## Creating a column chart {#create-diagram} @@ -98,14 +98,14 @@ To display an X-axis grouped column chart: {% list tabs group=indicators_number %} - - Single measure {#one} + - Single measure {#one} 1. Check if there is a dimension in the **Colors** section. 1. Duplicate this dimension in the **X** section. The sequence of dimensions affects the grouping order. ![one-measure](../../_assets/datalens/visualization-ref/bar-chart/one-measure.png) - - Two or more measures {#more} + - Two or more measures {#more} 1. Drag the [Measure Names](../concepts/chart/measure-values.md) dimension to the **Colors** section. 1. Drag the [Measure Names](../concepts/chart/measure-values.md) dimension to the **X** section. The sequence of dimensions affects the grouping order. @@ -125,23 +125,23 @@ To color columns in a chart based on the value of a measure: - Single measure {#one} - Copy the measure from the **Y** section to the **Colors** section. + Copy the measure from the **Y** section to the **Colors** section. - Columns in the chart will take on colors as a function of the measure values. + Columns in the chart will take on colors as a function of the measure values. - ![image](../../_assets/datalens/operations/chart/column-colors-1.png) + ![image](../../_assets/datalens/operations/chart/column-colors-1.png) - Two or more measures {#more} - Drag the [Measure Values](../concepts/chart/measure-values.md) measure to the **Colors** section. + Drag the [Measure Values](../concepts/chart/measure-values.md) measure to the **Colors** section. - The columns in the chart will take on colors depending on the values of all the measures listed in the **Y** section. + The columns in the chart will take on colors depending on the values of all the measures listed in the **Y** section. - ![image](../../_assets/datalens/operations/chart/column-colors-2.png) + ![image](../../_assets/datalens/operations/chart/column-colors-2.png) {% endlist %} -1. Configure a color gradient for the measure as well. To do this, in the top right-hand corner of the **Colors** section, click ![image](../../_assets/console-icons/gear.svg) (the icon is displayed when you mouse over the section). +1. Configure a color gradient for the measure as well. To do so, in the top-right corner of the **Colors** section, click ![image](../../_assets/console-icons/gear.svg) (the icon is displayed when you hover over the section). 1. In the color settings, specify: * **Gradient type**: Select two or three colors. @@ -149,20 +149,20 @@ To color columns in a chart based on the value of a measure: * Gradient direction: Change the gradient direction using the ![image](../../_assets/console-icons/arrow-right-arrow-left.svg) icon. * **Set threshold values**: Set numeric thresholds for each color. Works if the **Y** section contains a single value. -### Configuring the display of `null` values {#null-settings} +### Configuring display of `null` values {#null-settings} {% include [datalens-chart-null-settings](../../_includes/datalens/datalens-chart-null-settings.md) %} ## Recommendations {#recomentations} -* If category values contain a lot of text, try to make it shorter so that chart signatures look neater. You can use string functions or the `CASE` conditional statement in calculated fields. +* If category values contain a lot of text, try to make it shorter so that chart signatures look neater. You can use string functions in calculated fields or the `CASE` conditional statements. * If each column is a category rather than a time value, consider sorting the columns in ascending or descending order of the measure. This will make your chart look better and more informative. Sorting may also be helpful inside each column's subcategories. * We recommend using a column chart to display changes to a measure or measures over time. In this case, be careful when sorting values on the X-axis, because the user usually expects to see changes over time on the X-axis. * When visualizing multiple measures, select colors carefully. They should be distinguishable and contrasting. We recommend using no more than 3-5 colors per chart. If you want to emphasize one certain measure above the others, highlight it in some bright color. * You can split a chart by dimension into a number of small charts that are convenient to compare to one another. To do this, drag a dimension from the dataset to the **Split** section. - {% cut "Chart example" %} + {% cut "Chart example" %} - ![bar-chart-split](../../_assets/datalens/visualization-ref/bar-chart/bar-chart-split.png) + ![bar-chart-split](../../_assets/datalens/visualization-ref/bar-chart/bar-chart-split.png) - {% endcut %} + {% endcut %} diff --git a/en/datalens/visualization-ref/line-chart.md b/en/datalens/visualization-ref/line-chart.md index b7590fb3256..980cabaaedb 100644 --- a/en/datalens/visualization-ref/line-chart.md +++ b/en/datalens/visualization-ref/line-chart.md @@ -8,26 +8,26 @@ It can show multiple measures with different lines. For example, the basic sales {% cut "Source table" %} -| Year | Sales | Basic targets | Optimistic targets | ------ | --------- | --------- | --------- -| January 2019 | 209K | 200K | 210K | -| February 2019 | 194K | 205K | 220K | -| March 2019 | 333K | 250K | 280K | -| April 2019 | 359K | 260K | 290K | -| May 2019 | 394K | 270K | 300K | -| June 2019 | 477K | 300K | 350K | -| July 2019 | 557K | 350K | 400K | -| August 2019 | 685K | 400K | 450K | -| September 2019 | 609K | 500K | 550K | -| October 2019 | 665K | 530K | 570K | -| November 2019 | 724K | 600K | 670K | -| December 2019 | 869K | 700K | 800K | +Year | Sales | Basic targets | Optimistic targets +----- | --------- | --------- | --------- +January 2019| 209К | 200К | 210К +February 2019| 194К | 205К | 220К +March 2019| 333К | 250К | 280К +April 2019| 359К | 260К | 290К +May 2019| 394К | 270К | 300К +June 2019| 477К | 300К | 350К +July 2019| 557К | 350К | 400К +August 2019| 685К | 400К | 450К +September 2019| 609К | 500К | 550К +October 2019| 665К | 530К | 570К +November 2019| 724К | 600К | 670К +December 2019| 869К | 700К | 800К {% endcut %} If measure values differ significantly, you can place them on different Y axes. In this case, the values of each measure will be plotted on their own axis. For example, a chart for sales and customer count. -![line-chart-2measures-2y](../../_assets/datalens/visualization-ref/line-chart/line-chart-2measures-2y.png) + ![line-chart-2measures-2y](../../_assets/datalens/visualization-ref/line-chart/line-chart-2measures-2y.png) {% cut "Source table" %} @@ -54,36 +54,36 @@ This chart lets you compare multiple categories by a single measure. Each catego {% cut "Source table" %} -| Year | Home appliances | Household goods | Household cleaners | ------ | ---------| ---------- | ---------- -| January 2019 | 128K | 55K | 26K | -| February 2019 | 97K | 79K | 18K | -| March 2019 | 187K | 105K | 41K | -| April 2019 | 188K | 137K | 34K | -| May 2019 | 230K | 121K | 43K | -| June 2019 | 256K | 162K | 59K | -| July 2019 | 284K | 206K | 67K | -| August 2019 | 409K | 204K | 72K | -| September 2019 | 314K | 209K | 86K | -| October 2019 | 324K | 262K | 79K | -| November 2019 | 385K | 238K | 101K | -| December 2019 | 451K | 307K | 111K | +Year | Home appliances | Household goods | Household cleaners +----- | ---------| ---------- | ---------- +January 2019| 128К | 55К | 26К +February 2019| 97К | 79К | 18К +March 2019| 187К | 105К | 41К +April 2019| 188К | 137К | 34К +May 2019| 230К | 121К | 43К +June 2019| 256К | 162К | 59К +July 2019| 284К | 206К | 67К +August 2019| 409К | 204К | 72К +September 2019| 314К | 209К | 86К +October 2019| 324К | 262К | 79К +November 2019| 385К | 238К | 101К +December 2019| 451К | 307К | 111К {% endcut %} ## Wizard sections {#wizard-sections} -| Wizard
section | Description | +Wizard
section| Description ----- | ---- -| X | Dimension. You can only specify one field here. This dimension is usually a date. If this is the case, make sure to specify the `Date` data type for this field in the dataset. This is required for correct sorting and signature display. For better visualization, you can group dates into weeks, months, and years. For more information, see [{#T}](../concepts/chart/settings.md#field-settings). | -| Y | Measure. You can specify multiple measures.
If you add more than one measure to a section, the **Colors** section will contain a dimension named [Measure Names](../concepts/chart/measure-values.md). | -| Y2 | Measure. Use it to add a second Y axis to a chart. You can specify multiple measures.
If you add more than one measure to a section, the **Colors** section will contain a dimension named [Measure Names](../concepts/chart/measure-values.md). | -| Colors | [Measure Names](../concepts/chart/measure-values.md) dimension or field. Affects the color of lines. To delete [Measure Names](../concepts/chart/measure-values.md), click the cross icon or remove measures from the Y axis. | -| Forms | [Measure Names](../concepts/chart/measure-values.md) dimension or field. Affects the shape of lines. | -| Sorting | Dimension. You can only use one dimension from the X axis. Affects the sorting of the X axis. The sorting direction is marked with an icon next to the field: ![image](../../_assets/console-icons/bars-ascending-align-left.svg) for ascending or ![image](../../_assets/console-icons/bars-descending-align-left.svg) for descending. To change the sorting direction, click the icon. | -| Labels | Measure. Displays measure values on the chart. If multiple measures are added to the **Y** or **Y2** section, drag [Measure Values](../concepts/chart/measure-values.md) to this section. | -| Split | Dimension. Splits a chart horizontally by the selected dimension's values. The maximum number of splits per chart is 25. | -| Filters | Dimension or measure. Used as a filter. | +X | Dimension. You can only specify one field here. This dimension is usually a date. If this is the case, make sure to specify the `Date` data type for this field in the dataset. This is required for correct sorting and signature display. For better visualization, you can group dates into weeks, months, and years. For more information, see [{#T}](../concepts/chart/settings.md#field-settings). +Y | Measure. You can specify multiple measures.
If you add more than one measure to a section, the **Colors** section will contain a dimension named [Measure Names](../concepts/chart/measure-values.md). +Y2 | Measure. Use it to add a second Y axis to a chart. You can specify multiple measures.
If you add more than one measure to a section, the **Colors** section will contain a dimension named [Measure Names](../concepts/chart/measure-values.md). +Colors | [Measure Names](../concepts/chart/measure-values.md) dimension or field. Affects the color of lines. To delete [Measure Names](../concepts/chart/measure-values.md), click the cross icon or remove measures from the Y axis. +Forms | [Measure Names](../concepts/chart/measure-values.md) dimension or field. Affects the shape of lines. +Sorting | Dimension. You can use only one X axis dimension. Affects the sorting of the X axis. The sorting direction is marked with an icon next to the field: ![image](../../_assets/console-icons/bars-ascending-align-left.svg) for ascending or ![image](../../_assets/console-icons/bars-descending-align-left.svg) for descending. To change the sorting direction, click the icon. +Labels | Measure. Displays measure values on the chart. If multiple measures are added to the **Y** or **Y2** section, drag [Measure Values](../concepts/chart/measure-values.md) to this section. [Markup functions](../function-ref/markup-functions.md) are supported. For `String` type fields, you can configure using basic [{#T}](../dashboard/markdown.md) syntax: click the icon before the field name and enable **Markdown**. +Split | Dimension. Splits a chart horizontally by the selected dimension's values. The maximum number of splits per chart is 25. +Filters | Dimension or measure. Used as a filter. ## Creating a line chart {#create-diagram} @@ -100,58 +100,58 @@ To create a line chart: 1. Select **Line chart** as your chart type. 1. Drag a dimension from the dataset to the **X** section. The values will be displayed in the lower part of the chart on the X axis. 1. Drag one or more measures from the dataset to the **Y** section. The values will be displayed as a chart on the Y axis. -1. Drag one or more measures from the dataset to the **Y2** section. The values are displayed as a chart on the second Y axis. +1. Drag one or more measures from the dataset to the **Y2** section. The values will be displayed as a chart on the second Y axis. 1. Drag a dimension to the **Color** section. The measure value is divided by color depending on the selected dimension. 1. Drag a dimension or measure from the dataset to the **Filters** section. The field can be empty. In this case, no filters are applied. -### Configuring the display of `null` values {#null-settings} +### Configuring display of `null` values {#null-settings} {% include [datalens-chart-null-settings](../../_includes/datalens/datalens-chart-null-settings.md) %} ## Recommendations {#recomendations} * The perception of data on a line chart depends on its proportions. An upward or downward trend may intensify if the chart is contracted and be less evident if it's spread. + + {% cut "Chart examples" %} + + ![line-chart-proportions](../../_assets/datalens/visualization-ref/line-chart/line-chart-proportions.png) - {% cut "Chart examples" %} - - ![line-chart-proportions](../../_assets/datalens/visualization-ref/line-chart/line-chart-proportions.png) - - {% endcut %} - + {% endcut %} + * {% include [category-text](../../_includes/datalens/datalens-category-text.md) %} * When visualizing multiple measures, select colors carefully. They should be distinguishable and contrasting. We recommend using no more than 3-5 colors per chart. If you want to emphasize one certain measure above the others, highlight it in some bright color. * Disable the **Sum in tooltips** option in the [chart settings](../concepts/chart/settings.md#common-settings) if the chart lines represent different entities. For example, the sales amount and the number of customers. * Sign measure values on the chart. To do this, drag a measure from the dataset to the **Signatures** section. The chart will display its values. - {% cut "Chart example" %} + {% cut "Chart example" %} - ![line-chart-signatures-1](../../_assets/datalens/visualization-ref/line-chart/line-chart-signatures-1.png) + ![line-chart-signatures-1](../../_assets/datalens/visualization-ref/line-chart/line-chart-signatures-1.png) - {% endcut %} + {% endcut %} - If multiple measures are added to the **Y** or **Y2** section, drag [Measure Values](../concepts/chart/measure-values.md) to this section. + If multiple measures are added to the **Y** or **Y2** section, drag [Measure Values](../concepts/chart/measure-values.md) to this section. - {% cut "Chart example" %} + {% cut "Chart example" %} - ![line-chart-signatures-2](../../_assets/datalens/visualization-ref/line-chart/line-chart-signatures-2.png) + ![line-chart-signatures-2](../../_assets/datalens/visualization-ref/line-chart/line-chart-signatures-2.png) - {% endcut %} - - You can also sign the last value on the chart only. To do this, add a calculated field with the `MAX` function. For more information, see [Demo dashboard](https://datalens.yandex/9fms9uae7ip02?tab=Are). + {% endcut %} + You can also sign only the last value on the chart by adding a calculated field with the `MAX` function. For more information, see [Demo dashboard](https://datalens.yandex/9fms9uae7ip02?tab=Are). + * You can split a chart by dimension into a number of small charts that are convenient to compare to one another. To do this, drag a dimension from the dataset to the **Split** section. - {% cut "Chart example" %} + {% cut "Chart example" %} - ![line-chart-split](../../_assets/datalens/visualization-ref/line-chart/line-chart-split.png) + ![line-chart-split](../../_assets/datalens/visualization-ref/line-chart/line-chart-split.png) - {% endcut %} + {% endcut %} * For better visualization, use formatting in the [dimension](../concepts/chart/settings.md#measure-settings) and [measure](../concepts/chart/settings.md#indicator-settings) setup window. Check the data type for correct sorting and comparison of values. Specify additional parameters. For example, the format and units for numeric data and the number of decimal places for fractions. + + {% cut "Example of measure settings" %} + + ![line-chart-measure-settings](../../_assets/datalens/visualization-ref/line-chart/line-chart-measure-settings.png) - {% cut "Sample measure settings" %} - - ![line-chart-measure-settings](../../_assets/datalens/visualization-ref/line-chart/line-chart-measure-settings.png) - - {% endcut %} + {% endcut %} diff --git a/en/datalens/visualization-ref/normalized-area-chart.md b/en/datalens/visualization-ref/normalized-area-chart.md index 7407bdc32ae..cb0da26e32b 100644 --- a/en/datalens/visualization-ref/normalized-area-chart.md +++ b/en/datalens/visualization-ref/normalized-area-chart.md @@ -1,4 +1,4 @@ -# Normalized area chart ![](../../_assets/datalens/normalized-area.svg) +# Normalized stacked area chart ![](../../_assets/datalens/normalized-area.svg) A normalized area chart shows changes to the contribution of each category in a measure value over a time interval. Areas are highlighted in different colors and located above each other. The chart shows the percentage of areas and not their absolute value. The width of an area indicates its ratio to the total amount represented as 100%. For example, the percentage of different expenses in the total budget amount. @@ -6,20 +6,20 @@ A normalized area chart shows changes to the contribution of each category in a {% cut "Source table" %} -| Month | Gasoline | Rent | Food | Utility bills | ------ | ---------| ---------- | ---------- | ---------- -| January 2019 | 100 | 600 | 300 | 500 | -| February 2019 | 150 | 600 | 250 | 700 | -| March 2019 | 100 | 600 | 450 | 400 | -| April 2019 | 120 | 600 | 370 | 510 | -| May 2019 | 100 | 600 | 300 | 530 | -| June 2019 | 130 | 600 | 310 | 600 | -| July 2019 | 150 | 600 | 330 | 510 | -| August 2019 | 120 | 600 | 250 | 550 | -| September 2019 | 110 | 650 | 380 | 500 | -| October 2019 | 120 | 650 | 300 | 550 | -| November 2019 | 130 | 650 | 310 | 540 | -| December 2019 | 100 | 650 | 400 | 550 | +Month | Gasoline | Rent | Food | Utility bills +----- | ---------| ---------- | ---------- | ---------- +January 2019 | 100 | 600 | 300 | 500 +February 2019 | 150 | 600 | 250 | 700 +March 2019 | 100 | 600 | 450 | 400 +April 2019 | 120 | 600 | 370 | 510 +May 2019 | 100 | 600 | 300 | 530 +June 2019 | 130 | 600 | 310 | 600 +July 2019 | 150 | 600 | 330 | 510 +August 2019 | 120 | 600 | 250 | 550 +September 2019 | 110 | 650 | 380 | 500 +October 2019 | 120 | 650 | 300 | 550 +November 2019 | 130 | 650 | 310 | 540 +December 2019 | 100 | 650 | 400 | 550 {% endcut %} @@ -29,34 +29,34 @@ This type of chart is used to show a change to the proportion of categories, whi {% cut "Source table" %} -| Month | Home appliances | Household goods | Household cleaners | ------ | ---------| ---------- | ---------- -| January 2019 | 128K | 55K | 26K | -| February 2019 | 97K | 79K | 18K | -| March 2019 | 187K | 105K | 41K | -| April 2019 | 188K | 137K | 34K | -| May 2019 | 230K | 121K | 43K | -| June 2019 | 256K | 162K | 59K | -| July 2019 | 284K | 206K | 67K | -| August 2019 | 409K | 204K | 72K | -| September 2019 | 314K | 209K | 86K | -| October 2019 | 324K | 262K | 79K | -| November 2019 | 385K | 238K | 101K | -| December 2019 | 451K | 307K | 111K | +Month | Home appliances | Household goods | Household cleaners +----- | ---------| ---------- | ---------- +January 2019| 128К | 55К | 26К +February 2019| 97К | 79К | 18К +March 2019| 187К | 105К | 41К +April 2019| 188К | 137К | 34К +May 2019| 230К | 121К | 43К +June 2019| 256К | 162К | 59К +July 2019| 284К | 206К | 67К +August 2019| 409К | 204К | 72К +September 2019| 314К | 209К | 86К +October 2019| 324К | 262К | 79К +November 2019| 385К | 238К | 101К +December 2019| 451К | 307К | 111К {% endcut %} ## Wizard sections {#wizard-sections} -| Wizard
section | Description | +Wizard
section| Description ----- | ---- -| X | Dimension. You can only specify one field here. This dimension is usually a date. If this is the case, make sure to specify the `Date` data type for this field in the dataset. This is required for correct sorting and signature display. For better visualization, you can group dates into weeks, months, and years. For more information, see [{#T}](../concepts/chart/settings.md#field-settings). | -| Y | Measure. You can specify multiple measures. If you add more than one measure to a section, the **Colors** section will contain a dimension named [Measure Names](../concepts/chart/measure-values.md). | -| Colors | [Measure Names](../concepts/chart/measure-values.md) dimension or field that affects the color of lines. To remove [Measure Names](../concepts/chart/measure-values.md), delete measures from the Y axis. | -| Sorting | Dimension or measure. You can use a dimension from the **X** and **Color** sections or a measure from the Y axis. This section affects the sorting of values on the X axis or areas along the Y axis. The sorting direction is marked with an icon next to the field: ![image](../../_assets/console-icons/bars-ascending-align-left.svg) ascending or ![image](../../_assets/console-icons/bars-descending-align-left.svg) descending. To change the sorting direction, click the icon. | -| Labels | Measure. Displays measure values on the chart. If multiple measures are added to the **Y** section, drag [Measure Values](../concepts/chart/measure-values.md) to this section. | -| Split | Dimension. Splits a chart horizontally by the selected dimension's values. The maximum number of splits per chart is 25. | -| Filters | Dimension or measure. Used as a filter. | +X | Dimension. You can only specify one field here. This dimension is usually a date. If this is the case, make sure to specify the `Date` data type for this field in the dataset. This is required for correct sorting and signature display. For better visualization, you can group dates into weeks, months, and years. For more information, see [{#T}](../concepts/chart/settings.md#field-settings). +Y | Measure. You can specify multiple measures. If you add more than one measure to a section, the **Colors** section will contain a dimension named [Measure Names](../concepts/chart/measure-values.md). +Colors | [Measure Names](../concepts/chart/measure-values.md) dimension or field. Affects the color of lines. To remove [Measure Names](../concepts/chart/measure-values.md), delete measures from the Y axis. +Sorting | Dimension or measure. You can use a dimension from the **X** and **Color** sections or a measure from the Y axis. This section affects the sorting of values on the X axis or areas along the Y axis. The sorting direction is marked with an icon next to the field: ![image](../../_assets/console-icons/bars-ascending-align-left.svg) for ascending or ![image](../../_assets/console-icons/bars-descending-align-left.svg) for descending. To change the sorting direction, click the icon. +Labels | Measure. Displays measure values on the chart. If multiple measures are added to the **Y** section, drag [Measure Values](../concepts/chart/measure-values.md) to this section. [Markup functions](../function-ref/markup-functions.md) are supported. For `String` type fields, you can configure using basic [{#T}](../dashboard/markdown.md) syntax: click the icon before the field name and enable **Markdown**. +Split | Dimension. Splits a chart horizontally by the selected dimension's values. The maximum number of splits per chart is 25. +Filters | Dimension or measure. Used as a filter. ## Creating a normalized area chart {#create-diagram} @@ -81,34 +81,34 @@ To create a normalized area chart: * Do not display more than three to five areas on the chart. * To make it easier to track the dynamics, place the largest or most important categories closer to the chart base. To do this, drag the measure to the **Sorting** section or set up their order in the **Y** section. For example, when comparing budget expenses. - {% cut "Chart example" %} + {% cut "Chart example" %} - ![normalized-area-rec-1](../../_assets/datalens/visualization-ref/normalized-area-chart/normalized-area-rec-1.png) + ![normalized-area-rec-1](../../_assets/datalens/visualization-ref/normalized-area-chart/normalized-area-rec-1.png) - {% endcut %} + {% endcut %} + + To monitor the budget spending dynamics by the `Gasoline` category, place it close to the chart base. - To monitor the budget spending dynamics by the `Gasoline` category, place it close to the chart base. + {% cut "Chart example" %} - {% cut "Chart example" %} + ![normalized-area-rec-2](../../_assets/datalens/visualization-ref/normalized-area-chart/normalized-area-rec-2.png) - ![normalized-area-rec-2](../../_assets/datalens/visualization-ref/normalized-area-chart/normalized-area-rec-2.png) + {% endcut %} - {% endcut %} + If there is another important category, place it by the upper boundary of the chart. This way the areas will have clear boundaries to help visually compare their values. For example, to compare `Utility bills` and `Rent`. - If there is another important category, place it by the upper boundary of the chart. This way the areas will have clear boundaries to help visually compare their values. For example, to compare `Utility bills` and `Rent`. + {% cut "Chart example" %} + + ![normalized-area-rec-3](../../_assets/datalens/visualization-ref/normalized-area-chart/normalized-area-rec-3.png) - {% cut "Chart example" %} - - ![normalized-area-rec-3](../../_assets/datalens/visualization-ref/normalized-area-chart/normalized-area-rec-3.png) - - {% endcut %} + {% endcut %} * You can split a chart by dimension into a number of small charts that are convenient to compare to one another. To do this, drag a dimension from the dataset to the **Split** section. - {% cut "Chart example" %} + {% cut "Chart example" %} - ![normalized-area-chart-split](../../_assets/datalens/visualization-ref/normalized-area-chart/normalized-area-chart-split.png) + ![normalized-area-chart-split](../../_assets/datalens/visualization-ref/normalized-area-chart/normalized-area-chart-split.png) - {% endcut %} + {% endcut %} * To display the absolute values of variables, use a [stacked area chart](area-chart.md). diff --git a/en/datalens/visualization-ref/normalized-bar-chart.md b/en/datalens/visualization-ref/normalized-bar-chart.md index 3aeef8daf16..b98d787d998 100644 --- a/en/datalens/visualization-ref/normalized-bar-chart.md +++ b/en/datalens/visualization-ref/normalized-bar-chart.md @@ -6,20 +6,20 @@ A normalized bar chart shows the contribution, as a percentage, of multiple meas {% cut "Source table" %} -| Month | Gasoline | Rent | Food | Utility bills | ------ | ---------| ---------- | ---------- | ---------- -| January 2019 | 100 | 600 | 300 | 500 | -| February 2019 | 150 | 600 | 250 | 700 | -| March 2019 | 100 | 600 | 450 | 400 | -| April 2019 | 120 | 600 | 370 | 510 | -| May 2019 | 100 | 600 | 300 | 530 | -| June 2019 | 130 | 600 | 310 | 600 | -| July 2019 | 150 | 600 | 330 | 510 | -| August 2019 | 120 | 600 | 250 | 550 | -| September 2019 | 110 | 650 | 380 | 500 | -| October 2019 | 120 | 650 | 300 | 550 | -| November 2019 | 130 | 650 | 310 | 540 | -| December 2019 | 100 | 650 | 400 | 550 | +Month | Gasoline | Rent | Food | Utility bills +----- | ---------| ---------- | ---------- | ---------- +January 2019 | 100 | 600 | 300 | 500 +February 2019 | 150 | 600 | 250 | 700 +March 2019 | 100 | 600 | 450 | 400 +April 2019 | 120 | 600 | 370 | 510 +May 2019 | 100 | 600 | 300 | 530 +June 2019 | 130 | 600 | 310 | 600 +July 2019 | 150 | 600 | 330 | 510 +August 2019 | 120 | 600 | 250 | 550 +September 2019 | 110 | 650 | 380 | 500 +October 2019 | 120 | 650 | 300 | 550 +November 2019 | 130 | 650 | 310 | 540 +December 2019 | 100 | 650 | 400 | 550 {% endcut %} @@ -29,15 +29,15 @@ Or the percentage distribution of payment types across product subcategories. {% cut "Source table" %} -| Subcategory | Delivery | Pickup | +Subcategory | Delivery | Pickup -------------|---------| ----------| -| Beauty and health products | 615K | 373K | -| Kitchenware | 1929K | 1005K | -| Kitchen products | 1217K | 759K | -| Detergents | 1210K | 803K | -| Health and beauty equipment | 2046K | 1380K | -| Non-essential goods | 1368K | 894K | -| Cleaners | 1237K | 673K | +Beauty and health products | 615К | 373К +Kitchenware | 1,929К | 1,005К +Kitchen products | 1,217К | 759К +Detergents | 1,210К | 803К +Health and beauty equipment | 2,046К | 1,380К +Non-essential goods | 1,368К | 894К +Cleaners | 1,237К | 673К {% endcut %} @@ -47,33 +47,33 @@ A normalized bar chart shows the contribution, as a percentage, of each category {% cut "Source table" %} -| Month | Home appliances | Household goods | Household cleaners | ------ | ---------| ---------- | ---------- -| January 2019 | 128K | 55K | 26K | -| February 2019 | 97K | 79K | 18K | -| March 2019 | 187K | 105K | 41K | -| April 2019 | 188K | 137K | 34K | -| May 2019 | 230K | 121K | 43K | -| June 2019 | 256K | 162K | 59K | -| July 2019 | 284K | 206K | 67K | -| August 2019 | 409K | 204K | 72K | -| September 2019 | 314K | 209K | 86K | -| October 2019 | 324K | 262K | 79K | -| November 2019 | 385K | 238K | 101K | -| December 2019 | 451K | 307K | 111K | +Month | Home appliances | Household goods | Household cleaners +----- | ---------| ---------- | ---------- +January 2019| 128К | 55К | 26К +February 2019| 97К | 79К | 18К +March 2019| 187К | 105К | 41К +April 2019| 188К | 137К | 34К +May 2019| 230К | 121К | 43К +June 2019| 256К | 162К | 59К +July 2019| 284К | 206К | 67К +August 2019| 409К | 204К | 72К +September 2019| 314К | 209К | 86К +October 2019| 324К | 262К | 79К +November 2019| 385К | 238К | 101К +December 2019| 451К | 307К | 111К {% endcut %} ## Wizard sections {#wizard-sections} -| Wizard
section | Description | +Wizard
section| Description ----- | ---- -| Y | Dimensions. You can specify one or two dimensions. For the `Date` and `Date and time` types, you can set grouping by time: minutes, hours, weeks, and so on. | -| X | Measure. You can specify multiple measures. If you add more than one measure to a section, the **Colors** section will contain a dimension named [Measure Names](../concepts/chart/measure-values.md). You can move [Measure Names](../concepts/chart/measure-values.md) to the Y axis. | -| Colors | [Measure Names](../concepts/chart/measure-values.md) dimension or field that affects the color of lines. To remove [Measure Names](../concepts/chart/measure-values.md), delete measures from the Y-axis. | -| Sorting | Dimension or measure. Affects the column sorting. The sorting direction is marked with an icon next to the field: ![image](../../_assets/console-icons/bars-ascending-align-left.svg) for ascending or ![image](../../_assets/console-icons/bars-descending-align-left.svg) for descending. To change the sorting direction, click the icon. | -| Labels | Measure. Displays measure values on the chart. If multiple measures are added to the **Y** section, drag [Measure Values](../concepts/chart/measure-values.md) to this section. | -| Filters | Dimension or measure. Used as a filter. | +Y | Dimensions. You can specify one or two dimensions. For the `Date` and `Date and time` types, you can set grouping by time: minutes, hours, weeks, and so on. +X | Measure. You can specify multiple measures. If you add more than one measure to a section, the **Colors** section will contain a dimension named [Measure Names](../concepts/chart/measure-values.md). You can move [Measure Names](../concepts/chart/measure-values.md) to the Y axis. +Colors | [Measure Names](../concepts/chart/measure-values.md) dimension or field. Affects the color of lines. To remove [Measure Names](../concepts/chart/measure-values.md), delete measures from the Y axis. +Sorting | Dimension or measure. Affects the column sorting. The sorting direction is marked with an icon next to the field: ![image](../../_assets/console-icons/bars-ascending-align-left.svg) for ascending or ![image](../../_assets/console-icons/bars-descending-align-left.svg) for descending. To change the sorting direction, click the icon. +Labels | Measure. Displays measure values on the chart. If multiple measures are added to the **Y** section, drag [Measure Values](../concepts/chart/measure-values.md) to this section. [Markup functions](../function-ref/markup-functions.md) are supported. For `String` type fields, you can configure using basic [{#T}](../dashboard/markdown.md) syntax: click the icon before the field name and enable **Markdown**. +Filters | Dimension or measure. Used as a filter. ## Creating a normalized bar chart {#create-diagram} diff --git a/en/datalens/visualization-ref/normalized-column-chart.md b/en/datalens/visualization-ref/normalized-column-chart.md index aa825731dc7..e9da1a6527d 100644 --- a/en/datalens/visualization-ref/normalized-column-chart.md +++ b/en/datalens/visualization-ref/normalized-column-chart.md @@ -6,20 +6,20 @@ A normalized column chart shows the contribution of each measure or category to {% cut "Source table" %} -| Month | Home appliances | Household goods | Household cleaners | ------ | ---------| ---------- | ---------- -| January 2019 | 128K | 55K | 26K | -| February 2019 | 97K | 79K | 18K | -| March 2019 | 187K | 105K | 41K | -| April 2019 | 188K | 137K | 34K | -| May 2019 | 230K | 121K | 43K | -| June 2019 | 256K | 162K | 59K | -| July 2019 | 284K | 206K | 67K | -| August 2019 | 409K | 204K | 72K | -| September 2019 | 314K | 209K | 86K | -| October 2019 | 324K | 262K | 79K | -| November 2019 | 385K | 238K | 101K | -| December 2019 | 451K | 307K | 111K | +Month | Home appliances | Household goods | Household cleaners +----- | ---------| ---------- | ---------- +January 2019| 128К | 55К | 26К +February 2019| 97К | 79К | 18К +March 2019| 187К | 105К | 41К +April 2019| 188К | 137К | 34К +May 2019| 230К | 121К | 43К +June 2019| 256К | 162К | 59К +July 2019| 284К | 206К | 67К +August 2019| 409К | 204К | 72К +September 2019| 314К | 209К | 86К +October 2019| 324К | 262К | 79К +November 2019| 385К | 238К | 101К +December 2019| 451К | 307К | 111К {% endcut %} @@ -29,34 +29,34 @@ This type of chart is used to see the contribution of each measure to the total {% cut "Source table" %} -| Month | Gasoline | Rent | Food | Utility bills | ------ | ---------| ---------- | ---------- | ---------- -| January 2019 | 100 | 600 | 300 | 500 | -| February 2019 | 150 | 600 | 250 | 700 | -| March 2019 | 100 | 600 | 450 | 400 | -| April 2019 | 120 | 600 | 370 | 510 | -| May 2019 | 100 | 600 | 300 | 530 | -| June 2019 | 130 | 600 | 310 | 600 | -| July 2019 | 150 | 600 | 330 | 510 | -| August 2019 | 120 | 600 | 250 | 550 | -| September 2019 | 110 | 650 | 380 | 500 | -| October 2019 | 120 | 650 | 300 | 550 | -| November 2019 | 130 | 650 | 310 | 540 | -| December 2019 | 100 | 650 | 400 | 550 | +Month | Gasoline | Rent | Food | Utility bills +----- | ---------| ---------- | ---------- | ---------- +January 2019 | 100 | 600 | 300 | 500 +February 2019 | 150 | 600 | 250 | 700 +March 2019 | 100 | 600 | 450 | 400 +April 2019 | 120 | 600 | 370 | 510 +May 2019 | 100 | 600 | 300 | 530 +June 2019 | 130 | 600 | 310 | 600 +July 2019 | 150 | 600 | 330 | 510 +August 2019 | 120 | 600 | 250 | 550 +September 2019 | 110 | 650 | 380 | 500 +October 2019 | 120 | 650 | 300 | 550 +November 2019 | 130 | 650 | 310 | 540 +December 2019 | 100 | 650 | 400 | 550 {% endcut %} ## Wizard sections {#wizard-sections} -| Wizard
section | Description | +Wizard
section| Description ----- | ---- -| X | Dimensions. You can specify one or two dimensions. | -| Y | Measure. You can specify multiple measures. If you add more than one measure to a section, the **Colors** section will contain a dimension named [Measure Names](../concepts/chart/measure-values.md). [Measure Names](../concepts/chart/measure-values.md) can be moved to the X-axis. | -| Colors | [Measure Names](../concepts/chart/measure-values.md) dimension or field that affects the color of lines. To remove [Measure Names](../concepts/chart/measure-values.md), delete measures from the Y axis. | -| Sorting | Dimension or measure. Affects the column sorting. The sorting direction is marked with an icon next to the field: ![image](../../_assets/console-icons/bars-ascending-align-left.svg) for ascending or ![image](../../_assets/console-icons/bars-descending-align-left.svg) for descending. To change the sorting direction, click the icon. | -| Labels | Measure. Displays measure values on the chart. If multiple measures are added to the **Y** section, drag [Measure Values](../concepts/chart/measure-values.md) to this section. | -| Split | Dimension. Splits a chart horizontally by the selected dimension's values. The maximum number of splits per chart is 25. | -| Filters | Dimension or measure. Used as a filter. | +X | Dimensions. You can specify one or two dimensions. +Y | Measure. You can specify multiple measures. If you add more than one measure to a section, the **Colors** section will contain a dimension named [Measure Names](../concepts/chart/measure-values.md). [Measure Names](../concepts/chart/measure-values.md) can be moved to the X-axis. +Colors | [Measure Names](../concepts/chart/measure-values.md) dimension or field. Affects the color of lines. To remove [Measure Names](../concepts/chart/measure-values.md), delete measures from the Y axis. +Sorting | Dimension or measure. Affects the column sorting. The sorting direction is marked with an icon next to the field: ![image](../../_assets/console-icons/bars-ascending-align-left.svg) for ascending or ![image](../../_assets/console-icons/bars-descending-align-left.svg) for descending. To change the sorting direction, click the icon. +Labels | Measure. Displays measure values on the chart. If multiple measures are added to the **Y** section, drag [Measure Values](../concepts/chart/measure-values.md) to this section. [Markup functions](../function-ref/markup-functions.md) are supported. For `String` type fields, you can configure using basic [{#T}](../dashboard/markdown.md) syntax: click the icon before the field name and enable **Markdown**. +Split | Dimension. Splits a chart horizontally by the selected dimension's values. The maximum number of splits per chart is 25. +Filters | Dimension or measure. Used as a filter. ## Creating a normalized column chart {#create-diagram} @@ -82,10 +82,10 @@ To create a normalized column chart: * Place segments so that the largest or most important categories are located closer to the chart base. This makes it easier to compare the values. * You can split a chart by dimension into a number of small charts that are convenient to compare to one another. To do this, drag a dimension from the dataset to the **Split** section. - {% cut "Chart example" %} + {% cut "Chart example" %} - ![normalized-bar-chart-split](../../_assets/datalens/visualization-ref/normalized-bar-chart/normalized-bar-chart-split.png) + ![normalized-bar-chart-split](../../_assets/datalens/visualization-ref/normalized-bar-chart/normalized-bar-chart-split.png) - {% endcut %} + {% endcut %} * To display the absolute values of variables, use a [column chart](column-chart.md). diff --git a/en/datalens/visualization-ref/pie-chart.md b/en/datalens/visualization-ref/pie-chart.md index 64d41ae8a15..e59266ca548 100644 --- a/en/datalens/visualization-ref/pie-chart.md +++ b/en/datalens/visualization-ref/pie-chart.md @@ -6,23 +6,23 @@ This chart shows a proportional relationship of different categories to a total {% cut "Source table" %} -| Product categories | Sales | ------|---------| -| Home appliances | 69M | -| Household goods | 57M | -| Household cleaners | 44M | +Product categories | Sales | +-----|---------| +Home appliances | 69М | +Household goods | 57М | +Household cleaners | 44М | {% endcut %} ## Wizard sections {#wizard-sections} -| Wizard
section | Description | +Wizard
section| Description ----- | ---- -| Color | Dimension. You can only specify one field here. | -| Measures | Measure. You can only specify one field here. | -| Sorting | Measure or dimension from the **Color** section. Affects area sorting. The sorting direction is marked with an icon next to the field: ![image](../../_assets/console-icons/bars-ascending-align-left.svg) for ascending or ![image](../../_assets/console-icons/bars-descending-align-left.svg) for descending. To change the sorting direction, click the icon. | -| Labels | Measure. Displays measure values on the chart. To add callouts with category names to the chart, drag the [Measure Names](../concepts/chart/measure-values.md) dimension to this section. | -| Filters | Dimension or measure. Used as a filter. | +Color | Dimension. You can only specify one field here. +Measures | Measure. You can only specify one field here. +Sorting | Measure or dimension from the **Color** section. Affects area sorting. The sorting direction is marked with an icon next to the field: ![image](../../_assets/console-icons/bars-ascending-align-left.svg) for ascending or ![image](../../_assets/console-icons/bars-descending-align-left.svg) for descending. To change the sorting direction, click the icon. +Labels | Measure. Displays measure values on the chart. To add callouts with category names to the chart, drag the [Measure Names](../concepts/chart/measure-values.md) dimension to this section. [Markup functions](../function-ref/markup-functions.md) are supported. For `String` type fields, you can configure using basic [{#T}](../dashboard/markdown.md) syntax: click the icon before the field name and enable **Markdown**. +Filters | Dimension or measure. Used as a filter. ## Creating a pie chart {#create-diagram} diff --git a/en/datalens/visualization-ref/point-map-chart.md b/en/datalens/visualization-ref/point-map-chart.md index e450d5c83e3..c4f5ca9b5b2 100644 --- a/en/datalens/visualization-ref/point-map-chart.md +++ b/en/datalens/visualization-ref/point-map-chart.md @@ -16,10 +16,10 @@ This map is used to monitor how points are distributed across the area. For exam Wizard
section| Description ----- | ---- Points (Geopoints) | Measure of the [Geopoint](../dataset/data-types.md#geopoint) type -Point size | Measure. Sets a point size depending on the measure value. +Point size | Measure. Sets point size depending on the measure value. Colors | Dimension or measure. Affects the intensity of point fill. Labels | Measure. Displayed as text on a point. When used, point size control is blocked. -Tooltips | Dimension or measure. A tooltip that appears when you hover over a point. +Tooltips | Dimension or measure. A tooltip that appears when you hover over a point. For `String` type fields, you can configure using basic [{#T}](../dashboard/markdown.md) syntax: click the icon before the field name and enable **Markdown**. Layer filters | Dimension or measure. Used as a filter for the current layer. Filters | Dimension or measure. Used as a filter for the entire chart. @@ -33,7 +33,7 @@ Filters | Dimension or measure. Used as a filter for the entire chart. 1. In the left-hand panel, select ![chart](../../_assets/console-icons/chart-column.svg) **Charts**. 1. Click **Create chart** → **Chart**. 1. At the top left, click ![image](../../_assets/console-icons/circles-intersection.svg) **Select dataset** and specify the dataset to visualize. If you do not have a dataset, [create one](../dataset/create-dataset.md#create). -1. Select the **Map** chart type. +1. Select **Map** for chart type. 1. Select the **Points (Geopoints)** layer type. 1. Drag a dimension of the [Geopoint](../dataset/data-types.md#geopoint) type from the dataset to the layer type selection section. 1. Set the size of the points displayed on the point map. Drag a measure to the **Point size** section or click ![image](../../_assets/console-icons/gear.svg) in the line with the section name. diff --git a/en/datalens/visualization-ref/ring-chart.md b/en/datalens/visualization-ref/ring-chart.md index 91a4cf80c80..f183cedf691 100644 --- a/en/datalens/visualization-ref/ring-chart.md +++ b/en/datalens/visualization-ref/ring-chart.md @@ -6,25 +6,25 @@ This chart shows the proportion of different categories using ring segments. The {% cut "Source table" %} -| Year | Sales | ------|---------| -| 2022 | 6M | -| 2021 | 28M | -| 2020 | 18M | -| 2019 | 9M | -| 2018 | 1M | +Year | Sales| +-----|---------| +2022 | 6М | +2021 | 28М | +2020 | 18М | +2019 | 9М | +2018 | 1М | {% endcut %} ## Wizard sections {#wizard-sections} -| Wizard
section | Description | +Wizard
section| Description ----- | ---- -| Color | Dimension. You can only specify one field here. | -| Measures | Affects the size of ring segments. You can only specify one field here. The total value of a measure is displayed in the center of a ring. Сalculations using [LOD expressions](../concepts/lod-aggregation.md), [window functions](../function-ref/window-functions.md), and [time series functions](../function-ref/time-series-functions.md) are not presented in the total value. | -| Sorting | Measure or dimension from the **Color** section. Affects segment sorting. The sorting direction is marked with an icon next to the field: ![image](../../_assets/console-icons/bars-ascending-align-left.svg) for ascending or ![image](../../_assets/console-icons/bars-descending-align-left.svg) for descending. To change the sorting direction, click the icon. | -| Labels | Measure. Displays measure values on the chart. To add callouts with category names to the chart, drag the [Measure Names](../concepts/chart/measure-values.md) dimension to this section. | -| Filters | Dimension or measure. Used as a filter. | +Color | Dimension. You can only specify one field here. +Measures | Affects the size of ring segments. You can only specify one field here. The total value of a measure is displayed in the center of a ring. Сalculations using [LOD expressions](../concepts/lod-aggregation.md), [window functions](../function-ref/window-functions.md), and [time series functions](../function-ref/time-series-functions.md) are not presented in the total value. +Sorting | Measure or dimension from the **Color** section. Affects segment sorting. The sorting direction is marked with an icon next to the field: ![image](../../_assets/console-icons/bars-ascending-align-left.svg) for ascending or ![image](../../_assets/console-icons/bars-descending-align-left.svg) for descending. To change the sorting direction, click the icon. +Labels | Measure. Displays measure values on the chart. To add callouts with category names to the chart, drag the [Measure Names](../concepts/chart/measure-values.md) dimension to this section. [Markup functions](../function-ref/markup-functions.md) are supported. For `String` type fields, you can configure using basic [{#T}](../dashboard/markdown.md) syntax: click the icon before the field name and enable **Markdown**. +Filters | Dimension or measure. Used as a filter. ## Creating a donut chart {#create-diagram} diff --git a/en/datalens/visualization-ref/scatter-chart.md b/en/datalens/visualization-ref/scatter-chart.md index cb3b265d725..18f77b8899b 100644 --- a/en/datalens/visualization-ref/scatter-chart.md +++ b/en/datalens/visualization-ref/scatter-chart.md @@ -30,10 +30,10 @@ You can use a gradient in a chart by adding a measure to the **Color** section. Wizard
section| Description ----- | ---- -X | Dimension or measure. Sets the X-axis value. -Y | Dimension or measure. Sets the Y-axis value. +X | Dimension or measure. Sets the X-axis value. For `String` type fields, you can configure using basic [{#T}](../dashboard/markdown.md) syntax: click the icon before the field name and enable **Markdown**. +Y | Dimension or measure. Sets the Y-axis value. For `String` type fields, you can configure using basic [{#T}](../dashboard/markdown.md) syntax: click the icon before the field name and enable **Markdown**. Points | Dimension. Specifies the number of points on the chart. -Point size | Measure. Sets a point size depending on the measure value. +Point size | Measure. Sets point size depending on the measure value. Colors | Dimension or measure. Affects the color of points. Sorting | Dimension. You can only use a dimension from the X axis. Affects the sorting of the X axis. The sorting direction is marked with an icon next to the field: ![image](../../_assets/console-icons/bars-ascending-align-left.svg) for ascending or ![image](../../_assets/console-icons/bars-descending-align-left.svg) for descending. To change the sorting direction, click the icon. Filters | Dimension or measure. Used as a filter. diff --git a/en/datalens/visualization-ref/tree-chart.md b/en/datalens/visualization-ref/tree-chart.md index 42c5715748a..461ef2584e2 100644 --- a/en/datalens/visualization-ref/tree-chart.md +++ b/en/datalens/visualization-ref/tree-chart.md @@ -8,25 +8,25 @@ For example, you can use a tree chart to visualize sales by product category and {% cut "Source table" %} -| Category | Subcategory | Sales | +| Category | Subcategory | Sales | |------------------|----------------------|----------| -| Home appliances | Kitchenware | 15000000 | -| Home appliances | Beauty and health products | 17000000 | -| Household goods | Kitchen products | 12000000 | -| Household goods | Essential goods | 8000000 | -| Household cleaners | Detergents | 4100000 | -| Household cleaners | Cleaners | 3300000 | +| Home appliances | Kitchenware | 15000000 | +| Home appliances | Beauty and health products | 17000000 | +| Household goods | Kitchen products | 12000000 | +| Household goods | Essential goods | 8000000 | +| Household cleaners | Detergents | 4100000 | +| Household cleaners | Cleaners | 3300000 | {% endcut %} ## Wizard sections {#wizard-sections} -| Wizard
section | Description | +Wizard
section| Description ----- | ---- -| Dimensions | Dimensions. Determines the hierarchy tree of nested rectangles. | -| Size | Measure. One measure that determines the area of a rectangle. | -| Colors | Dimension or measure. Affects the shading of rectangles in a chart. | -| Filters | Dimension or measure. Used as a filter. | +Dimensions | Dimensions Determines the hierarchy tree of nested rectangles. For `String` type fields, you can configure using basic [{#T}](../dashboard/markdown.md) syntax: click the icon before the field name and enable **Markdown**. +Disk | Measure. One measure that determines the area of a rectangle. +Colors | Dimension or measure. Affects the shading of rectangles in a chart. +Filters | Dimension or measure. Used as a filter. ## Creating a tree chart {#create-diagram} @@ -49,5 +49,5 @@ To create a tree chart: ## Recommendations {#recommendations} * Use this type of chart to show the relationship between a part and a whole. -* If there are few categories (up to 6), use a pie or donut chart. +* If there are few categories (up to six), use a pie or donut chart. * You cannot display negative values on a tree chart. \ No newline at end of file diff --git a/en/datasphere/api-ref/overview.md b/en/datasphere/api-ref/overview.md index fee9e720bde..091ed2547bd 100644 --- a/en/datasphere/api-ref/overview.md +++ b/en/datasphere/api-ref/overview.md @@ -1,6 +1,6 @@ --- -title: '{{ ml-platform-full-name }} API overview' -description: Managing {{ ml-platform-full-name }} resources using the API Basic methods for creating projects, uploading files, and working with notebooks +title: '{{ ml-platform-name }} API overview' +description: Managing {{ ml-platform-full-name }} resources via the API. Basic methods for creating projects, uploading files, and working with notebooks --- # {{ ml-platform-name }} API overview @@ -21,55 +21,61 @@ With `CommunityService` calls and `Community` methods, you can create, update, a | Returns information about a community | [Get](grpc/Community/get.md) | [get](Community/get.md) | | Returns a list of communities in the specified organization | [List](grpc/Community/list.md) | [list](Community/list.md) | -{% list tabs %} +{% list tabs group=api_type %} -- gRPC +- gRPC {#grpc-api} - **Example**. Creating a community: + **Example**. Creating a community: - ```bash - grpcurl -rpc-header "Authorization: Bearer " \ - -d '{"organization_id": ""}' \ - datasphere.{{ api-host }}:443 \ - yandex.cloud.datasphere.v2.CommunityService/Create - ``` + ```bash + grpcurl \ + -rpc-header "Authorization: Bearer " \ + -d '{"organization_id": ""}' \ + datasphere.{{ api-host }}:443 \ + yandex.cloud.datasphere.v2.CommunityService/Create + ``` - **Example**. Viewing a list of communities in an organization: + **Example**. Viewing a list of communities in an organization: - ```bash - grpcurl -rpc-header "Authorization: Bearer " \ - -d '{"organization_id": ""}' \ - datasphere.{{ api-host }}:443 \ - yandex.cloud.datasphere.v2.CommunityService/List - ``` + ```bash + grpcurl \ + -rpc-header "Authorization: Bearer " \ + -d '{"organization_id": ""}' \ + datasphere.{{ api-host }}:443 \ + yandex.cloud.datasphere.v2.CommunityService/List + ``` For more information about the `CommunityService` calls, see the [API documentation](grpc/Community/index.md). -- REST +- REST {#rest-api} - **Example**. Creating a community: + **Example**. Creating a community: - ```bash - curl -H "Authorization: Bearer " \ - -X POST "https://datasphere.{{ api-host }}/datasphere/v2/communities" \ - -d '{ "organizationId": "" }' - ``` + ```bash + curl \ + --header "Authorization: Bearer " \ + --request POST \ + "https://datasphere.{{ api-host }}/datasphere/v2/communities" \ + --data '{ "organizationId": "" }' + ``` - **Example**. Viewing a list of communities in an organization: + **Example**. Viewing a list of communities in an organization: - ```bash - curl -H "Authorization: Bearer " \ - -X GET "https://datasphere.{{ api-host }}/datasphere/v2/communities" \ - -d '{ "organizationId": "" }' - ``` + ```bash + curl \ + --header "Authorization: Bearer " \ + --request GET \ + "https://datasphere.{{ api-host }}/datasphere/v2/communities" \ + --data '{ "organizationId": "" }' + ``` - For more information about the `Community` methods, see the [API documentation](Community/index.md). + For more information about the `Community` methods, see the [API documentation](Community/index.md). {% endlist %} ## Working with projects {#project} -With `ProjectService` calls and `Project` methods, you can create, open, update, or delete a project. You can also view a list of projects in a particular community. +With `ProjectService` calls and `Project` methods, you can create, open, update, and delete a project. You can also view a list of projects in a particular community. | Description | gRPC | REST | | --- | --- | --- | @@ -80,49 +86,55 @@ With `ProjectService` calls and `Project` methods, you can create, open, update, | Returns information about a project | [Get](grpc/Project/get.md) | [get](Project/get.md) | | Retrieves the list of projects in the specified community | [List](grpc/Project/list.md) | [list](Project/list.md) | -{% list tabs %} +{% list tabs group=api_type %} -- gRPC +- gRPC {#grpc-api} - **Example**. Creating a project: + **Example**. Creating a project: - ```bash - grpcurl -rpc-header "Authorization: Bearer " \ - -d '{"community_id": ""}' \ - datasphere.{{ api-host }}:443 \ - yandex.cloud.datasphere.v2.ProjectService/Create - ``` + ```bash + grpcurl \ + -rpc-header "Authorization: Bearer " \ + -d '{"community_id": ""}' \ + datasphere.{{ api-host }}:443 \ + yandex.cloud.datasphere.v2.ProjectService/Create + ``` - **Example**. Viewing a list of folder projects: + **Example**. Viewing a list of folder projects: - ```bash - grpcurl -rpc-header "Authorization: Bearer " \ - -d '{"community_id": ""}' \ - datasphere.{{ api-host }}:443 \ - yandex.cloud.datasphere.v2.ProjectService/List - ``` + ```bash + grpcurl \ + -rpc-header "Authorization: Bearer " \ + -d '{"community_id": ""}' \ + datasphere.{{ api-host }}:443 \ + yandex.cloud.datasphere.v2.ProjectService/List + ``` For more information about the `ProjectService` calls, see the [API documentation](grpc/Project/index.md). -- REST +- REST {#rest-api} - **Example**. Creating a project: + **Example**. Creating a project: - ```bash - curl -H "Authorization: Bearer " \ - -X POST "https://datasphere.{{ api-host }}/datasphere/v2/projects" \ - -d '{ "communityId": "" }' - ``` + ```bash + curl \ + --header "Authorization: Bearer " \ + --request POST \ + "https://datasphere.{{ api-host }}/datasphere/v2/projects" \ + --data '{ "communityId": "" }' + ``` - **Example**. Viewing a list of community projects: + **Example**. Viewing a list of community projects: - ```bash - curl -H "Authorization: Bearer " \ - -X GET "https://datasphere.{{ api-host }}/datasphere/v2/projects" \ - -d '{ "communityId": "" }' - ``` + ```bash + curl \ + --header "Authorization: Bearer " \ + --request GET \ + "https://datasphere.{{ api-host }}/datasphere/v2/projects" \ + --data '{ "communityId": "" }' + ``` - For more information about the `Project` methods, see the [API documentation](Project/index.md). + For more information about the `Project` methods, see the [API documentation](Project/index.md). {% endlist %} @@ -135,36 +147,39 @@ To run a notebook, you can use the `Execute` call or the `execute` method in `Pr | Runs the specified notebook | [Execute](grpc/Project/execute.md) | [execute](Project/execute.md) | -{% list tabs %} +{% list tabs group=api_type %} -- gRPC +- gRPC {#grpc-api} - **Example**. Running the whole notebook: + **Example**. Running the whole notebook: - ```bash - grpcurl -rpc-header "Authorization: Bearer " \ - -d '{"project_id": "", "target": "notebook_id", "notebook_id": ""}' \ - datasphere.{{ api-host }}:443 \ - yandex.cloud.datasphere.v2.ProjectService/Execute - ``` + ```bash + grpcurl \ + -rpc-header "Authorization: Bearer " \ + -d '{"project_id": "", "target": "notebook_id", "notebook_id": ""}' \ + datasphere.{{ api-host }}:443 \ + yandex.cloud.datasphere.v2.ProjectService/Execute + ``` - To get the notebook ID, follow this guide: [{#T}](../operations/projects/get-notebook-cell-ids.md). + For instructions on how to get the notebook ID, refer to [{#T}](../operations/projects/get-notebook-cell-ids.md). For more information about the `ProjectService` calls, see the [API documentation](grpc/Project/index.md). -- REST +- REST {#rest-api} - **Example**. Running the whole notebook: + **Example**. Running the whole notebook: - ```bash - curl -H "Authorization: Bearer " \ - -X POST "https://datasphere.{{ api-host }}/datasphere/v2/projects/:execute" \ - -d '{ "notebook_id": "" }' - ``` + ```bash + curl \ + --header "Authorization: Bearer " \ + --request POST \ + "https://datasphere.{{ api-host }}/datasphere/v2/projects/:execute" \ + --data '{ "notebook_id": "" }' + ``` - To get the notebook ID, follow this guide: [{#T}](../operations/projects/get-notebook-cell-ids.md). + For instructions on how to get the notebook ID, refer to [{#T}](../operations/projects/get-notebook-cell-ids.md). - For more information about the `Project` methods, see the [API documentation](Project/index.md). + For more information about the `Project` methods, see the [API documentation](Project/index.md). {% endlist %} @@ -172,7 +187,7 @@ To run a notebook, you can use the `Execute` call or the `execute` method in `Pr ### Resource activation and deactivation {#activate-deactivate} -Each resource has its own group of API methods implemented in {{ ml-platform-name }}. By calling the `Activate` and `Deactivate` methods of the corresponding group in a given project, you can activate and deactivate the resources as needed. +Each resource has its own group of API methods implemented in {{ ml-platform-name }}. By calling the `Activate` and `Deactivate` methods of the respective group in a given project, you can activate and deactivate the resources as needed. | Description | gRPC | REST | | --- | --- | --- | @@ -182,49 +197,55 @@ Each resource has its own group of API methods implemented in {{ ml-platform-nam | Deactivates an S3 connector | [Deactivate](grpc/S3/deactivate.md) | [deactivate](S3/deactivate.md) | | Activates a Docker image | [Activate](grpc/DockerImage/activate.md) | [activate](DockerImage/activate.md) | -{% list tabs %} +{% list tabs group=api_type %} -- gRPC +- gRPC {#grpc-api} - **Example**. Activating a dataset: + **Example**. Activating a dataset: - ```bash - grpcurl -rpc-header "Authorization: Bearer " \ - -d "{\"project_id\": \"\", \"dataset_id\": \"\"}" \ - datasphere.{{ api-host }}:443 \ - yandex.cloud.datasphere.v2.DatasetService/Activate - ``` + ```bash + grpcurl \ + -rpc-header "Authorization: Bearer " \ + -d "{\"project_id\": \"\", \"dataset_id\": \"\"}" \ + datasphere.{{ api-host }}:443 \ + yandex.cloud.datasphere.v2.DatasetService/Activate + ``` - **Example**. Deactivating a dataset: + **Example**. Deactivating a dataset: - ```bash - grpcurl -rpc-header "Authorization: Bearer " \ - -d "{\"project_id\": \"\", \"dataset_id\": \"\"}" \ - datasphere.{{ api-host }}:443 \ - yandex.cloud.datasphere.v2.DatasetService/Deactivate - ``` + ```bash + grpcurl \ + -rpc-header "Authorization: Bearer " \ + -d "{\"project_id\": \"\", \"dataset_id\": \"\"}" \ + datasphere.{{ api-host }}:443 \ + yandex.cloud.datasphere.v2.DatasetService/Deactivate + ``` - Learn more about the `DatasetService` calls in the [API documentation](grpc/Dataset/index.md). + For more information about the `DatasetService` calls, see the [API documentation](grpc/Dataset/index.md). -- REST +- REST {#rest-api} - **Example**. Activating a dataset: + **Example**. Activating a dataset: - ```bash - curl -H "Authorization: Bearer " \ - -X POST "https://datasphere.{{ api-host }}/datasphere/v2/dataset/activate" \ - -d "{ \"datasetId\": \"\", \"projectId\": \"\" }" - ``` + ```bash + curl \ + --header "Authorization: Bearer " \ + --request POST \ + "https://datasphere.{{ api-host }}/datasphere/v2/dataset/activate" \ + --data "{ \"datasetId\": \"\", \"projectId\": \"\" }" + ``` - **Example**. Deactivating a dataset: + **Example**. Deactivating a dataset: - ```bash - curl -H "Authorization: Bearer " \ - -X POST "https://datasphere.{{ api-host }}/datasphere/v2/dataset/deactivate" \ - -d "{ \"datasetId\": \"\", \"projectId\": \"\" }" - ``` + ```bash + curl \ + --header "Authorization: Bearer " \ + --request POST \ + "https://datasphere.{{ api-host }}/datasphere/v2/dataset/deactivate" \ + --data "{ \"datasetId\": \"\", \"projectId\": \"\" }" + ``` - Learn more about the `Dataset` methods in the [API documentation](Dataset/index.md). + For more information about the `Dataset` methods, see the [API documentation](Dataset/index.md). {% endlist %} @@ -241,49 +262,55 @@ To enable your project to use another project's resources, you need to [share](. | Adds a resource to a project | [addResource](grpc/Project/addResource.md) | [addResource](Project/addResource.md) | | Deletes a resource from a project | [removeResource](grpc/Project/removeResource.md) | [removeResource](Project/removeResource.md) | -{% list tabs %} +{% list tabs group=api_type %} -- gRPC +- gRPC {#grpc-api} - **Example**. Adding a resource to a project: + **Example**. Adding a resource to a project: - ```bash - grpcurl -rpc-header "Authorization: Bearer " \ - -d "{\"project_id\": \"\", \"resource_id\": \"\"}" \ - datasphere.{{ api-host }}:443 \ - yandex.cloud.datasphere.v2.ProjectService/AddResource - ``` + ```bash + grpcurl \ + -rpc-header "Authorization: Bearer " \ + -d "{\"project_id\": \"\", \"resource_id\": \"\"}" \ + datasphere.{{ api-host }}:443 \ + yandex.cloud.datasphere.v2.ProjectService/AddResource + ``` - **Example**. Deleting a resource from a project: + **Example**. Deleting a resource from a project: - ```bash - grpcurl -rpc-header "Authorization: Bearer " \ - -d "{\"project_id\": \"\", \"resource_id\": \"\"}" \ - datasphere.{{ api-host }}:443 \ - yandex.cloud.datasphere.v2.ProjectService/RemoveResource - ``` + ```bash + grpcurl \ + -rpc-header "Authorization: Bearer " \ + -d "{\"project_id\": \"\", \"resource_id\": \"\"}" \ + datasphere.{{ api-host }}:443 \ + yandex.cloud.datasphere.v2.ProjectService/RemoveResource + ``` For more information about the `ProjectService` calls, see the [API documentation](grpc/Project/index.md). -- REST +- REST {#rest-api} - **Example**. Adding a resource to a project: + **Example**. Adding a resource to a project: - ```bash - curl -H "Authorization: Bearer " \ - -X POST "https://datasphere.{{ api-host }}/datasphere/v2/projects/:addResource" \ - -d "{ \"projectId\": \"\" }" - ``` + ```bash + curl \ + --header "Authorization: Bearer " \ + --request POST \ + "https://datasphere.{{ api-host }}/datasphere/v2/projects/:addResource" \ + --data "{ \"projectId\": \"\" }" + ``` - **Example**. Deleting a resource from a project: + **Example**. Deleting a resource from a project: - ```bash - curl -H "Authorization: Bearer " \ - -X POST "https://datasphere.{{ api-host }}/datasphere/v2/projects/:removeResource" \ - -d "{ \"projectId\": \"\" }" - ``` + ```bash + curl \ + --header "Authorization: Bearer " \ + --request POST \ + "https://datasphere.{{ api-host }}/datasphere/v2/projects/:removeResource" \ + --data "{ \"projectId\": \"\" }" + ``` - For more information about the `Project` methods, see the [API documentation](Project/index.md). + For more information about the `Project` methods, see the [API documentation](Project/index.md). {% endlist %} @@ -300,47 +327,53 @@ You can use the API to set up access to a project (`ProjectService`, `Project`) | Sets up access to a community | [SetAccessBindings](grpc/Community/setAccessBindings.md) | [SetAccessBindings](Community/setAccessBindings.md) | | Updates access to a community | [UpdateAccessBindings](grpc/Community/updateAccessBindings.md) | [UpdateAccessBindings](Community/updateAccessBindings.md) | -{% list tabs %} +{% list tabs group=api_type %} -- gRPC +- gRPC {#grpc-api} - **Example**. Viewing a list of access permissions for a project: + **Example**. Viewing a list of access permissions for a project: - ```bash - grpcurl -rpc-header "Authorization: Bearer " \ - -d '{"resource_id": ""}' \ - datasphere.{{ api-host }}:443 \ - yandex.cloud.datasphere.v2.ProjectService/ListAccessBindings - ``` + ```bash + grpcurl \ + -rpc-header "Authorization: Bearer " \ + -d '{"resource_id": ""}' \ + datasphere.{{ api-host }}:443 \ + yandex.cloud.datasphere.v2.ProjectService/ListAccessBindings + ``` - **Example**. Return a list of access permissions for a community: + **Example**. Return a list of access permissions for a community: - ```bash - grpcurl -rpc-header "Authorization: Bearer " \ - -d '{"resource_id": ""}' \ - datasphere.{{ api-host }}:443 \ - yandex.cloud.datasphere.v2.CommunityService/ListAccessBindings - ``` + ```bash + grpcurl \ + -rpc-header "Authorization: Bearer " \ + -d '{"resource_id": ""}' \ + datasphere.{{ api-host }}:443 \ + yandex.cloud.datasphere.v2.CommunityService/ListAccessBindings + ``` For more information about the [ProjectService](grpc/Project/index.md) and [CommunityService](grpc/Community/index.md) methods, see the API documentation. -- REST +- REST {#rest-api} - **Example**. Viewing a list of access permissions for a project: + **Example**. Viewing a list of access permissions for a project: - ```bash - curl -H "Authorization: Bearer " \ - -X GET "https://datasphere.{{ api-host }}/datasphere/v2/projects/:accessBindings" - ``` + ```bash + curl \ + --header "Authorization: Bearer " \ + --request GET \ + "https://datasphere.{{ api-host }}/datasphere/v2/projects/:accessBindings" + ``` - **Example**. Return a list of access permissions for a community: + **Example**. Return a list of access permissions for a community: - ```bash - curl -H "Authorization: Bearer " \ - -X GET "https://datasphere.{{ api-host }}/datasphere/v2/communities/:accessBindings" - ``` + ```bash + curl \ + --header "Authorization: Bearer " \ + --request GET \ + "https://datasphere.{{ api-host }}/datasphere/v2/communities/:accessBindings" + ``` - For more information about the [Project](Project/index.md) and [Community](Community/index.md) methods, see the API documentation. + For more information about the [Project](Project/index.md) and [Community](Community/index.md) methods, see the API documentation. {% endlist %} @@ -353,30 +386,33 @@ You can use the API to set up consumption limits for a project (`ProjectService` | Returns a project's balance | [getUnitBalance](grpc/Project/getUnitBalance.md) | [getUnitBalance](Project/getUnitBalance.md) | | Sets a project's balance | [setUnitBalance](grpc/Project/setUnitBalance.md) | [setUnitBalance](Project/setUnitBalance.md) | -{% list tabs %} +{% list tabs group=api_type %} -- gRPC +- gRPC {#grpc-api} - **Example**. Getting a project's balance: + **Example**. Getting a project's balance: - ```bash - grpcurl -rpc-header "Authorization: Bearer " \ - -d '{"project_id": ""}' \ - datasphere.{{ api-host }}:443 \ - yandex.cloud.datasphere.v2.ProjectService/GetUnitBalance - ``` + ```bash + grpcurl \ + -rpc-header "Authorization: Bearer " \ + -d '{"project_id": ""}' \ + datasphere.{{ api-host }}:443 \ + yandex.cloud.datasphere.v2.ProjectService/GetUnitBalance + ``` For more information about the `ProjectService` calls, see the [API documentation](grpc/Project/index.md). -- REST +- REST {#rest-api} - **Example**. Getting a project's balance: + **Example**. Getting a project's balance: - ```bash - curl -H "Authorization: Bearer " \ - -X GET "https://datasphere.{{ api-host }}/datasphere/v2/projects/:unitBalance" - ``` + ```bash + curl \ + --header "Authorization: Bearer " \ + --request GET \ + "https://datasphere.{{ api-host }}/datasphere/v2/projects/:unitBalance" + ``` - For more information about the `Project` methods, see the [API documentation](Project/index.md). + For more information about the `Project` methods, see the [API documentation](Project/index.md). -{% endlist %} \ No newline at end of file +{% endlist %} diff --git a/en/datasphere/concepts/jobs/airflow.md b/en/datasphere/concepts/jobs/airflow.md index c73b50ad885..fe8111dab1c 100644 --- a/en/datasphere/concepts/jobs/airflow.md +++ b/en/datasphere/concepts/jobs/airflow.md @@ -43,7 +43,7 @@ def run(): run() ``` -Job run logs are displayed in [{{ ds-cli }}](cli.md) and the web server interface. If there are any issues, the DAG operation will fail and the corresponding stack trace will appear in the logs. +Job execution logs are displayed in [{{ ds-cli }}](cli.md) and the web server interface. If there are any issues, the DAG operation will fail and the corresponding stack trace will appear in the logs. {% note info %} @@ -57,7 +57,7 @@ A non-blocking call allows you to perform new calculations on your {{ AF }} clus #### Example {#example-fork-from-dag} -Let's take a look at a DAG file with Airflow Sensor which requests the job status every minute using the `get_job` function. When the job is completed, the last operator, `handle_job_result`, is run: +Let's take a look at a DAG file with Airflow Sensor which inquires for job status every minute using the `get_job` function. When the job is completed, the last operator, `handle_job_result`, is run: ```python from typing import Optional @@ -101,6 +101,10 @@ run() Add additional operators before or after the job run by integrating it with other systems or external storages. +## Using the results of completed jobs {#use-results} + +{% include [dag-load-job-results](../../../_includes/datasphere/dag-load-job-results.md) %} + #### See also {#see-also} * [{#T}](./index.md) diff --git a/en/datasphere/concepts/jobs/index.md b/en/datasphere/concepts/jobs/index.md index 24fc56b9754..1255efa7b84 100644 --- a/en/datasphere/concepts/jobs/index.md +++ b/en/datasphere/concepts/jobs/index.md @@ -35,13 +35,13 @@ datasphere project job set-data-ttl --id --days When creating a job, specify its parameters in the `config.yaml` file, such as the [configuration of computing resources](../configurations.md) to run the job on and required files with input data. Depending on the settings specified in the configuration file, {{ ml-platform-name }} analyzes the job, identifies dependencies, [deploys the environment](environment.md) on the VM, and runs the job code. Job execution results are saved in the {{ ml-platform-name }} project files listed in the job configuration. ```yaml -# Job name. +# Job name name: simple-python-script -# Job description. +# Job description desc: Program description -# Entry point parameters to run computations. -cmd: > # Multi-line YAML string. +# Entry point parameters to run computations +cmd: > # Multi-line YAML string python3 src/main.py --params ${PARAMS} --features ${}/features.tsv @@ -50,7 +50,7 @@ cmd: > # Multi-line YAML string. --model ${MODEL} --epochs 5 -# Files with input data. +# Files with input data inputs: - misc/logging.yaml # File path relative to the job run directory on the local computer. - /usr/share/params.json: # Absolute path to the file on the local computer is saved to the PARAMS variable. @@ -79,12 +79,12 @@ env: # docker: # image: : # For example, <{{ registry }}/crtabcdef12345678900/myenv:0.1>. # For Docker Hub, you only need to specify `:`, e.g., `ubuntu:focal`. - # username: + # username: # password: # secret-id: PASSWORD # {{ ml-platform-name }} secret name. # Environment dependency build method. - python: auto # Fully automated environment build. + python: auto # Full environment build automation. # python: # Environment parameters are set manually. If no parameters are set, their values will be automatically taken from the current environment. # type: manual @@ -95,15 +95,21 @@ env: flags: - attach-project-disk # Mount project storage. -# Configurations of computing resources for runing a job. +# Computing resource configurations to run a job. cloud-instance-types: - g2.1 # Priority configuration. - g1.1 # Second priority configuration. # Extended working directory configuration. working-storage: - type: SSD # Disk type in use. Optional, the default type is SSD. Possible values: SSD. + type: SSD # Disk type in use. Optional, the default type is SSD. Possible values: SSD size: 150Gb # Working directory size from 100 GB to 10 TB. + +# Configuring graceful shutdown. +graceful-shutdown: + signal: SIGTERM # Signal to be sent to the job process on pressing Ctrl + C (cancel); SIGTERM by default. + # Possible values: SIGTERM, SIGINT, SIGHUP, SIGUSR1, SIGUSR2 + timeout: 15s # Timeout after which the job process gets SIGKILL if it has not finished yet. ``` The `config.yaml` file has multiple sections. @@ -145,6 +151,8 @@ The `config.yaml` file has multiple sections. You pay for the extended working directory specified in the `working-storage` section according to the [data storage pricing policy](../../pricing.md#prices-jobs). +1. The `graceful-shutdown` section defines the graceful shutdown parameters. If the section is not specified, then the `SIGKILL` signal is sent to the job when the user presses **Ctrl** + **C**. In this section, you can redefine the signal itself as well as the wait time for graceful shutdown. + #### See also {#see-also} * [{#T}](../../operations/projects/work-with-jobs.md) diff --git a/en/datasphere/concepts/spark-connector.md b/en/datasphere/concepts/spark-connector.md index e1c9e73284a..4ba065d5b62 100644 --- a/en/datasphere/concepts/spark-connector.md +++ b/en/datasphere/concepts/spark-connector.md @@ -18,11 +18,13 @@ The following information is stored for each Spark connector: You can [create](../operations/data/spark-connectors.md) a Spark connector in the [{{ ml-platform-name }} interface]({{ link-datasphere-main }}). When creating a Spark connector, you can choose the type of connection to an existing {{ dataproc-name }} cluster: SparkContext or Spark Connect (available only for {{ dataproc-name }} clusters version 2.2 or older). The SparkContext connection is used for temporary clusters. -Spark connectors are used in the project notebooks. When first running computations, you select the [configuration](./configurations.md) on which the notebook code will run. This VM resides on the network specified in the Spark connector, so it has network access to the {{ dataproc-name }} cluster but does not belong to it. The VM environment for working with the cluster differs from the {{ ml-platform-name }} [standard environment](./preinstalled-packages.md) and allows accessing the {{ dataproc-name }} cluster environment. You can also use [sessions](./data-proc.md#session) to work with the cluster. +Spark connectors are used in the project notebooks. When first running computations, you select the [configuration](./configurations.md) on which the notebook code will run. This VM resides on the network specified in the Spark connector, so it has network access to the {{ dataproc-name }} cluster but does not belong to it. By default, the notebook cell code will be executed on the VM. To execute the code on a {{ dataproc-name }} cluster, you must explicitly specify this when making a call (e.g., via `SparkContext::runJob`). + +The VM environment for working with the cluster differs from the {{ ml-platform-name }} [standard environment](./preinstalled-packages.md) and allows accessing the {{ dataproc-name }} cluster environment. You can also use [sessions](./data-proc.md#session) to work with the cluster. Once created, the Spark connector becomes available for the project. Like any other resource, you can publish the Spark connector in the community to use it in other projects. To do this, you need at least the `Editor` role in the project and the `Developer` role in the community in which you want to publish it. You can open the access on the **{{ ui-key.yc-ui-datasphere.common.access }}** tab on the Spark connector view page. The resource available to the community will appear on the community page under **{{ ui-key.yc-ui-datasphere.spaces-page.community-resources }}**. -If you chose a temporary {{ dataproc-name }} cluster when creating the Spark connector, {{ ml-platform-name }} will create a {{ dataproc-name }} cluster the first time you run computations in your notebook and will monitor it on its own. The cluster will be deleted if there are no computations on it for the period of time specified in the **{{ ui-key.yc-ui-datasphere.edit-project-page.dedicated-vm-inactivity-timeout }}** parameter, or if you force shut down the notebook VM. +If you chose a temporary {{ dataproc-name }} cluster when creating the Spark connector, {{ ml-platform-name }} will create a {{ dataproc-name }} cluster the first time you run computations in your notebook and will monitor it all by itself. The cluster starts and stops together with the notebook VM. The cluster will be deleted if there are no computations on it for the period of time specified in the **{{ ui-key.yc-ui-datasphere.edit-project-page.dedicated-vm-inactivity-timeout }}** parameter, or if you force shut down the notebook VM. ### Configurations of temporary clusters {#configurations} diff --git a/en/datasphere/concepts/temporary-data-proc-clusters.md b/en/datasphere/concepts/temporary-data-proc-clusters.md index 645fb53c7b9..dd1ea161dde 100644 --- a/en/datasphere/concepts/temporary-data-proc-clusters.md +++ b/en/datasphere/concepts/temporary-data-proc-clusters.md @@ -11,7 +11,7 @@ Regardless of the deployment option, all {{ dataproc-name }} clusters are charge ## Spark connector {#spark-with-temporary-cluster} -When creating a Spark connector, you can create a temporary {{ dataproc-name }} cluster and configure its parameters. {{ ml-platform-name }} will create such a cluster the first time you run computations in your notebook and will monitor it on its own. The cluster will be deleted as soon as the notebook VM is stopped. +When creating a Spark connector, you can create a temporary {{ dataproc-name }} cluster and configure its parameters. {{ ml-platform-name }} will create such a cluster the first time you run computations in your notebook and will monitor it all by itself. The cluster starts and stops together with the notebook VM. The notebook VM will be stopped if there are no computations on it for the period of time specified in the **{{ ui-key.yc-ui-datasphere.edit-project-page.dedicated-vm-inactivity-timeout }}** parameter. You can also force shut down the notebook VM. diff --git a/en/datasphere/jobs/api-ref/grpc/ProjectJob/list.md b/en/datasphere/jobs/api-ref/grpc/ProjectJob/list.md index 2ac97f4ba2a..09f8ebcdf4f 100644 --- a/en/datasphere/jobs/api-ref/grpc/ProjectJob/list.md +++ b/en/datasphere/jobs/api-ref/grpc/ProjectJob/list.md @@ -31,12 +31,12 @@ ID of the project. || The maximum number of results per page to return. If the number of available results is larger than `pageSize`, -the service returns a `ListProjectJobResponse.pageToken` +the service returns a [ListProjectJobResponse.page_token] that can be used to get the next page of results in subsequent list requests. || || pageToken | **string** Page token. To get the next page of results, set `pageToken` to the -`ListProjectJobResponse.pageToken` returned by a previous list request. || +[ListProjectJobResponse.page_token] returned by a previous list request. || || filter | **string** restrictions: diff --git a/en/datasphere/operations/deploy/alias-api.md b/en/datasphere/operations/deploy/alias-api.md index 643f1e2413c..b1d65b5184d 100644 --- a/en/datasphere/operations/deploy/alias-api.md +++ b/en/datasphere/operations/deploy/alias-api.md @@ -31,7 +31,8 @@ To send requests to aliases, you must have the `{{ roles-datasphere-user }}` or You can use the [gRPCurl](https://github.com/fullstorydev/grpcurl) utility to make gRPC calls. ```bash -grpcurl -H "Authorization: Bearer " \ +grpcurl \ + -H "Authorization: Bearer " \ -d '{ "folder_id": "", "alias_name": "", @@ -43,10 +44,10 @@ yandex.cloud.datasphere.v1.NodeService/ExecuteAlias Where: -* ``: [IAM token](../../../iam/concepts/authorization/iam-token.md) being used for authentication. +* ``: [IAM token](../../../iam/concepts/authorization/iam-token.md) used for authentication. * ``: ID of the folder where the project and the alias were created. * ``: Alias name. -* ``: Object in `{"a":2,"b":3}` format in which keys are mapped to input variables. +* ``: Object in `{"a":2,"b":3}` format where keys are mapped to input variables. In a successful response, the object is returned: @@ -63,20 +64,21 @@ In a successful response, the object is returned: You can use the [cURL](https://curl.se) utility to send REST requests. ```bash -curl -H "x-node-alias: datasphere.user." \ - -H "Authorization: Bearer " \ - -H "x-folder-id: " \ - -X \ - -d '' \ +curl \ + --header "x-node-alias: datasphere.user." \ + --header "Authorization: Bearer " \ + --header "x-folder-id: " \ + --request \ + --data '' \ https://node-api.datasphere.yandexcloud.net/ ``` Where: * ``: Alias name. -* ``: IAM token being used for authentication. +* ``: IAM token used for authentication. * ``: ID of the folder where the project and the alias were created. * ``: Type of the request to the alias. -* ``: Object in `{"a":2,"b":3}` format in which keys are mapped to input variables. +* ``: Object in `{"a":2,"b":3}` format where keys are mapped to input variables. The response returns a JSON object with output variables. diff --git a/en/datasphere/operations/deploy/node-api.md b/en/datasphere/operations/deploy/node-api.md index 15ca018b844..b625bb48beb 100644 --- a/en/datasphere/operations/deploy/node-api.md +++ b/en/datasphere/operations/deploy/node-api.md @@ -26,7 +26,8 @@ To send requests to nodes, you must have the `{{ roles-datasphere-user }}` or `{ ## Sample gRPC API call {#grpc-call-example} ```bash -grpcurl -H "Authorization: Bearer " \ +grpcurl \ + -H "Authorization: Bearer " \ -d '{ "folder_id": "", "node_id": "", @@ -38,9 +39,9 @@ yandex.cloud.datasphere.v1.NodeService/Execute Where: -* ``: [IAM token](../../../iam/concepts/authorization/iam-token.md) being used for authentication. -* ``: ID of the folder where the project and node were created. -* ``: ID of the node. +* ``: [IAM token](../../../iam/concepts/authorization/iam-token.md) used for authentication. +* ``: ID of the folder the project and node are created in. +* ``: Node ID. * ``: Object where keys match input variables. In a successful response, the object is returned: @@ -61,9 +62,9 @@ You can use the [cURL](https://curl.se) utility to send REST requests. ```bash curl https://datasphere.{{ api-host }}/datasphere/v1/nodes/:execute \ - -X POST \ - -H "Authorization: Bearer " - -d '{ + --request POST \ + --header "Authorization: Bearer " + --data '{ "folder_id": "", "node_id": "", "input": { } @@ -72,8 +73,8 @@ curl https://datasphere.{{ api-host }}/datasphere/v1/nodes/:execute \ Where: -* ``: IAM token being used for authentication. -* ``: ID of the folder where the project and node were created. +* ``: IAM token used for authentication. +* ``: ID of the folder the project and node are created in. * ``: Node ID. * ``: Object where keys match input variables. diff --git a/en/datasphere/operations/deploy/node-customization.md b/en/datasphere/operations/deploy/node-customization.md index a3ab8c8a695..cc0f0772259 100644 --- a/en/datasphere/operations/deploy/node-customization.md +++ b/en/datasphere/operations/deploy/node-customization.md @@ -4,7 +4,7 @@ 1. [Create a secret](../data/secrets.md#create) with a password for your container registry. - If you are using a registry created in {{ container-registry-full-name }}, authenticate using the authorized key for the [service account](../../../iam/concepts/users/service-accounts.md) that has the [required roles](../../../container-registry/security/index.md) and is specified in the [project settings](../projects/update.md). + If you are using a registry created in {{ container-registry-full-name }}, authenticate using the authorized key for the [service account](../../../iam/concepts/users/service-accounts.md) that has the [required roles](../../../container-registry/security/index.md) and is specified in the [project settings](../projects/update.md): 1. {% include [cli-install](../../../_includes/cli-install.md) %} @@ -39,7 +39,7 @@ Result: ```text - Login succeeded + Login Succeeded ``` {% include [disclaimer](../../../_includes/iam/authorized-keys-disclaimer.md) %} @@ -51,7 +51,7 @@ * ``: Image name in {{ ml-platform-name }}. * ``: Image tag in {{ ml-platform-name }}. - * ``: {{ container-registry-name }} image path. + * ``: Path to the {{ container-registry-name }} image in the `cr.yandex//`; * ``: Image [tag](../../../container-registry/concepts/docker-image.md#version). During the uploading, specify the username and choose a secret with a password. For authorization in {{ container-registry-name }}, provide the `json_key` token type as username and enter the secret instead of password. diff --git a/en/datasphere/operations/index.md b/en/datasphere/operations/index.md index b46c22eadc1..d96c79141ab 100644 --- a/en/datasphere/operations/index.md +++ b/en/datasphere/operations/index.md @@ -1,6 +1,6 @@ --- -title: How to work with {{ ml-platform-full-name }} -description: The page contains all guides on working with {{ ml-platform-full-name }} in {{ yandex-cloud }}. Learn how to create a project, install dependencies, run a code sample in a notebook, work with checkpoints, manage computing resources, publish a notebook, use Git, upload data from a variety of sources, and deploy a trained model as a microservice. +title: Guides on using {{ ml-platform-full-name }} +description: The page presents all the guides on how to use {{ ml-platform-full-name }} in {{ yandex-cloud }}. Learn how to create a project, install dependencies, run a code sample in a notebook, work with checkpoints, manage computing resources, publish a notebook, use Git, upload data from a variety of sources, and deploy a trained model as a microservice. --- # Step-by-step guides for {{ ml-platform-name }} @@ -79,6 +79,7 @@ description: The page contains all guides on working with {{ ml-platform-full-na * [{#T}](projects/authentication.md) * [{#T}](projects/work-with-jobs.md) * [{#T}](projects/jobs-toolkit.md) +* [{#T}](projects/use-job-results.md) ## Shared access to resources, projects, and computation results {#share} diff --git a/en/datasphere/operations/projects/use-job-results.md b/en/datasphere/operations/projects/use-job-results.md new file mode 100644 index 00000000000..87c6232279c --- /dev/null +++ b/en/datasphere/operations/projects/use-job-results.md @@ -0,0 +1,29 @@ +# Using results of completed jobs + +Sometimes you need to process the [job](../../concepts/jobs/index.md) outputs or use them to run another job. To do this, upload them using the {{ ds-jobs }} SDK `download_job_files` function or substitute them into another job using the [DAG Airflow](../../concepts/jobs/airflow.md) operator. + +## Uploading via {{ ds-cli }} {#cli} + +To upload job results into the working directory using [{{ ds-cli }}](../../concepts/jobs/cli.md), run this command by substituting the job ID: + +{% list tabs group=programming_language %} + +- Bash {#bash} + + ```bash + datasphere project job download-files --id + ``` + +{% endlist %} + +The function has optional parameters: + +* `with_logs`: Upload [logs](../../concepts/jobs/cli.md#logs), `false` by default. +* `with_diagnostics`: Upload diagnostic files, `false` by default. +* `with_diagnostics`: File upload directory, the working directory by default. + +To use the uploaded data in another job, specify the data in the `input` parameter in the `config.yaml` [file](../../concepts/jobs/index.md#config). + +## Uploading via DAG Airflow {#dag} + +{% include [dag-load-job-results](../../../_includes/datasphere/dag-load-job-results.md) %} diff --git a/en/datasphere/toc.yaml b/en/datasphere/toc.yaml index f2d4f37e41a..67edf2359b0 100644 --- a/en/datasphere/toc.yaml +++ b/en/datasphere/toc.yaml @@ -129,6 +129,8 @@ items: href: operations/projects/work-with-jobs.md - name: Working with Visual Studio Code jobs href: operations/projects/jobs-toolkit.md + - name: Using results of completed jobs + href: operations/projects/use-job-results.md - name: Shared access items: - name: Publishing a notebook @@ -253,7 +255,7 @@ items: href: tutorials/node-from-model.md - name: Deploying a gRPC service based on a Docker image href: tutorials/grpc-node.md - - name: '{{ yagpt-name }} model tuning' + - name: Fine-tuning {{ yagpt-name }} href: tutorials/yagpt-tuning.md - name: Tuning classifiers based on {{ yagpt-name }} href: tutorials/yagpt-tuning-classifier.md diff --git a/en/datasphere/troubleshooting/troubles-with-spark.md b/en/datasphere/troubleshooting/troubles-with-spark.md index 97dc04054dc..477c2ac9cdb 100644 --- a/en/datasphere/troubleshooting/troubles-with-spark.md +++ b/en/datasphere/troubleshooting/troubles-with-spark.md @@ -3,3 +3,12 @@ When using Spark, a hidden directory named `.spark/` is created in the project storage, and that directory contains service information about all Spark connectors available in the project. To see hidden files and directories, in the panel at the top of the {{ jlab }}Lab interface, click **View** ⟶ **Show Hidden Files**. A Spark session is created before the start of the first notebook cell and can be accessed via the `spark` variable. If an error occurs during session creation, the `spark` variable will not be available, and an error report will appear in a file named `.spark/connector//session_creation_err_.txt`. Attach this file when you contact [technical support]({{ link-console-support }}). + +## Error writing data to S3 {#s3-load-data} + +If a `Could not find any valid local directory for s3ablock-0001` error occurs when writing data to S3, add one of the following parameters in the Spark connector settings under **{{ ui-key.yc-ui-datasphere.spark-connector.spark-settings }}**: + +Parameter | Description +---|--- +`spark.hadoop.fs.s3a.fast.upload.buffer` = `bytebuffer` | Fast file upload using RAM. The file size must not exceed the available RAM size. +`spark.hadoop.fs.s3a.buffer.dir` = `/tmp` | Standard upload to disk diff --git a/en/dns/operations/zone-access.md b/en/dns/operations/zone-access.md index 3ce743243a1..e061914d3be 100644 --- a/en/dns/operations/zone-access.md +++ b/en/dns/operations/zone-access.md @@ -206,7 +206,7 @@ To grant a user, group, or [service account](../../iam/concepts/users/service-ac {% note alert %} - The `setAccessBindings` method and the `DnsZoneService/SetAccessBindings` call completely rewrite the resource access permissions. All current resource roles will be deleted. + The `setAccessBindings` method and the `DnsZoneService/SetAccessBindings` call completely overwrite access permissions for the resource. All current resource roles will be deleted. {% endnote %} diff --git a/en/dns/operations/zone-create-private.md b/en/dns/operations/zone-create-private.md index 74669762f9a..a3e116b8a83 100644 --- a/en/dns/operations/zone-create-private.md +++ b/en/dns/operations/zone-create-private.md @@ -15,7 +15,7 @@ To create a private [DNS zone](../concepts/dns-zone.md): 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_dns }}**. 1. Click **{{ ui-key.yacloud.dns.button_zone-create }}**. 1. Specify the zone settings: - 1. **{{ ui-key.yacloud.dns.label_zone }}**: Domain zone. The zone name must end with a dot. You cannot create public top-level domain (TLD) zones. To create a domain zone with non-Latin characters, use the [Punycode](https://{{ lang }}.wikipedia.org/wiki/Punycode) encoding. + 1. **{{ ui-key.yacloud.dns.label_zone }}**: Domain zone. The zone name must end with a period. You cannot create public top-level domain (TLD) zones. To create a domain zone with non-Latin characters, use the [Punycode](https://{{ lang }}.wikipedia.org/wiki/Punycode) encoding. 1. **{{ ui-key.yacloud.common.type }}**: `{{ ui-key.yacloud.dns.label_private }}`. 1. Specify the networks whose resources will be included in the zone being created. 1. **{{ ui-key.yacloud.common.name }}** of the zone. @@ -47,7 +47,7 @@ To create a private [DNS zone](../concepts/dns-zone.md): Where: * `--name`: Zone name. It must be unique within the folder. This is an optional parameter. - * `--zone`: Domain zone. The zone name must end with a dot. You cannot create public top-level domain (TLD) zones. To create a domain zone with non-Latin characters, use the [Punycode](https://{{ lang }}.wikipedia.org/wiki/Punycode) encoding. This is a required parameter. + * `--zone`: Domain zone. The zone name must end with a period. You cannot create public top-level domain (TLD) zones. To create a domain zone with non-Latin characters, use the [Punycode](https://{{ lang }}.wikipedia.org/wiki/Punycode) encoding. This is a required parameter. * `--private-visibility`: Flag for creating a private zone. * `--network-ids`: IDs of the networks whose resources will be included in the zone. @@ -93,11 +93,12 @@ To create a private [DNS zone](../concepts/dns-zone.md): * `name`: Zone name. It must be unique within the folder. This is an optional parameter. * `description`: Zone description. This is an optional parameter. * `labels`: DNS zone labels. This is an optional parameter. - * `zone`: Domain zone. The zone name must end with a dot. You cannot create public top-level domain (TLD) zones. To create a domain zone with non-Latin characters, use the [Punycode](https://{{ lang }}.wikipedia.org/wiki/Punycode) encoding. This is a required parameter. + * `zone`: Domain zone. The zone name must end with a period. You cannot create public top-level domain (TLD) zones. To create a domain zone with non-Latin characters, use the [Punycode](https://{{ lang }}.wikipedia.org/wiki/Punycode) encoding. This is a required parameter. * `public`: Zone visibility, public or private. This is an optional parameter. * `private_networks`: IDs of the networks that have access to domain names within this zone. This is an optional parameter. For more information about the `yandex_dns_zone` resource properties, see the [provider documentation]({{ tf-provider-resources-link }}/dns_zone). + 1. Create resources: {% include [terraform-validate-plan-apply](../../_tutorials/_tutorials_includes/terraform-validate-plan-apply.md) %} diff --git a/en/dns/operations/zone-create-public.md b/en/dns/operations/zone-create-public.md index 5d90ce6082d..cc60dae281b 100644 --- a/en/dns/operations/zone-create-public.md +++ b/en/dns/operations/zone-create-public.md @@ -15,8 +15,8 @@ To create a public [DNS zone](../concepts/dns-zone.md): 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_dns }}**. 1. Click **{{ ui-key.yacloud.dns.button_zone-create }}**. 1. Specify the zone settings: - 1. **{{ ui-key.yacloud.dns.label_zone }}**: Domain zone. The zone name must end with a dot. You cannot create public top-level domain (TLD) zones. To create a domain zone with non-Latin characters, use the [Punycode](https://{{ lang }}.wikipedia.org/wiki/Punycode) encoding. - 1. **{{ ui-key.yacloud.common.type }}**: `{{ ui-key.yacloud.dns.label_public }}`. + 1. **{{ ui-key.yacloud.dns.label_zone }}**: Domain zone. The zone name must end with a period. You cannot create public top-level domain (TLD) zones. To create a domain zone with non-Latin characters, use the [Punycode](https://{{ lang }}.wikipedia.org/wiki/Punycode) encoding. + 1. **{{ ui-key.yacloud.common.type }}**: `{{ ui-key.yacloud.dns.label_public }}` 1. **{{ ui-key.yacloud.common.name }}** of the zone. 1. Click **{{ ui-key.yacloud.common.create }}**. @@ -44,7 +44,7 @@ To create a public [DNS zone](../concepts/dns-zone.md): Where: * `--name`: Zone name. It must be unique within the folder. This is an optional parameter. - * `--zone`: Domain zone. The zone name must end with a dot. You cannot create public top-level domain (TLD) zones. To create a domain zone with non-Latin characters, use the [Punycode](https://{{ lang }}.wikipedia.org/wiki/Punycode) encoding. This is a required parameter. + * `--zone`: Domain zone. The zone name must end with a period. You cannot create public top-level domain (TLD) zones. To create a domain zone with non-Latin characters, use the [Punycode](https://{{ lang }}.wikipedia.org/wiki/Punycode) encoding. This is a required parameter. * `--public-visibility`: Flag for creating a public zone. Result: @@ -85,7 +85,7 @@ To create a public [DNS zone](../concepts/dns-zone.md): * `name`: Zone name. It must be unique within the folder. This is an optional parameter. * `description`: Zone description. This is an optional parameter. * `labels`: DNS zone labels. This is an optional parameter. - * `zone`: Domain zone. The zone name must end with a dot. You cannot create public top-level domain (TLD) zones. To create a domain zone with non-Latin characters, use the [Punycode](https://{{ lang }}.wikipedia.org/wiki/Punycode) encoding. This is a required parameter. + * `zone`: Domain zone. The zone name must end with a period. You cannot create public top-level domain (TLD) zones. To create a domain zone with non-Latin characters, use the [Punycode](https://{{ lang }}.wikipedia.org/wiki/Punycode) encoding. This is a required parameter. * `public`: Zone visibility, public or private. This is an optional parameter. For more information about the `yandex_dns_zone` resource properties, see the [provider documentation]({{ tf-provider-resources-link }}/dns_zone). @@ -106,4 +106,4 @@ To create a public [DNS zone](../concepts/dns-zone.md): {% endlist %} -To get access to public zone domain names, you need to delegate the domain. Specify the addresses of the `ns1.{{ dns-ns-host-sld }}` and the `ns2.{{ dns-ns-host-sld }}` servers in your user area on your registrar's website. \ No newline at end of file +To get access to public zone domain names, you need to delegate the domain. Specify the addresses of the `ns1.{{ dns-ns-host-sld }}` and `ns2.{{ dns-ns-host-sld }}` servers in your account on your registrar's website. \ No newline at end of file diff --git a/en/foundation-models/concepts/classifier/index.md b/en/foundation-models/concepts/classifier/index.md index ace3a7853ec..6ecc260ce97 100644 --- a/en/foundation-models/concepts/classifier/index.md +++ b/en/foundation-models/concepts/classifier/index.md @@ -1,11 +1,14 @@ # Classifiers based on {{ yagpt-name }} +_The {{ yagpt-name }} based classifier functionality is at the [Preview stage](../../../overview/concepts/launch-stages.md)._ + + {{ foundation-models-full-name }} allows classifying the text requests provided in prompts. Classification in {{ yagpt-name }}-based [models](./models.md) is implemented in the [{{ foundation-models-name }} Text Classification API](../../text-classification/api-ref/index.md). There are three types of classification available in {{ foundation-models-name }}: -* _Binary_ classification assigns a request to one of two classes, e.g., [spam](https://en.wikipedia.org/wiki/Spamming) or non-spam. +* _Binary_ classification puts a request into one of two possible classes, such as [spam](https://en.wikipedia.org/wiki/Spamming) or non-spam. * _Multi-class_ classification puts a request into one (and only one) of more than two classes. For example, a computer CPU can belong to one generation only. -* _Multi-label_ classification allows you to assign a request to multiple different non-mutually exclusive classes at the same time. For example, a single social media post may have multiple [hashtags](https://en.wikipedia.org/wiki/Hashtag) at the same time. +* _Multi-label_ classification allows putting a request into a number of different non-mutually exclusive classes at the same time. For example, multiple [hashtags](https://en.wikipedia.org/wiki/Hashtag) can belong to the same post on social media at the same time. Classification models are only available in [synchronous mode](../index.md#working-mode). @@ -13,7 +16,7 @@ Classification models are only available in [synchronous mode](../index.md#worki ## Prompt-based classifiers {#readymade} -{{ foundation-models-name }} prompt-based classifiers support binary and multi-class classification, require no model tuning, and are prompt-controlled. The [fewShotClassify](../../text-classification/api-ref/TextClassification/fewShotClassify.md) Text Classification API method enables [using](../../operations/classifier/readymade.md) these two prompt-based classifiers: _Zero-shot_ and _few-shot_. You can provide between 2 and 20 classes to the `fewShotClassify` method. +{{ foundation-models-name }} prompt-based classifiers support binary and multi-class classification, require no model tuning, and are prompt-controlled. The [fewShotClassify](../../text-classification/api-ref/TextClassification/fewShotClassify.md) Text Classification API method enables [using](../../operations/classifier/readymade.md) these two prompt-based classifiers: _Zero-shot_ and _Few-shot_. You can provide 2 to 20 classes to the `fewShotClassify` method. {% note tip %} @@ -23,9 +26,9 @@ Classification models are only available in [synchronous mode](../index.md#worki ### Zero-shot classifier {#zero-shot} -The zero-shot classifier allows you to perform binary and multi-class classification by providing only the [model ID](./models.md), task description, request text, and an array of class names in the request body. +The Zero-shot classifier allows to perform binary and multi-class classification by providing only the [model ID](./models.md), task description, request text, and an array of class names in the request body. -Request body format for the zero-shot classifier: +Request body format for the Zero-shot classifier: ```json { @@ -48,16 +51,16 @@ Where: {% include [labels-should-make-sense-notice](../../../_includes/foundation-models/classifier/labels-should-make-sense-notice.md) %} -* `text`: Message text. +* `text`: Text content of the message. -Use the `https://{{ api-host-llm }}/foundationModels/v1/fewShotTextClassification` endpoint for [requests](../../operations/classifier/readymade.md) to zero-shot classifiers. +Use the `https://{{ api-host-llm }}/foundationModels/v1/fewShotTextClassification` endpoint for [requests](../../operations/classifier/readymade.md) to Zero-shot classifiers. ### Few-shot classifier {#few-shot} -The few-shot classifier enables binary and multi-class classification by providing the model with an array of sample requests for the classes specified in the `labels` field. You need to list these sample requests in the `samples` field of the request body to get more accurate results from the classifier. +The Few-shot classifier enables binary and multi-class classification by providing the model with an array of sample requests for the classes specified in the `labels` field. Sample requests are provided in the `samples` field of the request body, improving the classifier result accuracy. -Request body format for the few-shot classifier: +Request body format for the Few-shot classifier: ```json { @@ -95,10 +98,10 @@ Where: {% include [labels-should-make-sense-notice](../../../_includes/foundation-models/classifier/labels-should-make-sense-notice.md) %} -* `text`: Message text. +* `text`: Text content of the message. * `samples`: Array of sample requests for the classes specified in the `labels` field. Sample requests are provided as objects, each one containing one text request sample and the class to which such request should belong. -Use the `https://{{ api-host-llm }}/foundationModels/v1/fewShotTextClassification` endpoint for [requests](../../operations/classifier/readymade.md) to few-shot classifiers. +Use the `https://{{ api-host-llm }}/foundationModels/v1/fewShotTextClassification` endpoint for [requests](../../operations/classifier/readymade.md) to Few-shot classifiers. {% note warning %} @@ -108,7 +111,7 @@ You can deliver multiple classification examples in a single request. All exampl ## Trainable classifiers {#trainable} -If you are not satisfied with the output quality of the [zero-shot](#zero-shot) and [few-shot](#few-shot) classifiers, [tune your own one](../../../datasphere/tutorials/yagpt-tuning-classifier.md) based on {{ yagpt-name }} in {{ ml-platform-full-name }}. [Trainable classifiers](../../../datasphere/concepts/models/foundation-models.md#classifier-training) can be trained to offer all supported classification types. +If you are not satisfied with the output quality of the [Zero-shot](#zero-shot) and [Few-shot](#few-shot) classifiers, [tune your own one](../../../datasphere/tutorials/yagpt-tuning-classifier.md) based on {{ yagpt-name }} in {{ ml-platform-full-name }}. [Trainable classifiers](../../../datasphere/concepts/models/foundation-models.md#classifier-training) can be trained to offer all supported classification types. To [run](../../operations/classifier/additionally-trained.md) a request to the classifier of a model fine-tuned in {{ ml-platform-name }}, use the [classify](../../text-classification/api-ref/TextClassification/classify.md) Text Classification API method. If you do so, you only need to provide the [model ID](./models.md) and the request text to the model. The names of the classes between which the model will be distributing requests must be specified during model tuning and are not provided in the request. @@ -157,7 +160,7 @@ All {{ foundation-models-name }} classifier types return the result in the follo Where: * `label`: Class name. -* `confidence`: Probability of assigning the request text to this class. +* `confidence`: Probability of the request text belonging to this class. In multi-class classification, the sum of the `confidence` values for all classes is always `1`. diff --git a/en/foundation-models/concepts/index.md b/en/foundation-models/concepts/index.md index de4afe237e7..f8950e0cd56 100644 --- a/en/foundation-models/concepts/index.md +++ b/en/foundation-models/concepts/index.md @@ -7,7 +7,7 @@ description: '{{ foundation-models-full-name }} is a service that provides acces {{ foundation-models-full-name }} comprises several large generative neural networks and allows you to leverage their capabilities for your business development. -The {{ yagpt-name }} neural network is geared to address various needs related to creating text content. {{ yagpt-full-name }} can generate product descriptions, articles, news stories, newsletters, blog posts, and many other things. The quality of the neural network's response depends directly on the accuracy of the instructions you provide. With a more specific prompt, you are more likely to get the result you expect. +{{ yagpt-name }} is geared to address various needs related to creating text content. {{ yagpt-full-name }} can generate product descriptions, articles, news stories, newsletters, blog posts, and many other things. The quality of the neural network's response depends directly on the accuracy of the instructions you provide. With a more specific prompt, you are more likely to get the result you expect. {{ foundation-models-name }} provides the [API](../embeddings/api-ref/index.md) to work with _embeddings_, i.e., vector representations of text. It can be used to classify information, compare and match texts, or search through a knowledge base of your own. For more information on embeddings and the Embeddings API, see [{#T}](./embeddings.md). @@ -31,4 +31,4 @@ Different models support different operating modes. Generative models are managed using _prompts_. A good prompt should contain the context of your request to the model (instruction) and the actual task the model should complete based on the provided context. The more specific your prompt, the more accurate will be the results returned by the model. -Apart from the prompt, other request parameters will impact the model's output too. Use {{ foundation-models-name }} Playground in the [management console]({{ link-console-main }}) to test your requests. +Apart from the prompt, other request parameters will impact the model's output too. Use {{ foundation-models-name }} Playground available from the [management console]({{ link-console-main }}) to test your requests. diff --git a/en/foundation-models/concepts/yandexart/index.md b/en/foundation-models/concepts/yandexart/index.md index d67abcd951f..22cd8bd6d0c 100644 --- a/en/foundation-models/concepts/yandexart/index.md +++ b/en/foundation-models/concepts/yandexart/index.md @@ -4,7 +4,7 @@ _The {{ yandexart-name }} feature is at the [Preview](../../../overview/concepts {{ yandexart-name }} is a generative neural network that creates images based on a text request. {{ yandexart-name }} uses the cascaded diffusion method to iteratively elaborate the images from noise. -In addition to a text description, you need to specify a special parameter called _seed_ to generate an image. A seed is any number from 0 to 2^64^. It serves as a starting point for image generation from noise and allows to achieve repeatability. Thus, with the same prompt and seed, the generation result will be the same. To change the generated image, change the seed value or the description. +In addition to a text description, you need to specify a special parameter called _seed_ to generate an image. A seed is any number from 0 to 2^63^-1. It serves as a starting point for image generation from noise and allows to achieve repeatability. Thus, with the same prompt and seed, the generation result will be the same. To change the generated image, change the seed value or the description. You can also specify the format of the final image in the `mime_type` parameter. Currently the supported value is `image/jpeg`. diff --git a/en/foundation-models/concepts/yandexgpt/index.md b/en/foundation-models/concepts/yandexgpt/index.md index 50ed4178c84..f66fcc5a4d5 100644 --- a/en/foundation-models/concepts/yandexgpt/index.md +++ b/en/foundation-models/concepts/yandexgpt/index.md @@ -8,7 +8,7 @@ There are two interfaces for {{ yagpt-full-name }} in {{ yandex-cloud }}. You ca {{ foundation-models-name }} Playground is a good option for introduction and testing: use it to send synchronous requests to {{ yagpt-full-name }} models. You can communicate with a model in these two formats: -* In **Prompt mode**, you submit a ready-made prompt to the model and get the result. The model treats each new question as a stand-alone task without saving the context of the previous request. In this format, you can choose between {{ gpt-lite }} and {{ gpt-pro }}, in the management console. +* In **Prompt mode**, you submit a ready-made prompt to the model and get the result. The model treats each new question as a stand-alone task without saving the context of the previous request. In this format, you can choose between the {{ gpt-lite }} and {{ gpt-pro }} models in the management console. * In **Chat mode**, you can chat with the model to update your instructions and elaborate on your previous inputs. The communication context is transmitted in every message and maintained throughout the current session until you explicitly start a new one. To work in chat mode, use the {{ gpt-pro }} model. @@ -18,9 +18,9 @@ To learn more about the {{ yagpt-full-name }} models, see [{#T}](models.md). ## Formatting of model responses {#answers-formatting} -By default, the model returns a response formatted using [Markdown](https://en.wikipedia.org/wiki/Markdown). Use the prompt text to get a response with additional formatting, e.g., with an [emoji](https://en.wikipedia.org/wiki/Emoji) or in a different format, such as [JSON](https://en.wikipedia.org/wiki/JSON), [XML](https://en.wikipedia.org/wiki/XML), etc. +By default, the model returns a response formatted using [Markdown](https://en.wikipedia.org/wiki/Markdown). Use the prompt text to get a response with additional formatting, e.g., with [emoji](https://en.wikipedia.org/wiki/Emoji), or in a different format, e.g., [JSON](https://en.wikipedia.org/wiki/JSON), [XML](https://en.wikipedia.org/wiki/XML), etc. -Example: +Examples: ```json { @@ -37,7 +37,7 @@ Example: }, { "role": "user", - "text": "Name any three groups of goods one can find in a grocery store. For each group, provide three subgroups. Present the result as a JSON object, with each group of goods as a key in the JSON object and arrays from the relevant subgroups as values. No introductory phrases or explanations needed, just data. Do not use Markdown!" + "text": "Name any three groups of products one can find in a grocery store. For each group, provide three subgroups. Present the result as a JSON object, where each group of products is represented by a key in the JSON object, and arrays from the relevant subgroups are the values. No introductory phrases or explanations needed, just data. Do not use Markdown." } ] } @@ -52,7 +52,7 @@ Result: { "message": { "role": "assistant", - "text": "{\n \"meat\": [\"beef\", \"pork\", \"mutton\"],\n \"dairy products\": [\"milk\", \"cottage cheese\", \"sour cream\"],\n \"fruits\": [\"apples\", \"bananas\", \"oranges\"]\n}" + "text": "{\n \"meat\": [\"beef\", \"pork\", \"mutton\"],\n \"dairy products\": [\"milk\", \"curd\", \"sour cream\"],\n \"fruit\": [\"apples\", \"bananas\", \"oranges\"]\n}" }, "status": "ALTERNATIVE_STATUS_FINAL" } @@ -69,7 +69,7 @@ Result: The model returned a response in JSON format with line breaks replaced with `\n` and quotation marks escaped. -If you do not get the expected result using the prompt, try [fine-tuning](../../tutorials/yagpt-tuning.md) the model in [{{ ml-platform-full-name}}]({{ link-datasphere-main }}). +If you do not get the result you expect using the prompt, try [fine-tuning](../../tutorials/yagpt-tuning.md) the model in [{{ ml-platform-full-name}}]({{ link-datasphere-main }}). #### See also {#see-also} diff --git a/en/foundation-models/operations/classifier/additionally-trained.md b/en/foundation-models/operations/classifier/additionally-trained.md index 45905066612..9f9c11a0031 100644 --- a/en/foundation-models/operations/classifier/additionally-trained.md +++ b/en/foundation-models/operations/classifier/additionally-trained.md @@ -37,9 +37,10 @@ To send a request to the classifier: ```bash export IAM_TOKEN= - curl -X POST \ - -H "Authorization: Bearer ${IAM_TOKEN}" \ - -d "@" \ + curl \ + --request POST \ + --header "Authorization: Bearer ${IAM_TOKEN}" \ + --data "@" \ "https://{{ api-host-llm }}:443/foundationModels/v1/textClassification" ``` diff --git a/en/foundation-models/operations/classifier/readymade.md b/en/foundation-models/operations/classifier/readymade.md index 55821ae7b9c..2ed0452b95d 100644 --- a/en/foundation-models/operations/classifier/readymade.md +++ b/en/foundation-models/operations/classifier/readymade.md @@ -30,7 +30,7 @@ To send a request to the classifier: ``` Where: - * `modelUri`: [ID of the model](../../../foundation-models/concepts/classifier/models.md) that will be used to classify the message. The parameter contains {{ yandex-cloud }} [folder ID](../../../resource-manager/operations/folder/get-id.md). + * `modelUri`: [ID of the model](../../../foundation-models/concepts/classifier/models.md) that will be used to classify the message. The parameter contains the {{ yandex-cloud }} [folder ID](../../../resource-manager/operations/folder/get-id.md). * `text`: Text content of the message. * `taskDescription`: Text description of the task for the classifier. * `labels`: Array of classes. @@ -67,14 +67,14 @@ To send a request to the classifier: ``` Where: - * `modelUri`: [ID of the model](../../../foundation-models/concepts/classifier/models.md) that will be used to classify the message. The parameter contains {{ yandex-cloud }} [folder ID](../../../resource-manager/operations/folder/get-id.md). + * `modelUri`: [ID of the model](../../../foundation-models/concepts/classifier/models.md) that will be used to classify the message. The parameter contains the {{ yandex-cloud }} [folder ID](../../../resource-manager/operations/folder/get-id.md). * `text`: Text content of the message. * `taskDescription`: Text description of the task for the classifier. * `labels`: Array of classes. {% include [labels-should-make-sense-notice](../../../_includes/foundation-models/classifier/labels-should-make-sense-notice.md) %} - * `samples`: Array of sample requests for the classes specified in the `labels` field. Sample requests are provided as objects, each one containing one text request sample and the class to which such request should belong. + * `samples`: Array with examples of requests for the classes specified in the `labels` field. Examples of requests are provided as objects, each containing one example of a text query and the class to which such query should belong. {% endlist %} @@ -90,20 +90,21 @@ To send a request to the classifier: ```bash export IAM_TOKEN= - curl -X POST \ - -H "Authorization: Bearer ${IAM_TOKEN}" \ - -d "@" \ + curl \ + --request POST \ + --header "Authorization: Bearer ${IAM_TOKEN}" \ + --data "@" \ "https://{{ api-host-llm }}/foundationModels/v1/fewShotTextClassification" ``` {% note info %} - The `https://{{ api-host-llm }}/foundationModels/v1/fewShotTextClassification` endpoint works only with prompt-based classifiers. For [fine-tuned](additionally-trained.md) classifiers, use `https://{{ api-host-llm }}:443/foundationModels/v1/textClassification`. + The `https://{{ api-host-llm }}/foundationModels/v1/fewShotTextClassification` endpoint only works with prompt-based classifiers. For [fine-tuned](additionally-trained.md) classifiers, use `https://{{ api-host-llm }}:443/foundationModels/v1/textClassification`. {% endnote %} {% endlist %} - In the response, the service will return classification results with certain `confidence` values for the probability of classifying the request text into each one of the classes: + In the response, the service will return classification results with certain `confidence` values for the probability of classifying the query text into each one of the classes: {% list tabs group=classifier-models %} @@ -153,4 +154,4 @@ To send a request to the classifier: {% endlist %} - The sum of the `confidence` values for all classes is always equal to `1`. \ No newline at end of file + The sum of the `confidence` values for all classes is always `1`. \ No newline at end of file diff --git a/en/foundation-models/operations/index.md b/en/foundation-models/operations/index.md index 2310409e5d9..b8003bc8f5f 100644 --- a/en/foundation-models/operations/index.md +++ b/en/foundation-models/operations/index.md @@ -1,5 +1,5 @@ --- -title: '{{ foundation-models-full-name }} guides' +title: Guides on using {{ foundation-models-full-name }} description: The page presents all the guides on how to use {{ foundation-models-full-name }} in {{ yandex-cloud }}. How-to guides. --- diff --git a/en/foundation-models/operations/yandexart/request.md b/en/foundation-models/operations/yandexart/request.md index 9fb34cdc155..7e3fa56de72 100644 --- a/en/foundation-models/operations/yandexart/request.md +++ b/en/foundation-models/operations/yandexart/request.md @@ -27,7 +27,7 @@ To improve the quality of responses, {{ yandexart-name }} logs user prompts. Do {% include [bash-windows-note-single](../../../_includes/translate/bash-windows-note-single.md) %} - 1. Create a request body file, e.g., `prompt.json`: + 1. Create a file with the request body, e.g., `prompt.json`: ```json { @@ -53,9 +53,10 @@ To improve the quality of responses, {{ yandexart-name }} logs user prompts. Do 1. To send a request to the neural network using the [ImageGenerationAsync.generate](../../image-generation/api-ref/ImageGenerationAsync/generate.md) method, run the following command: ```bash - curl --request POST \ - -H "Authorization: Bearer " \ - -d "@prompt.json" \ + curl \ + --request POST \ + --header "Authorization: Bearer " \ + --data "@prompt.json" \ "https://llm.{{ api-host }}/foundationModels/v1/imageGenerationAsync" ``` @@ -75,12 +76,12 @@ To improve the quality of responses, {{ yandexart-name }} logs user prompts. Do 1. Generating an image may take from a few seconds to a few hours. Wait for a while and send a request to `https://llm.api.cloud.yandex.net:443/operations/` to get the generation result. When the image is ready, you will get the result in a [Base64-encoded](https://en.wikipedia.org/wiki/Base64) file named `image.jpeg`. ```bash - curl -X GET -H "Authorization: Bearer " https://llm.api.cloud.yandex.net:443/operations/ | jq -r '.response | .image' | base64 -d > image.jpeg + curl --request GET --header "Authorization: Bearer " https://llm.api.cloud.yandex.net:443/operations/ | jq -r '.response | .image' | base64 -d > image.jpeg ``` Where: - * ``: IAM token you got [before you started](#before-begin). - * ``: The `id` field value obtained in response to the generation request. + * ``: IAM token you obtained [when getting started](#before-begin). + * ``: `id` field value obtained in response to the generation request. {% endlist %} diff --git a/en/foundation-models/operations/yandexgpt/async-request.md b/en/foundation-models/operations/yandexgpt/async-request.md index e4a0a3d5394..56b6ff9dc13 100644 --- a/en/foundation-models/operations/yandexgpt/async-request.md +++ b/en/foundation-models/operations/yandexgpt/async-request.md @@ -34,7 +34,7 @@ You can request {{ yagpt-full-name }} models in [asynchronous mode](../../concep "messages": [ { "role": "system", - "text": "Translate text" + "text": "Translate the text" }, { "role": "user", @@ -46,16 +46,17 @@ You can request {{ yagpt-full-name }} models in [asynchronous mode](../../concep {% include [api-parameters](../../../_includes/foundation-models/yandexgpt/api-parameters.md) %} - 1. To send the request to the model, run this command: + 1. Send a request to the model by running this command: ```bash export FOLDER_ID= export IAM_TOKEN= - curl --request POST \ - -H "Content-Type: application/json" \ - -H "Authorization: Bearer ${IAM_TOKEN}" \ - -H "x-folder-id: ${FOLDER_ID}" \ - -d "@" \ + curl \ + --request POST \ + --header "Content-Type: application/json" \ + --header "Authorization: Bearer ${IAM_TOKEN}" \ + --header "x-folder-id: ${FOLDER_ID}" \ + --data "@" \ "https://llm.{{ api-host }}/foundationModels/v1/completionAsync" ``` @@ -83,8 +84,9 @@ You can request {{ yagpt-full-name }} models in [asynchronous mode](../../concep 1. Send a request to get the operation result: ```bash - curl -X GET \ - -H "Authorization: Bearer ${IAM_TOKEN}" \ + curl \ + --request GET \ + --header "Authorization: Bearer ${IAM_TOKEN}" \ https://{{ api-host-operation }}/operations/ ``` diff --git a/en/foundation-models/operations/yandexgpt/create-chat.md b/en/foundation-models/operations/yandexgpt/create-chat.md index 8d2e71160f7..b7b1b57ab95 100644 --- a/en/foundation-models/operations/yandexgpt/create-chat.md +++ b/en/foundation-models/operations/yandexgpt/create-chat.md @@ -5,9 +5,9 @@ description: Follow this guide to learn how to use {{ yagpt-full-name }} in chat # How to create a chat with {{ yagpt-name }} -{{ yagpt-full-name }} models do not retain the context of previous messages, so to make a dialog with the model, you need to save the message history on the client side and send it with each request to the model. The [chat](../../concepts/yandexgpt/index.md) available in {{ foundation-models-name }} Playground consists of a series of prompts where the context of each new request includes the model's responses to previous ones. {{ yagpt-full-name }} models can work with context of up to {{ yagpt-max-tokens }} [tokens](../../concepts/yandexgpt/tokens.md). +{{ yagpt-full-name }} models do not retain the context of previous messages, so to have a continuous dialog with the model, you need to save the message history on your device and send it with each request to the model. The [chat](../../concepts/yandexgpt/index.md) available in {{ foundation-models-name }} Playground consists of a series of prompts where the context of each new request includes the model's responses to previous ones. {{ yagpt-full-name }} models can work with context of up to {{ yagpt-max-tokens }} [tokens](../../concepts/yandexgpt/tokens.md). -To create a chat with the model in your application and avoid delays in responses, send prompts in [synchronous](../../concepts/index.md#working-mode) mode using the [completion](../../text-generation/api-ref/TextGeneration/completion.md) method. +To create a chat with a model in your application and avoid delays in responses, send prompts in [synchronous](../../concepts/index.md#working-mode) mode using the [completion](../../text-generation/api-ref/TextGeneration/completion.md) method. To create a chat: @@ -46,94 +46,95 @@ To create a chat: - cURL {#curl} - Run this command: + Run this command: - ```bash - export FOLDER_ID= - export IAM_TOKEN= - curl --request POST \ - -H "Content-Type: application/json" \ - -H "Authorization: Bearer ${IAM_TOKEN}" \ - -H "x-folder-id: ${FOLDER_ID}" \ - -d "@" \ - "https://llm.{{ api-host }}/foundationModels/v1/completion" - ``` + ```bash + export FOLDER_ID= + export IAM_TOKEN= + curl \ + --request POST \ + --header "Content-Type: application/json" \ + --header "Authorization: Bearer ${IAM_TOKEN}" \ + --header "x-folder-id: ${FOLDER_ID}" \ + --data "@" \ + "https://llm.{{ api-host }}/foundationModels/v1/completion" + ``` - Where: + Where: - * `FOLDER_ID`: ID of the folder for which your account has the `{{ roles-yagpt-user }}` role or higher. - * `IAM_TOKEN`: IAM token of your account. + * `FOLDER_ID`: ID of the folder for which your account has the `{{ roles-yagpt-user }}` role or higher. + * `IAM_TOKEN`: Your account's IAM token. - Python 3 {#python} - 1. Create an `index.py` file and add the following code to it: + 1. Create a file named `index.py` and add the following code to it: - ```python - import requests - import json - import os + ```python + import requests + import json + import os - def gpt(auth_headers): + def gpt(auth_headers): - url = 'https://llm.api.cloud.yandex.net/foundationModels/v1/completion' + url = 'https://llm.api.cloud.yandex.net/foundationModels/v1/completion' - with open('body.json', 'r', encoding='utf-8') as f: - data = json.dumps(json.load(f)) - resp = requests.post(url, headers=auth_headers, data=data) + with open('body.json', 'r', encoding='utf-8') as f: + data = json.dumps(json.load(f)) + resp = requests.post(url, headers=auth_headers, data=data) - if resp.status_code != 200: - raise RuntimeError( - 'Invalid response received: code: {}, message: {}'.format( - {resp.status_code}, {resp.text} - ) - ) + if resp.status_code != 200: + raise RuntimeError( + 'Invalid response received: code: {}, message: {}'.format( + {resp.status_code}, {resp.text} + ) + ) - return resp.text + return resp.text - if __name__ == "__main__": - if os.getenv('IAM_TOKEN') is not None: - iam_token = os.environ['IAM_TOKEN'] - headers = { - 'Authorization': f'Bearer {iam_token}', - } - elif os.getenv('API_KEY') is not None: - api_key = os.environ['API_KEY'] - headers = { - 'Authorization': f'Api-Key {api_key}', - } - else: - print ('Please save either an IAM token or an API key into a corresponding `IAM_TOKEN` or `API_KEY` environment variable.') - exit() + if __name__ == "__main__": + if os.getenv('IAM_TOKEN') is not None: + iam_token = os.environ['IAM_TOKEN'] + headers = { + 'Authorization': f'Bearer {iam_token}', + } + elif os.getenv('API_KEY') is not None: + api_key = os.environ['API_KEY'] + headers = { + 'Authorization': f'Api-Key {api_key}', + } + else: + print ('Please save either an IAM token or an API key into a corresponding `IAM_TOKEN` or `API_KEY` environment variable.') + exit() - print(gpt(headers)) - ``` + print(gpt(headers)) + ``` - 1. Save the authentication data to the environment variable: + 1. Save the authentication data to the environment variable: - **Authentication using an IAM token:** + **Authentication with an IAM token:** - ```bash - export IAM_TOKEN= - ``` + ```bash + export IAM_TOKEN= + ``` - **Authentication using an API key (for service accounts only):** + **Authentication with an API key (for service accounts only):** - ```bash - export API_KEY= - ``` + ```bash + export API_KEY= + ``` - 1. Run the created file: + 1. Run the file you created: - ```bash - python index.py - ``` + ```bash + python index.py + ``` {% endlist %} -1. In response to the request, the model will return the generated text: +1. In response to your request, the model will return the generated text: {% cut "Result:" %} - + ```json { "result": { @@ -155,12 +156,12 @@ To create a chat: } } ``` - + {% endcut %} - + Save the `message` record value for use in subsequent requests. -1. Add the `message` record value obtained as a result of the previous request to the model, as well as the new user question, to the end of the `messages` array in the request file: +1. Add the `messages` record value obtained in the model's response to your previous request, as well as the new user question, to the end of the `message` array in the request file: ```json { @@ -181,7 +182,7 @@ To create a chat: }, { "role": "assistant", - "text": "Albert Einstein was an outstanding physicist, whose works in theoretical physics, theoretical mechanics, and philosophy of science became fundamental. He dedicated his career to studying the fundamentals of the Universe, including the theory of relativity, both special and general. Additionally, Albert Einstein studied:\n\n* thermodynamics,\n* statistical mechanics,\n* electromagnetism,\n* quantum theory,\n* special relativity, and others.\n\n His general relativity works found wide recognition and had a profound influence on the development of modern physics." + "text": "Albert Einstein was an outstanding physicist, whose works in theoretical physics, theoretical mechanics, and philosophy of science became fundamental. He dedicated his career to studying the fundamentals of the Universe, including the theory of relativity, both special and general. Additionally, Albert Einstein studied:\n\n* thermodynamics,\n* statistical mechanics,\n* electromagnetism,\n* quantum theory,\n* special relativity, and more.\n\n His general relativity works found wide recognition and had a profound influence on the development of modern physics." }, { "role": "user", @@ -191,7 +192,7 @@ To create a chat: } ``` -1. Send a new request to the model, repeating step 3 of this guide. In response to your request, the model will again return the generated text: +1. Send a new request to the model, repeating _Step 3_ of this guide. In response to your request, the model will again return the generated text: {% cut "Result:" %} @@ -202,7 +203,7 @@ To create a chat: { "message": { "role": "assistant", - "text": "Here are some discoveries commonly associated with the name of Albert Einstein:\n1. **Special theory of relativity (STR)**: Theory describing motion, laws of mechanics, and spatiotemporal relationships at random velocities less than the speed of light in a vacuum.\n1. **General theory of relativity (GTR)**: Geometric theory of gravitation based on the prediction of the interrelation between the spacetime, matter, and energy coordinates.\n1. **Quantum theory of the photoelectric effect**: Explanation of the photoelectric effect, the phenomenon of electron emission from matter under the influence of electromagnetic radiation.\n1. **Brownian motion**: Phenomenon of the chaotic, random movement of microscopic particles suspended in a liquid or a gas, caused by the thermal motion of molecules in the surrounding medium.\n1. **Equivalence principle**: Idea that gravitational and inertial mass are different aspects of the same physical quantity.\n1. **Cosmological solutions of the GTR equations**: Contribution to the theory of the structure and dynamics of the universe.\n1. **Nuclear model of the atom: Description of the atom structure based on protons, neutrons, and electrons.\nThese are just some of the discoveries made by Albert Einstein. His contributions to science and philosophy are immense, and his research continues to influence our ideas of nature and the universe." + "text": "Here are some discoveries commonly associated with the name of Albert Einstein:\n1. **Special theory of relativity (STR)**: Theory describing motion, laws of mechanics, and spatiotemporal relationships at random velocities less than the speed of light in a vacuum.\n1. **General theory of relativity (GTR)**: Geometric theory of gravitation based on the prediction of the interrelation between the spacetime, matter, and energy coordinates.\n1. **Quantum theory of the photoelectric effect**: Explanation of the photoelectric effect, a phenomenon of electron emission from matter under the influence of electromagnetic radiation.\n1. **Brownian motion**: Phenomenon of chaotic, random movement of microscopic particles suspended in a liquid or gas, caused by the thermal motion of molecules in the surrounding medium.\n1. **Equivalence principle**: Idea that gravitational and inertial mass are different aspects of the same physical quantity.\n1. **Cosmological solutions of the GTR equations**: Contribution to the theory of the structure and dynamics of the universe.\n1. **Nuclear model of the atom**: Description of the atom structure based on protons, neutrons, and electrons.\nThese are just some of the discoveries made by Albert Einstein. His contributions to science and philosophy are immense, and his research continues to shape our ideas of nature and the universe." }, "status": "ALTERNATIVE_STATUS_FINAL" } @@ -221,7 +222,7 @@ To create a chat: Once again, save the `message` record value for use in subsequent requests. -1. Continue to expand the request context with the received responses and user questions: +1. Continue expanding the request context with the received responses and user questions: ```json { @@ -242,7 +243,7 @@ To create a chat: }, { "role": "assistant", - "text": "Albert Einstein was an outstanding physicist, whose works in theoretical physics, theoretical mechanics, and philosophy of science became fundamental. He dedicated his career to studying the fundamentals of the Universe, including the theory of relativity, both special and general. Additionally, Albert Einstein studied:\n\n* thermodynamics,\n* statistical mechanics,\n* electromagnetism,\n* quantum theory,\n* special relativity, and others.\n\n His general relativity works found wide recognition and had a profound influence on the development of modern physics." + "text": "Albert Einstein was an outstanding physicist, whose works in theoretical physics, theoretical mechanics, and philosophy of science became fundamental. He dedicated his career to studying the fundamentals of the Universe, including the theory of relativity, both special and general. Additionally, Albert Einstein studied:\n\n* thermodynamics,\n* statistical mechanics,\n* electromagnetism,\n* quantum theory,\n* special relativity, and more.\n\n His general relativity works found wide recognition and had a profound influence on the development of modern physics." }, { "role": "user", @@ -250,11 +251,11 @@ To create a chat: }, { "role": "assistant", - "text": "Here are some discoveries commonly associated with the name of Albert Einstein:\n1. **Special theory of relativity (STR)**: Theory describing motion, laws of mechanics, and spatiotemporal relationships at random velocities less than the speed of light in a vacuum.\n1. **General theory of relativity (GTR)**: Geometric theory of gravitation based on the prediction of the interrelation between the spacetime, matter, and energy coordinates.\n1. **Quantum theory of the photoelectric effect**: Explanation of the photoelectric effect, the phenomenon of electron emission from matter under the influence of electromagnetic radiation.\n1. **Brownian motion**: Phenomenon of the chaotic, random movement of microscopic particles suspended in a liquid or a gas, caused by the thermal motion of molecules in the surrounding medium.\n1. **Equivalence principle**: Idea that gravitational and inertial mass are different aspects of the same physical quantity.\n1. **Cosmological solutions of the GTR equations**: Contribution to the theory of the structure and dynamics of the universe.\n1. **Nuclear model of the atom: Description of the atom structure based on protons, neutrons, and electrons.\nThese are just some of the discoveries made by Albert Einstein. His contributions to science and philosophy are immense, and his research continues to influence our ideas of nature and the universe." + "text": "Here are some discoveries commonly associated with the name of Albert Einstein:\n1. **Special theory of relativity (STR)**: Theory describing motion, laws of mechanics, and spatiotemporal relationships at random velocities less than the speed of light in a vacuum.\n1. **General theory of relativity (GTR)**: Geometric theory of gravitation based on the prediction of the interrelation between the spacetime, matter, and energy coordinates.\n1. **Quantum theory of the photoelectric effect**: Explanation of the photoelectric effect, a phenomenon of electron emission from matter under the influence of electromagnetic radiation.\n1. **Brownian motion**: Phenomenon of chaotic, random movement of microscopic particles suspended in a liquid or gas, caused by the thermal motion of molecules in the surrounding medium.\n1. **Equivalence principle**: Idea that gravitational and inertial mass are different aspects of the same physical quantity.\n1. **Cosmological solutions of the GTR equations**: Contribution to the theory of the structure and dynamics of the universe.\n1. **Nuclear model of the atom**: Description of the atom structure based on protons, neutrons, and electrons.\nThese are just some of the discoveries made by Albert Einstein. His contributions to science and philosophy are immense, and his research continues to shape our ideas of nature and the universe." }, { "role": "user", - "text": "Provide me with a shorter response" + "text": "Give me a shorter response" } ] } diff --git a/en/foundation-models/operations/yandexgpt/create-prompt.md b/en/foundation-models/operations/yandexgpt/create-prompt.md index f97fdb9288d..5cf76fb5742 100644 --- a/en/foundation-models/operations/yandexgpt/create-prompt.md +++ b/en/foundation-models/operations/yandexgpt/create-prompt.md @@ -11,7 +11,7 @@ To generate text in [prompt mode](../../concepts/index.md#working-mode), send a {% include notitle [ai-before-beginning](../../../_includes/foundation-models/yandexgpt/ai-before-beginning.md) %} -## Request to the model via the REST API {#request} +## Request to a model via the REST API {#request} {% list tabs group=programming_language %} @@ -48,23 +48,24 @@ To generate text in [prompt mode](../../concepts/index.md#working-mode), send a {% include [api-parameters](../../../_includes/foundation-models/yandexgpt/api-parameters.md) %} - 1. To send the request to the model, run this command: + 1. Send a request to the model by running this command: ```bash export FOLDER_ID= export IAM_TOKEN= - curl --request POST \ - -H "Content-Type: application/json" \ - -H "Authorization: Bearer ${IAM_TOKEN}" \ - -H "x-folder-id: ${FOLDER_ID}" \ - -d "@" \ + curl \ + --request POST \ + --header "Content-Type: application/json" \ + --header "Authorization: Bearer ${IAM_TOKEN}" \ + --header "x-folder-id: ${FOLDER_ID}" \ + --data "@" \ "https://llm.{{ api-host }}/foundationModels/v1/completion" ``` Where: * `FOLDER_ID`: ID of the folder for which your account has the `{{ roles-yagpt-user }}` role or higher. - * `IAM_TOKEN`: IAM token received [before getting started](#before-begin). + * `IAM_TOKEN`: IAM token you got [before you started](#before-begin). {% cut "Result:" %} @@ -137,7 +138,7 @@ To generate text in [prompt mode](../../concepts/index.md#working-mode), send a run(args.iam_token, args.folder_id, args.user_text) ``` - 1. Run the `test.py` file substituting the [IAM token](../../../iam/concepts/authorization/iam-token.md) and [folder ID](../../../resource-manager/operations/folder/get-id.md) values: + 1. Run the `test.py` file, substituting the [IAM token](../../../iam/concepts/authorization/iam-token.md) and [folder ID](../../../resource-manager/operations/folder/get-id.md) values: ```bash export IAM_TOKEN= @@ -159,7 +160,7 @@ To generate text in [prompt mode](../../concepts/index.md#working-mode), send a {% endlist %} -## Request to the model via the gRPC API {#request-grpc} +## Request to a model via the gRPC API {#request-grpc} {% list tabs group=programming_language %} @@ -167,7 +168,7 @@ To generate text in [prompt mode](../../concepts/index.md#working-mode), send a {% include [bash-windows-note-single](../../../_includes/translate/bash-windows-note-single.md) %} - 1. Clone the {{ yandex-cloud }} API repository by entering the code into a notebook cell. + 1. Clone the {{ yandex-cloud }} API repository by entering the code into a notebook cell: ```bash git clone https://github.com/yandex-cloud/cloudapi @@ -179,7 +180,7 @@ To generate text in [prompt mode](../../concepts/index.md#working-mode), send a pip install grpcio-tools ``` - 1. Go to the directory hosting the cloned {{ yandex-cloud }} API repository: + 1. Go to the folder hosting the cloned {{ yandex-cloud }} API repository: ```bash cd @@ -254,7 +255,7 @@ To generate text in [prompt mode](../../concepts/index.md#working-mode), send a run(args.iam_token, args.folder_id, args.user_text) ``` - 1. Run the `test.py` file substituting the [IAM token](../../../iam/concepts/authorization/iam-token.md) and [folder ID](../../../resource-manager/operations/folder/get-id.md) values: + 1. Run the `test.py` file, substituting the [IAM token](../../../iam/concepts/authorization/iam-token.md) and [folder ID](../../../resource-manager/operations/folder/get-id.md) values: ```bash export IAM_TOKEN= @@ -280,7 +281,7 @@ To generate text in [prompt mode](../../concepts/index.md#working-mode), send a With the `stream` parameter enabled, the server will provide not just the final text generation result but intermediate results as well. Each intermediate response contains the whole currently available generation result. Until the final response is received, the generation results may change as new messages arrive. -The `stream` parameter's operation is most evident when creating and processing large texts. +You can see most clearly how the `stream` parameter works when creating and processing large texts. {% note warning %} @@ -288,7 +289,7 @@ The `stream` parameter is not available for the model's [asynchronous mode](asyn {% endnote %} -Generate the gRPC client interface code as described in [this guide](#request-grpc). At Step 6, generate a file named `test.py` with the code to access the model. +Generate the gRPC client interface code as described in [this guide](#request-grpc). At _Step 6_, generate a file named `test.py` with the code to access the model. ```python # coding=utf8 diff --git a/en/foundation-models/operations/yandexgpt/disable-logging.md b/en/foundation-models/operations/yandexgpt/disable-logging.md index 7250c513d35..399b0275cfb 100644 --- a/en/foundation-models/operations/yandexgpt/disable-logging.md +++ b/en/foundation-models/operations/yandexgpt/disable-logging.md @@ -16,12 +16,13 @@ Request example: export FOLDER_ID= export IAM_TOKEN= - curl --request POST \ - -H "Content-Type: application/json" \ - -H "Authorization: Bearer ${IAM_TOKEN}" \ - -H "x-data-logging-enabled: false" \ - -H "x-folder-id: ${FOLDER_ID}" \ - -d "@" \ + curl \ + --request POST \ + --header "Content-Type: application/json" \ + --header "Authorization: Bearer ${IAM_TOKEN}" \ + --header "x-data-logging-enabled: false" \ + --header "x-folder-id: ${FOLDER_ID}" \ + --data "@" \ "https://llm.{{ api-host }}/foundationModels/v1/completion" ``` diff --git a/en/foundation-models/pricing.md b/en/foundation-models/pricing.md index acea4871b0c..6d0c64c6b6f 100644 --- a/en/foundation-models/pricing.md +++ b/en/foundation-models/pricing.md @@ -129,6 +129,7 @@ Cost of using {{ yagpt-full-name }} for text generation with the following param * Model working mode: Synchronous + {% include [usd-generating-pro-ml](../_pricing_examples/foundation-models/usd-generating-pro-ml.md) %} diff --git a/en/foundation-models/quickstart/yandexart.md b/en/foundation-models/quickstart/yandexart.md index 66e5ff0c2bf..d1049167315 100644 --- a/en/foundation-models/quickstart/yandexart.md +++ b/en/foundation-models/quickstart/yandexart.md @@ -4,40 +4,40 @@ In this section, you will learn how to use the {{ yandexart-name }} neural network to generate images. -In the [management console]({{ link-console-main }}/link/foundation-models/yandexart), {{ art-freetier }} free requests per day are available to new users without a [billing account](../../billing/concepts/billing-account.md). To access the API and increase usage [quotas](../concepts/limits.md), [link](../../billing/operations/pin-cloud.md) your billing account to the cloud. +In the [management console]({{ link-console-main }}/link/foundation-models/yandexart), {{ art-freetier }} free prompts per day are available to new users without a [billing account](../../billing/concepts/billing-account.md). To access the API and increase usage [quotas](../concepts/limits.md), [link](../../billing/operations/pin-cloud.md) your billing account to the cloud. ## Getting started {#before-begin} To get started in {{ yandex-cloud }}: 1. Log in to the [management console]({{ link-console-main }}). If not signed up yet, navigate to the management console and follow the instructions. -1. In [{{ billing-name }}]({{ link-console-billing }}), make sure that you have a [billing account](../../billing/concepts/billing-account.md) linked and its [status](../../billing/concepts/billing-account-statuses.md) is `ACTIVE` or `TRIAL_ACTIVE`. If you do not have a billing account yet, [create one](../../billing/quickstart/index.md#create_billing_account). +1. In [{{ billing-name }}]({{ link-console-billing }}), make sure you have a [billing account](../../billing/concepts/billing-account.md) linked and its [status](../../billing/concepts/billing-account-statuses.md) is `ACTIVE` or `TRIAL_ACTIVE`. If you do not have a billing account yet, [create one](../../billing/quickstart/index.md#create_billing_account). 1. If you do not have a [folder](../../resource-manager/concepts/resources-hierarchy.md#folder) yet, [create one](../../resource-manager/operations/folder/create.md). {% list tabs group=instructions %} - Management console {#console} - You can start working from the management console right away. + You can start working from the management console right away. - API {#api} - To run sample requests using the API, install: + To run sample requests using the API, install: - * [cURL](https://curl.haxx.se) to send API requests - * [jq](https://github.com/jqlang/jq) utility to work with JSON files + * [cURL](https://curl.haxx.se) to send API requests + * [jq](https://github.com/jqlang/jq) utility to work with JSON files - To work with the {{ yandexart-name }} API, you need to get authenticated using your account: + To work with the {{ yandexart-name }} API, you need to get authenticated using your account: - 1. Get an IAM token for your [Yandex account](../../iam/operations/iam-token/create.md) or [federated account](../../iam/operations/iam-token/create-for-federation.md). - 1. Get the [ID of the folder](../../resource-manager/operations/folder/get-id.md) for which your account has the `{{ roles-yaart-user }}` role or higher. You will need the folder ID to get the [model's URI](../concepts/yandexart/models.md). - 1. When accessing {{ yandexart-name }} via the API, specify the IAM token in the `Authorization` header of each request: + 1. Get an IAM token for your [Yandex account](../../iam/operations/iam-token/create.md) or [federated account](../../iam/operations/iam-token/create-for-federation.md). + 1. Get the [ID of the folder](../../resource-manager/operations/folder/get-id.md) for which your account has the `{{ roles-yaart-user }}` role or higher. You will need the folder ID to get the [model URI](../concepts/yandexart/models.md). + 1. When accessing {{ yandexart-name }} via the API, specify the IAM token in the `Authorization` header of each request: - ```json - x-folder-id: - ``` + ```json + x-folder-id: + ``` - For information about other API authentication methods, see [{#T}](../api-ref/authentication.md). + For information about other API authentication methods, see [{#T}](../api-ref/authentication.md). {% endlist %} @@ -53,74 +53,79 @@ To improve the quality of responses, {{ yandexart-name }} logs user prompts. Do - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the folder for which your account has the `{{ roles-yaart-user }}` role or higher. - 1. In the list of services, select **{{ foundation-models-name }}**. - 1. In the left-hand panel, select ![image](../../_assets/console-icons/palette.svg) **{{ yandexart-name }}**. - 1. In the input field, describe the image you want to generate. You should use vivid and detailed descriptions, specify styles if you want your image styled in a certain way. - 1. Leave the [**seed** parameter](../concepts/yandexart/index.md) random or specify any value. - 1. Click **Generate**. Generating an image takes some time. The output will appear on the left side of the screen. + 1. In the [management console]({{ link-console-main }}), select the folder for which your account has the `{{ roles-yaart-user }}` role or higher. + 1. In the list of services, select **{{ foundation-models-name }}**. + 1. In the left-hand panel, select ![image](../../_assets/console-icons/palette.svg) **{{ yandexart-name }}**. + 1. In the input field, describe the image you want to generate. You should use vivid and detailed descriptions, specify styles if you want your image styled in a certain way. + 1. Leave the [**seed** parameter](../concepts/yandexart/index.md) random or specify any value. + 1. Click **Generate**. Generating an image takes some time. The output will appear on the left side of the screen. - API {#api} - 1. Create a file with the request body, e.g., `prompt.json`: - - ```json - { - "modelUri": "art:///yandex-art/latest", - "generationOptions": { - "seed": "1863", - "aspectRatio": { - "widthRatio": "2", - "heightRatio": "1" - } - }, - "messages": [ - { - "weight": "1", - "text": "a pattern of pastel colored succulents of various sorts, hd full wallpaper, sharp focus, many intricate details, picture depth, top view" + 1. Create a file with the request body, e.g., `prompt.json`: + + ```json + { + "modelUri": "art:///yandex-art/latest", + "generationOptions": { + "seed": "1863", + "aspectRatio": { + "widthRatio": "2", + "heightRatio": "1" } - ] - } - ``` + }, + "messages": [ + { + "weight": "1", + "text": "a pattern of pastel colored succulents of various sorts, hd full wallpaper, sharp focus, many intricate details, picture depth, top view" + } + ] + } + ``` - {% include [api-parameters](../../_includes/foundation-models/yandexart/api-parameters.md) %} + {% include [api-parameters](../../_includes/foundation-models/yandexart/api-parameters.md) %} - 1. To send a request to the neural network using the [ImageGenerationAsync.generate](../image-generation/api-ref/ImageGenerationAsync/generate.md) method, run the following command: + 1. To send a request to the neural network using the [ImageGenerationAsync.generate](../image-generation/api-ref/ImageGenerationAsync/generate.md) method, run the following command: - ```bash - curl --request POST \ - -H "Authorization: Bearer " \ - -d "@prompt.json" \ - "https://llm.{{ api-host }}/foundationModels/v1/imageGenerationAsync" - ``` + ```bash + curl \ + --request POST \ + --header "Authorization: Bearer " \ + --data "@prompt.json" \ + "https://llm.{{ api-host }}/foundationModels/v1/imageGenerationAsync" + ``` - Where: + Where: - * ``: IAM token you got for your account. - * `prompt.json`: JSON file with request parameters. + * ``: IAM token you got for your account. + * `prompt.json`: JSON file with request parameters. - The service will return the ID of your request in response: + The service will return the ID of your request in response: - ```json - { - "id":"fbveu1sntj**********","description":"","createdAt":null,"createdBy":"","modifiedAt":null,"done":false,"metadata":null} - ``` + ```json + { + "id":"fbveu1sntj**********","description":"","createdAt":null,"createdBy":"","modifiedAt":null,"done":false,"metadata":null} + ``` - 1. Generating an image takes some time. Wait for 10 seconds and send your request to get the generation result. When the image is ready, you will get the result in a [Base64-encoded](https://en.wikipedia.org/wiki/Base64) file named `image.jpeg`. + 1. Generating an image takes some time. Wait for 10 seconds and send your request to get the generation result. When the image is ready, you will get the result in a [Base64-encoded](https://en.wikipedia.org/wiki/Base64) file named `image.jpeg`. - ```bash - curl -X GET -H "Authorization: Bearer " https://llm.api.cloud.yandex.net:443/operations/ | jq -r '.response | .image' | base64 -d > image.jpeg - ``` + ```bash + curl \ + --request GET \ + --header "Authorization: Bearer " \ + https://llm.api.cloud.yandex.net:443/operations/ | \ + jq -r '.response | .image' | base64 -d > image.jpeg + ``` - Where: + Where: - * ``: IAM token received [before you started](#before-begin). - * ``: `id` field value obtained in response to the generation request. + * ``: IAM token you got [before you started](#before-begin). + * ``: The `id` field value obtained in response to the generation request. - **Result:** + **Result**: - ![succulent](../../_assets/yandexgpt/succulent.jpeg) + ![succulent](../../_assets/yandexgpt/succulent.jpeg) {% endlist %} diff --git a/en/foundation-models/quickstart/yandexgpt.md b/en/foundation-models/quickstart/yandexgpt.md index e9f37a101d9..dbf71e0415e 100644 --- a/en/foundation-models/quickstart/yandexgpt.md +++ b/en/foundation-models/quickstart/yandexgpt.md @@ -2,7 +2,7 @@ In this section, you will learn how to use the {{ yagpt-name }} neural network to generate text in [synchronous mode](../concepts/index.md#working-mode) without adding context. For other examples, see [Guides on how to use {{ yagpt-full-name }}](../operations/index.md#yandexgpt-api) -The [management console]({{ link-console-main }}/link/foundation-models/yandexgpt) provides a quick and easy way for new users without a [billing account](../../billing/concepts/billing-account.md) to try out the model with {{ gpt-freetier }} free prompts per hour. To access the API and increase usage [quotas](../concepts/limits.md), [link](../../billing/operations/pin-cloud.md) your billing account to your cloud. +The [management console]({{ link-console-main }}/link/foundation-models/yandexgpt) provides a quick and easy way for new users without a [billing account](../../billing/concepts/billing-account.md) to try out the model with {{ gpt-freetier }} free requests per hour. To access the API and increase usage [quotas](../concepts/limits.md), [link](../../billing/operations/pin-cloud.md) your billing account to your cloud. For information about {{ yagpt-full-name }} pricing, see [{#T}](../pricing.md). @@ -11,34 +11,34 @@ For information about {{ yagpt-full-name }} pricing, see [{#T}](../pricing.md). To get started in {{ yandex-cloud }}: 1. Log in to the [management console]({{ link-console-main }}). If not signed up yet, navigate to the management console and follow the instructions. -1. In [{{ billing-name }}]({{ link-console-billing }}), make sure that you have a [billing account](../../billing/concepts/billing-account.md) linked and its [status](../../billing/concepts/billing-account-statuses.md) is `ACTIVE` or `TRIAL_ACTIVE`. If you do not have a billing account yet, [create one](../../billing/quickstart/index.md#create_billing_account). +1. In [{{ billing-name }}]({{ link-console-billing }}), make sure you have a [billing account](../../billing/concepts/billing-account.md) linked and its [status](../../billing/concepts/billing-account-statuses.md) is `ACTIVE` or `TRIAL_ACTIVE`. If you do not have a billing account yet, [create one](../../billing/quickstart/index.md#create_billing_account). 1. If you do not have a [folder](../../resource-manager/concepts/resources-hierarchy.md#folder) yet, [create one](../../resource-manager/operations/folder/create.md). {% list tabs group=instructions %} - Management console {#console} - You can start working from the management console right away. + You can start working from the management console right away. - API {#api} - To run sample requests using the API, install [cURL](https://curl.haxx.se). + To run sample requests using the API, install [cURL](https://curl.haxx.se). - To work with the {{ yagpt-name }} API, you need to get authenticated using your account: + To work with the {{ yagpt-name }} API, you need to get authenticated using your account: - 1. Get an IAM token: see the guide for a [Yandex account](../../iam/operations/iam-token/create.md) or [federated account](../../iam/operations/iam-token/create-for-federation.md). - 1. Get the [ID of the folder](../../resource-manager/operations/folder/get-id.md) for which your account has the `{{ roles-yagpt-user }}` role or higher. - 1. When accessing {{ yagpt-full-name }} via the API, provide the received parameters in each request: + 1. Get an IAM token: see the guide for a [Yandex account](../../iam/operations/iam-token/create.md) or [federated account](../../iam/operations/iam-token/create-for-federation.md). + 1. Get the [ID of the folder](../../resource-manager/operations/folder/get-id.md) for which your account has the `{{ roles-yagpt-user }}` role or higher. + 1. When accessing {{ yagpt-full-name }} via the API, provide the received parameters in each request: - * Specify the IAM token in the `Authorization` header. - * Specify the folder ID in the `x-folder-id` header. + * Specify the IAM token in the `Authorization` header. + * Specify the folder ID in the `x-folder-id` header. - ```json - Authorization: Bearer - x-folder-id: - ``` + ```json + Authorization: Bearer + x-folder-id: + ``` - For information about other API authentication methods, see [{#T}](../api-ref/authentication.md). + For information about other API authentication methods, see [{#T}](../api-ref/authentication.md). {% endlist %} @@ -50,93 +50,94 @@ To get started in {{ yandex-cloud }}: - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the folder for which your account has the `{{ roles-yagpt-user }}` role or higher. - 1. In the list of services, select **{{ foundation-models-name }}**. - 1. In the left-hand panel, select ![image](../../_assets/console-icons/dice-3.svg) **{{ ui-key.yacloud.yagpt.label_promt }}**. - - ![screen01](../../_assets/foundation-models/quickstart/yandexgpt/screen01.png) + 1. In the [management console]({{ link-console-main }}), select the folder for which your account has the `{{ roles-yagpt-user }}` role or higher. + 1. In the list of services, select **{{ foundation-models-name }}**. + 1. In the left-hand panel, select ![image](../../_assets/console-icons/dice-3.svg) **{{ ui-key.yacloud.yagpt.label_promt }}**. - 1. In the **{{ ui-key.yacloud.yagpt.label_temperature-text }}** field, enter a value between `0` and `1` that determines the versatility of the model's response. With a higher value, you get less deterministic request result. - 1. Describe the request context under **{{ ui-key.yacloud.yagpt.label_instruction-text }}**. - 1. Describe your request to the model under **{{ ui-key.yacloud.yagpt.label_request-text }}**. - 1. Click **{{ ui-key.yacloud.yagpt.label_button-instruct-submit }}**. The answer will be shown on the right part of the screen. + ![screen01](../../_assets/foundation-models/quickstart/yandexgpt/screen01.png) - ![screen02](../../_assets/foundation-models/quickstart/yandexgpt/screen02.png) + 1. In the **{{ ui-key.yacloud.yagpt.label_temperature-text }}** field, enter a value between `0` and `1` for the model's response variability. With a higher value, you get a less deterministic result. + 1. Describe the request context under **{{ ui-key.yacloud.yagpt.label_instruction-text }}**. + 1. Describe your request to the model under **{{ ui-key.yacloud.yagpt.label_request-text }}**. + 1. Click **{{ ui-key.yacloud.yagpt.label_button-instruct-submit }}**. The answer will be shown on the right part of the screen. + + ![screen02](../../_assets/foundation-models/quickstart/yandexgpt/screen02.png) - API {#api} - 1. Create a file with the request body, e.g., `prompt.json`: - - ```json - { - "modelUri": "gpt:///yandexgpt-lite", - "completionOptions": { - "stream": false, - "temperature": 0.6, - "maxTokens": "2000" - }, - "messages": [ - { - "role": "system", - "text": "Find errors in the text and fix them" - }, - { - "role": "user", - "text": "Laminate flooring is sutiable for instalation in the kitchen or in a child's room. It withsatnds moisturre and mechanical dammage thanks to a proctive layer of melamine films 0.2 mm thick and a wax-treated interlocking systme." - } - ] - } - ``` - - Where: - - {% include [api-parameters](../../_includes/foundation-models/yandexgpt/api-parameters.md) %} - - 1. Use the [completion](../text-generation/api-ref/TextGeneration/completion.md) method to send a request to the neural network in the following command: - - ```bash - export FOLDER_ID= - export IAM_TOKEN= - curl --request POST \ - -H "Content-Type: application/json" \ - -H "Authorization: Bearer ${IAM_TOKEN}" \ - -H "x-folder-id: ${FOLDER_ID}" \ - -d "@prompt.json" \ - "https://llm.{{ api-host }}/foundationModels/v1/completion" - ``` - - Where: - - * `FOLDER_ID`: ID of the folder for which your account has the `{{ roles-yagpt-user }}` role or higher. - * `IAM_TOKEN`: IAM token received [before starting](#before-begin). - - The service will respond with the generated text: - - ```json - { - "result": { - "alternatives": [ - { - "message": { - "role": "assistant", - "text": "Laminate flooring is suitable for installation in the kitchen or in a child's room. It withstands moisture and mechanical damage thanks to a protective layer of melamine films 0.2 mm thick and a wax-treated interlocking system." - }, - "status": "ALTERNATIVE_STATUS_TRUNCATED_FINAL" - } - ], - "usage": { - "inputTextTokens": "67", - "completionTokens": "50", - "totalTokens": "117" - }, - "modelVersion": "06.12.2023" - } - } - ``` + 1. Create a file with the request body, e.g., `prompt.json`: + + ```json + { + "modelUri": "gpt:///yandexgpt-lite", + "completionOptions": { + "stream": false, + "temperature": 0.6, + "maxTokens": "2000" + }, + "messages": [ + { + "role": "system", + "text": "Find and correct errors in the text." + }, + { + "role": "user", + "text": "Laminate flooring is sutiable for instalation in the kitchen or in a child's room. It withsatnds moisturre and mechanical dammage thanks to a proctive layer of melamine films 0.2 mm thick and a wax-treated interlocking systme." + } + ] + } + ``` + + Where: + + {% include [api-parameters](../../_includes/foundation-models/yandexgpt/api-parameters.md) %} + + 1. Use the [completion](../text-generation/api-ref/TextGeneration/completion.md) method to send a request to the neural network in the following command: + + ```bash + export FOLDER_ID= + export IAM_TOKEN= + curl \ + --request POST \ + --header "Content-Type: application/json" \ + --header "Authorization: Bearer ${IAM_TOKEN}" \ + --header "x-folder-id: ${FOLDER_ID}" \ + --data "@prompt.json" \ + "https://llm.{{ api-host }}/foundationModels/v1/completion" + ``` + + Where: + + * `FOLDER_ID`: ID of the folder for which your account has the `{{ roles-yagpt-user }}` role or higher. + * `IAM_TOKEN`: IAM token you got [before you started](#before-begin). + + In response, the service will return the generated text: + + ```json + { + "result": { + "alternatives": [ + { + "message": { + "role": "assistant", + "text": "Laminate flooring is suitable for installation in the kitchen or in a child's room. It withstands moisture and mechanical damage thanks to a protective layer of melamine films 0.2 mm thick and a wax-treated interlocking system." + }, + "status": "ALTERNATIVE_STATUS_TRUNCATED_FINAL" + } + ], + "usage": { + "inputTextTokens": "67", + "completionTokens": "50", + "totalTokens": "117" + }, + "modelVersion": "06.12.2023" + } + } + ``` {% endlist %} #### What's next {#what-is-next} * [Learn more about {{ yagpt-full-name }}](../concepts/index.md) -* [Learn about API authentication methods](../api-ref/authentication.md) +* [Learn about API authentication methods](../api-ref/authentication.md) \ No newline at end of file diff --git a/en/foundation-models/sdk/index.md b/en/foundation-models/sdk/index.md new file mode 100644 index 00000000000..67eff157ae2 --- /dev/null +++ b/en/foundation-models/sdk/index.md @@ -0,0 +1,39 @@ +# {{ ml-sdk-full-name }} + +{{ ai-studio-full-name }} provides {{ ml-sdk-full-name }}, a library of tools and code examples for Python development. {{ ml-sdk-name }} provides a standardized method of working with foundation models and simplifies integration with other {{ yandex-cloud }} services. + +The {{ ml-sdk-name }} library implements the synchronous and asynchronous Python interfaces based on gRPC API calls of {{ ai-studio-name }} services. {{ ml-sdk-name }} offers the following features: +* [Text generation](../concepts/yandexgpt/index.md) by {{ yagpt-name }} +* Working with [embeddings](../concepts/embeddings.md) +* Working with [{{ yagpt-name }} based classifiers](../concepts/classifier/index.md) +* Integration with [LangChain](https://www.langchain.com/) + +You can see the full list of supported functions, library source code, and use cases on [GitHub](https://github.com/yandex-cloud/yandex-cloud-ml-sdk). + +## Installation and usage {#install} + +You can install the {{ ml-sdk-name }} library using the [pip](https://pip.pypa.io/en/stable/) package manager: + +```bash +pip install yandex-cloud-ml-sdk +``` + +When initializing the library, you need to specify the [ID of the folder](../../resource-manager/operations/folder/get-id.md) you will use to work with models as well as authentication credentials. {{ ml-sdk-name }} supports the following authentication methods: +* [IAM token](../../iam/operations/iam-token/create.md) +* [API key](../../iam/operations/api-key/create.md) +* [OAuth token](../../iam/concepts/authorization/oauth-token.md) + +The example below will prompt {{ gpt-pro }} with "What is sky?". + +```python +from yandex_cloud_ml_sdk import YCloudML + +sdk = YCloudML(folder_id="", auth="") + +model = sdk.models.completions('yandexgpt') +model = model.configure(temperature=0.5) +result = model.run("What is sky?") + +for alternative in result: + print(alternative) +``` \ No newline at end of file diff --git a/en/foundation-models/text-generation/api-ref/TextGeneration/completion.md b/en/foundation-models/text-generation/api-ref/TextGeneration/completion.md index 1719f3b1d5b..ae0b2d5b77e 100644 --- a/en/foundation-models/text-generation/api-ref/TextGeneration/completion.md +++ b/en/foundation-models/text-generation/api-ref/TextGeneration/completion.md @@ -26,8 +26,45 @@ POST https://llm.{{ api-host }}/foundationModels/v1/completion "messages": [ { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "object" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } + // end of the list of possible fields + } + ], + "tools": [ + { + // Includes only one of the fields `function` + "function": { + "name": "string", + "description": "string", + "parameters": "object" + } // end of the list of possible fields } ] @@ -47,6 +84,10 @@ Configuration options for completion generation. || || messages[] | **[Message](#yandex.cloud.ai.foundation_models.v1.Message)** A list of messages representing the context for the completion model. || +|| tools[] | **[Tool](#yandex.cloud.ai.foundation_models.v1.Tool)** + +List of tools that are available for the model to invoke during the completion generation. +Note: This parameter is not yet supported and will be ignored if provided. || |# ## CompletionOptions {#yandex.cloud.ai.foundation_models.v1.CompletionOptions} @@ -85,9 +126,134 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **object** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + +## Tool {#yandex.cloud.ai.foundation_models.v1.Tool} + +Represents a tool that can be invoked during completion generation. + +#| +||Field | Description || +|| function | **[FunctionTool](#yandex.cloud.ai.foundation_models.v1.FunctionTool)** + +Represents a function that can be called. + +Includes only one of the fields `function`. || +|# + +## FunctionTool {#yandex.cloud.ai.foundation_models.v1.FunctionTool} + +Represents a function tool that can be invoked during completion generation. + +#| +||Field | Description || +|| name | **string** + +The name of the function. || +|| description | **string** + +A description of the function's purpose or behavior. || +|| parameters | **object** + +A JSON Schema that defines the expected parameters for the function. +The schema should describe the required fields, their types, and any constraints or default values. || |# ## Response {#yandex.cloud.ai.foundation_models.v1.CompletionResponse} @@ -100,8 +266,34 @@ Message content. || { "message": { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "object" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } // end of the list of possible fields }, "status": "string" @@ -149,7 +341,8 @@ The generation status of the alternative - `ALTERNATIVE_STATUS_TRUNCATED_FINAL`: Incomplete final alternative resulting from reaching the maximum allowed number of tokens. - `ALTERNATIVE_STATUS_FINAL`: Final alternative generated without running into any limits. - `ALTERNATIVE_STATUS_CONTENT_FILTER`: Generation was stopped due to the discovery of potentially sensitive content in the prompt or generated response. -To fix, modify the prompt and restart generation. || +To fix, modify the prompt and restart generation. +- `ALTERNATIVE_STATUS_TOOL_CALLS`: Tools were invoked during the completion generation. || |# ## Message {#yandex.cloud.ai.foundation_models.v1.Message2} @@ -168,9 +361,103 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList2)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList2)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList2} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall2)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall2} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall2)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall2} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **object** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList2} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult2)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult2} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult2)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult2} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || |# ## ContentUsage {#yandex.cloud.ai.foundation_models.v1.ContentUsage} diff --git a/en/foundation-models/text-generation/api-ref/TextGenerationAsync/completion.md b/en/foundation-models/text-generation/api-ref/TextGenerationAsync/completion.md index 88c5d34ebec..f6f4fa61b0e 100644 --- a/en/foundation-models/text-generation/api-ref/TextGenerationAsync/completion.md +++ b/en/foundation-models/text-generation/api-ref/TextGenerationAsync/completion.md @@ -26,8 +26,45 @@ POST https://llm.{{ api-host }}/foundationModels/v1/completionAsync "messages": [ { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "object" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } + // end of the list of possible fields + } + ], + "tools": [ + { + // Includes only one of the fields `function` + "function": { + "name": "string", + "description": "string", + "parameters": "object" + } // end of the list of possible fields } ] @@ -47,6 +84,10 @@ Configuration options for completion generation. || || messages[] | **[Message](#yandex.cloud.ai.foundation_models.v1.Message)** A list of messages representing the context for the completion model. || +|| tools[] | **[Tool](#yandex.cloud.ai.foundation_models.v1.Tool)** + +List of tools that are available for the model to invoke during the completion generation. +Note: This parameter is not yet supported and will be ignored if provided. || |# ## CompletionOptions {#yandex.cloud.ai.foundation_models.v1.CompletionOptions} @@ -85,9 +126,134 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **object** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + +## Tool {#yandex.cloud.ai.foundation_models.v1.Tool} + +Represents a tool that can be invoked during completion generation. + +#| +||Field | Description || +|| function | **[FunctionTool](#yandex.cloud.ai.foundation_models.v1.FunctionTool)** + +Represents a function that can be called. + +Includes only one of the fields `function`. || +|# + +## FunctionTool {#yandex.cloud.ai.foundation_models.v1.FunctionTool} + +Represents a function tool that can be invoked during completion generation. + +#| +||Field | Description || +|| name | **string** + +The name of the function. || +|| description | **string** + +A description of the function's purpose or behavior. || +|| parameters | **object** + +A JSON Schema that defines the expected parameters for the function. +The schema should describe the required fields, their types, and any constraints or default values. || |# ## Response {#yandex.cloud.operation.Operation} @@ -116,8 +282,34 @@ Message content. || { "message": { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "object" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } // end of the list of possible fields }, "status": "string" @@ -255,7 +447,8 @@ The generation status of the alternative - `ALTERNATIVE_STATUS_TRUNCATED_FINAL`: Incomplete final alternative resulting from reaching the maximum allowed number of tokens. - `ALTERNATIVE_STATUS_FINAL`: Final alternative generated without running into any limits. - `ALTERNATIVE_STATUS_CONTENT_FILTER`: Generation was stopped due to the discovery of potentially sensitive content in the prompt or generated response. -To fix, modify the prompt and restart generation. || +To fix, modify the prompt and restart generation. +- `ALTERNATIVE_STATUS_TOOL_CALLS`: Tools were invoked during the completion generation. || |# ## Message {#yandex.cloud.ai.foundation_models.v1.Message2} @@ -274,11 +467,105 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList2)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList2)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || |# +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList2} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall2)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall2} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall2)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall2} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **object** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList2} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult2)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult2} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult2)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult2} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + ## ContentUsage {#yandex.cloud.ai.foundation_models.v1.ContentUsage} An object representing the number of content [tokens](/docs/foundation-models/concepts/yandexgpt/tokens) used by the completion model. diff --git a/en/foundation-models/text-generation/api-ref/Tokenizer/tokenizeCompletion.md b/en/foundation-models/text-generation/api-ref/Tokenizer/tokenizeCompletion.md index a1e1261d98f..73a37220d12 100644 --- a/en/foundation-models/text-generation/api-ref/Tokenizer/tokenizeCompletion.md +++ b/en/foundation-models/text-generation/api-ref/Tokenizer/tokenizeCompletion.md @@ -26,8 +26,45 @@ POST https://llm.{{ api-host }}/foundationModels/v1/tokenizeCompletion "messages": [ { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "object" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } + // end of the list of possible fields + } + ], + "tools": [ + { + // Includes only one of the fields `function` + "function": { + "name": "string", + "description": "string", + "parameters": "object" + } // end of the list of possible fields } ] @@ -47,6 +84,10 @@ Configuration options for completion generation. || || messages[] | **[Message](#yandex.cloud.ai.foundation_models.v1.Message)** A list of messages representing the context for the completion model. || +|| tools[] | **[Tool](#yandex.cloud.ai.foundation_models.v1.Tool)** + +List of tools that are available for the model to invoke during the completion generation. +Note: This parameter is not yet supported and will be ignored if provided. || |# ## CompletionOptions {#yandex.cloud.ai.foundation_models.v1.CompletionOptions} @@ -85,9 +126,134 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **object** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + +## Tool {#yandex.cloud.ai.foundation_models.v1.Tool} + +Represents a tool that can be invoked during completion generation. + +#| +||Field | Description || +|| function | **[FunctionTool](#yandex.cloud.ai.foundation_models.v1.FunctionTool)** + +Represents a function that can be called. + +Includes only one of the fields `function`. || +|# + +## FunctionTool {#yandex.cloud.ai.foundation_models.v1.FunctionTool} + +Represents a function tool that can be invoked during completion generation. + +#| +||Field | Description || +|| name | **string** + +The name of the function. || +|| description | **string** + +A description of the function's purpose or behavior. || +|| parameters | **object** + +A JSON Schema that defines the expected parameters for the function. +The schema should describe the required fields, their types, and any constraints or default values. || |# ## Response {#yandex.cloud.ai.foundation_models.v1.TokenizeResponse} diff --git a/en/foundation-models/text-generation/api-ref/grpc/TextGeneration/completion.md b/en/foundation-models/text-generation/api-ref/grpc/TextGeneration/completion.md index d75fb715107..028f8fdfa46 100644 --- a/en/foundation-models/text-generation/api-ref/grpc/TextGeneration/completion.md +++ b/en/foundation-models/text-generation/api-ref/grpc/TextGeneration/completion.md @@ -24,8 +24,45 @@ A method for generating text completions in [synchronous mode](/docs/foundation- "messages": [ { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "google.protobuf.Struct" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } + // end of the list of possible fields + } + ], + "tools": [ + { + // Includes only one of the fields `function` + "function": { + "name": "string", + "description": "string", + "parameters": "google.protobuf.Struct" + } // end of the list of possible fields } ] @@ -45,6 +82,10 @@ Configuration options for completion generation. || || messages[] | **[Message](#yandex.cloud.ai.foundation_models.v1.Message)** A list of messages representing the context for the completion model. || +|| tools[] | **[Tool](#yandex.cloud.ai.foundation_models.v1.Tool)** + +List of tools that are available for the model to invoke during the completion generation. +Note: This parameter is not yet supported and will be ignored if provided. || |# ## CompletionOptions {#yandex.cloud.ai.foundation_models.v1.CompletionOptions} @@ -83,9 +124,134 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + +## Tool {#yandex.cloud.ai.foundation_models.v1.Tool} + +Represents a tool that can be invoked during completion generation. + +#| +||Field | Description || +|| function | **[FunctionTool](#yandex.cloud.ai.foundation_models.v1.FunctionTool)** + +Represents a function that can be called. + +Includes only one of the fields `function`. || +|# + +## FunctionTool {#yandex.cloud.ai.foundation_models.v1.FunctionTool} + +Represents a function tool that can be invoked during completion generation. + +#| +||Field | Description || +|| name | **string** + +The name of the function. || +|| description | **string** + +A description of the function's purpose or behavior. || +|| parameters | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +A JSON Schema that defines the expected parameters for the function. +The schema should describe the required fields, their types, and any constraints or default values. || |# ## CompletionResponse {#yandex.cloud.ai.foundation_models.v1.CompletionResponse} @@ -96,8 +262,34 @@ Message content. || { "message": { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "google.protobuf.Struct" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } // end of the list of possible fields }, "status": "AlternativeStatus" @@ -145,7 +337,8 @@ The generation status of the alternative - `ALTERNATIVE_STATUS_TRUNCATED_FINAL`: Incomplete final alternative resulting from reaching the maximum allowed number of tokens. - `ALTERNATIVE_STATUS_FINAL`: Final alternative generated without running into any limits. - `ALTERNATIVE_STATUS_CONTENT_FILTER`: Generation was stopped due to the discovery of potentially sensitive content in the prompt or generated response. -To fix, modify the prompt and restart generation. || +To fix, modify the prompt and restart generation. +- `ALTERNATIVE_STATUS_TOOL_CALLS`: Tools were invoked during the completion generation. || |# ## Message {#yandex.cloud.ai.foundation_models.v1.Message2} @@ -164,9 +357,103 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList2)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList2)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList2} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall2)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall2} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall2)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall2} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList2} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult2)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult2} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult2)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult2} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || |# ## ContentUsage {#yandex.cloud.ai.foundation_models.v1.ContentUsage} diff --git a/en/foundation-models/text-generation/api-ref/grpc/TextGenerationAsync/completion.md b/en/foundation-models/text-generation/api-ref/grpc/TextGenerationAsync/completion.md index 5c0b9687bfd..37d669b9f21 100644 --- a/en/foundation-models/text-generation/api-ref/grpc/TextGenerationAsync/completion.md +++ b/en/foundation-models/text-generation/api-ref/grpc/TextGenerationAsync/completion.md @@ -24,8 +24,45 @@ A method for generating text completions in [asynchronous mode](/docs/foundation "messages": [ { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "google.protobuf.Struct" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } + // end of the list of possible fields + } + ], + "tools": [ + { + // Includes only one of the fields `function` + "function": { + "name": "string", + "description": "string", + "parameters": "google.protobuf.Struct" + } // end of the list of possible fields } ] @@ -45,6 +82,10 @@ Configuration options for completion generation. || || messages[] | **[Message](#yandex.cloud.ai.foundation_models.v1.Message)** A list of messages representing the context for the completion model. || +|| tools[] | **[Tool](#yandex.cloud.ai.foundation_models.v1.Tool)** + +List of tools that are available for the model to invoke during the completion generation. +Note: This parameter is not yet supported and will be ignored if provided. || |# ## CompletionOptions {#yandex.cloud.ai.foundation_models.v1.CompletionOptions} @@ -83,9 +124,134 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + +## Tool {#yandex.cloud.ai.foundation_models.v1.Tool} + +Represents a tool that can be invoked during completion generation. + +#| +||Field | Description || +|| function | **[FunctionTool](#yandex.cloud.ai.foundation_models.v1.FunctionTool)** + +Represents a function that can be called. + +Includes only one of the fields `function`. || +|# + +## FunctionTool {#yandex.cloud.ai.foundation_models.v1.FunctionTool} + +Represents a function tool that can be invoked during completion generation. + +#| +||Field | Description || +|| name | **string** + +The name of the function. || +|| description | **string** + +A description of the function's purpose or behavior. || +|| parameters | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +A JSON Schema that defines the expected parameters for the function. +The schema should describe the required fields, their types, and any constraints or default values. || |# ## operation.Operation {#yandex.cloud.operation.Operation} @@ -106,8 +272,34 @@ Message content. || { "message": { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "google.protobuf.Struct" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } // end of the list of possible fields }, "status": "AlternativeStatus" @@ -214,7 +406,8 @@ The generation status of the alternative - `ALTERNATIVE_STATUS_TRUNCATED_FINAL`: Incomplete final alternative resulting from reaching the maximum allowed number of tokens. - `ALTERNATIVE_STATUS_FINAL`: Final alternative generated without running into any limits. - `ALTERNATIVE_STATUS_CONTENT_FILTER`: Generation was stopped due to the discovery of potentially sensitive content in the prompt or generated response. -To fix, modify the prompt and restart generation. || +To fix, modify the prompt and restart generation. +- `ALTERNATIVE_STATUS_TOOL_CALLS`: Tools were invoked during the completion generation. || |# ## Message {#yandex.cloud.ai.foundation_models.v1.Message2} @@ -233,11 +426,105 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList2)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList2)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || |# +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList2} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall2)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall2} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall2)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall2} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList2} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult2)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult2} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult2)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult2} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + ## ContentUsage {#yandex.cloud.ai.foundation_models.v1.ContentUsage} An object representing the number of content [tokens](/docs/foundation-models/concepts/yandexgpt/tokens) used by the completion model. diff --git a/en/foundation-models/text-generation/api-ref/grpc/Tokenizer/tokenizeCompletion.md b/en/foundation-models/text-generation/api-ref/grpc/Tokenizer/tokenizeCompletion.md index f7155869ab0..d72df7fd1c9 100644 --- a/en/foundation-models/text-generation/api-ref/grpc/Tokenizer/tokenizeCompletion.md +++ b/en/foundation-models/text-generation/api-ref/grpc/Tokenizer/tokenizeCompletion.md @@ -24,8 +24,45 @@ RPC method for tokenizing content of CompletionRequest "messages": [ { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "google.protobuf.Struct" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } + // end of the list of possible fields + } + ], + "tools": [ + { + // Includes only one of the fields `function` + "function": { + "name": "string", + "description": "string", + "parameters": "google.protobuf.Struct" + } // end of the list of possible fields } ] @@ -45,6 +82,10 @@ Configuration options for completion generation. || || messages[] | **[Message](#yandex.cloud.ai.foundation_models.v1.Message)** A list of messages representing the context for the completion model. || +|| tools[] | **[Tool](#yandex.cloud.ai.foundation_models.v1.Tool)** + +List of tools that are available for the model to invoke during the completion generation. +Note: This parameter is not yet supported and will be ignored if provided. || |# ## CompletionOptions {#yandex.cloud.ai.foundation_models.v1.CompletionOptions} @@ -83,9 +124,134 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + +## Tool {#yandex.cloud.ai.foundation_models.v1.Tool} + +Represents a tool that can be invoked during completion generation. + +#| +||Field | Description || +|| function | **[FunctionTool](#yandex.cloud.ai.foundation_models.v1.FunctionTool)** + +Represents a function that can be called. + +Includes only one of the fields `function`. || +|# + +## FunctionTool {#yandex.cloud.ai.foundation_models.v1.FunctionTool} + +Represents a function tool that can be invoked during completion generation. + +#| +||Field | Description || +|| name | **string** + +The name of the function. || +|| description | **string** + +A description of the function's purpose or behavior. || +|| parameters | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +A JSON Schema that defines the expected parameters for the function. +The schema should describe the required fields, their types, and any constraints or default values. || |# ## TokenizeResponse {#yandex.cloud.ai.foundation_models.v1.TokenizeResponse} diff --git a/en/foundation-models/toc.yaml b/en/foundation-models/toc.yaml index eb0c9f886b1..c9b3d017e4d 100644 --- a/en/foundation-models/toc.yaml +++ b/en/foundation-models/toc.yaml @@ -13,7 +13,7 @@ items: href: operations/index.md - name: '{{ yagpt-full-name }}' items: - - name: Sending requests in prompt mode + - name: Sending a request in prompt mode href: operations/yandexgpt/create-prompt.md - name: Sending a series of requests in chat mode href: operations/yandexgpt/create-chat.md @@ -47,7 +47,7 @@ items: href: concepts/embeddings.md - name: Classifiers based on {{ yagpt-name }} items: - - name: Overview of classifiers + - name: Classifier overview href: concepts/classifier/index.md - name: Models href: concepts/classifier/models.md @@ -311,6 +311,8 @@ items: href: api-ref/v1alpha/grpc/Tokenizer/index.md - name: Tokenize href: api-ref/v1alpha/grpc/Tokenizer/tokenize.md + - name: '{{ ml-sdk-full-name }}' + href: sdk/index.md - name: Access management href: security/index.md - name: Pricing policy diff --git a/en/foundation-models/tutorials/yagpt-tuning.md b/en/foundation-models/tutorials/yagpt-tuning.md index 85c63569842..d78395a7fc3 100644 --- a/en/foundation-models/tutorials/yagpt-tuning.md +++ b/en/foundation-models/tutorials/yagpt-tuning.md @@ -1,8 +1,10 @@ --- -title: Tutorial for tuning a {{ yagpt-name }} model in {{ ml-platform-full-name }} -description: Follow this tutorial to tune a {{ yagpt-name }} model on your own examples. +title: How to tune {{ yagpt-name }} in {{ ml-platform-full-name }} +description: Follow this guide to tune a {{ yagpt-name }} model on your own examples. --- # {{ yagpt-name }} model tuning +@[youtube](https://www.youtube.com/embed/hGrH0Shovtk?si=5SZGXtHxtRTMpzdY) + {% include [yagpt-tuning](../../_tutorials/ml-ai/yagpt-tuning.md) %} \ No newline at end of file diff --git a/en/getting-started/_includes/quickstart-qa-whats-next.md b/en/getting-started/_includes/quickstart-qa-whats-next.md index 74b41c5a4fd..33207202101 100644 --- a/en/getting-started/_includes/quickstart-qa-whats-next.md +++ b/en/getting-started/_includes/quickstart-qa-whats-next.md @@ -2,6 +2,13 @@ ### Questions about billing accounts and paid accounts {#billing-account} +#### Why do I need a billing account with a linked bank card? {#linked-bank-card} + +Billing accounts are used to identify users paying for {{ yandex-cloud }} resources. Even if you plan to use only free services, you still need a billing account: grants and promo codes are credited to it. + +To activate a billing account, we require you to link a bank card to make sure that you are a human and not a robot. When linking the card, a small amount will be debited and immediately returned. That is how we verify that your card is real. + +Payment for {{ yandex-cloud }} services and resources will be debited from your bank card only after you explicitly allow this, that is, after you switch to a paid account. #### What happens after the trial period ends? Will you start debiting money right away? {#payment-after-trial} @@ -9,6 +16,7 @@ However, if your [grant](../usage-grant.md) has expired, access to your resources will be blocked for 30 days or until you switch to paid consumption. For more information about expiry of the trial period, see [{#T}](../free-trial/concepts/trial-ending.md). +To activate a billing account, we require you to link a bank card to make sure that you are a human and not a robot. When linking the card, a small amount will be debited and immediately returned. That is how we verify that your card is real. ### Questions about the initial grant {#grant} @@ -18,9 +26,11 @@ No, you cannot switch back to the trial version, but the grant will not be lost. #### I have not used up the initial grant, but my cloud is blocked. What should I do? {#cloud-blocked-during-trial} +The cloud may be blocked for a few reasons: -The initial grant is provisionally divided into two parts that can be used at the same time. One part covers payment for the Compute service, the other part — the rest of the {{ yandex-cloud }} services. If you run out of one part, you can continue using the cloud by switching to a paid account. The unspent part of the grant will be preserved. For more information about using the initial grant and switching to a paid period, see [{#T}](../free-trial/concepts/upgrade-to-paid.md). +1. Make sure that a valid card is linked to your account. If you linked the card and then deleted it, your account may be blocked. +1. The initial grant is provisionally divided into two parts that can be used at the same time. One part covers payment for the Compute service, the other part — the rest of the {{ yandex-cloud }} services. If you run out of one part, you can continue using the cloud by switching to a paid account. The unspent part of the grant will be preserved. For more information about using the initial grant and switching to a paid period, see [{#T}](../free-trial/concepts/upgrade-to-paid.md). #### I could not use up the initial grant in 60 days. Can I use {{ yandex-cloud }}? {#initial-grant-expiring} diff --git a/en/getting-started/free-trial/concepts/limits.md b/en/getting-started/free-trial/concepts/limits.md index 038e940c7fd..6002a2874ab 100644 --- a/en/getting-started/free-trial/concepts/limits.md +++ b/en/getting-started/free-trial/concepts/limits.md @@ -22,12 +22,7 @@ Technical support is provided in full during the trial period. For more informat ## {{ marketplace-full-name }} {#marketplace} - -Some products are not available during the trial period, such as: -* Microsoft SQL Server -* Windows Server Standard -* Windows RDS - +During the trial period, no {{ marketplace-full-name }} paid products are available. However, once your paid consumption starts, you will be able to use the balance of your starting grant to pay for them. ## Service quotas and limits {#quotes-and-limits} diff --git a/en/getting-started/free-trial/concepts/trial-ending.md b/en/getting-started/free-trial/concepts/trial-ending.md index 1ad9a35da86..0827debc197 100644 --- a/en/getting-started/free-trial/concepts/trial-ending.md +++ b/en/getting-started/free-trial/concepts/trial-ending.md @@ -1,8 +1,11 @@ # End of trial period +Your trial period will end automatically depending on the payment method you selected when [creating your billing account for businesses](../../../billing/quickstart/index.md). -The trial period ends automatically when you use up the [grant](../../usage-grant.md) or when it expires. - +| Payment method | Terms of termination | +----- | ----- +| Wire transfer | The [grant](../../usage-grant.md) was used up or expired. | +| Bank card | The [grant](../../usage-grant.md) or one of its parts was used up and/or the grant expired. | Unless you upgraded to the paid version, access to your resources will be suspended for 60 days after the trial period ends: * Your VM instances and DB clusters will be stopped. diff --git a/en/getting-started/free-trial/concepts/upgrade-to-paid.md b/en/getting-started/free-trial/concepts/upgrade-to-paid.md index 8bfb57a7278..80f82b11f53 100644 --- a/en/getting-started/free-trial/concepts/upgrade-to-paid.md +++ b/en/getting-started/free-trial/concepts/upgrade-to-paid.md @@ -4,8 +4,9 @@ You do not upgrade to the paid version automatically after the trial period ends {% note info %} +Upgrading to the paid version with the **{{ ui-key.yacloud_billing.billing.account.overview.payment-type_label_card }}** payment method involves the risk of your billing account balance becoming negative. -We recommend you to keep track of the money you spend from your personal account and maintain a positive balance manually. If you fail to pay the arrears within the timeline set forth in the agreement, {{ yandex-cloud }} reserves the right to change the status of your billing account to `SUSPENDED`. +We recommend you to keep track of the money you spend from your personal account and maintain a positive balance manually. If you fail to pay your arrears within the timeline set forth in the agreement, {{ yandex-cloud }} reserves the right to change the status of your billing account to `SUSPENDED`. To control spending on {{ yandex-cloud }} resources more effectively, we recommend using a [budget](../../../billing/concepts/budget.md). @@ -18,11 +19,52 @@ To control spending on {{ yandex-cloud }} resources more effectively, we recomme The grant terms of use remain in effect after the upgrade. +The grant terms of use depend on the payment method you select when creating your billing account: -The remainder of the grant can be used to pay for any {{ yandex-cloud }} services. +Payment method | Using the grant +----- | ----- +Wire transfer | The remainder of the grant can be used to pay for any {{ yandex-cloud }} services. +Credit or debit card | The remainder of one of the grant [parts](../../usage-grant.md) can only be used to pay for the services that part of the grant was originally intended for. ## Paying for services In {{ yandex-cloud }}, you pay for services based on the amount of resources consumed. For detailed guidelines on how to pay for resources after upgrading to the paid version, see the {{ billing-name }} [documentation](../../../billing/). +## Examples + +{% list tabs group=examples %} + +- Example 1 {#example1} + + You are a resident of the Russian Federation and have registered a business account with the **{{ ui-key.yacloud_billing.billing.account.overview.payment-type_label_card }}** payment method. + + In 20 days, you spent ₽500 on {{ compute-full-name }} and ₽3,000 on other services. As you have fully spent one of the grant parts, the trial period terminates automatically and access to {{ yandex-cloud }} services is suspended unless you upgrade to the paid version. + + If you upgrade to the paid version within 60 days, you can use the remainder of the grant until it expires: + - (1,000 - 500) = ₽500 for {{ compute-name }} and support services. + +- Example 2 {#example2} + + You are a non-resident of the Russian Federation and have registered a business account with the **{{ ui-key.yacloud_billing.billing.account.overview.payment-type_label_card }}** payment method. + + In 20 days, you spent $10 on {{ compute-full-name }} and $30 on other services. + + You upgraded to the paid version. The trial period terminates automatically. + + After upgrading to the paid version, you can continue to use the remainder of the grant until it expires: + - (15 - 10) = $5 for {{ compute-name }} and support services. + - (50 - 30) = $20 for various services (other than {{ compute-name }} and support services). + +- Example 3 {#example3} + + You are a resident of the Russian Federation and have registered a business account with the **{{ ui-key.yacloud_billing.billing.account.overview.payment-type_label_invoice }}** payment method. + + In 45 days, you spent ₽2,500 on various services. + + You upgraded to the paid version. The trial period terminates automatically. + + After upgrading to the paid version, you can continue to use the remainder of the grant until it expires: + - (4,000 - 2,500) = ₽1,500 on various services. + +{% endlist %} \ No newline at end of file diff --git a/en/getting-started/legal-entity/payments.md b/en/getting-started/legal-entity/payments.md index 1394718fe42..59cdf6a8900 100644 --- a/en/getting-started/legal-entity/payments.md +++ b/en/getting-started/legal-entity/payments.md @@ -22,6 +22,11 @@ To top up your personal account: {% list tabs group=payments %} +- Bank card {#card} + + Enter the payment amount and click **{{ ui-key.yacloud_billing.billing.account.dashboard-overview.popup-refill_button_individual-action }}**. Then enter your card details and click **Pay**. We accept Visa and MasterCard. + + Your payment will be processed in real time and completed within 15 minutes. - Bank transfer {#transfer} @@ -31,7 +36,10 @@ To top up your personal account: Before paying, please make sure the following is correct in your payment order: * Payment amount. - * Banking information of Yandex.Cloud LLC (Russia), Cloud Services Kazakhstan LLP (Kazakhstan), and SAG (for non-residents of Russia and Kazakhstan). + * Banking information of Yandex.Cloud LLC (Russia), Cloud Services Kazakhstan LLP (Kazakhstan), Iron Hive doo Beograd (Serbia) or Direct Cursus Technology L.L.C. (Dubai) (for non-residents of Russia and Kazakhstan). + + {% include [legal-entity-nonresidents](../../_includes/billing/legal-entity-nonresidents.md) %} + * Your company or individual entrepreneur TIN. * [Personal account number](../../billing/concepts/personal-account.md#id) in the payment details. * [Contract number](../../billing/concepts/contract.md) in the payment details. diff --git a/en/getting-started/legal-entity/registration.md b/en/getting-started/legal-entity/registration.md index 2d32e6f827e..ee0b6f4925b 100644 --- a/en/getting-started/legal-entity/registration.md +++ b/en/getting-started/legal-entity/registration.md @@ -11,6 +11,7 @@ description: In this tutorial, you will learn how to create a billing account fo A billing account is required even if your plan is to use only free services. When creating your first billing account linked to your user account, you will get your [initial grant](../usage-grant.md). +![quickstart](../../_assets/overview/legal-entity-trial-period.svg) Provide details to create a billing account. diff --git a/en/getting-started/legal-entity/resources-hierarchy.md b/en/getting-started/legal-entity/resources-hierarchy.md index 85699ef1f4b..3fb987da547 100644 --- a/en/getting-started/legal-entity/resources-hierarchy.md +++ b/en/getting-started/legal-entity/resources-hierarchy.md @@ -10,40 +10,40 @@ The owner can create new folders and resources in this cloud, and manage access - Management console {#console} - {% include [create-folder](../../_includes/create-folder.md) %} + {% include [create-folder](../../_includes/create-folder.md) %} - CLI {#cli} - 1. View the description of the create folder command: + 1. View the description of the create folder command: ``` yc resource-manager folder create --help ``` - 1. Create a new folder: + 1. Create a new folder: * with a name and without a description: + + ``` + yc resource-manager folder create \ + --name new-folder + ``` - ``` - yc resource-manager folder create \ - --name new-folder - ``` + The folder naming requirements are as follows: - The folder naming requirements are as follows: - - {% include [name-format](../../_includes/name-format.md) %} + {% include [name-format](../../_includes/name-format.md) %} * with a name and description: - ``` - yc resource-manager folder create \ - --name new-folder \ - --description "my first folder with description" - ``` + ``` + yc resource-manager folder create \ + --name new-folder \ + --description "my first folder with description" + ``` - API {#api} - To create a folder, use the [create](../../resource-manager/api-ref/Folder/create.md) method for the [Folder](../../resource-manager/api-ref/Folder/index.md). + To create a folder, use the [create](../../resource-manager/api-ref/Folder/create.md) method for the [Folder](../../resource-manager/api-ref/Folder/index.md). {% endlist %} @@ -55,52 +55,52 @@ The management console only allows you to change the name of a folder. To change - Management console {#console} - 1. On the [home page]({{ link-console-main }}) of the management console, select the folder. This page displays folders for the selected cloud. If necessary, [switch to another cloud](../../resource-manager/operations/cloud/switch-cloud.md). - 1. Click ![image](../../_assets/console-icons/ellipsis.svg) next to the folder and select **{{ ui-key.yacloud.common.edit }}**. - 1. Enter a new name for the folder. - 1. Click **{{ ui-key.yacloud.iam.cloud.folders.popup-edit_button_save }}**. + 1. On the management console [home page]({{ link-console-main }}), select the folder. This page displays folders for the selected cloud. You can [switch to another cloud](../../resource-manager/operations/cloud/switch-cloud.md), if required. + 1. Click ![image](../../_assets/console-icons/ellipsis.svg) next to the folder and select **{{ ui-key.yacloud.common.edit }}**. + 1. Enter a new name for the folder. + 1. Click **{{ ui-key.yacloud.iam.cloud.folders.popup-edit_button_save }}**. - CLI {#cli} - 1. View the description of the update folder command: + 1. View the description of the update folder command: ``` yc resource-manager folder update --help ``` - 1. If you know the folder ID or name, proceed to the next step. Otherwise, use one of these methods to get them: + 1. If you know the folder ID or name, proceed to the next step. Otherwise, use one of these methods to get them: * Get a list of folders: - ``` - $ yc resource-manager folder list - +----------------------+--------------------+--------+--------+-------------+ - | ID | NAME | LABELS | STATUS | DESCRIPTION | - +----------------------+--------------------+--------+--------+-------------+ - | b1gppulhhm2aaufq9eug | yet-another-folder | | ACTIVE | | - | b1gvmob95yysaplct532 | default | | ACTIVE | | - +----------------------+--------------------+--------+--------+-------------+ - ``` + ``` + $ yc resource-manager folder list + +----------------------+--------------------+--------+--------+-------------+ + | ID | NAME | LABELS | STATUS | DESCRIPTION | + +----------------------+--------------------+--------+--------+-------------+ + | b1gppulhhm2aaufq9eug | yet-another-folder | | ACTIVE | | + | b1gvmob95yysaplct532 | default | | ACTIVE | | + +----------------------+--------------------+--------+--------+-------------+ + ``` * If you know the ID of the resource that belongs to the required folder, you can get the folder ID from the information about that resource: - ``` - yc get - ``` + ``` + yc get + ``` - Where: - * ``: Name of the service, such as `compute`. - * ``: Resource category, e.g., `instance`. - * ``: Resource ID. + Where: + * ``: Service name, e.g., `compute`. + * ``: Resource category, e.g., `instance`. + * ``: Resource ID. - For example, the `fhmp74bfis2aim728p2a` VM belongs to the `b1gpvjd9ir42nsng55ck` folder: + For example, the `fhmp74bfis2aim728p2a` VM belongs to the `b1gpvjd9ir42nsng55ck` folder: - ``` - yc compute instance get fhmp74bfis2ais728p2a - id: fhmp74bfis2ais728p2a - folder_id: b1gpvjd9ia42nsng55ck - ... - ``` - 1. Change the folder parameters, e.g., name and description. You can specify the folder to update by its name or ID. + ``` + yc compute instance get fhmp74bfis2ais728p2a + id: fhmp74bfis2ais728p2a + folder_id: b1gpvjd9ia42nsng55ck + ... + ``` + 1. Change the folder parameters, e.g., name and description. You can specify the folder to update by its name or ID. ``` yc resource-manager folder update default \ @@ -118,8 +118,8 @@ The management console only allows you to change the name of a folder. To change - API {#api} - To edit the folder, use the [update](../../resource-manager/api-ref/Folder/update.md) method for the [Folder](../../resource-manager/api-ref/Folder/index.md) resource. - + To edit the folder, use the [update](../../resource-manager/api-ref/Folder/update.md) method for the [Folder](../../resource-manager/api-ref/Folder/index.md) resource. + {% endlist %} ## Assign folder roles {#access-to-user} @@ -128,20 +128,20 @@ The management console only allows you to change the name of a folder. To change - Management console {#console} - 1. {% include [grant-role-console-first-steps](../../_includes/iam/grant-role-console-first-steps.md) %} - 1. {% include [configure-roles-console](../../_includes/iam/configure-roles-console.md) %} - 1. Select a folder in the **Roles in folders** section and click ![image](../../_assets/console-icons/plus.svg). - 1. Select a role from the list. + 1. {% include [grant-role-console-first-steps](../../_includes/iam/grant-role-console-first-steps.md) %} + 1. {% include [configure-roles-console](../../_includes/iam/configure-roles-console.md) %} + 1. Select a folder in the **Roles in folders** section and click ![image](../../_assets/console-icons/plus.svg). + 1. Select a role from the list. - CLI {#cli} - 1. View the description of the command to assign a role for a folder: + 1. View the description of the command to assign a role for a folder: ``` yc resource-manager folder add-access-binding --help ``` - 1. Select a folder, e.g., `my-folder`: + 1. Select a folder, e.g., `my-folder`: ``` yc resource-manager folder list @@ -152,7 +152,7 @@ The management console only allows you to change the name of a folder. To change +----------------------+-----------+--------+--------+ ``` - 1. Choose the [role](../../iam/concepts/access-control/roles.md). + 1. Choose the [role](../../iam/concepts/access-control/roles.md). ``` yc iam role list @@ -165,7 +165,7 @@ The management console only allows you to change the name of a folder. To change | ... | | +--------------------------------+-------------+ ``` - 1. Find out the user ID from the login or email address. To assign a role to a service account or a user group rather than to a single user, see the [examples](#examples) below. + 1. Find out the user ID from the login or email address. To assign a role to a service account or a user group rather than to a single user, see the [examples](#examples) below. ``` yc iam user-account get test-user @@ -174,7 +174,7 @@ The management console only allows you to change the name of a folder. To change login: test-user default_email: test-user@yandex.ru ``` - 1. Assign the `editor` role for the `my-folder` folder to a user named `test-user`. In the subject, specify the `userAccount` type and user ID: + 1. Assign the `editor` role to `test-user` for `my-folder`. In the subject, specify the `userAccount` type and user ID: ``` yc resource-manager folder add-access-binding my-folder \ @@ -184,12 +184,13 @@ The management console only allows you to change the name of a folder. To change - API {#api} - Use the [updateAccessBindings](../../resource-manager/api-ref/Folder/updateAccessBindings.md) method for the [Folder](../../resource-manager/api-ref/Folder/index.md) resource. You will need the folder ID and the ID of the user to whom you want to assign the role for the folder. + Use the [updateAccessBindings](../../resource-manager/api-ref/Folder/updateAccessBindings.md) method for the [Folder](../../resource-manager/api-ref/Folder/index.md) resource. You will need the folder ID and the ID of the user to whom you want to assign the role for the folder. - 1. Find out the folder ID using the [list](../../resource-manager/api-ref/Folder/list.md): + 1. Find out the folder ID using the [list](../../resource-manager/api-ref/Folder/list.md): ```bash - $ curl -H "Authorization: Bearer " \ - https://resource-manager.{{ api-host }}/resource-manager/v1/folders?cloudId=b1gg8sgd16g7qca5onqs + curl \ + --header "Authorization: Bearer " \ + https://resource-manager.{{ api-host }}/resource-manager/v1/folders?cloudId=b1gg8sgd16g7qca5onqs { "folders": [ @@ -203,11 +204,12 @@ The management console only allows you to change the name of a folder. To change ] } ``` - - 1. Find out the user ID from the login using the [getByLogin](../../iam/api-ref/YandexPassportUserAccount/getByLogin.md) method: - + + 1. Find out the user ID from the login using the [getByLogin](../../iam/api-ref/YandexPassportUserAccount/getByLogin.md) method: + ```bash - curl -H "Authorization: Bearer " \ + curl \ + --header "Authorization: Bearer " \ https://iam.{{ api-host }}/iam/v1/yandexPassportUserAccounts:byLogin?login=test-user { @@ -218,14 +220,15 @@ The management console only allows you to change the name of a folder. To change } } ``` - - 1. Assign the `editor` role for the `my-folder` folder to the user. Set the `action` property to `ADD` and specify the `userAccount` type and user ID in the `subject` property: + + 1. Assign the `editor` role to the user for `my-folder`. Set the `action` property to `ADD` and specify the `userAccount` type and user ID in the `subject` property: ```bash - curl -X POST \ - -H 'Content-Type: application/json' \ - -H "Authorization: Bearer " \ - -d '{ + curl \ + --request POST \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer " \ + --data '{ "accessBindingDeltas": [{ "action": "ADD", "accessBinding": { @@ -245,28 +248,28 @@ The management console only allows you to change the name of a folder. To change - Management console {#console} - Follow the guide at the [beginning of the section](#access-to-user) and assign the user multiple roles. + Follow the guide at the [beginning of the section](#access-to-user) and assign the user multiple roles. - To assign a role to another user, select the user on the [Users and roles]({{ link-console-access-management }}) tab and click **Configure roles**. + To assign a role to another user, select the user on the [Users and roles]({{ link-console-access-management }}) tab and click **Configure roles**. - CLI {#cli} - The `add-access-binding` command allows you to add only one role. You can assign multiple roles using the `set-access-binding` command. - - {% note alert %} + The `add-access-binding` command allows you to add only one role. You can assign multiple roles using the `set-access-binding` command. - The `set-access-binding` command completely rewrites access permissions for the resource. All current resource roles will be deleted. + {% note alert %} - {% endnote %} + The `set-access-binding` method completely rewrites access permissions for the resource. All current resource roles will be deleted. - 1. Make sure the resource has no roles assigned that you would not want to lose: + {% endnote %} + 1. Make sure the resource has no roles assigned that you would not want to lose: + ``` yc resource-manager folder list-access-binding my-folder ``` - - 1. For example, assign a role to multiple users: - + + 1. For example, assign a role to multiple users: + ``` yc resource-manager folder set-access-bindings my-folder \ --access-binding role=editor,subject=userAccount:gfei8n54hmfhuk5nogse @@ -275,55 +278,57 @@ The management console only allows you to change the name of a folder. To change - API {#api} - Assign the `editor` role to one user and the `viewer` role to another user: - - ```bash - curl -X POST \ - -H 'Content-Type: application/json' \ - -H "Authorization: Bearer " \ - -d '{ - "accessBindingDeltas": [{ - "action": "ADD", - "accessBinding": { - "roleId": "editor", - "subject": { - "id": "gfei8n54hmfhuk5nogse", - "type": "userAccount" - } - } - },{ - "action": "ADD", - "accessBinding": { - "roleId": "viewer", - "subject": { - "id": "helj89sfj80aj24nugsz", - "type": "userAccount" - }}}]}' \ - https://resource-manager.{{ api-host }}/resource-manager/v1/folders/b1gd129pp9ha0vnvf5g7:updateAccessBindings - ``` - - You can also assign roles using the [setAccessBindings](../../resource-manager/api-ref/Folder/setAccessBindings.md). - - {% note alert %} - - The `setAccessBindings` method completely rewrites access permissions for the resource. All current resource roles will be deleted. - - {% endnote %} - - ```bash - curl -X POST \ - -H 'Content-Type: application/json' \ - -H "Authorization: Bearer " \ - -d '{ - "accessBindings": [{ - "roleId": "editor", - "subject": { "id": "ajei8n54hmfhuk5nog0g", "type": "userAccount" } - },{ - "roleId": "viewer", - "subject": { "id": "helj89sfj80aj24nugsz", "type": "userAccount" } - }]}' \ - https://resource-manager.{{ api-host }}/resource-manager/v1/folders/b1gd129pp9ha0vnvf5g7:setAccessBindings - ``` + Assign the `editor` role to one user and the `viewer` role to another: + + ```bash + curl \ + --request POST \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer " \ + --data '{ + "accessBindingDeltas": [{ + "action": "ADD", + "accessBinding": { + "roleId": "editor", + "subject": { + "id": "gfei8n54hmfhuk5nogse", + "type": "userAccount" + } + } + },{ + "action": "ADD", + "accessBinding": { + "roleId": "viewer", + "subject": { + "id": "helj89sfj80aj24nugsz", + "type": "userAccount" + }}}]}' \ + https://resource-manager.{{ api-host }}/resource-manager/v1/folders/b1gd129pp9ha0vnvf5g7:updateAccessBindings + ``` + + You can also assign roles using the [setAccessBindings](../../resource-manager/api-ref/Folder/setAccessBindings.md). + + {% note alert %} + + The `setAccessBindings` method completely rewrites access permissions for the resource. All current resource roles will be deleted. + + {% endnote %} + + ```bash + curl \ + --request POST \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer " \ + --data '{ + "accessBindings": [{ + "roleId": "editor", + "subject": { "id": "ajei8n54hmfhuk5nog0g", "type": "userAccount" } + },{ + "roleId": "viewer", + "subject": { "id": "helj89sfj80aj24nugsz", "type": "userAccount" } + }]}' \ + https://resource-manager.{{ api-host }}/resource-manager/v1/folders/b1gd129pp9ha0vnvf5g7:setAccessBindings + ``` {% endlist %} @@ -337,14 +342,14 @@ Allow the service account to manage the folder and its resources: - Management console {#console} - {% include [grant-role-console-sa](../../_includes/grant-role-console-sa.md) %} + {% include [grant-role-console-sa](../../_includes/grant-role-console-sa.md) %} - CLI {#cli} - {% include [grant-role-for-sa-to-folder-via-cli](../../_includes/iam/grant-role-for-sa-to-folder-via-cli.md) %} + {% include [grant-role-for-sa-to-folder-via-cli](../../_includes/iam/grant-role-for-sa-to-folder-via-cli.md) %} - API {#api} - {% include [grant-role-for-sa-to-folder-via-api](../../_includes/iam/grant-role-for-sa-to-folder-via-api.md) %} + {% include [grant-role-for-sa-to-folder-via-api](../../_includes/iam/grant-role-for-sa-to-folder-via-api.md) %} {% endlist %} diff --git a/en/getting-started/usage-grant.md b/en/getting-started/usage-grant.md index 9ffd9556c5e..069f9295391 100644 --- a/en/getting-started/usage-grant.md +++ b/en/getting-started/usage-grant.md @@ -1,6 +1,6 @@ --- title: Initial grant for individual and business accounts -description: When you create your first billing account, you receive an initial grant. It can be given only once to an individual or legal entity provided that you have never purchased {{ yandex-cloud }} services or activated the trial period before. +description: When you create your first billing account, you get the initial grant. You can get it only once as an individual or legal entity, provided that you have never purchased {{ yandex-cloud }} services nor activated the trial period before. --- # Initial grant for individual and business accounts @@ -16,9 +16,9 @@ Learn more about grants in the [{{ billing-name }} documentation](../billing/con ## Business account {#business} - -The grant terms of use depend on your country of residence. - +Grant terms of use depend on: +* Your country of residence. +* The payment method you select when registering and [creating your billing account](../billing/quickstart/index.md). ### Grant terms of use {#terms-august} @@ -27,28 +27,27 @@ The grant terms of use depend on your country of residence. - Residents of Russia {#russia} - | Payment method | Using the grant | + | Payment method | Using the grant| |--------------------|---| - | Credit or debit card | The grant is provisionally divided into two parts and distributed across the services as follows:
_Part 1_: ₽1,000 from the total grant amount. It can be used to pay for {{ compute-full-name }} features (including VM images), {{ marketplace-full-name }} products, and support.
_Part 2_: ₽3,000 from the total grant amount. It can be used to pay for features of other {{ yandex-cloud }} services. | + | Credit or debit card | The grant is provisionally divided into two parts and distributed across the services as follows:
_Part 1_: ₽1,000 from the total grant amount. It can be used to pay for {{ compute-full-name }} services (including VM images) and support services.
_Part 2_: ₽3,000 from the total grant amount. It can be used to pay for other {{ yandex-cloud }} services. | | Wire transfer | The total grant amount of ₽4,000 can be used to pay for any {{ yandex-cloud }} services. | - Residents of Kazakhstan {#kazakhstan} - | Payment method | Using the grant | - |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---| - | Credit or debit card | The grant is provisionally divided into two parts and distributed across the services as follows:
_Part 1_: ₸6,000 from the total grant amount. It can be used to pay for {{ compute-full-name }} features (including VM images), {{ marketplace-full-name }} products, and support.
_Part 2_: ₸18,000 from the total grant amount. It can be used to pay for features of other {{ yandex-cloud }} services. | + | Payment method | Using the grant| + |--------------------|---| + | Credit or debit card | The grant is provisionally divided into two parts and distributed across the services as follows:
_Part 1_: ₸6,000 from the total grant amount. It can be used to pay for {{ compute-full-name }} services (including VM images) and support services.
_Part 2_: ₸18,000 from the total grant amount. It can be used to pay for other {{ yandex-cloud }} services. | | Wire transfer | The total grant amount of ₸24,000 can be used to pay for any {{ yandex-cloud }} services. | - Non-residents of Russia and Kazakhstan {#nonresidents} - | Payment method | Using the grant | + | Payment method | Using the grant| |--------------------|---| - | Bank card | The grant is provisionally divided into two parts and distributed across the services as follows:
_Part 1_: $15 of the total grant amount. It can be used to pay for {{ compute-full-name }} features (including VM images), {{ marketplace-full-name }} products, and support.
_Part 2_: $35 from the total grant amount. It can be used to pay for features of other {{ yandex-cloud }} services. | - | Wire transfer | The total grant in the amount of $50 can be used to pay for any {{ yandex-cloud }} services. | + | Credit or debit card | The grant is provisionally divided into two parts and distributed across the services as follows:
_Part 1_: $15 from the total grant amount. It can be used to pay for {{ compute-full-name }} services (including VM images) and support services.
_Part 2_: $35 from the total grant amount. It can be used to pay for other {{ yandex-cloud }} services.| + | Wire transfer | Total grant in the amount of $50 can be used to pay for any {{ yandex-cloud }} services | {% endlist %} -For more information about [billing accounts](../billing/concepts/billing-account.md) and the [terms and conditions for non-residents of Russia](../billing/qa/non-resident.md), see the {{ billing-name }} documentation. - +For more information about [billing accounts](../billing/concepts/billing-account.md) and the [terms and conditions for non-residents of Russia](../billing/qa/non-resident.md), see the {{ billing-name }} documentation. \ No newline at end of file diff --git a/en/iam/concepts/authorization/api-key.md b/en/iam/concepts/authorization/api-key.md index 0976ab11259..f480fc0e77e 100644 --- a/en/iam/concepts/authorization/api-key.md +++ b/en/iam/concepts/authorization/api-key.md @@ -11,19 +11,17 @@ If someone might have gotten access to your private key, [delete it](../../opera {% endnote %} -Storing the API key is your responsibility. {{ yandex-cloud }} only provides access to an API key while it is being created. If the key is lost or damaged, you cannot restore it. In this case, you can [reissue](../../operations/compromised-credentials.md#api-key-reissue) the key or create a new one. +It is the user's responsibility to store the API key. {{ yandex-cloud }} provides access to an API key only during its creation. If the key is lost or damaged, you cannot restore it. In which case you can [reissue](../../operations/compromised-credentials.md#api-key-reissue) the key or create a new one. {% include [key-has-last-used-data](../../../_includes/iam/key-has-last-used-data.md) %} -## API keys with a limited scope and validity period {#scoped-api-keys} +## API keys with scope and validity limits {#scoped-api-keys} -You can create API keys with a limited scope and validity period. This will reduce the risk of their unauthorized use. - -You can create such keys to manage {{ ydb-full-name }} tables and topics (`yc.ydb.tables.manage` and `yc.ydb.topics.manage`). +You can [create](../../operations/api-key/create.md) API keys with a limited scope and an expiration date. This will reduce the risk of unauthorized use of your keys. ## Using an API key {#use} -Enter the API key when accessing {{ yandex-cloud }} resources via the API. Provide the API key in the `Authorization` header in the following format: +Enter your API key when accessing {{ yandex-cloud }} resources via the API. Provide the API key in the `Authorization` header in the following format: ``` Authorization: Api-Key diff --git a/en/iam/concepts/authorization/iam-token.md b/en/iam/concepts/authorization/iam-token.md index 992c6f3f05a..8c6680d200c 100644 --- a/en/iam/concepts/authorization/iam-token.md +++ b/en/iam/concepts/authorization/iam-token.md @@ -22,12 +22,18 @@ IAM tokens are valid for a maximum of {{ iam-token-lifetime }}. A token's lifeti To avoid situations when your token has expired and you do not have a new token yet, request it beforehand. -If you generate a new {{ iam-short-name }} token, the previous one continues to be valid until its lifetime expires. +If you generate a new {{ iam-short-name }} token, the previous one continues to be valid until its lifetime ends or you [revoke](../../operations/iam-token/revoke-iam-token.md) it. If a token is created using cookies (for example, under [federated authentication](../../../cli/operations/authentication/federated-user.md)), its lifetime is limited to that of the cookies. If the cookies are revoked (for example, when the user logs out), all the tokens generated for the cookies are canceled. The {{ iam-short-name }} API may return the same token in response to different requests if it is still a long time before it expires. +## IAM token revocation {#revoke} + +If your IAM token has been [compromised](../../operations/compromised-credentials.md), or you want to terminate your old IAM token when issuing a new one for security reasons, you can [revoke](../../operations/iam-token/revoke-iam-token.md) the token before its lifetime expires. + +Any authenticated user can revoke an IAM token using the [YC CLI](../../../cli/quickstart.md) or [API](../../api-ref/authentication.md). + ## Services that support this authentication method {#supported-services} This authentication method is supported by all services, except for those with AWS-compatible APIs. Such services require an IAM token only for managing [access keys](access-key.md) and [service accounts](../users/service-accounts.md). @@ -62,3 +68,4 @@ t1.7euelSbPyceKx87JqpuRl1qZiY-Ryi3rnpWaksrKaZqUppnLncmDnpeajZvl8_dZNAFl-e8ENXMH_ * [{#T}](../../../compute/operations/vm-connect/auth-inside-vm.md) * [{#T}](../../../functions/operations/function-sa.md) * [{#T}](./index.md) +* [{#T}](../../operations/iam-token/revoke-iam-token.md) \ No newline at end of file diff --git a/en/iam/operations/compromised-credentials.md b/en/iam/operations/compromised-credentials.md index 97978d44c3b..74c1f5be47e 100644 --- a/en/iam/operations/compromised-credentials.md +++ b/en/iam/operations/compromised-credentials.md @@ -1,5 +1,5 @@ --- -title: Handling secrets that are available in the public domain in {{ yandex-cloud }} +title: Processing secrets that have become publicly available in {{ yandex-cloud }} description: In this tutorial, you will learn what you should do if your secrets leaked to the public domain. --- @@ -17,49 +17,23 @@ description: In this tutorial, you will learn what you should do if your secrets ### IAM token {#iam-reissue} -You cannot delete an IAM token. If you create a new IAM token, the previous one remains valid. - To prevent a hacker from using your token: -1. Perform the following actions with the service account the IAM token was issued for: - - * For a service account: [reissue](#key-reissue) the authorized key of the service account that the token is granted for or delete the account. - * For a Yandex or federated account, do one of the following: - - * [Remove the account](../../organization/operations/edit-account.md) from all organizations while the token is valid. - * Revoke the rights of the account in any [cloud](users/delete) and [organization](../../organization/security/index.md#revoke) for the token validity period. - - {% note info %} - - IAM tokens are valid for [up to 12 hours](../concepts/authorization/iam-token.md#lifetime). - - {% endnote %} - -2. Create a new IAM token. +1. [Revoke](./iam-token/revoke-iam-token.md) the compromised IAM token. +1. Create a new IAM token. - * [Guide for a Yandex account](iam-token/create.md). - * [Guide for a service account](iam-token/create-for-sa.md). - * [Guide for a federated account](iam-token/create-for-federation.md). + * [For a Yandex account](iam-token/create.md). + * [For a service account](iam-token/create-for-sa.md). + * [For a federated account](iam-token/create-for-federation.md). ### OAuth token {#oauth-reissue} -You can revoke an OAuth token. In this case, the IAM token that is obtained using the OAuth token remains valid. +You can revoke an OAuth token. In this case, the IAM tokens obtained using the OAuth token will remain valid. Therefore, you must also revoke all such IAM tokens. To prevent a hacker from using your token: 1. [Revoke the OAuth token](https://yandex.com/dev/oauth/doc/dg/reference/token-invalidate.html). - -1. Revoke the rights of the account that the OAuth token belongs to in one of the following ways: - - * [Remove the account](../../organization/operations/edit-account.md) from all organizations while the IAM token is valid. - * Revoke the rights of the account in any [cloud](users/delete) and [organization](../../organization/security/index.md#revoke) for the IAM token validity period. - - {% note info %} - - IAM tokens are valid for up to 12 hours. Learn more about the [IAM token lifetime](../concepts/authorization/iam-token.md#lifetime). - - {% endnote %} - +1. [Revoke](./iam-token/revoke-iam-token.md) all IAM tokens obtained using the compromised OAuth token. 1. [Get a new OAuth token]({{ link-cloud-oauth }}). ### Authorized key {#key-reissue} @@ -95,12 +69,12 @@ Follow the steps described in the [Authorized key](#key-reissue) section. [Create a new CAPTCHA](../../smartcaptcha/quickstart.md#creat-captcha) and, on the website page, replace the old CAPTCHA, whose [server key](../../smartcaptcha/concepts/keys.md) was compromised, with the new one. -### Cookies {#cookie-invalidation} +### Cookie {#cookie-invalidation} Disable cookies: -1. [Change your password](https://yandex.com/support/id/profile.html) in Yandex ID. -1. [Log in to Yandex ID](https://passport.yandex.com/) with the new password. +1. [Change](https://yandex.com/support/id/profile.html) your Yandex ID password. +1. [Log in to Yandex ID](https://passport.yandex.com/) with your new password. ## Check for any unauthorized actions {#searching-unauthorized-access} @@ -123,9 +97,9 @@ You can configure [exporting audit logs to a SIEM system](../../audit-trails/con ## Contact support {#support} -Report the incident to the [support team]({{ link-console-support }}). This will help us enhance secret protection in future {{ yandex-cloud }} releases. +Report the incident to the [support]({{ link-console-support }}). This will help us enhance secret protection in future {{ yandex-cloud }} releases. -You can learn more about the [technical support terms](../../support/overview.md) here. +You can learn more about the support terms [here](../../support/overview.md). ## Follow our recommendations on building a secure infrastructure {#recommendations} diff --git a/en/iam/operations/iam-token/create-for-federation.md b/en/iam/operations/iam-token/create-for-federation.md index 3f959249807..5537e045335 100644 --- a/en/iam/operations/iam-token/create-for-federation.md +++ b/en/iam/operations/iam-token/create-for-federation.md @@ -15,11 +15,11 @@ The [IAM token](../../../iam/concepts/authorization/iam-token.md) lifetime canno - CLI {#cli} - {% include [cli-install](../../../_includes/cli-install.md) %} + {% include [cli-install](../../../_includes/cli-install.md) %} - 1. [Authenticate with the CLI as a federated user](../../../cli/operations/authentication/federated-user.md). + 1. [Authenticate with the CLI as a federated user](../../../cli/operations/authentication/federated-user.md). - 1. Get an IAM token: + 1. Get an IAM token: ```bash yc iam create-token @@ -33,4 +33,8 @@ The [IAM token](../../../iam/concepts/authorization/iam-token.md) lifetime canno ### Using an IAM token obtained via the CLI {#use-cli} -{% include [include](../../../_includes/iam/iam-token-usage-examples.md) %} \ No newline at end of file +{% include [include](../../../_includes/iam/iam-token-usage-examples.md) %} + +#### See also {#see-also} + +* [{#T}](./revoke-iam-token.md) \ No newline at end of file diff --git a/en/iam/operations/iam-token/create-for-sa.md b/en/iam/operations/iam-token/create-for-sa.md index cf7d413332d..589caaf818e 100644 --- a/en/iam/operations/iam-token/create-for-sa.md +++ b/en/iam/operations/iam-token/create-for-sa.md @@ -53,588 +53,588 @@ On [jwt.io](https://jwt.io) you can view the list of libraries and try generatin {% list tabs group=programming_language %} -- Step-by-step guide {#instruction} +- Guide {#instruction} - Generate the parts that make up a JWT: - * `header`: Base64Url-encoded JWT headers. - * `payload`: Base64Url-encoded JWT Claims Set. - * `signature`: Signature generated from parts of the header and payload. + Generate the parts that make up a JWT: + * `header`: Base64Url-encoded JWT headers. + * `payload`: Base64Url-encoded JWT Claims Set. + * `signature`: Signature generated from parts of the header and payload. - To create a JWT, join all parts using a period as the delimiter: + To create a JWT, join all parts using a period as the delimiter: - ``` - header.payload.signature - ``` + ``` + header.payload.signature + ``` - **1.1. Generating header** + **1.1. Generating a header** - A service account's JWT header must contain the following fields: - * `typ`: Token type, the value is always `JWT`. - * `alg`: Encryption algorithm. The only supported algorithm is [PS256](https://tools.ietf.org/html/rfc7518#section-3.5). - * `kid`: ID of the public key obtained when [creating authorized keys](../authorized-key/create.md). The key must belong to the service account that the IAM token is requested for. + A service account's JWT header must contain the following fields: + * `typ`: Token type, the value is always `JWT`. + * `alg`: Encryption algorithm. The only supported algorithm is [PS256](https://tools.ietf.org/html/rfc7518#section-3.5). + * `kid`: ID of the public key obtained when [creating authorized keys](../authorized-key/create.md). The key must belong to the service account that the IAM token is requested for. - For example: + Examples: - ``` - { - "typ": "JWT", - "alg": "PS256", - "kid": "lfkoe35hsk58********" - } - ``` + ``` + { + "typ": "JWT", + "alg": "PS256", + "kid": "lfkoe35hsk58********" + } + ``` - Save the result as a Base64Url-encoded string. + Save the result as a Base64Url-encoded string. - **1.2. Generating payload** + **1.2. Generating a payload** - A service account's JWT payload must contain the following fields: - * `iss`: ID of the service account whose key the JWT is signed with. - * `aud`: Link by which an IAM token will be requested: `https://iam.{{ api-host }}/iam/v1/tokens`. - * `iat`: JWT issue time in [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time) format. - * `exp`: JWT expiration time in Unix timestamp format. The expiration time must not exceed the issue time by more than one hour, i.e., `exp - iat ≤ 3600`. + A service account's JWT payload must contain the following fields: + * `iss`: ID of the service account whose key the JWT is signed with. + * `aud`: Link by which an IAM token will be requested: `https://iam.{{ api-host }}/iam/v1/tokens`. + * `iat`: JWT issue time in [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time) format. + * `exp`: JWT expiration time in Unix timestamp format. The expiration time must not exceed the issue time by more than one hour, i.e., `exp - iat ≤ 3600`. - For example: + Examples: - ``` - { - "iss": "ajepg0mjt06s********", - "aud": "https://iam.{{ api-host }}/iam/v1/tokens", - "iat": 1516239022, - "exp": 1516240822 - } - ``` + ``` + { + "iss": "ajepg0mjt06s********", + "aud": "https://iam.{{ api-host }}/iam/v1/tokens", + "iat": 1516239022, + "exp": 1516240822 + } + ``` - Save the result as a Base64Url-encoded string. + Save the result as a Base64Url-encoded string. - **1.3. Generating signature** + **1.3. Generating a signature** - Create a signature using the private key obtained when [creating authorized keys](../authorized-key/create.md). For the signature, use a string consisting of the header and payload separated by a dot (`.`): + Create a signature using the private key obtained when [creating authorized keys](../authorized-key/create.md). For the signature, use a string consisting of the header and payload separated by a period (`.`): - ``` - header.payload - ``` + ``` + header.payload + ``` - The only supported algorithm is [PS256](https://tools.ietf.org/html/rfc7518#section-3.5). + The only supported algorithm is [PS256](https://tools.ietf.org/html/rfc7518#section-3.5). - Save the result as a Base64Url-encoded string. + Save the result as a Base64Url-encoded string. - If you generate a token using [jwt.io](https://jwt.io), note that `\n` in the key value must be replaced with line breaks. + If you generate a token using [jwt.io](https://jwt.io), note that `\n` in the key value must be replaced with line breaks. - Python {#python} - Example of creating a JWT using [PyJWT](https://github.com/jpadilla/pyjwt/): - - Verified for Python 3.12.2 and PyJWT 2.8.0. - - The required data is read from the JSON file obtained when creating the authorized key. - - Install the `PyJWT` and `cryptography` modules to use the `PS256` algorithm: - - ```bash - pip3 install PyJWT - pip3 install cryptography - ``` - - ```python - import time - import jwt - import json - - # Reading the private key from the JSON file - with open('', 'r') as f: - obj = f.read() - obj = json.loads(obj) - private_key = obj['private_key'] - key_id = obj['id'] - service_account_id = obj['service_account_id'] - - now = int(time.time()) - payload = { - 'aud': 'https://iam.{{ api-host }}/iam/v1/tokens', - 'iss': service_account_id, - 'iat': now, - 'exp': now + 3600 - } - - # JWT generation. - encoded_token = jwt.encode( - payload, - private_key, - algorithm='PS256', - headers={'kid': key_id} - ) - - #Writing the key to the file - with open('jwt_token.txt', 'w') as j: - j.write(encoded_token) - - # Printing to the console - print(encoded_token) - - ``` + Example of creating a JWT using [PyJWT](https://github.com/jpadilla/pyjwt/): + - Verified for Python 3.12.2 and PyJWT 2.8.0. + - The required data is read from the JSON file obtained when creating the authorized key. + + Install the `PyJWT` and `cryptography` modules to use `PS256` algorithm: + + ```bash + pip3 install PyJWT + pip3 install cryptography + ``` + + ```python + import time + import jwt + import json + + # Reading a private key from a JSON file + with open('', 'r') as f: + obj = f.read() + obj = json.loads(obj) + private_key = obj['private_key'] + key_id = obj['id'] + service_account_id = obj['service_account_id'] + + now = int(time.time()) + payload = { + 'aud': 'https://iam.{{ api-host }}/iam/v1/tokens', + 'iss': service_account_id, + 'iat': now, + 'exp': now + 3600 + } + + # JWT generation. + encoded_token = jwt.encode( + payload, + private_key, + algorithm='PS256', + headers={'kid': key_id} + ) + + #Writing a key to a file + with open('jwt_token.txt', 'w') as j: + j.write(encoded_token) + + # Printing to console + print(encoded_token) + + ``` - Java {#java} - Example of creating a JWT using the [JJWT](https://github.com/jwtk/jjwt), [Bouncy Castle](https://github.com/bcgit/bc-java), and [Jackson Databind](https://github.com/FasterXML/jackson-databind) libraries: - - Verified for Java 21 and JJWT 0.12.5. - - The required data is read from the JSON file obtained when creating the authorized key. - - ```java - package com.mycompany.java.jwt; - - import com.fasterxml.jackson.databind.ObjectMapper; - import io.jsonwebtoken.Jwts; - import io.jsonwebtoken.SignatureAlgorithm; - import org.bouncycastle.util.io.pem.PemObject; - import org.bouncycastle.util.io.pem.PemReader; - - import java.io.StringReader; - import java.nio.file.Files; - import java.nio.file.Paths; - import java.security.KeyFactory; - import java.security.PrivateKey; - import java.security.spec.PKCS8EncodedKeySpec; - import java.time.Instant; - import java.util.Date; - - public class JavaJwt { - - public static class KeyInfo { - - public String id; - public String service_account_id; - public String private_key; - } - - public static void main(String[] args) throws Exception { - - String content = new String(Files.readAllBytes(Paths.get(""))); - KeyInfo keyInfo = (new ObjectMapper()).readValue(content, KeyInfo.class); - - String privateKeyString = keyInfo.private_key; - String serviceAccountId = keyInfo.service_account_id; - String keyId = keyInfo.id; - - PemObject privateKeyPem; - try (PemReader reader = new PemReader(new StringReader(privateKeyString))) { - privateKeyPem = reader.readPemObject(); - } - - KeyFactory keyFactory = KeyFactory.getInstance("RSA"); - PrivateKey privateKey = keyFactory.generatePrivate(new PKCS8EncodedKeySpec(privateKeyPem.getContent())); - - Instant now = Instant.now(); - - // JWT generation. - String encodedToken = Jwts.builder() - .setHeaderParam("kid", keyId) - .setIssuer(serviceAccountId) - .setAudience("https://iam.{{ api-host }}/iam/v1/tokens") - .setIssuedAt(Date.from(now)) - .setExpiration(Date.from(now.plusSeconds(3600))) - .signWith(privateKey, SignatureAlgorithm.PS256) - .compact(); - System.out.println(encodedToken); - } - } - ``` + Example of creating a JWT using the [JJWT](https://github.com/jwtk/jjwt), [Bouncy Castle](https://github.com/bcgit/bc-java), and [Jackson Databind](https://github.com/FasterXML/jackson-databind) libraries: + - Verified for Java 21 and JJWT 0.12.5. + - The required data is read from the JSON file obtained when creating the authorized key. + + ```java + package com.mycompany.java.jwt; + + import com.fasterxml.jackson.databind.ObjectMapper; + import io.jsonwebtoken.Jwts; + import io.jsonwebtoken.SignatureAlgorithm; + import org.bouncycastle.util.io.pem.PemObject; + import org.bouncycastle.util.io.pem.PemReader; + + import java.io.StringReader; + import java.nio.file.Files; + import java.nio.file.Paths; + import java.security.KeyFactory; + import java.security.PrivateKey; + import java.security.spec.PKCS8EncodedKeySpec; + import java.time.Instant; + import java.util.Date; + + public class JavaJwt { + + public static class KeyInfo { + + public String id; + public String service_account_id; + public String private_key; + } + + public static void main(String[] args) throws Exception { + + String content = new String(Files.readAllBytes(Paths.get(""))); + KeyInfo keyInfo = (new ObjectMapper()).readValue(content, KeyInfo.class); + + String privateKeyString = keyInfo.private_key; + String serviceAccountId = keyInfo.service_account_id; + String keyId = keyInfo.id; + + PemObject privateKeyPem; + try (PemReader reader = new PemReader(new StringReader(privateKeyString))) { + privateKeyPem = reader.readPemObject(); + } + + KeyFactory keyFactory = KeyFactory.getInstance("RSA"); + PrivateKey privateKey = keyFactory.generatePrivate(new PKCS8EncodedKeySpec(privateKeyPem.getContent())); + + Instant now = Instant.now(); + + // JWT generation. + String encodedToken = Jwts.builder() + .setHeaderParam("kid", keyId) + .setIssuer(serviceAccountId) + .setAudience("https://iam.{{ api-host }}/iam/v1/tokens") + .setIssuedAt(Date.from(now)) + .setExpiration(Date.from(now.plusSeconds(3600))) + .signWith(privateKey, SignatureAlgorithm.PS256) + .compact(); + System.out.println(encodedToken); + } + } + ``` - C# {#csharp} - Example of creating a JWT using [jose-jwt](https://www.nuget.org/packages/jose-jwt/): - - Verified for jose-jwt 5.0.0. - - **Net Framework / Net Core**: - - Verified for Net Framework 4.8.1 and Net Core 3.1. - - ```c# - using System; - using System.Collections.Generic; - using System.IO; - using System.Security.Cryptography; - using Jose; - using Org.BouncyCastle.Crypto.Parameters; - using Org.BouncyCastle.OpenSsl; - using Org.BouncyCastle.Security; - - namespace ConsoleApp - { - class Program - { - static void Main(string[] args) - { - var serviceAccountId = ""; - var keyId = ""; - var now = DateTimeOffset.UtcNow.ToUnixTimeSeconds(); - - var headers = new Dictionary() - { - { "kid", keyId } - }; - - var payload = new Dictionary() - { - { "aud", "https://iam.{{ api-host }}/iam/v1/tokens" }, - { "iss", serviceAccountId }, - { "iat", now }, - { "exp", now + 3600 } - }; - - RsaPrivateCrtKeyParameters privateKeyParams; - using (var pemStream = File.OpenText("")) - { - privateKeyParams = new PemReader(pemStream).ReadObject() as RsaPrivateCrtKeyParameters; - } - - using (var rsa = RSA.Create()) - { - rsa.ImportParameters(DotNetUtilities.ToRSAParameters(privateKeyParams)); - string encodedToken = Jose.JWT.Encode(payload, rsa, JwsAlgorithm.PS256, headers); - } - } - } - } - - ``` - - **.NET 5.0+**: - - Verified for NET 5.0, NET 6.0, NET 7.0, and NET 8.0. - - ```c# - using System; - using System.Collections.Generic; - using System.IO; - using System.Security.Cryptography; - using Jose; - - namespace ConsoleApp - { - class Program - { - static void Main(string[] args) - { - var serviceAccountId = ""; - var keyId = ""; - var now = DateTimeOffset.UtcNow.ToUnixTimeSeconds(); - - var headers = new Dictionary() - { - { "kid", keyId } - }; - - var payload = new Dictionary() - { - { "aud", "https://iam.{{ api-host }}/iam/v1/tokens" }, - { "iss", serviceAccountId }, - { "iat", now }, - { "exp", now + 3600 } - }; - - using (var rsa = RSA.Create()) - { - rsa.ImportFromPem(File.ReadAllText("").ToCharArray()); - string encodedToken = Jose.JWT.Encode(payload, rsa, JwsAlgorithm.PS256, headers); - } - } - } - } - ``` + Example of creating a JWT using [jose-jwt](https://www.nuget.org/packages/jose-jwt/): + - Verified for jose-jwt 5.0.0. + + **Net Framework / Net Core**: + + Verified for Net Framework 4.8.1 and Net Core 3.1. + + ```c# + using System; + using System.Collections.Generic; + using System.IO; + using System.Security.Cryptography; + using Jose; + using Org.BouncyCastle.Crypto.Parameters; + using Org.BouncyCastle.OpenSsl; + using Org.BouncyCastle.Security; + + namespace ConsoleApp + { + class Program + { + static void Main(string[] args) + { + var serviceAccountId = ""; + var keyId = ""; + var now = DateTimeOffset.UtcNow.ToUnixTimeSeconds(); + + var headers = new Dictionary() + { + { "kid", keyId } + }; + + var payload = new Dictionary() + { + { "aud", "https://iam.{{ api-host }}/iam/v1/tokens" }, + { "iss", serviceAccountId }, + { "iat", now }, + { "exp", now + 3600 } + }; + + RsaPrivateCrtKeyParameters privateKeyParams; + using (var pemStream = File.OpenText("")) + { + privateKeyParams = new PemReader(pemStream).ReadObject() as RsaPrivateCrtKeyParameters; + } + + using (var rsa = RSA.Create()) + { + rsa.ImportParameters(DotNetUtilities.ToRSAParameters(privateKeyParams)); + string encodedToken = Jose.JWT.Encode(payload, rsa, JwsAlgorithm.PS256, headers); + } + } + } + } + + ``` + + **.NET 5.0+**: + + Verified for NET 5.0, NET 6.0, NET 7.0, and NET 8.0. + + ```c# + using System; + using System.Collections.Generic; + using System.IO; + using System.Security.Cryptography; + using Jose; + + namespace ConsoleApp + { + class Program + { + static void Main(string[] args) + { + var serviceAccountId = ""; + var keyId = ""; + var now = DateTimeOffset.UtcNow.ToUnixTimeSeconds(); + + var headers = new Dictionary() + { + { "kid", keyId } + }; + + var payload = new Dictionary() + { + { "aud", "https://iam.{{ api-host }}/iam/v1/tokens" }, + { "iss", serviceAccountId }, + { "iat", now }, + { "exp", now + 3600 } + }; + + using (var rsa = RSA.Create()) + { + rsa.ImportFromPem(File.ReadAllText("").ToCharArray()); + string encodedToken = Jose.JWT.Encode(payload, rsa, JwsAlgorithm.PS256, headers); + } + } + } + } + ``` - Go {#go} - Example of creating a JWT using [golang-jwt](https://github.com/golang-jwt/jwt). - - Verified for Go1.22.1 and golang-jwt v5. - - The private key is read from the JSON file obtained when creating the authorized key. - - Install the required packages: - - ``` - install jwt v5 - go get -u github.com/golang-jwt/jwt/v5 - ``` - - ```go - package main - - import ( - "crypto/rsa" - "encoding/json" - "log" - "os" - "time" - - "github.com/golang-jwt/jwt/v5" - ) - - func main() { - // Getting a token - token := signedToken() - // Saving the token to the file - err := os.WriteFile("jwt_token.txt", []byte(token), 0644) - if err != nil { - log.Fatal(err) - } - // Printing the token to the console - fmt.Println("Here is token:") - fmt.Println(token) - } - - const ( - keyID = "" - serviceAccountID = "" - keyFile = "" - ) - - // JWT generation. - func signedToken() string { - claims := jwt.RegisteredClaims{ - Issuer: serviceAccountID, - ExpiresAt: jwt.NewNumericDate(time.Now().UTC().Add(1 * time.Hour)), - IssuedAt: jwt.NewNumericDate(time.Now().UTC()), - NotBefore: jwt.NewNumericDate(time.Now().UTC()), - Audience: []string{"https://iam.{{ api-host }}/iam/v1/tokens"}, - } - token := jwt.NewWithClaims(jwt.SigningMethodPS256, claims) - token.Header["kid"] = keyID - - privateKey := loadPrivateKey() - signed, err := token.SignedString(privateKey) - if err != nil { - panic(err) - } - return signed - } - - type keyFileStruct struct { - PrivateKey string `json:"private_key"` - } - - func loadPrivateKey() *rsa.PrivateKey { - data, err := os.ReadFile(keyFile) - if err != nil { - panic(err) - } - - var keyData keyFileStruct - if err := json.Unmarshal(data, &keyData); err != nil { - panic(err) - } - - rsaPrivateKey, err := jwt.ParseRSAPrivateKeyFromPEM([]byte(keyData.PrivateKey)) - if err != nil { - panic(err) - } - return rsaPrivateKey - } - ``` + Example of creating a JWT using [golang-jwt](https://github.com/golang-jwt/jwt). + - Verified for Go1.22.1 and golang-jwt v5. + - The private key is read from the JSON file obtained when creating the authorized key. + + Install the required packages: + + ``` + install jwt v5 + go get -u github.com/golang-jwt/jwt/v5 + ``` + + ```go + package main + + import ( + "crypto/rsa" + "encoding/json" + "log" + "os" + "time" + + "github.com/golang-jwt/jwt/v5" + ) + + func main() { + // Getting a token + token := signedToken() + // Saving the token to a file + err := os.WriteFile("jwt_token.txt", []byte(token), 0644) + if err != nil { + log.Fatal(err) + } + // Printing the token to console + fmt.Println("Here is token:") + fmt.Println(token) + } + + const ( + keyID = "" + serviceAccountID = "" + keyFile = "" + ) + + // JWT generation. + func signedToken() string { + claims := jwt.RegisteredClaims{ + Issuer: serviceAccountID, + ExpiresAt: jwt.NewNumericDate(time.Now().UTC().Add(1 * time.Hour)), + IssuedAt: jwt.NewNumericDate(time.Now().UTC()), + NotBefore: jwt.NewNumericDate(time.Now().UTC()), + Audience: []string{"https://iam.{{ api-host }}/iam/v1/tokens"}, + } + token := jwt.NewWithClaims(jwt.SigningMethodPS256, claims) + token.Header["kid"] = keyID + + privateKey := loadPrivateKey() + signed, err := token.SignedString(privateKey) + if err != nil { + panic(err) + } + return signed + } + + type keyFileStruct struct { + PrivateKey string `json:"private_key"` + } + + func loadPrivateKey() *rsa.PrivateKey { + data, err := os.ReadFile(keyFile) + if err != nil { + panic(err) + } + + var keyData keyFileStruct + if err := json.Unmarshal(data, &keyData); err != nil { + panic(err) + } + + rsaPrivateKey, err := jwt.ParseRSAPrivateKeyFromPEM([]byte(keyData.PrivateKey)) + if err != nil { + panic(err) + } + return rsaPrivateKey + } + ``` - Node.js {#node} - Example of creating a JWT using [node-jose](https://github.com/cisco/node-jose): - - Verified for Node.js v20.12.1 and node-jose 2.2.0. - - The required data is read from the JSON file obtained when creating the authorized key. + Example of creating a JWT using [node-jose](https://github.com/cisco/node-jose): + - Verified for Node.js v20.12.1 and node-jose 2.2.0. + - The required data is read from the JSON file obtained when creating the authorized key. - ```js - var jose = require('node-jose'); - var fs = require('fs'); + ```js + var jose = require('node-jose'); + var fs = require('fs'); - var json = JSON.parse(fs.readFileSync(require.resolve(''))); + var json = JSON.parse(fs.readFileSync(require.resolve(''))); - var key = json.private_key; - var serviceAccountId = json.service_account_id; - var keyId = json.id; + var key = json.private_key; + var serviceAccountId = json.service_account_id; + var keyId = json.id; - var now = Math.floor(new Date().getTime() / 1000); + var now = Math.floor(new Date().getTime() / 1000); - var payload = { - aud: "https://iam.{{ api-host }}/iam/v1/tokens", - iss: serviceAccountId, - iat: now, - exp: now + 3600 - }; + var payload = { + aud: "https://iam.{{ api-host }}/iam/v1/tokens", + iss: serviceAccountId, + iat: now, + exp: now + 3600 + }; - jose.JWK.asKey(key, 'pem', { kid: keyId, alg: 'PS256' }) - .then(function (result) { - jose.JWS.createSign({ format: 'compact' }, result) - .update(JSON.stringify(payload)) - .final() - .then(function (result) { - console.log(result); - }); - }); - ``` + jose.JWK.asKey(key, 'pem', { kid: keyId, alg: 'PS256' }) + .then(function (result) { + jose.JWS.createSign({ format: 'compact' }, result) + .update(JSON.stringify(payload)) + .final() + .then(function (result) { + console.log(result); + }); + }); + ``` - PHP {#php} - Example of creating a JWT using [PHP JWT Framework](https://github.com/web-token/jwt-framework): - - Verified for PHP v8.3.4 and web-token/jwt-framework v3.3.5. - - Verified for PHP v7.4.33 and web-token/jwt-framework v2.2.11. - - The required data is read from the JSON file obtained when creating the authorized key. - - - ```php - require 'vendor/autoload.php'; - - use Jose\Component\Core\AlgorithmManager; - use Jose\Component\KeyManagement\JWKFactory; - use Jose\Component\Signature\Algorithm\PS256; - use Jose\Component\Signature\JWSBuilder; - use Jose\Component\Signature\Serializer\CompactSerializer; - - // Reading data from the file - $keyData = json_decode(file_get_contents(""), true); - $privateKeyPem = $keyData['private_key']; - $keyId = $keyData['id']; - $serviceAccountId = $keyData['service_account_id']; - - // You need to delete the private key header/metadata - if (strpos($privateKeyPem, "PLEASE DO NOT REMOVE THIS LINE!") === 0) { - $privateKeyPem = substr($privateKeyPem, strpos($privateKeyPem, "\n") + 1); - } - - $jwk = JWKFactory::createFromKey( - $privateKeyPem, - null, - [ - 'alg' => 'PS256', - 'use' => 'sig', - 'kid' => $keyId, - ] - ); - - $algorithmManager = new AlgorithmManager([new PS256()]); - $jwsBuilder = new JWSBuilder($algorithmManager); - - $payload = json_encode([ - 'iss' => $serviceAccountId, - 'aud' => "https://iam.{{ api-host }}/iam/v1/tokens", - 'iat' => time(), - 'nbf' => time(), - 'exp' => time() + 3600, - ]); - - $jws = $jwsBuilder - ->create() - ->withPayload($payload) - ->addSignature($jwk, ['alg' => 'PS256', 'typ'=>'JWT', 'kid' => $keyId]) - ->build(); - - - $serializer = new CompactSerializer(); - $token = $serializer->serialize($jws, 0); - - // Saving the token to the file - file_put_contents('jwt_token.txt', $token); - // Printing the token to the console - echo "JWT Token: " . $token . PHP_EOL; - ``` + Example of creating a JWT using [PHP JWT Framework](https://github.com/web-token/jwt-framework): + - Verified for PHP v8.3.4 and web-token/jwt-framework v3.3.5. + - Verified for PHP v7.4.33 and web-token/jwt-framework v2.2.11. + - The required data is read from the JSON file obtained when creating the authorized key. + + + ```php + require 'vendor/autoload.php'; + + use Jose\Component\Core\AlgorithmManager; + use Jose\Component\KeyManagement\JWKFactory; + use Jose\Component\Signature\Algorithm\PS256; + use Jose\Component\Signature\JWSBuilder; + use Jose\Component\Signature\Serializer\CompactSerializer; + + // Reading data from a file + $keyData = json_decode(file_get_contents(""), true); + $privateKeyPem = $keyData['private_key']; + $keyId = $keyData['id']; + $serviceAccountId = $keyData['service_account_id']; + + // You need to delete header/metadata from the private key + if (strpos($privateKeyPem, "PLEASE DO NOT REMOVE THIS LINE!") === 0) { + $privateKeyPem = substr($privateKeyPem, strpos($privateKeyPem, "\n") + 1); + } + + $jwk = JWKFactory::createFromKey( + $privateKeyPem, + null, + [ + 'alg' => 'PS256', + 'use' => 'sig', + 'kid' => $keyId, + ] + ); + + $algorithmManager = new AlgorithmManager([new PS256()]); + $jwsBuilder = new JWSBuilder($algorithmManager); + + $payload = json_encode([ + 'iss' => $serviceAccountId, + 'aud' => "https://iam.{{ api-host }}/iam/v1/tokens", + 'iat' => time(), + 'nbf' => time(), + 'exp' => time() + 3600, + ]); + + $jws = $jwsBuilder + ->create() + ->withPayload($payload) + ->addSignature($jwk, ['alg' => 'PS256', 'typ'=>'JWT', 'kid' => $keyId]) + ->build(); + + + $serializer = new CompactSerializer(); + $token = $serializer->serialize($jws, 0); + + // Saving the token to a file + file_put_contents('jwt_token.txt', $token); + // Printing the token to console + echo "JWT Token: " . $token . PHP_EOL; + ``` - C++ {#cpp} - Example of creating a JWT using [jwt-cpp](https://github.com/Thalhammer/jwt-cpp): - - Verified for C++ 14 and jwt-cpp 0.7.0. - - The required data is read from the JSON file obtained when creating the authorized key. - - ```cpp - #include - #include - #include - - #include "jwt-cpp/jwt.h" - - int main() - { - std::ifstream key_file(""); - std::string content((std::istreambuf_iterator(key_file)), - (std::istreambuf_iterator())); - - picojson::value v; - std::string err = picojson::parse(v, content); - auto privateKey = v.get("private_key").to_str(); - auto serviceAccountId = v.get("service_account_id").to_str(); - auto keyId = v.get("id").to_str(); - - auto now = std::chrono::system_clock::now(); - auto expires_at = now + std::chrono::hours(1); - picojson::array audience_array; - audience_array.push_back(picojson::value("https://iam.{{ api-host }}/iam/v1/tokens")); - auto algorithm = jwt::algorithm::ps256( - "", - privateKey); - - // JWT generation. - auto encoded_token = jwt::create() - .set_key_id(keyId) - .set_issuer(serviceAccountId) - .set_audience(audience_array) - .set_issued_at(now) - .set_expires_at(expires_at) - .sign(algorithm); - - std::cout << encoded_token; - } - ``` + Example of creating a JWT using [jwt-cpp](https://github.com/Thalhammer/jwt-cpp): + - Verified for C++ 14 and jwt-cpp 0.7.0. + - The required data is read from the JSON file obtained when creating the authorized key. + + ```cpp + #include + #include + #include + + #include "jwt-cpp/jwt.h" + + int main() + { + std::ifstream key_file(""); + std::string content((std::istreambuf_iterator(key_file)), + (std::istreambuf_iterator())); + + picojson::value v; + std::string err = picojson::parse(v, content); + auto privateKey = v.get("private_key").to_str(); + auto serviceAccountId = v.get("service_account_id").to_str(); + auto keyId = v.get("id").to_str(); + + auto now = std::chrono::system_clock::now(); + auto expires_at = now + std::chrono::hours(1); + picojson::array audience_array; + audience_array.push_back(picojson::value("https://iam.{{ api-host }}/iam/v1/tokens")); + auto algorithm = jwt::algorithm::ps256( + "", + privateKey); + + // JWT generation. + auto encoded_token = jwt::create() + .set_key_id(keyId) + .set_issuer(serviceAccountId) + .set_audience(audience_array) + .set_issued_at(now) + .set_expires_at(expires_at) + .sign(algorithm); + + std::cout << encoded_token; + } + ``` - Ruby {#ruby} - Example of creating a JWT using [ruby-jwt](https://github.com/jwt/ruby-jwt): - - Verified for Ruby 3.2.3 and jwt 2.8.1. - - The required data is read from the JSON file obtained when creating the authorized key. - - Install the jwt package: - - ``` - gem install jwt - ``` - - - ```ruby - - require 'jwt' - require 'json' - require 'time' - - KEY_FILE = '' - KEY_DATA = JSON.parse(File.read(KEY_FILE)) - KEY_ID = KEY_DATA['id'] - SERVICE_ACCOUNT_ID = KEY_DATA['service_account_id'] - - def load_private_key - OpenSSL::PKey::RSA.new(KEY_DATA['private_key']) - rescue IOError, JSON::ParserError, OpenSSL::PKey::RSAError => e - raise "Failed to load or parse private key: #{e.message}" - end - - def signed_token - payload = { - iss: SERVICE_ACCOUNT_ID, - exp: Time.now.to_i + 3600, - iat: Time.now.to_i, - nbf: Time.now.to_i, - aud: "https://iam.{{ api-host }}/iam/v1/tokens" - } - - header = { - kid: KEY_ID - } - - private_key = load_private_key - - JWT.encode(payload, private_key, 'PS256', header) - end - - # Main execution - begin - token = signed_token - File.write('jwt_token.txt', token) - # Or, alternatively, print the token to the console - # puts "Here is the token:" - # puts token - rescue => e - puts "An error occurred: #{e.message}" - end - - ``` + Example of creating a JWT using [ruby-jwt](https://github.com/jwt/ruby-jwt): + - Verified for Ruby 3.2.3 and jwt 2.8.1. + - The required data is read from the JSON file obtained when creating the authorized key. + + Install the jwt package: + + ``` + gem install jwt + ``` + + + ```ruby + + require 'jwt' + require 'json' + require 'time' + + KEY_FILE = '' + KEY_DATA = JSON.parse(File.read(KEY_FILE)) + KEY_ID = KEY_DATA['id'] + SERVICE_ACCOUNT_ID = KEY_DATA['service_account_id'] + + def load_private_key + OpenSSL::PKey::RSA.new(KEY_DATA['private_key']) + rescue IOError, JSON::ParserError, OpenSSL::PKey::RSAError => e + raise "Failed to load or parse private key: #{e.message}" + end + + def signed_token + payload = { + iss: SERVICE_ACCOUNT_ID, + exp: Time.now.to_i + 3600, + iat: Time.now.to_i, + nbf: Time.now.to_i, + aud: "https://iam.{{ api-host }}/iam/v1/tokens" + } + + header = { + kid: KEY_ID + } + + private_key = load_private_key + + JWT.encode(payload, private_key, 'PS256', header) + end + + # Main execution + begin + token = signed_token + File.write('jwt_token.txt', token) + # Or, alternatively, print the token to the console + # puts "Here is the token:" + # puts token + rescue => e + puts "An error occurred: #{e.message}" + end + + ``` {% endlist %} @@ -651,58 +651,58 @@ When exchanging the JWT for an IAM token, make sure the following conditions are - API {#api} - To get an IAM token, use the [create](../../api-ref/IamToken/create.md) REST API method for the [IamToken](../../api-ref/IamToken/index.md) resource or the [IamTokenService/CreateForServiceAccount](../../api-ref/grpc/IamToken/createForServiceAccount.md) gRPC API call. + To get an IAM token, use the [create](../../api-ref/IamToken/create.md) REST API method for the [IamToken](../../api-ref/IamToken/index.md) resource or the [IamTokenService/CreateForServiceAccount](../../api-ref/grpc/IamToken/createForServiceAccount.md) gRPC API call. - Sample request using cURL for the `create` REST API method: + Example of request using cURL for the `create` REST API method: - ```curl - curl -X POST \ - -H 'Content-Type: application/json' \ - -d '{"jwt": ""}' \ - https://iam.{{ api-host }}/iam/v1/tokens - ``` + ```curl + curl -X POST \ + -H 'Content-Type: application/json' \ + -d '{"jwt": ""}' \ + https://iam.{{ api-host }}/iam/v1/tokens + ``` - Where `` is the JWT received in the previous step. + Where `` is the JWT token you got in the previous step. - Go {#go} - Example of a JWT exchange for an IAM token: - - ```go - import ( - "encoding/json" - "fmt" - "io/ioutil" - "net/http" - "strings" - ) - - func getIAMToken() string { - jot := signedToken() - fmt.Println(jot) - resp, err := http.Post( - "https://iam.{{ api-host }}/iam/v1/tokens", - "application/json", - strings.NewReader(fmt.Sprintf(`{"jwt":"%s"}`, jot)), - ) - if err != nil { - panic(err) - } - defer resp.Body.Close() - if resp.StatusCode != http.StatusOK { - body, _ := ioutil.ReadAll(resp.Body) - panic(fmt.Sprintf("%s: %s", resp.Status, body)) - } - var data struct { - IAMToken string `json:"iamToken"` - } - err = json.NewDecoder(resp.Body).Decode(&data) - if err != nil { - panic(err) - } - return data.IAMToken - } - ``` + Example of a JWT exchange for an IAM token: + + ```go + import ( + "encoding/json" + "fmt" + "io/ioutil" + "net/http" + "strings" + ) + + func getIAMToken() string { + jot := signedToken() + fmt.Println(jot) + resp, err := http.Post( + "https://iam.{{ api-host }}/iam/v1/tokens", + "application/json", + strings.NewReader(fmt.Sprintf(`{"jwt":"%s"}`, jot)), + ) + if err != nil { + panic(err) + } + defer resp.Body.Close() + if resp.StatusCode != http.StatusOK { + body, _ := ioutil.ReadAll(resp.Body) + panic(fmt.Sprintf("%s: %s", resp.Status, body)) + } + var data struct { + IAMToken string `json:"iamToken"` + } + err = json.NewDecoder(resp.Body).Decode(&data) + if err != nil { + panic(err) + } + return data.IAMToken + } + ``` {% endlist %} @@ -711,5 +711,6 @@ When exchanging the JWT for an IAM token, make sure the following conditions are #### What's next {#what-is-next} -* [{#T}](../sa/set-access-bindings.md) -* [{#T}](../sa/assign-role-for-sa.md) +* [{#T}](../sa/set-access-bindings.md). +* [{#T}](../sa/assign-role-for-sa.md). +* [{#T}](./revoke-iam-token.md). \ No newline at end of file diff --git a/en/iam/operations/iam-token/create.md b/en/iam/operations/iam-token/create.md index 11c1344ae30..157d3eda232 100644 --- a/en/iam/operations/iam-token/create.md +++ b/en/iam/operations/iam-token/create.md @@ -41,4 +41,5 @@ description: Follow this guide to get an IAM token for an account. #### See also {#see-also} -* [Using an IAM token in a Helm chart](../../../container-registry/operations/helm-chart/helm-chart-push.md) \ No newline at end of file +* [Using an IAM token in a Helm chart](../../../container-registry/operations/helm-chart/helm-chart-push.md) +* [Revoking an IAM token](./revoke-iam-token.md) \ No newline at end of file diff --git a/en/iam/operations/iam-token/revoke-iam-token.md b/en/iam/operations/iam-token/revoke-iam-token.md new file mode 100644 index 00000000000..22c2723d756 --- /dev/null +++ b/en/iam/operations/iam-token/revoke-iam-token.md @@ -0,0 +1,67 @@ +--- +title: How to revoke an IAM token +description: Follow this guide to revoke an IAM token you got earlier. +--- + +# Revoking an IAM token + +You can revoke an [IAM token](../../concepts/authorization/iam-token.md) you got earlier. You may need to do this, for example, if the token is [compromised](../compromised-credentials.md) or if you are getting a new one. + +To revoke an IAM token: + +{% list tabs group=instructions %} + +- CLI {#cli} + + {% include [cli-install](../../../_includes/cli-install.md) %} + + {% include [default-catalogue](../../../_includes/default-catalogue.md) %} + + 1. Check out the description of the IAM token revocation command: + + ```bash + yc iam revoke-token --help + ``` + + 1. Revoke the IAM token by specifying it in this command: + + ```bash + yc iam revoke-token \ + --iam-token "" + ``` + + Result: + + ```text + subject_id: ajei280a73vc******** + ``` + +- API {#api} + + Run an http request specifying the IAM token to revoke: + + ```bash + curl \ + --request POST \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer " \ + --data '{ + "iamToken": "" + }' \ + https://iam.{{ api-host }}/iam/v1/tokens:revoke + ``` + + Result: + + ```json + { + "subjectId": "ajei280a73vc********" + } + +{% endlist %} + +#### See also {#see-also} + +* [{#T}](./create.md) +* [{#T}](./create-for-federation.md) +* [{#T}](./create-for-sa.md) \ No newline at end of file diff --git a/en/iam/toc.yaml b/en/iam/toc.yaml index 5da509de6a5..7a5305e8bcc 100644 --- a/en/iam/toc.yaml +++ b/en/iam/toc.yaml @@ -61,6 +61,8 @@ items: href: operations/iam-token/create-for-sa.md - name: Getting an IAM token for a federated account href: operations/iam-token/create-for-federation.md + - name: Revoking an IAM token + href: operations/iam-token/revoke-iam-token.md - name: Keys items: - name: Creating a static access key diff --git a/en/load-testing/concepts/agent-select.md b/en/load-testing/concepts/agent-select.md new file mode 100644 index 00000000000..5eb3d30e1e5 --- /dev/null +++ b/en/load-testing/concepts/agent-select.md @@ -0,0 +1,85 @@ +# Agent selection + +When [creating a test](../operations/create-test-bucket.md#create-test), you can either specify a test agent right away by selecting one from the list or configure selecting the first agent that becomes available. The agent selection function allows you to filter test agents by parameters you set. + +## Specifying a test agent {#select} + +To specify a test agent: + +{% list tabs group=instructions %} + +- Management console {#console} + + 1. In the [management console]({{ link-console-main }}), select the folder for testing. + 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_load-testing }}**. + 1. In the ![image](../../_assets/load-testing/test.svg) **{{ ui-key.yacloud.load-testing.label_tests-list }}** tab, click **{{ ui-key.yacloud.load-testing.button_create-test }}**. + 1. In the **{{ ui-key.yacloud.load-testing.label_agents-list }}** section, click **{{ ui-key.yacloud.load-testing.label_agent-from-list-selector }}**. + 1. Select the name of the agent you need from the drop-down list. + + {% note info %} + + Within a single test, you can assign multiple agents to [work synchronously](../tutorials/loadtesting-multiply.md), which allows you to increase the load on the test target. + To do this, either select multiple agent names from the list or use **Only** and **Except** buttons in the row with the name of one of the agents. These buttons allow you to select only this agent or all agents other than this one, respectively. + + {% endnote %} + +- CLI {#cli} + + When creating a test, specify agent IDs: + + ```bash + export AGENT_ID1='' + export AGENT_ID2='' + + yc loadtesting test create \ + --name "yc-examples-test" \ + --description "Test has been created using YC" \ + --labels source=gh,type=tutorial,kind=multi \ + --configuration id=$TEST_CONFIG_ID,agent-id=$AGENT_ID1,test-data=$TEST_PAYLOAD_FILE_IN_CONFIG \ + --configuration id=$TEST_CONFIG_ID,agent-id=$AGENT_ID2,test-data=$TEST_PAYLOAD_FILE_IN_CONFIG \ + --test-data name=$TEST_PAYLOAD_FILE_IN_CONFIG,s3bucket=$S3_PAYLOAD_BUCKET,s3file=$S3_PAYLOAD_FILENAME + + ``` + +{% endlist %} + +## Setting up selection of the first test agent that becomes available {#filter} + +To configure selecting the first test agent that becomes available: + +{% list tabs group=instructions %} + +- Management console {#console} + + 1. In the [management console]({{ link-console-main }}), select the folder for testing. + 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_load-testing }}**. + 1. In the ![image](../../_assets/load-testing/test.svg) **{{ ui-key.yacloud.load-testing.label_tests-list }}** tab, click **{{ ui-key.yacloud.load-testing.button_create-test }}**. + 1. In the **{{ ui-key.yacloud.load-testing.label_agents-list }}** section, click **{{ ui-key.yacloud.load-testing.label_agent-by-filter-selector }}**. + 1. If any of the agents is suitable for the test, select **{{ ui-key.yacloud.load-testing.label_agent-by-filter-any-option }}**; otherwise, select **{{ ui-key.yacloud.load-testing.label_agent-by-filter-condition-option }}** and set up the agent filtering conditions: + * (Optional) In the **{{ ui-key.yacloud.load-testing.filter_label_tags }}** section, click **{{ ui-key.yacloud.component.label-set.button_add-label }}** and specify the labels for agent selection in `key:value` format. + * (Optional) In the **{{ ui-key.yacloud.load-testing.field_name-filter }}** field, specify a string that must be present in the names of the agents you want to start the test configuration on. + 1. In the **{{ ui-key.yacloud.load-testing.label_agents-count }}** field, specify how many agents will be used to run the test in synch: This will allow you to increase the load on the test target. + +- CLI {#cli} + + Set the filtering conditions: + + ```bash + + export ANY_AGENT_SELECTOR="" + export SPECIFIC_AGENT_SELECTOR="labels.key IN (value1, value2)" + + yc loadtesting test create \ + --name "yc-examples-test" \ + --description "Test has been created using YC" \ + --labels source=gh,type=tutorial \ + --configuration id=$TEST_CONFIG_ID,agent-by-filter=$ANY_AGENT_SELECTOR,test-data=$TEST_PAYLOAD_FILE_IN_CONFIG \ + --configuration id=$TEST_CONFIG_ID,agent-by-filter={$SPECIFIC_AGENT_SELECTOR},test-data=$TEST_PAYLOAD_FILE_IN_CONFIG \ + --test-data name=$TEST_PAYLOAD_FILE_IN_CONFIG,s3bucket=$S3_PAYLOAD_BUCKET,s3file=$S3_PAYLOAD_FILENAME + + ``` + + In this example, the first part of the test will be performed on any suitable agent (because no filtering conditions are set in `ANY_AGENT_SELECTOR`), while the second part, on any agent with the `key` label set to `value1` or `value2`. + +{% endlist %} + diff --git a/en/load-testing/concepts/load-test-regressions.md b/en/load-testing/concepts/load-test-regressions.md index 3d313c9a1ea..209449d4586 100644 --- a/en/load-testing/concepts/load-test-regressions.md +++ b/en/load-testing/concepts/load-test-regressions.md @@ -1,6 +1,6 @@ # Load test regressions -For each test launched through the service, you can determine a number of integral metrics, such as [response time](load-test-results.md#quantiles), [number of service responses with incorrect codes](load-test-results.md#network-codes), RPS disorders, etc. Integral metrics allow the user to quickly assess the quality of the test or the service being tested. +For each test you run with {{ load-testing-full-name }}, you can specify a certain number of integral metrics, such as [response time](load-test-results.md#quantiles), [number of service responses with incorrect codes](load-test-results.md#network-codes), RPS disorders, etc. Integral metrics allow the user to quickly assess the quality of the test or the service being tested. Using the visualization tools on the **Regressions** page, you can create graphs of dependencies of integral metrics on time for any performed tests. @@ -34,8 +34,13 @@ A testing thread is a separate instance of a load generator. It is usually equal This chart displays the dependence of RPS disorder on time. +### Thresholds for regression metrics {#check-regressions} -# See also +For each metric (line) on the regression dashboard charts, you can add a threshold value the excess of which should be considered abnormal. The chart areas where values exceed the thresholds are highlighted with the same color as the relevant metric line. -[How to create a regression dashboard](../operations/regressions.md) +For individual tests, you can also use the `check-regressions` [command](../../cli/cli-ref/managed-services/loadtesting/test/check-regression.md) in the {{ yandex-cloud }} CLI to check whether metric thresholds were exceeded. For more information, see [{#T}](../operations/check-regression.md). +## See also {#see-also} + +[Creating a regression dashboard](../operations/regressions.md) +[Checking regression metrics for exceeded thresholds](../operations/check-regression.md) diff --git a/en/load-testing/concepts/monitoring.md b/en/load-testing/concepts/monitoring.md index 64b962bb197..d8227ba8659 100644 --- a/en/load-testing/concepts/monitoring.md +++ b/en/load-testing/concepts/monitoring.md @@ -137,7 +137,7 @@ You can enable test agent monitoring in the settings when you [create a test](.. ``` Where: * `resource_id`: Test agent name. - * `folderId`: ID of the folder containing the test agent. + * `folderId`: ID of the folder containing the test agent. This plugin also allows you to configure additional parameters: @@ -145,7 +145,7 @@ You can enable test agent monitoring in the settings when you [create a test](.. panels: panel_name: ... - api_host: monitoring.api.cloud.yandex.net:443 + api_host: {{ api-host-monitoring-1 }}:443 token: LOADTESTING_YC_TOKEN timeout: 5s request_timeout: 10s @@ -155,7 +155,7 @@ You can enable test agent monitoring in the settings when you [create a test](.. ``` Where: - * `api_host`: Address of the {{ monitoring-name }} API used to collect data. The default value is `monitoring.api.cloud.yandex.net:443`. + * `api_host`: Address of the {{ monitoring-name }} API used to collect data. The default value is `{{ api-host-monitoring-1 }}:443`. * `token`: [IAM token](../../iam/concepts/authorization/iam-token.md) file path. The default value is taken from the `LOADTESTING_YC_TOKEN` environment variable. * `timeout`: Plugin shutdown timeout after the load test is over. The default value is five seconds. * `request_timeout`: {{ monitoring-name }} API request timeout. The default value is ten seconds. diff --git a/en/load-testing/operations/check-regression.md b/en/load-testing/operations/check-regression.md new file mode 100644 index 00000000000..5a63f7f2c42 --- /dev/null +++ b/en/load-testing/operations/check-regression.md @@ -0,0 +1,115 @@ +# Checking regression metrics for exceeded thresholds using CLI + +For each metric (line) on the [regression dashboard](./regressions.md) charts, you can add a threshold value the excess of which should be considered abnormal. In addition to graphical display of areas where thresholds are exceeded, you can get information about regressions using a [CLI command](../../cli/cli-ref/managed-services/loadtesting/test/check-regression.md). + +This page describes the main use cases for the `yc loadtesting test check-regression` command to check if thresholds are exceeded in regression charts. + +## Preparing test IDs {#get-test-ids} + +Get a list of test IDs with the `yc loadtesting test list` command: + +Response example: + +``` ++----------------------+---------+--------+---------------------+----------+ +| ID | NAME | LABELS | CREATED | FINISHED | ++----------------------+---------+--------+---------------------+----------+ +| ff6mmyz7s4t2m4****** | test780 | | 2024-09-29 09:26:56 | | ++----------------------+---------+--------+---------------------+----------+ +``` + +Use the IDs you get to run the check command. + +## Checking all charts of a selected test {#check-test} + +If you run the command without any additional parameters, it will check for regression on all the charts in your folder which contain the selected test. + +Run this command: + +``` +yc loadtesting test check-regression +``` + +Example of running the command: + +``` +yc loadtesting test check-regression ff6mmyz7s4t2m4****** + + Test: autotest-pandora-line-uripost (id=ff6mmyz7s4t2m4******) + +------------------------------------------------------------------------------------ + Charts checked (count): 3 + Thresholds: 2 OK / 1 FAILED + + + status value threshold fn metric case chart dashboard + +-------------------------------------------------------------------------------------------------------------------------------------------------------------- + OK 0 value <= 5 percent Responses: protocol code (5xx) overall all tests: less than 5% 5xx codes test-dashboard + OK 100 value >= 90 percent Responses: protocol code (200) overall all tests: more than 90% 200 codes test-dashboard + FAILED 27 value <= 20 q99 Latency overall Response time: autotest-pandora-line-uripost autotest + - 18 - q98 Latency overall Response time: autotest-pandora-line-uripost autotest + - 4.3 - q75 Latency overall Response time: autotest-pandora-line-uripost autotest + - 3.39 - q50 Latency overall Response time: autotest-pandora-line-uripost autotest +``` + +## Checking charts on a given dashboard {#check-graphs-from-dashboard} + +If you run the command with the `--dashboard-id` parameter, it will only check the charts from the dashboard you specify. + +You can get the dashboard ID on the page with the list of dashboards (the ID column is hidden by default), or take it from the dashboard page URL. + +Run this command: + +``` +yc loadtesting test check-regression --dashboard-id +``` + +Example of running the command: + +``` +yc loadtesting test check-regression ff6mmyz7s4t2m4****** --dashboard-id ff6jqg3mf5xhby****** + + Test: autotest-pandora-line-uripost (id=ff6mmyz7s4t2m4******) + +------------------------------------------------------------------------------------ + Charts checked (count): 2 + Thresholds: 2 OK / 0 FAILED + + + status value threshold fn metric case chart dashboard + +------------------------------------------------------------------------------------------------------------------------------------------- + OK 0 value <= 5 percent Responses: protocol code (5xx) overall all tests: less than 5% 5xx codes test-dashboard + OK 100 value >= 90 percent Responses: protocol code (200) overall all tests: more than 90% 200 codes test-dashboard +``` + +## Checking an idividual chart {#check-graph} + +If you run the command with the `--dashboard-id` and `--chart-id` parameters, it will only check the thresholds on a specific chart. + +``` +yc loadtesting test check-regression --dashboard-id --chart-id +``` + +You can get the dashboard ID on the page with the list of dashboards (the ID column is hidden by default), or take it from the dashboard page URL. + +To get the chart ID, click ![image](../../_assets/console-icons/chevrons-expand-up-right.svg) next to any of the charts on the dashboard. This will open a separate chart page. You can find the ID is at the top of the page and in its URL. + +Example of running the command: + +``` +yc loadtesting test check-regression ff6mmyz7s4t2m4****** --dashboard-id ff6jqg3mf5xhby****** --chart-id 57651054-35af-47ea-a5a8-6a1a8dbe4377 + + Test: autotest-pandora-line-uripost (id=ff6mmyz7s4t2m4******) + +------------------------------------------------------------------------------------ + Charts checked (count): 1 + Thresholds: 1 OK / 0 FAILED + + + status value threshold fn metric case chart dashboard + +----------------------------------------------------------------------------------------------------------------------------------------- + OK 0 value <= 5 percent Responses: protocol code (5xx) overall all tests: less than 5% 5xx codes test-dashboard +``` \ No newline at end of file diff --git a/en/load-testing/operations/create-test-bucket.md b/en/load-testing/operations/create-test-bucket.md index a424a3555fb..53b45610018 100644 --- a/en/load-testing/operations/create-test-bucket.md +++ b/en/load-testing/operations/create-test-bucket.md @@ -15,21 +15,21 @@ You can upload payloads from a [{{ objstorage-full-name }}](../../storage/) [buc 1. [Create](create-agent.md) a test agent. 1. [Create](../../storage/operations/buckets/create.md) a bucket and [upload](../../storage/operations/objects/upload.md) the test data file into it. 1. Grant the service account linked to the [agent](../concepts/agent.md) read permission in the bucket. To do this, edit the bucket's [ACL](../../storage/concepts/acl.md): - 1. In the [management console]({{ link-console-main }}), select the folder where the bucket is located. - 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_storage }}**. - 1. Click ![image](../../_assets/horizontal-ellipsis.svg) next to the bucket and select **{{ ui-key.yacloud.storage.buckets.button_permissions }}**. - 1. In the window that opens, enter the service account name, select the `READ` permissions to the bucket, and click **{{ ui-key.yacloud.common.add }}**. - 1. Click **{{ ui-key.yacloud.common.save }}**. + 1. In the [management console]({{ link-console-main }}), select the folder the bucket is in. + 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_storage }}**. + 1. Click ![image](../../_assets/horizontal-ellipsis.svg) next to the bucket and select **{{ ui-key.yacloud.storage.buckets.button_permissions }}**. + 1. In the window that opens, enter the service account name, select the `READ` permissions to the bucket, and click **{{ ui-key.yacloud.common.add }}**. + 1. Click **{{ ui-key.yacloud.common.save }}**. - This grants the service account permission to read data from this bucket only. + This grants the service account permission to read data from this bucket only. - {% note info %} + {% note info %} - As an alternative to editing the bucket ACL, you can [assign](../../iam/operations/roles/grant.md) the service account the `storage.editor` [role](../../storage/security/index.md#storage-editor). + As an alternative to editing the bucket ACL, you can [assign](../../iam/operations/roles/grant.md) the `storage.editor` [role](../../storage/security/index.md#storage-editor) to the service account. - This method is less secure, since it allows the service account to perform any operations with all buckets in the [folder](../../resource-manager/concepts/resources-hierarchy.md#folder): creating, deleting, and updating a bucket, or granting public access to them. + This method is less secure, since it allows the service account to perform any operations with all buckets in the [folder](../../resource-manager/concepts/resources-hierarchy.md#folder): creating, deleting, and updating a bucket, or granting public access to them. - {% endnote %} + {% endnote %} ## Creating a test {#create-test} @@ -37,16 +37,16 @@ You can upload payloads from a [{{ objstorage-full-name }}](../../storage/) [buc 1. In the [management console]({{ link-console-main }}), select the folder for testing. 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_load-testing }}**. 1. In the ![image](../../_assets/load-testing/test.svg) **{{ ui-key.yacloud.load-testing.label_tests-list }}** tab, click **{{ ui-key.yacloud.load-testing.button_create-test }}**. -1. Select a test agent or create a new one. +1. [Select](../concepts/agent-select.md) a test agent or create a new one. 1. (Optional) Select or create a [log group](../../logging/concepts/log-group.md). 1. Under **Attached files**: - 1. Click **{{ ui-key.yacloud.load-testing.label_choose-from-bucket }}**. - 1. Find the bucket in the drop-down list and specify the path to the payload file. + 1. Click **{{ ui-key.yacloud.load-testing.label_choose-from-bucket }}**. + 1. Find the bucket in the drop-down list and specify the path to the payload file. - Alternatively, you can **Select files** from your computer. In this case, you will have to reupload the files every time you run the test. + Alternatively, you can **Select files** from your computer. In this case, you will have to reupload the files every time you run the test. 1. Depending on the selected configuration type, set the parameters under **{{ ui-key.yacloud.load-testing.label_test-settings }}**: - {% include [test settings](../../_includes/load-testing/test-settings.md) %} + {% include [test settings](../../_includes/load-testing/test-settings.md) %} 1. Click **{{ ui-key.yacloud.common.create }}**. \ No newline at end of file diff --git a/en/load-testing/operations/export-test-reports.md b/en/load-testing/operations/export-test-reports.md new file mode 100644 index 00000000000..7aac9e201dc --- /dev/null +++ b/en/load-testing/operations/export-test-reports.md @@ -0,0 +1,32 @@ +--- +title: How to export a test report in {{ objstorage-full-name }} +description: Follow this guide to export your reports into static formats. +--- + +# Exporting a test report + +In {{ load-testing-name }}, you can export test results to a [{{ objstorage-full-name }}](../../storage/) bucket as static format files (HTML, PDF, or CSV). Once generated, you can download a report from the bucket either via a link or directly. + +## Exporting a report to {{ objstorage-full-name }} {#export-report} + +1. In the [management console]({{ link-console-main }}), select the folder. +1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_load-testing }}**. +1. In the ![image](../../_assets/load-testing/test.svg) **{{ ui-key.yacloud.load-testing.label_tests-list }}** tab, select the test you need. +1. On the test page, click ![image](../../_assets/console-icons/ellipsis.svg) in the top-right corner and select **{{ ui-key.yacloud.load-testing.button_export-report }}**. +1. In the **{{ ui-key.yacloud.load-testing.label_report-export-title }}** dialog: + - Under **{{ ui-key.yacloud.load-testing.field_report-export-bucket }}**, select the bucket you need or create a new one. + - In the **{{ ui-key.yacloud.load-testing.field_report-export-folder }}** field, enter the name of the folder you want to save your report to. If there is no folder with this name in the bucket, it will be created. + - Under **{{ ui-key.yacloud.load-testing.field_report-export-format }}**, select the target format. + - Configure the time interval format as needed in the **{{ ui-key.yacloud.load-testing.field_report-export-time-interval }}** field (whole or current). The current interval will only become available after you move the interval boundaries on the timeline in the **{{ ui-key.yacloud.load-testing.label_test-report }}** tab. +1. Click **{{ ui-key.yacloud.load-testing.button_export-report }}**. + +## Downloading a report from {{ objstorage-full-name }} {#download-report} + +1. In the [management console]({{ link-console-main }}), select the folder. +1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_load-testing }}**. +1. In the ![image](../../_assets/load-testing/test.svg) **{{ ui-key.yacloud.load-testing.label_tests-list }}** tab, select the test you need. +1. In the **{{ ui-key.yacloud.load-testing.label_report-exports-history-title }}** tab, make sure the export operation you need has the **{{ ui-key.yacloud.common.operations.column_value_done }}** status. +1. Use the link in the **File path** column to go to the export operation page. +1. In the top-right corner, click **{{ ui-key.yacloud.storage.file.button_generate }}** to get a link to the report. +1. To download the report, click **{{ ui-key.yacloud.storage.file.button_download }}**. +1. You can configure access permissions for your reports if you need to. In the top-right corner, click ![image](../../_assets/console-icons/ellipsis.svg) to select a user group and set access level for it. diff --git a/en/load-testing/operations/index.md b/en/load-testing/operations/index.md index e6ad34bd532..def0d9026f6 100644 --- a/en/load-testing/operations/index.md +++ b/en/load-testing/operations/index.md @@ -1,5 +1,5 @@ --- -title: How to work with {{ load-testing-full-name }} +title: Guides on using {{ load-testing-full-name }} description: In this article, you will learn how to work with {{ load-testing-full-name }} in {{ yandex-cloud }}. --- @@ -9,5 +9,9 @@ description: In this article, you will learn how to work with {{ load-testing-fu * [{#T}](security-groups-agent.md) * [{#T}](security-groups-target.md) * [{#T}](create-test-bucket.md) +* [{#T}](export-test-reports.md) +* [{#T}](payload-dispatcher.md) * [{#T}](logging.md) -* [{#T}](save-artifacts.md) \ No newline at end of file +* [{#T}](regressions.md) +* [{#T}](save-artifacts.md) +* [{#T}](operation-logs.md) \ No newline at end of file diff --git a/en/load-testing/operations/regressions.md b/en/load-testing/operations/regressions.md index 1a805cfbf19..f3368305e27 100644 --- a/en/load-testing/operations/regressions.md +++ b/en/load-testing/operations/regressions.md @@ -94,7 +94,7 @@ Add a second regression chart: If you want other users to easily read your dashboard, add a common header for the charts and explanatory text: -1. In the panel at the bottom of the page, click ![image](../../_assets/load-testing/header.svg) **Title**. +1. In the panel at the bottom of the page, click ![image](../../_assets/load-testing/header.svg) **Text**. 1. Specify a header and select its size. 1. Click **Add**. 1. Drag the header to the position above the charts. If required, change the height and width of the header field. @@ -119,6 +119,3 @@ In edit mode, you can: To add a new dashboard, click **Create dashboard** on the ![image](../../_assets/load-testing/regressions.svg) **{{ ui-key.yacloud.load-testing.label_regressions-title }}** page in the top-right corner of the page. To delete a dashboard, click ![image](../../_assets/options.svg) on the ![image](../../_assets/load-testing/regressions.svg) **{{ ui-key.yacloud.load-testing.label_regressions-title }}** page in the dashboard list next to the required dashboard and select **{{ ui-key.yc-ui-datasphere.common.delete }}**. - - - diff --git a/en/load-testing/toc.yaml b/en/load-testing/toc.yaml index f6123910048..9fb5374b6ea 100644 --- a/en/load-testing/toc.yaml +++ b/en/load-testing/toc.yaml @@ -15,12 +15,16 @@ items: href: operations/security-groups-target.md - name: Creating a test with data from a bucket href: operations/create-test-bucket.md + - name: Exporting a test report + href: operations/export-test-reports.md - name: Collecting user requests using Dispatcher href: operations/payload-dispatcher.md - name: Transferring test logs to {{ cloud-logging-name }} href: operations/logging.md - name: Creating and configuring a regression dashboard href: operations/regressions.md + - name: Checking regression metrics for exceeded thresholds + href: operations/check-regression.md - name: Saving test artifacts to {{ objstorage-name }} href: operations/save-artifacts.md - name: Viewing operations with the service's resources @@ -45,16 +49,18 @@ items: href: tutorials/loadtesting-overload-migration.md - name: Running external agents for load testing href: tutorials/loadtesting-external-agent.md - - name: Invoking load testing from {{ GL }}} CI + - name: Invoking load testing from {{ GL }} CI href: tutorials/loadtesting-gitlab-ci.md - name: Comparing load test results href: tutorials/loadtesting-results-compare.md - name: Concepts items: - - name: Overview + - name: Service overview href: concepts/index.md - name: Agent href: concepts/agent.md + - name: Agent selection + href: concepts/agent-select.md - name: Load generator href: concepts/load-generator.md - name: Load profile diff --git a/en/load-testing/user/api-ref/Agent/create.md b/en/load-testing/user/api-ref/Agent/create.md index 1d6faabb2a1..30bc0eeeb23 100644 --- a/en/load-testing/user/api-ref/Agent/create.md +++ b/en/load-testing/user/api-ref/Agent/create.md @@ -42,15 +42,16 @@ POST https://loadtesting.{{ api-host }}/loadtesting/api/v1/agent "description": "string", "typeId": "string", "size": "string", - "blockSize": "string", + // Includes only one of the fields `imageId`, `snapshotId` + "imageId": "string", + "snapshotId": "string", + // end of the list of possible fields "diskPlacementPolicy": { "placementGroupId": "string", "placementGroupPartition": "string" }, - // Includes only one of the fields `imageId`, `snapshotId` - "imageId": "string", - "snapshotId": "string" - // end of the list of possible fields + "blockSize": "string", + "kmsKeyId": "string" }, "diskId": "string" // end of the list of possible fields @@ -267,12 +268,6 @@ To get a list of available disk types, use the [yandex.cloud.compute.v1.DiskType || size | **string** (int64) Required field. Size of the disk, specified in bytes. || -|| blockSize | **string** (int64) - -Block size of the disk, specified in bytes. The default is 4096. || -|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** - -Placement policy configuration. || || imageId | **string** ID of the image to create the disk from. @@ -283,6 +278,15 @@ Includes only one of the fields `imageId`, `snapshotId`. || ID of the snapshot to restore the disk from. Includes only one of the fields `imageId`, `snapshotId`. || +|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** + +Placement policy configuration. || +|| blockSize | **string** (int64) + +Block size of the disk, specified in bytes. The default is 4096. || +|| kmsKeyId | **string** + +ID of KMS key for disk encryption || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} diff --git a/en/load-testing/user/api-ref/Agent/update.md b/en/load-testing/user/api-ref/Agent/update.md index 59c2e54b3eb..3ccfb4e29c6 100644 --- a/en/load-testing/user/api-ref/Agent/update.md +++ b/en/load-testing/user/api-ref/Agent/update.md @@ -49,15 +49,16 @@ Required field. ID of the agent to update. || "description": "string", "typeId": "string", "size": "string", - "blockSize": "string", + // Includes only one of the fields `imageId`, `snapshotId` + "imageId": "string", + "snapshotId": "string", + // end of the list of possible fields "diskPlacementPolicy": { "placementGroupId": "string", "placementGroupPartition": "string" }, - // Includes only one of the fields `imageId`, `snapshotId` - "imageId": "string", - "snapshotId": "string" - // end of the list of possible fields + "blockSize": "string", + "kmsKeyId": "string" }, "diskId": "string" // end of the list of possible fields @@ -265,12 +266,6 @@ To get a list of available disk types, use the [yandex.cloud.compute.v1.DiskType || size | **string** (int64) Required field. Size of the disk, specified in bytes. || -|| blockSize | **string** (int64) - -Block size of the disk, specified in bytes. The default is 4096. || -|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** - -Placement policy configuration. || || imageId | **string** ID of the image to create the disk from. @@ -281,6 +276,15 @@ Includes only one of the fields `imageId`, `snapshotId`. || ID of the snapshot to restore the disk from. Includes only one of the fields `imageId`, `snapshotId`. || +|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** + +Placement policy configuration. || +|| blockSize | **string** (int64) + +Block size of the disk, specified in bytes. The default is 4096. || +|| kmsKeyId | **string** + +ID of KMS key for disk encryption || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} diff --git a/en/load-testing/user/api-ref/grpc/Agent/create.md b/en/load-testing/user/api-ref/grpc/Agent/create.md index efeabb51928..6fc44940762 100644 --- a/en/load-testing/user/api-ref/grpc/Agent/create.md +++ b/en/load-testing/user/api-ref/grpc/Agent/create.md @@ -40,15 +40,16 @@ Also creates a corresponding compute instance. "description": "string", "typeId": "string", "size": "int64", - "blockSize": "int64", + // Includes only one of the fields `imageId`, `snapshotId` + "imageId": "string", + "snapshotId": "string", + // end of the list of possible fields "diskPlacementPolicy": { "placementGroupId": "string", "placementGroupPartition": "int64" }, - // Includes only one of the fields `imageId`, `snapshotId` - "imageId": "string", - "snapshotId": "string" - // end of the list of possible fields + "blockSize": "int64", + "kmsKeyId": "string" }, "diskId": "string" // end of the list of possible fields @@ -265,12 +266,6 @@ To get a list of available disk types, use the [yandex.cloud.compute.v1.DiskType || size | **int64** Required field. Size of the disk, specified in bytes. || -|| blockSize | **int64** - -Block size of the disk, specified in bytes. The default is 4096. || -|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** - -Placement policy configuration. || || imageId | **string** ID of the image to create the disk from. @@ -281,6 +276,15 @@ Includes only one of the fields `imageId`, `snapshotId`. || ID of the snapshot to restore the disk from. Includes only one of the fields `imageId`, `snapshotId`. || +|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** + +Placement policy configuration. || +|| blockSize | **int64** + +Block size of the disk, specified in bytes. The default is 4096. || +|| kmsKeyId | **string** + +ID of KMS key for disk encryption || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} diff --git a/en/load-testing/user/api-ref/grpc/Agent/update.md b/en/load-testing/user/api-ref/grpc/Agent/update.md index 1a04e6256e2..12ccbf1b578 100644 --- a/en/load-testing/user/api-ref/grpc/Agent/update.md +++ b/en/load-testing/user/api-ref/grpc/Agent/update.md @@ -39,15 +39,16 @@ Updates the specified agent. "description": "string", "typeId": "string", "size": "int64", - "blockSize": "int64", + // Includes only one of the fields `imageId`, `snapshotId` + "imageId": "string", + "snapshotId": "string", + // end of the list of possible fields "diskPlacementPolicy": { "placementGroupId": "string", "placementGroupPartition": "int64" }, - // Includes only one of the fields `imageId`, `snapshotId` - "imageId": "string", - "snapshotId": "string" - // end of the list of possible fields + "blockSize": "int64", + "kmsKeyId": "string" }, "diskId": "string" // end of the list of possible fields @@ -251,12 +252,6 @@ To get a list of available disk types, use the [yandex.cloud.compute.v1.DiskType || size | **int64** Required field. Size of the disk, specified in bytes. || -|| blockSize | **int64** - -Block size of the disk, specified in bytes. The default is 4096. || -|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** - -Placement policy configuration. || || imageId | **string** ID of the image to create the disk from. @@ -267,6 +262,15 @@ Includes only one of the fields `imageId`, `snapshotId`. || ID of the snapshot to restore the disk from. Includes only one of the fields `imageId`, `snapshotId`. || +|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** + +Placement policy configuration. || +|| blockSize | **int64** + +Block size of the disk, specified in bytes. The default is 4096. || +|| kmsKeyId | **string** + +ID of KMS key for disk encryption || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} diff --git a/en/lockbox/api-ref/Secret/list.md b/en/lockbox/api-ref/Secret/list.md index cff09ca417c..2328e60faaf 100644 --- a/en/lockbox/api-ref/Secret/list.md +++ b/en/lockbox/api-ref/Secret/list.md @@ -23,13 +23,13 @@ Required field. ID of the folder to list secrets in. || || pageSize | **string** (int64) The maximum number of results per page to return. If the number of available -results is larger than `page_size`, the service returns a [ListSecretsRequest.nextPageToken](#yandex.cloud.lockbox.v1.ListSecretsResponse) +results is larger than `page_size`, the service returns a [ListSecretsRequest.next_page_token] that can be used to get the next page of results in subsequent list requests. Default value: 100. || || pageToken | **string** Page token. To get the next page of results, set `page_token` to the -[ListSecretsRequest.nextPageToken](#yandex.cloud.lockbox.v1.ListSecretsResponse) returned by a previous list request. || +[ListSecretsRequest.next_page_token] returned by a previous list request. || |# ## Response {#yandex.cloud.lockbox.v1.ListSecretsResponse} diff --git a/en/lockbox/api-ref/Secret/listOperations.md b/en/lockbox/api-ref/Secret/listOperations.md index cea002bf6b9..69a538d99cf 100644 --- a/en/lockbox/api-ref/Secret/listOperations.md +++ b/en/lockbox/api-ref/Secret/listOperations.md @@ -29,13 +29,13 @@ Required field. ID of the secret to get operations for. || || pageSize | **string** (int64) The maximum number of results per page that should be returned. If the number of available -results is larger than `page_size`, the service returns a [ListSecretOperationsRequest.nextPageToken](/docs/lockbox/api-ref/Secret/list#yandex.cloud.lockbox.v1.ListSecretsResponse) +results is larger than `page_size`, the service returns a [ListSecretOperationsRequest.next_page_token] that can be used to get the next page of results in subsequent list requests. Default value: 100. || || pageToken | **string** Page token. To get the next page of results, set `page_token` to the -[ListSecretOperationsRequest.nextPageToken](/docs/lockbox/api-ref/Secret/list#yandex.cloud.lockbox.v1.ListSecretsResponse) returned by a previous list request. || +[ListSecretOperationsRequest.next_page_token] returned by a previous list request. || |# ## Response {#yandex.cloud.lockbox.v1.ListSecretOperationsResponse} @@ -77,8 +77,8 @@ List of operations for the specified secret. || || nextPageToken | **string** This token allows you to get the next page of results for list requests. If the number of results -is larger than [ListSecretOperationsResponse.pageSize](/docs/lockbox/api-ref/Secret/list#yandex.cloud.lockbox.v1.ListSecretsRequest), use the `next_page_token` as the value -for the [ListSecretOperationsResponse.pageToken](/docs/lockbox/api-ref/Secret/list#yandex.cloud.lockbox.v1.ListSecretsRequest) query parameter in the next list request. +is larger than [ListSecretOperationsResponse.page_size], use the `next_page_token` as the value +for the [ListSecretOperationsResponse.page_token] query parameter in the next list request. Each subsequent list request will have its own `next_page_token` to continue paging through the results. || |# diff --git a/en/lockbox/api-ref/Secret/listVersions.md b/en/lockbox/api-ref/Secret/listVersions.md index aef00417347..f0b2633622d 100644 --- a/en/lockbox/api-ref/Secret/listVersions.md +++ b/en/lockbox/api-ref/Secret/listVersions.md @@ -29,13 +29,13 @@ Required field. ID of the secret to list versions for. || || pageSize | **string** (int64) The maximum number of results per page to return. If the number of available -results is larger than `page_size`, the service returns a [ListVersionsRequest.nextPageToken](/docs/lockbox/api-ref/Secret/list#yandex.cloud.lockbox.v1.ListSecretsResponse) +results is larger than `page_size`, the service returns a [ListVersionsRequest.next_page_token] that can be used to get the next page of results in subsequent list requests. Default value: 100. || || pageToken | **string** Page token. To get the next page of results, set `page_token` to the -[ListVersionsRequest.nextPageToken](/docs/lockbox/api-ref/Secret/list#yandex.cloud.lockbox.v1.ListSecretsResponse) returned by a previous list request. || +[ListVersionsRequest.next_page_token] returned by a previous list request. || |# ## Response {#yandex.cloud.lockbox.v1.ListVersionsResponse} diff --git a/en/lockbox/api-ref/grpc/Secret/list.md b/en/lockbox/api-ref/grpc/Secret/list.md index dcc71e083f2..843815fe53d 100644 --- a/en/lockbox/api-ref/grpc/Secret/list.md +++ b/en/lockbox/api-ref/grpc/Secret/list.md @@ -29,13 +29,13 @@ Required field. ID of the folder to list secrets in. || || pageSize | **int64** The maximum number of results per page to return. If the number of available -results is larger than `page_size`, the service returns a [ListSecretsRequest.nextPageToken](#yandex.cloud.lockbox.v1.ListSecretsResponse) +results is larger than `page_size`, the service returns a [ListSecretsRequest.next_page_token] that can be used to get the next page of results in subsequent list requests. Default value: 100. || || pageToken | **string** Page token. To get the next page of results, set `page_token` to the -[ListSecretsRequest.nextPageToken](#yandex.cloud.lockbox.v1.ListSecretsResponse) returned by a previous list request. || +[ListSecretsRequest.next_page_token] returned by a previous list request. || |# ## ListSecretsResponse {#yandex.cloud.lockbox.v1.ListSecretsResponse} diff --git a/en/lockbox/api-ref/grpc/Secret/listOperations.md b/en/lockbox/api-ref/grpc/Secret/listOperations.md index ed28fd71867..d51caa51733 100644 --- a/en/lockbox/api-ref/grpc/Secret/listOperations.md +++ b/en/lockbox/api-ref/grpc/Secret/listOperations.md @@ -29,13 +29,13 @@ Required field. ID of the secret to get operations for. || || pageSize | **int64** The maximum number of results per page that should be returned. If the number of available -results is larger than `page_size`, the service returns a [ListSecretOperationsRequest.nextPageToken](/docs/lockbox/api-ref/grpc/Secret/list#yandex.cloud.lockbox.v1.ListSecretsResponse) +results is larger than `page_size`, the service returns a [ListSecretOperationsRequest.next_page_token] that can be used to get the next page of results in subsequent list requests. Default value: 100. || || pageToken | **string** Page token. To get the next page of results, set `page_token` to the -[ListSecretOperationsRequest.nextPageToken](/docs/lockbox/api-ref/grpc/Secret/list#yandex.cloud.lockbox.v1.ListSecretsResponse) returned by a previous list request. || +[ListSecretOperationsRequest.next_page_token] returned by a previous list request. || |# ## ListSecretOperationsResponse {#yandex.cloud.lockbox.v1.ListSecretOperationsResponse} @@ -69,8 +69,8 @@ List of operations for the specified secret. || || nextPageToken | **string** This token allows you to get the next page of results for list requests. If the number of results -is larger than [ListSecretOperationsResponse.pageSize](/docs/lockbox/api-ref/grpc/Secret/list#yandex.cloud.lockbox.v1.ListSecretsRequest), use the `next_page_token` as the value -for the [ListSecretOperationsResponse.pageToken](/docs/lockbox/api-ref/grpc/Secret/list#yandex.cloud.lockbox.v1.ListSecretsRequest) query parameter in the next list request. +is larger than [ListSecretOperationsResponse.page_size], use the `next_page_token` as the value +for the [ListSecretOperationsResponse.page_token] query parameter in the next list request. Each subsequent list request will have its own `next_page_token` to continue paging through the results. || |# diff --git a/en/lockbox/api-ref/grpc/Secret/listVersions.md b/en/lockbox/api-ref/grpc/Secret/listVersions.md index 97193592c75..39b1a4b6873 100644 --- a/en/lockbox/api-ref/grpc/Secret/listVersions.md +++ b/en/lockbox/api-ref/grpc/Secret/listVersions.md @@ -29,13 +29,13 @@ Required field. ID of the secret to list versions for. || || pageSize | **int64** The maximum number of results per page to return. If the number of available -results is larger than `page_size`, the service returns a [ListVersionsRequest.nextPageToken](/docs/lockbox/api-ref/grpc/Secret/list#yandex.cloud.lockbox.v1.ListSecretsResponse) +results is larger than `page_size`, the service returns a [ListVersionsRequest.next_page_token] that can be used to get the next page of results in subsequent list requests. Default value: 100. || || pageToken | **string** Page token. To get the next page of results, set `page_token` to the -[ListVersionsRequest.nextPageToken](/docs/lockbox/api-ref/grpc/Secret/list#yandex.cloud.lockbox.v1.ListSecretsResponse) returned by a previous list request. || +[ListVersionsRequest.next_page_token] returned by a previous list request. || |# ## ListVersionsResponse {#yandex.cloud.lockbox.v1.ListVersionsResponse} diff --git a/en/lockbox/release-notes.md b/en/lockbox/release-notes.md new file mode 100644 index 00000000000..b8d62569a61 --- /dev/null +++ b/en/lockbox/release-notes.md @@ -0,0 +1,13 @@ +--- +title: '{{ lockbox-full-name }} release notes' +description: This section contains {{ lockbox-name }} release notes. +--- + +# {{ lockbox-full-name }} release notes + +## Q3 2024 {#q3-2024} + +* Added the ability to generate secrets automatically. For [generated secrets](concepts/secret.md#secret-type) you can customize the length and specify the character composition. +* Added a new `yandex_lockbox_secret_version_hashed` resource, which allows storing a secret value in the {{ TF }} state in encrypted form. This resource is used when [creating a new version of the secret](operations/secret-version-manage.md#create-version) and is recommended instead of `yandex_lockbox_secret_version`. We also continue supporting `yandex_lockbox_secret_version`. +* It is now possible to schedule [secret version deletion](operations/secret-version-manage.md#set-deleting-time) via {{ TF }} for the `yandex_lockbox_secret_version_hashed` and `yandex_lockbox_secret_version` resources. +* Added the ability to store keys for {{ iam-short-name }} service accounts in the {{ TF }} state in a secure form. To do this, place them in {{ lockbox-name }} using the `output_to_lockbox` parameter. You can specify this parameter for the `yandex_iam_service_account_key`, `yandex_iam_service_account_api_key`, and `yandex_iam_service_account_static_access_key` resources. \ No newline at end of file diff --git a/en/lockbox/toc.yaml b/en/lockbox/toc.yaml index a11b64737a9..529ff982dfb 100644 --- a/en/lockbox/toc.yaml +++ b/en/lockbox/toc.yaml @@ -180,6 +180,8 @@ items: href: metrics.md - name: '{{ at-name }} events' href: at-ref.md + - name: Release notes + href: release-notes.md - name: FAQ href: qa/index.md base: en/lockbox diff --git a/en/logging/api-ref/grpc/LogReading/read.md b/en/logging/api-ref/grpc/LogReading/read.md index 1bb6d142600..4579260145c 100644 --- a/en/logging/api-ref/grpc/LogReading/read.md +++ b/en/logging/api-ref/grpc/LogReading/read.md @@ -206,7 +206,7 @@ Also may be provided by the user. || Timestamp of the entry. || || ingestedAt | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp)** -Entry ingestion time observed by [LogIngestionService]. || +Entry ingestion time observed by [LogIngestionService](/docs/logging/api-ref/grpc/LogIngestion/). || || savedAt | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp)** Entry save time. diff --git a/en/managed-airflow/operations/cluster-create.md b/en/managed-airflow/operations/cluster-create.md index f88a60de58a..68775c056d5 100644 --- a/en/managed-airflow/operations/cluster-create.md +++ b/en/managed-airflow/operations/cluster-create.md @@ -12,13 +12,9 @@ keywords: Every {{ maf-name }} cluster consists of a set of {{ AF }} components, each of which can be represented in multiple instances. The instances may reside in different availability zones. -## Before creating a cluster {#before-creating} +## Creating a cluster {#create-cluster} -1. In the folder where you want to create a cluster, [create a service account](../../iam/operations/sa/create.md) with the `managed-airflow.integrationProvider` role. -1. [Create a {{ objstorage-full-name }} bucket](../../storage/operations/buckets/create.md) to store [DAG files](../concepts/index.md#about-the-service). -1. [Make sure](../../iam/operations/roles/get-assigned-roles.md) your account has the [{{ roles-vpc-user }}](../../vpc/security/index.md#vpc-user) role and the [{{ roles.maf.editor }} role or higher](../security/index.md#roles-list) for creating a cluster. - -## Create a cluster {#create-cluster} +To create a {{ maf-name }} cluster, you need the [{{ roles-vpc-user }}](../../vpc/security/index.md#vpc-user) role and the [{{ roles.maf.editor }} role or higher](../security/index.md#roles-list). For more information on assigning roles, see the [{{ iam-name }} documentation](../../iam/operations/roles/grant.md). {% list tabs group=instructions %} @@ -51,7 +47,9 @@ Every {{ maf-name }} cluster consists of a set of {{ AF }} components, each of w {% endnote %} - * Select the [previously created](#before-creating) service account with the `managed-airflow.integrationProvider` role. + * Select an existing service account or create a new one. + + Make sure to assign the `managed-airflow.integrationProvider` [role](../../iam/concepts/access-control/roles.md) to the service account: 1. Under **{{ ui-key.yacloud.mdb.forms.section_network-settings }}**, select: @@ -99,17 +97,19 @@ Every {{ maf-name }} cluster consists of a set of {{ AF }} components, each of w {% endnote %} - 1. Under **{{ ui-key.yacloud.airflow.section_storage }}**, specify a name for the previously created bucket that will store DAG files. + 1. Under **{{ ui-key.yacloud.airflow.section_storage }}**, select a bucket or create a new one. This bucket will store DAG files. + + Make sure to [grant the `READ` permission](../../storage/operations/buckets/edit-acl.md) for this bucket to the cluster service account. 1. (Optional) Under **{{ ui-key.yacloud.mdb.forms.section_additional }}**, enable cluster deletion protection. - 1. (Optional) Under **{{ ui-key.yacloud.airflow.section_airflow-configuration }}**: + 1. Optionally, under **{{ ui-key.yacloud.airflow.section_airflow-configuration }}**: * Specify [{{ AF }} additional properties](https://airflow.apache.org/docs/apache-airflow/2.2.4/configurations-ref.html) additional properties, e.g., `api.maximum_page_limit` as a key and `150` as its value. - Fill out the fields manually or import the settings from a configuration file (see [configuration file example](https://{{ s3-storage-host }}/doc-files/managed-airflow/airflow.cfg)). + Fill in the fields manually or import the settings from a configuration file (see [configuration file example](https://{{ s3-storage-host }}/doc-files/managed-airflow/airflow.cfg)). - * Enable the **{{ ui-key.yacloud.airflow.field_lockbox }}** option to use secrets in [{{ lockbox-full-name }}](../../lockbox/concepts/index.md) for [storing {{ AF }} configuration data, variables, and connection parameters](../concepts/impersonation.md#lockbox-integration). + * Enable the **{{ ui-key.yacloud.airflow.field_lockbox }}** option to use secrets in [{{ lockbox-full-name }}](../../lockbox/concepts/index.md) to [store {{ AF }} configuration data, variables, and connection parameters](../concepts/impersonation.md#lockbox-integration). {% include [sa-roles-for-lockbox](../../_includes/managed-airflow/sa-roles-for-lockbox.md) %} diff --git a/en/managed-airflow/operations/cluster-update.md b/en/managed-airflow/operations/cluster-update.md index fe301234c34..97a1cc5c959 100644 --- a/en/managed-airflow/operations/cluster-update.md +++ b/en/managed-airflow/operations/cluster-update.md @@ -33,6 +33,8 @@ After creating a cluster, you can change its basic and advanced settings. 1. Under **{{ ui-key.yacloud.airflow.section_dependencies }}**, delete or add names of pip and deb packages. + 1. Under **{{ ui-key.yacloud.airflow.section_storage }}**, select an existing bucket to store DAG files or create a new one. Make sure to [grant the `READ` permission](../../storage/operations/buckets/edit-acl.md) for this bucket to the cluster service account. + 1. Under **{{ ui-key.yacloud.mdb.forms.section_additional }}**, enable or disable deletion protection. 1. Under **{{ ui-key.yacloud.airflow.section_airflow-configuration }}**: diff --git a/en/managed-airflow/operations/index.md b/en/managed-airflow/operations/index.md index 0b84e6f5256..b6ffe2e71d9 100644 --- a/en/managed-airflow/operations/index.md +++ b/en/managed-airflow/operations/index.md @@ -10,3 +10,4 @@ description: In this article, you will learn how to work with {{ maf-full-name } * [{#T}](af-interfaces.md) * [Uploading DAG files to a cluster](upload-dags.md) * [Deleting a cluster](cluster-delete.md) +* [Viewing operations with clusters](operation-logs.md) \ No newline at end of file diff --git a/en/managed-airflow/operations/operation-logs.md b/en/managed-airflow/operations/operation-logs.md new file mode 100644 index 00000000000..f7fafe6cbb7 --- /dev/null +++ b/en/managed-airflow/operations/operation-logs.md @@ -0,0 +1,43 @@ +# Viewing operations with clusters + +All actions with {{ maf-name }} clusters are logged as a list of operations. Each operation is assigned a unique ID. + +## Getting a list of operations {#get-operations} + +{% list tabs group=instructions %} + +- Management console {#console} + + To get a list of operations for a {{ maf-name }} cluster: + + 1. In the [management console]({{ link-console-main }}), open the folder with the cluster. + 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-airflow }}**. + 1. In the left-hand panel, select ![image](../../_assets/console-icons/cubes-3.svg) **{{ ui-key.yacloud.mdb.clusters.label_title }}**. + 1. Select the cluster you need. + 1. Go to the ![image](../../_assets/console-icons/list-check.svg) **{{ ui-key.yacloud.common.operations-key-value }}** panel for the selected cluster. + + You will see a list of operations with the selected cluster. + +- API {#api} + + Use the [listOperations](../api-ref/Cluster/listOperations.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/ListOperations](../api-ref/grpc/Cluster/listOperations.md) gRPC API call and provide the cluster ID in the request. + +{% endlist %} + +## Getting detailed information about an operation {#get-operations-info} + +1. [Get a list of operations](#get-operations) for a cluster. +1. Copy the ID of the operation. +1. Get detailed information about the operation: + + {% list tabs group=instructions %} + + - API {#api} + + Use the [OperationService/Get](../api-ref/grpc/Operation/get.md) gRPC API call and provide the operation ID in the request. + + {% endlist %} + +## See also {#see-also} + +* [{#T}](../../api-design-guide/concepts/about-async.md) \ No newline at end of file diff --git a/en/managed-airflow/operations/upload-dags.md b/en/managed-airflow/operations/upload-dags.md index 21f298fb47a..8793462eb1e 100644 --- a/en/managed-airflow/operations/upload-dags.md +++ b/en/managed-airflow/operations/upload-dags.md @@ -6,16 +6,15 @@ DAG files are uploaded to the [{{ objstorage-full-name }} bucket](../../storage/ To upload DAG files into a cluster: -1. [Grant](../../storage/operations/buckets/edit-acl.md) to the service account a `READ` permission for the bucket. Use the service account and bucket you specified when creating the cluster. 1. Create a folder, e.g., `dags`, in the bucket and [upload a DAG file to it](../../storage/operations/objects/upload.md#simple). This will upload DAG into the cluster. - You can upload your DAG file to the bucket root, but it uploads quicker to a folder. + You can upload your DAG file to the bucket root, but it uploads quicker to a folder. - If uploading additional scripts or modules used in DAG to this folder, specify the full path to these scripts or modules in the bucket. For example, you have uploaded all the files to the `dags` folder. If so, specify the following in the `from ... import` section of the DAG file: + If uploading additional scripts or modules used in DAG to this folder, specify the full path to these scripts or modules in the bucket. For example, you have uploaded all the files to the `dags` folder. If so, specify the following in `from ... import` of the DAG file: - ```python - from dags. import - ``` + ```python + from dags. import + ``` 1. [Open the {{ AF }} web interface](af-interfaces.md#web-gui). 1. Make sure that the new DAG file has appeared in the **DAGs** section. It may take a few minutes to upload a DAG file from the bucket. diff --git a/en/managed-airflow/quickstart.md b/en/managed-airflow/quickstart.md index eecab2c4eff..d0560930926 100644 --- a/en/managed-airflow/quickstart.md +++ b/en/managed-airflow/quickstart.md @@ -24,7 +24,8 @@ To get started with the service: 1. [Make sure](../iam/operations/roles/get-assigned-roles.md) your account has the [{{ roles-vpc-user }}](../vpc/security/index.md#vpc-user) role and the [{{ roles.maf.editor }} role or higher](security/index.md#roles-list) for creating a cluster. 1. [Create a {{ objstorage-full-name }}](../storage/operations/buckets/create.md) bucket for storing {{ maf-name }} [DAG files](concepts/index.md#about-the-service). 1. [Create a service account](../iam/operations/sa/create.md). -1. [Assign the service account](../iam/operations/sa/assign-role-for-sa.md) the `storage.viewer` role for a folder or bucket. +1. [Assign the service account](../iam/operations/sa/assign-role-for-sa.md) the `managed-airflow.integrationProvider` role for a folder or bucket. +1. [Grant the `READ` permission](../storage/operations/buckets/edit-acl.md) for the bucket to the service account. ## Create a cluster {#cluster-create} diff --git a/en/managed-airflow/toc.yaml b/en/managed-airflow/toc.yaml index 2e0195dac0b..ec0bd91355c 100644 --- a/en/managed-airflow/toc.yaml +++ b/en/managed-airflow/toc.yaml @@ -17,6 +17,8 @@ items: href: operations/upload-dags.md - name: Deleting a cluster href: operations/cluster-delete.md + - name: Viewing operations with clusters + href: operations/operation-logs.md - name: Tutorials items: - name: All tutorials diff --git a/en/managed-clickhouse/operations/cluster-backups.md b/en/managed-clickhouse/operations/cluster-backups.md index de914a0e7f6..887f0e90aaf 100644 --- a/en/managed-clickhouse/operations/cluster-backups.md +++ b/en/managed-clickhouse/operations/cluster-backups.md @@ -22,27 +22,27 @@ Backups are created based on a random replica host. If there is no cluster host - Management console {#console} - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. - 1. Click the cluster name and open the **{{ ui-key.yacloud.clickhouse.cluster.switch_backups }}** tab. - 1. Click **{{ ui-key.yacloud.mdb.cluster.backups.button_create }}**. + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. + 1. Click the cluster name and open the **{{ ui-key.yacloud.clickhouse.cluster.switch_backups }}** tab. + 1. Click **{{ ui-key.yacloud.mdb.cluster.backups.button_create }}**. - {% include [no-prompt](../../_includes/mdb/backups/no-prompt.md) %} + {% include [no-prompt](../../_includes/mdb/backups/no-prompt.md) %} - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To create a cluster backup: + To create a cluster backup: - 1. View a description of the CLI create {{ CH }} backup command: + 1. View a description of the CLI create {{ CH }} backup command: ```bash {{ yc-mdb-ch }} cluster backup --help ``` - 1. Request the creation of a backup specifying the cluster name or ID: + 1. Request the creation of a backup specifying the cluster name or ID: ```bash {{ yc-mdb-ch }} cluster backup @@ -52,9 +52,9 @@ Backups are created based on a random replica host. If there is no cluster host - API {#api} - To create a backup, use the [backup](../api-ref/Cluster/backup.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Backup](../api-ref/grpc/Cluster/backup.md) gRPC API call and provide the cluster ID in the `clusterId` request parameter. + To create a backup, use the [backup](../api-ref/Cluster/backup.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Backup](../api-ref/grpc/Cluster/backup.md) gRPC API call and provide the cluster ID in the `clusterId` request parameter. - You can get the cluster ID with a [list of clusters in the folder](cluster-list.md#list-clusters). + You can get the cluster ID with a [list of clusters in the folder](cluster-list.md#list-clusters). {% endlist %} @@ -62,7 +62,7 @@ Backups are created based on a random replica host. If there is no cluster host ## Restoring clusters from backups {#restore} -When you restore a cluster from a backup, you create a new cluster with the backup data. If the cloud has insufficient [resources](../concepts/limits.md) to create such a cluster, you will not be able to restore from the backup. The average backup recovery speed is 10 MBps per database core. +When you restore a cluster from a backup, you create a new cluster with the backup data. If the cloud does not have sufficient [resources](../concepts/limits.md) to create such a cluster, you will not be able to restore your data from a backup. The average backup recovery speed is 10 MBps per database core. You can restore an individual [shard](../concepts/sharding.md) or the whole cluster. You can restore the whole cluster only by using the CLI or API. @@ -72,38 +72,38 @@ You can restore an individual [shard](../concepts/sharding.md) or the whole clus - Management console {#console} - To restore an existing cluster from a backup: - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. - 1. Click the cluster name and open the **{{ ui-key.yacloud.clickhouse.cluster.switch_backups }}** tab. - 1. Click ![image](../../_assets/console-icons/ellipsis.svg) for the backup you need and click **{{ ui-key.yacloud.mdb.cluster.backups.button_restore }}**. - 1. Change the settings of the new cluster if required. You can select a folder for the new cluster from the **{{ ui-key.yacloud.mdb.forms.base_field_folder }}** list. - 1. Click **{{ ui-key.yacloud.mdb.forms.button_restore }}**. + To restore an existing cluster from a backup: + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. + 1. Click the cluster name and open the **{{ ui-key.yacloud.clickhouse.cluster.switch_backups }}** tab. + 1. Click ![image](../../_assets/console-icons/ellipsis.svg) for the backup you need and click **{{ ui-key.yacloud.mdb.cluster.backups.button_restore }}**. + 1. Change the settings of the new cluster if required. You can select a folder for the new cluster from the **{{ ui-key.yacloud.mdb.forms.base_field_folder }}** list. + 1. Click **{{ ui-key.yacloud.mdb.forms.button_restore }}**. - To restore a previously deleted cluster from a backup: - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. - 1. In the left-hand panel, select ![image](../../_assets/console-icons/archive.svg) **{{ ui-key.yacloud.clickhouse.switch_backups }}**. - 1. Find the backup you need using the backup creation time and cluster ID. The **{{ ui-key.yacloud.common.id }}** column contains IDs in `:` format. - 1. Click ![image](../../_assets/console-icons/ellipsis.svg) for the backup you need and click **{{ ui-key.yacloud.mdb.cluster.backups.button_restore }}**. - 1. Change the settings of the new cluster if required. You can select a folder for the new cluster from the **{{ ui-key.yacloud.mdb.forms.base_field_folder }}** list. - 1. Click **{{ ui-key.yacloud.mdb.forms.button_restore }}**. + To restore a previously deleted cluster from a backup: + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. + 1. In the left-hand panel, select ![image](../../_assets/console-icons/archive.svg) **{{ ui-key.yacloud.clickhouse.switch_backups }}**. + 1. Find the backup you need using the backup creation time and cluster ID. The **{{ ui-key.yacloud.common.id }}** column contains IDs formatted as `:`. + 1. Click ![image](../../_assets/console-icons/ellipsis.svg) for the backup you need and click **{{ ui-key.yacloud.mdb.cluster.backups.button_restore }}**. + 1. Change the settings of the new cluster if required. You can select a folder for the new cluster from the **{{ ui-key.yacloud.mdb.forms.base_field_folder }}** list. + 1. Click **{{ ui-key.yacloud.mdb.forms.button_restore }}**. - {{ mch-name }} will launch the operation to create a cluster from the backup. + {{ mch-name }} will launch the operation to create a cluster from the backup. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To restore a cluster from a backup: + To restore a cluster from a backup: - 1. View a description of the CLI restore {{ CH }} cluster command: + 1. View a description of the CLI restore {{ CH }} cluster command: ```bash {{ yc-mdb-ch }} cluster restore --help ``` - 1. Getting a list of available {{ CH }} cluster backups: + 1. Getting a list of available {{ CH }} cluster backups: ```bash {{ yc-mdb-ch }} backup list @@ -118,7 +118,7 @@ You can restore an individual [shard](../concepts/sharding.md) or the whole clus +--------------------------+---------------------+----------------------+---------------------+-------------+-------+-----------+ ``` - 1. To restore an individual shard, pass the ID of a single backup: + 1. To restore an individual shard, pass the ID of a single backup: ```bash @@ -130,7 +130,7 @@ You can restore an individual [shard](../concepts/sharding.md) or the whole clus --host type=,` `zone-id=,` `subnet-id= \ - --clickhouse-disk-size= \ + --clickhouse-disk-size= \ --clickhouse-disk-type= \ --clickhouse-resource-preset= ``` @@ -142,50 +142,50 @@ You can restore an individual [shard](../concepts/sharding.md) or the whole clus * `--name`: Cluster name. * `--environment`: Environment: - * `PRODUCTION`: For stable versions of your apps. - * `PRESTABLE`: For testing purposes. The prestable environment is similar to the production environment and likewise covered by the SLA, but it is the first to get new functionalities, improvements, and bug fixes. In the prestable environment, you can test compatibility of new versions with your application. + * `PRODUCTION`: For stable versions of your apps. + * `PRESTABLE`: For testing purposes. The prestable environment is similar to the production environment and likewise covered by the SLA, but it is the first to get new functionalities, improvements, and bug fixes. In the prestable environment, you can test compatibility of new versions with your application. * `--network-name`: [Network name](../../vpc/concepts/network.md#network). * `--host`: Host parameters: - * `type`: Host type: `clickhouse` or `zookeeper`. - * `zone-id`: [Availability zone](../../overview/concepts/geo-scope.md). - * `subnet-id`: [Subnet ID](../../vpc/concepts/network.md#subnet). Specify if two or more subnets are created in the selected availability zone. + * `type`: Host type: `clickhouse` or `zookeeper`. + * `zone-id`: [Availability zone](../../overview/concepts/geo-scope.md). + * `subnet-id`: [Subnet ID](../../vpc/concepts/network.md#subnet). Specify if two or more subnets are created in the selected availability zone. * `--resource-preset`: [Host class](../concepts/instance-types.md#available-flavors). * `--disk-size`: Storage size in GB. * `--disk-type`: [Disk type](../concepts/storage.md): - * `network-hdd` - * `network-ssd` + * `network-hdd` + * `network-ssd` - * `local-ssd` - * `network-ssd-nonreplicated` + * `local-ssd` + * `network-ssd-nonreplicated` - 1. To restore the entire cluster, provide backup IDs for all cluster shards: + 1. To restore the entire cluster, provide backup IDs for all cluster shards: ```bash {{ yc-mdb-ch }} cluster restore \ - --backup-id= \ + --backup-id= \ ... ``` - API {#api} - To restore a cluster from a backup, use the [restore](../api-ref/Cluster/restore.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Restore](../api-ref/grpc/Cluster/restore.md) gRPC API call and provide the following in the request: + To restore a cluster from a backup, use the [restore](../api-ref/Cluster/restore.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Restore](../api-ref/grpc/Cluster/restore.md) gRPC API call and provide the following in the request: - * Backup ID of the appropriate shard in the `backupId` parameter. To find out the ID, [retrieve a list of cluster backups](#list-backups). - * Name of the new cluster that will contain the data recovered from the backup, in the `name` parameter. It must be unique within the folder. - * Cluster environment in the `environment` parameter. - * Cluster configuration in the `configSpec` parameter. - * Configuration of the cluster hosts in one or more `hostSpecs` parameters. - * Network ID in the `networkId` parameter. + * Shard's backup ID in the `backupId` parameter. To find out the ID, [get a list of cluster backups](#list-backups). + * Name of the new cluster that will contain the data recovered from the backup, in the `name` parameter. It must be unique within the folder. + * Cluster environment in the `environment` parameter. + * Cluster configuration in the `configSpec` parameter. + * Configuration of the cluster hosts in one or more `hostSpecs` parameters. + * Network ID in the `networkId` parameter. - To restore the entire cluster, provide backup IDs for the remaining cluster shards in the `additionalBackupIds` parameter: + To restore the whole cluster, provide backup IDs for the remaining cluster shards in the `additionalBackupIds` parameter. {% endlist %} @@ -195,61 +195,61 @@ You can restore an individual [shard](../concepts/sharding.md) or the whole clus - Management console {#console} - To get a list of cluster backups: - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. - 1. Click the cluster name and open the **{{ ui-key.yacloud.clickhouse.cluster.switch_backups }}** tab. + To get a list of cluster backups: + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. + 1. Click the cluster name and open the **{{ ui-key.yacloud.clickhouse.cluster.switch_backups }}** tab. - To get a list of all backups in a folder: - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. - 1. In the left-hand panel, select ![image](../../_assets/console-icons/archive.svg) **{{ ui-key.yacloud.clickhouse.switch_backups }}**. + To get a list of all backups in a folder: + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. + 1. In the left-hand panel, select ![image](../../_assets/console-icons/archive.svg) **{{ ui-key.yacloud.clickhouse.switch_backups }}**. - These lists contain the following information: + These lists contain the following information: - * Backup name. - * Source shard. - * Backup size. - * Backup type: `Automated` or `Manual`. - * Start time of backup creation in UTC (Coordinated Universal Time). - * End time of backup creation in UTC. + * Backup name. + * Source shard. + * Backup size. + * Backup type: `Automated` or `Manual`. + * Start time of backup creation in UTC (Coordinated Universal Time). + * End time of backup creation in UTC. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To get a list of {{ CH }} cluster backups available in the default folder, run the command: + To get a list of {{ CH }} cluster backups available in the default folder, run the command: - ```bash - {{ yc-mdb-ch }} backup list - ``` + ```bash + {{ yc-mdb-ch }} backup list + ``` - ```text - +--------------------------+---------------------+----------------------+---------------------+-------------+-------+-----------+ - | ID | CREATED AT | SOURCE CLUSTER ID | STARTED AT | SHARD NAMES | SIZE | TYPE | - +--------------------------+---------------------+----------------------+---------------------+-------------+-------+-----------+ - | c9qud5etkq19********:... | 2023-12-08 00:09:17 | c9qud5etkq19******** | 2023-12-08 00:08:06 | shard1 | 30 KB | AUTOMATED | - | c9qud5etkq19********:... | 2023-12-07 08:17:04 | c9qud5etkq19******** | 2023-12-07 08:15:54 | shard1 | 30 KB | MANUAL | - +--------------------------+---------------------+----------------------+---------------------+-------------+-------+-----------+ - ``` + ```text + +--------------------------+---------------------+----------------------+---------------------+-------------+-------+-----------+ + | ID | CREATED AT | SOURCE CLUSTER ID | STARTED AT | SHARD NAMES | SIZE | TYPE | + +--------------------------+---------------------+----------------------+---------------------+-------------+-------+-----------+ + | c9qud5etkq19********:... | 2023-12-08 00:09:17 | c9qud5etkq19******** | 2023-12-08 00:08:06 | shard1 | 30 KB | AUTOMATED | + | c9qud5etkq19********:... | 2023-12-07 08:17:04 | c9qud5etkq19******** | 2023-12-07 08:15:54 | shard1 | 30 KB | MANUAL | + +--------------------------+---------------------+----------------------+---------------------+-------------+-------+-----------+ + ``` - The resulting table contains the following information: + The resulting table contains the following information: - * ID of the backup. - * End time of backup creation in UTC (Coordinated Universal Time). - * ID of the cluster that the backup was created for. - * Start time of backup creation in UTC. - * Source shard name. - * Backup size. - * Backup type: `Automated` or `Manual`. + * ID of the backup. + * End time of backup creation in UTC (Coordinated Universal Time). + * ID of the cluster that the backup was created for. + * Start time of backup creation in UTC. + * Source shard name. + * Backup size. + * Backup type: `AUTOMATED` or `MANUAL`. - API {#api} - To get a list of cluster backups, use the [listBackups](../api-ref/Cluster/listBackups.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/ListBackups](../api-ref/grpc/Cluster/listBackups.md) gRPC API call and provide the cluster ID in the `clusterId` request parameter. + To get a list of cluster backups, use the [listBackups](../api-ref/Cluster/listBackups.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/ListBackups](../api-ref/grpc/Cluster/listBackups.md) gRPC API call and provide the cluster ID in the `clusterId` request parameter. - To get a list of backups for all the {{ mch-name }} clusters in the folder, use the [list](../api-ref/Backup/list.md) REST API method for the [Backup](../api-ref/Backup/index.md) resource or the [BackupService/List](../api-ref/grpc/Backup/list.md) gRPC API call and provide the folder ID in the `folderId` request parameter. + To get a list of backups for all the {{ mch-name }} clusters in the folder, use the [list](../api-ref/Backup/list.md) REST API method for the [Backup](../api-ref/Backup/index.md) resource or the [BackupService/List](../api-ref/grpc/Backup/list.md) gRPC API call and provide the folder ID in the `folderId` request parameter. - You can get the cluster ID with a [list of clusters in the folder](cluster-list.md#list-clusters). + You can get the cluster ID with a [list of clusters in the folder](cluster-list.md#list-clusters). {% endlist %} @@ -260,33 +260,33 @@ You can restore an individual [shard](../concepts/sharding.md) or the whole clus - Management console {#console} - To get information about the backup of an existing cluster: - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. - 1. Click the cluster name and open the **{{ ui-key.yacloud.clickhouse.cluster.switch_backups }}** tab. + To get information about the backup of an existing cluster: + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. + 1. Click the cluster name and open the **{{ ui-key.yacloud.clickhouse.cluster.switch_backups }}** tab. - To get information about the backup of a previously deleted cluster: - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. - 1. In the left-hand panel, select ![image](../../_assets/console-icons/archive.svg) **{{ ui-key.yacloud.clickhouse.switch_backups }}**. + To get information about the backup of a previously deleted cluster: + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. + 1. In the left-hand panel, select ![image](../../_assets/console-icons/archive.svg) **{{ ui-key.yacloud.clickhouse.switch_backups }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To get information about a {{ CH }} cluster backup, run the command: + To get information about a {{ CH }} cluster backup, run the command: - ```bash - {{ yc-mdb-ch }} backup get - ``` + ```bash + {{ yc-mdb-ch }} backup get + ``` - You can retrieve the backup ID with a [list of backups](#list-backups). + You can retrieve the backup ID with a [list of backups](#list-backups). - API {#api} - To get information about a backup, use the [get](../api-ref/Backup/get.md) REST API method for the [Backup](../api-ref/Backup/index.md) resource or the [BackupService/Get](../api-ref/grpc/Backup/get.md) gRPC API call and provide the backup ID in the `backupId` request parameter. + To get information about a backup, use the [get](../api-ref/Backup/get.md) REST API method for the [Backup](../api-ref/Backup/index.md) resource or the [BackupService/Get](../api-ref/grpc/Backup/get.md) gRPC API call and provide the backup ID in the `backupId` request parameter. - To find out the ID, [retrieve a list of backups](#list-backups). + To find out the ID, [retrieve a list of backups](#list-backups). {% endlist %} @@ -296,32 +296,32 @@ You can restore an individual [shard](../concepts/sharding.md) or the whole clus - Management console {#console} - In the [management console]({{ link-console-main }}), you can set the backup start time when [creating](cluster-create.md) or [updating](update.md) a cluster. + In the [management console]({{ link-console-main }}), you can set the backup start time when [creating](cluster-create.md) or [updating a cluster](update.md). - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To set a backup start time, provide the value you need in `HH:MM:SS` format in the `--backup-window-start` argument of the cluster update command: + To set the backup start time, provide the required value in `HH:MM:SS` format in the `--backup-window-start` argument of the `cluster update` command: - ```bash - {{ yc-mdb-ch }} cluster update \ - --backup-window-start= - ``` + ```bash + {{ yc-mdb-ch }} cluster update \ + --backup-window-start= + ``` - You can request the cluster ID and name with a [list of clusters in the folder](cluster-list.md#list-clusters). + You can request the cluster ID and name with a [list of clusters in the folder](cluster-list.md#list-clusters). - API {#api} - To set the backup start time, use the [update](../api-ref/Cluster/update.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Update](../api-ref/grpc/Cluster/update.md) gRPC API call and provide the following in the request: + To set the backup start time, use the [update](../api-ref/Cluster/update.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Update](../api-ref/grpc/Cluster/update.md) gRPC API call and provide the following in the request: - * Cluster ID in the `clusterId` parameter. You can get it together [with a list of clusters in the folder](cluster-list.md#list-clusters). - * New backup start time in the `configSpec.backupWindowStart` parameter. - * List of cluster configuration fields to be updated in the `updateMask` parameter (in this case, `configSpec.backupWindowStart`). + * Cluster ID in the `clusterId` parameter. You can get it with a [list of clusters in the folder](cluster-list.md#list-clusters). + * New backup start time in the `configSpec.backupWindowStart` parameter. + * List of updatable cluster configuration fields in the `updateMask` parameter (in this case, `configSpec.backupWindowStart`). - {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} + {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} {% endlist %} diff --git a/en/managed-clickhouse/operations/cluster-list.md b/en/managed-clickhouse/operations/cluster-list.md index 5c39fea4bfc..2b490da654e 100644 --- a/en/managed-clickhouse/operations/cluster-list.md +++ b/en/managed-clickhouse/operations/cluster-list.md @@ -13,34 +13,34 @@ You can request detailed information about each {{ mch-short-name }} cluster you - Management console {#console} - In the [management console]({{ link-console-main }}), go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. + In the [management console]({{ link-console-main }}), go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To request a list of {{ CH }} clusters in the default folder, run the command: + To request a list of {{ CH }} clusters in the default folder, run the command: - ``` - {{ yc-mdb-ch }} cluster list + ``` + {{ yc-mdb-ch }} cluster list - +----------------------+------+-------------+---------+---------------------+--------+---------+ - | ID | NAME | ENVIRONMENT | VERSION | CREATED AT | HEALTH | STATUS | - +----------------------+------+-------------+---------+---------------------+--------+---------+ - | c9qf1kmm0ebi******** | mych | PRODUCTION | 23.8 | 2024-06-06 10:23:22 | ALIVE | RUNNING | - | ... | - +----------------------+------+-------------+---------+---------------------+--------+---------+ - ``` + +----------------------+------+-------------+---------+---------------------+--------+---------+ + | ID | NAME | ENVIRONMENT | VERSION | CREATED AT | HEALTH | STATUS | + +----------------------+------+-------------+---------+---------------------+--------+---------+ + | c9qf1kmm0ebi******** | mych | PRODUCTION | 23.8 | 2024-06-06 10:23:22 | ALIVE | RUNNING | + | ... | + +----------------------+------+-------------+---------+---------------------+--------+---------+ + ``` - REST API {#api} - 1. [Get an IAM token for API authentication](../api-ref/authentication.md) and place it in the environment variable: + 1. [Get an IAM token for API authentication](../api-ref/authentication.md) and place it in the environment variable: {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} - 1. Use the [Cluster.list](../api-ref/Cluster/list.md) method and make a request, e.g., via {{ api-examples.rest.tool }}: + 1. Use the [Cluster.list](../api-ref/Cluster/list.md) method and make a request, e.g., via {{ api-examples.rest.tool }}: ```bash curl \ @@ -53,17 +53,17 @@ You can request detailed information about each {{ mch-short-name }} cluster you You can request the folder ID with a [list of folders in the cloud](../../resource-manager/operations/folder/get-id.md). - 1. View the [server response](../api-ref/Cluster/list.md#yandex.cloud.mdb.clickhouse.v1.ListClustersResponse) to make sure the request was successful. + 1. View the [server response](../api-ref/Cluster/list.md#yandex.cloud.mdb.clickhouse.v1.ListClustersResponse) to make sure the request was successful. - gRPC API {#grpc-api} - 1. [Get an IAM token for API authentication](../api-ref/authentication.md) and place it in the environment variable: + 1. [Get an IAM token for API authentication](../api-ref/authentication.md) and place it in the environment variable: {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} - 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} - 1. Use the [ClusterService/List](../api-ref/grpc/Cluster/list.md) call and make a request, e.g., via {{ api-examples.grpc.tool }}: + 1. Use the [ClusterService/List](../api-ref/grpc/Cluster/list.md) call and make a request, e.g., via {{ api-examples.grpc.tool }}: ```bash grpcurl \ @@ -83,7 +83,7 @@ You can request detailed information about each {{ mch-short-name }} cluster you You can request the folder ID with a [list of folders in the cloud](../../resource-manager/operations/folder/get-id.md). - 1. View the [server response](../api-ref/grpc/Cluster/list.md#yandex.cloud.mdb.clickhouse.v1.ListClustersResponse) to make sure the request was successful. + 1. View the [server response](../api-ref/grpc/Cluster/list.md#yandex.cloud.mdb.clickhouse.v1.ListClustersResponse) to make sure the request was successful. {% endlist %} @@ -93,30 +93,30 @@ You can request detailed information about each {{ mch-short-name }} cluster you - Management console {#console} - 1. In the [management console]({{ link-console-main }}), go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. - 1. Click the cluster name. + 1. In the [management console]({{ link-console-main }}), go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. + 1. Click the cluster name. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To get information about a {{ CH }} cluster, run the following command: + To get information about a {{ CH }} cluster, run the following command: - ``` - {{ yc-mdb-ch }} cluster get - ``` + ``` + {{ yc-mdb-ch }} cluster get + ``` - You can request the cluster ID and name with a [list of clusters in the folder](#list-clusters). + You can request the cluster ID and name with a [list of clusters in the folder](#list-clusters). - REST API {#api} - 1. [Get an IAM token for API authentication](../api-ref/authentication.md) and place it in the environment variable: + 1. [Get an IAM token for API authentication](../api-ref/authentication.md) and place it in the environment variable: {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} - 1. Use the [Cluster.get](../api-ref/Cluster/get.md) method and make a request, e.g., via {{ api-examples.rest.tool }}: + 1. Use the [Cluster.get](../api-ref/Cluster/get.md) method and make a request, e.g., via {{ api-examples.rest.tool }}: ```bash curl \ @@ -125,19 +125,19 @@ You can request detailed information about each {{ mch-short-name }} cluster you --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/clusters/' ``` - You can request the cluster ID with a [list of clusters in the folder](#list-clusters). + You can get the cluster ID with a [list of clusters in the folder](#list-clusters). - 1. View the [server response](../api-ref/Cluster/get.md#yandex.cloud.mdb.clickhouse.v1.Cluster) to make sure the request was successful. + 1. View the [server response](../api-ref/Cluster/get.md#yandex.cloud.mdb.clickhouse.v1.Cluster) to make sure the request was successful. - gRPC API {#grpc-api} - 1. [Get an IAM token for API authentication](../api-ref/authentication.md) and place it in the environment variable: + 1. [Get an IAM token for API authentication](../api-ref/authentication.md) and place it in the environment variable: {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} - 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} - 1. Use the [ClusterService/Get](../api-ref/grpc/Cluster/get.md) call and make a request, e.g., via {{ api-examples.grpc.tool }}: + 1. Use the [ClusterService/Get](../api-ref/grpc/Cluster/get.md) call and make a request, e.g., via {{ api-examples.grpc.tool }}: ```bash grpcurl \ @@ -153,45 +153,95 @@ You can request detailed information about each {{ mch-short-name }} cluster you yandex.cloud.mdb.clickhouse.v1.ClusterService.Get ``` - You can request the cluster ID with a [list of clusters in the folder](#list-clusters). + You can get the cluster ID with a [list of clusters in the folder](#list-clusters). - 1. View the [server response](../api-ref/grpc/Cluster/create.md#yandex.cloud.mdb.clickhouse.v1.Cluster) to make sure the request was successful. + 1. View the [server response](../api-ref/grpc/Cluster/create.md#yandex.cloud.mdb.clickhouse.v1.Cluster) to make sure the request was successful. {% endlist %} -## Viewing a list of operations in a cluster {#list-operations} +## Viewing operations with clusters {#list-operations} -{% include [list-operations-about](../../_includes/mdb/list-operations-about.md) %} +All actions with {{ mch-name }} clusters are logged as a list of operations. Each operation is assigned a unique ID. + +### Getting a list of operations {#get-operations} {% list tabs group=instructions %} - Management console {#console} - 1. In the [management console]({{ link-console-main }}), go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. - 1. Click the cluster name. - 1. Go to the **{{ ui-key.yacloud.clickhouse.cluster.switch_operations }}** tab. - -- CLI {#cli} + To view operations with all {{ mch-name }} clusters, in the left-hand panel, select ![image](../../_assets/console-icons/list-check.svg) **{{ ui-key.yacloud.clickhouse.switch_operations }}**. In the list that opens, you will also see operations with the resources that were deleted. - {% include [cli-install](../../_includes/cli-install.md) %} + You can get a list of operations for a cluster: - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + 1. In the [management console]({{ link-console-main }}), open the folder with the cluster. + 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. + 1. In the left-hand panel, select ![image](../../_assets/console-icons/cubes-3.svg) **{{ ui-key.yacloud.clickhouse.switch_list }}**. + 1. Select the cluster you need. + 1. Go to the ![image](../../_assets/console-icons/list-check.svg) **{{ ui-key.yacloud.clickhouse.switch_operations }}** panel for the selected cluster. - To get a list of operations, run the following command: + You will see a list of operations with the selected cluster. - ``` - {{ yc-mdb-ch }} cluster list-operations - ``` +- CLI {#cli} - You can request the cluster ID and name with a [list of clusters in the folder](#list-clusters). + {% include [cli-install](../../_includes/cli-install.md) %} + + {% include [default-catalogue](../../_includes/default-catalogue.md) %} + + To get a list of operations for a {{ mch-name }} cluster, run this command: + + ```bash + yc managed-clickhouse cluster list-operations + ``` + + Result: + + ```text + +----------------------+---------------------+----------------------+---------------------+--------+--------------------------------+ + | ID | CREATED AT | CREATED BY | MODIFIED AT | STATUS | DESCRIPTION | + +----------------------+---------------------+----------------------+---------------------+--------+--------------------------------+ + | c5m7ll6pq3j8******** | 2024-08-08 19:05:42 | mdb-maintainer | 2024-08-15 19:20:05 | DONE | Modify ClickHouse cluster | + | c5mb0no66172******** | 2024-06-19 12:48:40 | mdb-maintainer | 2024-06-26 12:50:14 | DONE | Modify ClickHouse cluster | + | c5m9hvmb3lg9******** | 2024-01-17 08:05:16 | ajeef73j5iq9******** | 2024-01-17 08:14:59 | DONE | Add ZooKeeper to ClickHouse | + | | | | | | cluster | + | c5mniao7leml******** | 2023-11-13 19:34:54 | ajeef73j5iq9******** | 2023-11-13 19:35:10 | DONE | Update user in ClickHouse | + | | | | | | cluster | + | c5m6of9he7op******** | 2023-11-13 19:25:21 | ajeef73j5iq9******** | 2023-11-13 19:32:00 | DONE | Create ClickHouse cluster | + +----------------------+---------------------+----------------------+---------------------+---- ---+--------------------------------+ + ``` + + You can get the cluster ID and name with a [list of clusters](cluster-list.md#list-clusters) in the folder. + + By default, information about operations is provided as text. To get detailed information, specify the `yaml` or `json` output data format using the `--format` flag: + + ```bash + yc managed-clickhouse cluster list-operations epdplu8jn7sr******** --format yaml + ``` + + Result: + + ```text + - id: c5m7ll6pq3j8******** + description: Modify ClickHouse cluster + created_at: "2024-08-08T19:05:42.362668Z" + created_by: mdb-maintainer + modified_at: "2024-08-15T19:20:05.917268Z" + done: true + metadata: + '@type': type.googleapis.com/yandex.cloud.mdb.clickhouse.v1.UpdateClusterMetadata + cluster_id: c9q7vuuoiqml******** + response: + '@type': type.googleapis.com/google.rpc.Status + message: OK + ... + ``` - REST API {#api} - 1. [Get an IAM token for API authentication](../api-ref/authentication.md) and place it in the environment variable: + 1. [Get an IAM token for API authentication](../api-ref/authentication.md) and place it in the environment variable: - {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} - 1. Use the [Cluster.listOperations](../api-ref/Cluster/listOperations.md) method and make a request, e.g., via {{ api-examples.rest.tool }}: + 1. Use the [Cluster.listOperations](../api-ref/Cluster/listOperations.md) method and make a request, e.g., via {{ api-examples.rest.tool }}: ```bash curl \ @@ -200,19 +250,19 @@ You can request detailed information about each {{ mch-short-name }} cluster you --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/clusters//operations' ``` - You can request the cluster ID with a [list of clusters in the folder](#list-clusters). + You can get the cluster ID with a [list of clusters in the folder](#list-clusters). - 1. View the [server response](../api-ref/Cluster/listOperations.md#yandex.cloud.mdb.clickhouse.v1.ListClusterOperationsResponse) to make sure the request was successful. + 1. View the [server response](../api-ref/Cluster/listOperations.md#yandex.cloud.mdb.clickhouse.v1.ListClusterOperationsResponse) to make sure the request was successful. - gRPC API {#grpc-api} - 1. [Get an IAM token for API authentication](../api-ref/authentication.md) and place it in the environment variable: + 1. [Get an IAM token for API authentication](../api-ref/authentication.md) and place it in the environment variable: {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} - 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} - 1. Use the [ClusterService/ListOperations](../api-ref/grpc/Cluster/listOperations.md) call and make a request, e.g., via {{ api-examples.grpc.tool }}: + 1. Use the [ClusterService/ListOperations](../api-ref/grpc/Cluster/listOperations.md) call and make a request, e.g., via {{ api-examples.grpc.tool }}: ```bash grpcurl \ @@ -228,10 +278,57 @@ You can request detailed information about each {{ mch-short-name }} cluster you yandex.cloud.mdb.clickhouse.v1.ClusterService.ListOperations ``` - You can request the cluster ID with a [list of clusters in the folder](#list-clusters). + You can get the cluster ID with a [list of clusters in the folder](#list-clusters). - 1. View the [server response](../api-ref/grpc/Cluster/listOperations.md#yandex.cloud.mdb.clickhouse.v1.ListClusterOperationsResponse) to make sure the request was successful. + 1. View the [server response](../api-ref/grpc/Cluster/listOperations.md#yandex.cloud.mdb.clickhouse.v1.ListClusterOperationsResponse) to make sure the request was successful. {% endlist %} +### Getting detailed information about an operation {#get-operations-info} + +1. [Get a list of operations](#get-operations) for a cluster. +1. Copy the ID of the operation. +1. Get detailed information about the operation: + + {% list tabs group=instructions %} + + - CLI {#cli} + + {% include [cli-install](../../_includes/cli-install.md) %} + + {% include [default-catalogue](../../_includes/default-catalogue.md) %} + + Run this command: + + ```bash + yc operation get + ``` + + Result: + + ```text + id: c5m6of9he7op******** + description: Create ClickHouse cluster + created_at: "2023-11-13T19:25:21.762164Z" + created_by: ajeef73j5iq9******** + modified_at: "2023-11-13T19:32:00.464591Z" + done: true + metadata: + '@type': type.googleapis.com/yandex.cloud.mdb.clickhouse.v1.CreateClusterMetadata + cluster_id: c9q7vuuoiqml******** + response: + '@type': type.googleapis.com/yandex.cloud.mdb.clickhouse.v1.Cluster + ... + ``` + + - API {#api} + + Use the [get](../api-ref/Cluster/get.md) REST API method for the [Operation](../api-ref/Operation/index.md) resource or the [OperationService/Get](../api-ref/grpc/Operation/get.md) gRPC API call and provide the operation ID in the request. + + {% endlist %} + +### See also {#see-also} + +* [{#T}](../../api-design-guide/concepts/about-async.md) + {% include [clickhouse-disclaimer](../../_includes/clickhouse-disclaimer.md) %} diff --git a/en/managed-clickhouse/operations/cluster-users.md b/en/managed-clickhouse/operations/cluster-users.md index dc071d1a070..09d11a009c5 100644 --- a/en/managed-clickhouse/operations/cluster-users.md +++ b/en/managed-clickhouse/operations/cluster-users.md @@ -7,7 +7,7 @@ description: In this tutorial, you will learn how to manage {{ mch-name }} clust {{ mch-name }} provides two ways for you to manage users and their individual settings: -* Using native {{ yandex-cloud }} interfaces, such as the CLI, API, or management console. Select this method to create, update, and delete users and custom user settings using {{ mch-full-name }} features. +* Using native {{ yandex-cloud }} interfaces, such as the management console, CLI, {{ TF }}, or API. Select this method to create, update, and delete users and custom user settings using {{ mch-full-name }} features. * SQL queries to the cluster. Select this method to use your existing solutions to create and manage users or if you are using [RBAC](https://en.wikipedia.org/wiki/Role-based_access_control). {% note warning %} @@ -27,10 +27,15 @@ Creating a new {{ CH }} cluster automatically creates [service users](../concept To enable management, activate the **{{ ui-key.yacloud.mdb.forms.database_field_sql-user-management }}** option when [creating](cluster-create.md) or [reconfiguring](update.md#SQL-management) a cluster. +{% note warning %} + +You cannot disable the SQL user management setting once it is enabled. + +{% endnote %} + In a cluster with user management via SQL enabled: -* User management using the standard {{ yandex-cloud }} interfaces (CLI, API, management console) is unavailable. -* You cannot enable user management using standard {{ yandex-cloud }} interfaces (CLI, API, or management console). +* User management via standard {{ yandex-cloud }} interfaces (management console, CLI, API, {{ TF }}) is unavailable. * The existing users as well as user settings made with the standard {{ yandex-cloud }} interfaces will be saved. * Users are managed under the `admin` account. You set its password when you select the **{{ ui-key.yacloud.mdb.forms.database_field_sql-user-management }}** option. @@ -147,7 +152,7 @@ For more information about managing users via SQL, see the [{{ CH }} documentati For more information about creating this file, see [Creating clusters](cluster-create.md). - 1. Add the `user` section to the {{ mch-name }} cluster description: + 1. Add a `user` section to the {{ mch-name }} cluster description: ```hcl resource "yandex_mdb_clickhouse_cluster" "" { @@ -653,7 +658,7 @@ Let's say you need to add a new user named `ro-user` with the password `Passw0rd SET readonly=0 ``` - As a result, the command should display a message stating that you cannot change the setting in read-only mode: + As a result, the command should return a message stating that you cannot change the setting in read-only mode: ``` DB::Exception: Cannot modify 'readonly' setting in readonly mode. diff --git a/en/managed-clickhouse/operations/s3-access.md b/en/managed-clickhouse/operations/s3-access.md index 5d9cecff71e..bffb99ee886 100644 --- a/en/managed-clickhouse/operations/s3-access.md +++ b/en/managed-clickhouse/operations/s3-access.md @@ -62,6 +62,12 @@ To use {{ mch-name }} to work with data of an object in {{ objstorage-name }}, y A link such as `https://{{ s3-storage-host }}//?X-Amz-Algorithm=...` should be changed to `https://{{ s3-storage-host }}//` with all parameters in the query string removed. +{% note info %} + +You cannot use [signed links](../../storage/concepts/pre-signed-urls.md) to access a bucket from a cluster. + +{% endnote %} + ## Examples of working with objects {#examples} You can use [object links](#get-link-to-object), such as `https://{{ s3-storage-host }}//` to work with geotags and schemas or to use the `s3` table function and the `S3` table engine. diff --git a/en/managed-clickhouse/operations/update.md b/en/managed-clickhouse/operations/update.md index 04375d65390..05352b22283 100644 --- a/en/managed-clickhouse/operations/update.md +++ b/en/managed-clickhouse/operations/update.md @@ -11,11 +11,11 @@ After creating a cluster, you can: * [Change service account settings](#change-service-account). -* [{#T}](#change-resource-preset) +* [{#T}](#change-resource-preset). -* [{#T}](#change-disk-size) +* [{#T}](#change-disk-size). -* [{#T}](#SQL-management) +* [{#T}](#SQL-management). * [Change additional cluster settings](#change-additional-settings). @@ -31,7 +31,7 @@ Learn more about other cluster updates: * [Migrating a cluster to a different availability zone](host-migration.md). -* [Configuring {{ CH }} servers](change-server-level-settings.md) according to the [{{ CH }} documentation]({{ ch.docs }}/operations/server-configuration-parameters/settings). +* [Configuring {{ CH }} servers](change-server-level-settings.md) as described in the [{{ CH }} documentation]({{ ch.docs }}/operations/server-configuration-parameters/settings). * [Changing {{ CH }} settings at the query level](change-query-level-settings.md). @@ -42,11 +42,11 @@ Learn more about other cluster updates: - Management console {#console} - 1. In the [management console]({{ link-console-main }}), go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. - 1. Select the cluster and click **{{ ui-key.yacloud.mdb.cluster.overview.button_action-edit }}** in the top panel. - 1. Under **{{ ui-key.yacloud.mdb.forms.section_service-settings }}**, select the service account you need from the list, or [create a new one](../../iam/operations/sa/create.md). For more information about setting up service accounts, see [{#T}](s3-access.md). + 1. In the [management console]({{ link-console-main }}), go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. + 1. Select the cluster and click **{{ ui-key.yacloud.mdb.cluster.overview.button_action-edit }}** in the top panel. + 1. Under **{{ ui-key.yacloud.mdb.forms.section_service-settings }}**, select the service account you need from the list, or [create a new one](../../iam/operations/sa/create.md). For more information about setting up service accounts, see [{#T}](s3-access.md). - {% include [mdb-service-account-update](../../_includes/mdb/service-account-update.md) %} + {% include [mdb-service-account-update](../../_includes/mdb/service-account-update.md) %} {% endlist %} @@ -75,103 +75,103 @@ The minimum number of cores per {{ ZK }} host depends on the total number of c - Management console {#console} - 1. In the [management console]({{ link-console-main }}), go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. - 1. Select the cluster and click **{{ ui-key.yacloud.mdb.cluster.overview.button_action-edit }}** in the top panel. - 1. To change the {{ CH }} host class, select the platform, VM type, and required host class under **{{ ui-key.yacloud.mdb.forms.new_section_resource }}**. - 1. To change the {{ ZK }} host class, select the platform, VM type, and required {{ ZK }} host class under **{{ ui-key.yacloud.mdb.forms.section_zookeeper-resource }}**. - 1. Click **{{ ui-key.yacloud.mdb.forms.button_edit }}**. + 1. In the [management console]({{ link-console-main }}), go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. + 1. Select the cluster and click **{{ ui-key.yacloud.mdb.cluster.overview.button_action-edit }}** in the top panel. + 1. To change the {{ CH }} host class, select the platform, VM type, and required host class under **{{ ui-key.yacloud.mdb.forms.new_section_resource }}**. + 1. To change the {{ ZK }} host class, select the platform, VM type, and required {{ ZK }} host class under **{{ ui-key.yacloud.mdb.forms.section_zookeeper-resource }}**. + 1. Click **{{ ui-key.yacloud.mdb.forms.button_edit }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To change the [host class](../concepts/instance-types.md) for the cluster: + To change the [host class](../concepts/instance-types.md) for the cluster: - 1. View a description of the update cluster CLI command: + 1. View a description of the update cluster CLI command: - ```bash - {{ yc-mdb-ch }} cluster update --help - ``` + ```bash + {{ yc-mdb-ch }} cluster update --help + ``` - 1. Request a list of available host classes (the `ZONE IDS` column specifies the availability zones where you can select the appropriate class): + 1. Request a list of available host classes (the `ZONE IDS` column specifies the availability zones where you can select the appropriate class): - ```bash - {{ yc-mdb-ch }} resource-preset list - - +-----------+--------------------------------+-------+----------+ - | ID | ZONE IDS | CORES | MEMORY | - +-----------+--------------------------------+-------+----------+ - | s1.micro | {{ region-id }}-a, {{ region-id }}-b, | 2 | 8.0 GB | - | | {{ region-id }}-d | | | - | ... | - +-----------+--------------------------------+-------+----------+ - ``` + ```bash + {{ yc-mdb-ch }} resource-preset list + +-----------+--------------------------------+-------+----------+ + | ID | ZONE IDS | CORES | MEMORY | + +-----------+--------------------------------+-------+----------+ + | s1.micro | {{ region-id }}-a, {{ region-id }}-b, | 2 | 8.0 GB | + | | {{ region-id }}-d | | | + | ... | + +-----------+--------------------------------+-------+----------+ + ``` - 1. Specify the class in the update cluster command: - ```bash - {{ yc-mdb-ch }} cluster update \ - --clickhouse-resource-preset= - ``` + 1. Specify the class in the update cluster command: + + ```bash + {{ yc-mdb-ch }} cluster update \ + --clickhouse-resource-preset= + ``` - {{ mch-short-name }} will run the update host class command for the cluster. + {{ mch-short-name }} will run the update host class command for the cluster. - 1. To change the class of a {{ ZK }} host, provide the value you need in the `--zookeeper-resource-preset` parameter. + 1. To change the class of a {{ ZK }} host, provide the value you need in the `--zookeeper-resource-preset` parameter. - {{ TF }} {#tf} - 1. Open the current {{ TF }} configuration file with an infrastructure plan. + 1. Open the current {{ TF }} configuration file with an infrastructure plan. - For more information about how to create this file, see [Creating clusters](cluster-create.md). + For more information about creating this file, see [Creating clusters](cluster-create.md). - 1. In the {{ mch-name }} cluster description, change the value of the `resource_preset_id` parameter in the `clickhouse.resources` and `zookeeper.resources` sections for {{ CH }} and {{ ZK }} hosts, respectively: + 1. In the {{ mch-name }} cluster description, change the value of the `resource_preset_id` parameter in the `clickhouse.resources` and `zookeeper.resources` sections for {{ CH }} and {{ ZK }} hosts, respectively: - ```hcl - resource "yandex_mdb_clickhouse_cluster" "" { - ... - clickhouse { - resources { - resource_preset_id = "<{{ CH }}_host_class>" - ... + ```hcl + resource "yandex_mdb_clickhouse_cluster" "" { + ... + clickhouse { + resources { + resource_preset_id = "<{{ CH }}_host_class>" + ... + } } - } - zookeeper { - resources { - resource_preset_id = "<{{ ZK }}_class_host>" - ... + zookeeper { + resources { + resource_preset_id = "<{{ ZK }}_host_class>" + ... + } } } - } - ``` + ``` - 1. Make sure the settings are correct. + 1. Make sure the settings are correct. - {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} + {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} - 1. Confirm updating the resources. + 1. Confirm updating the resources. - {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} + {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} - For more information, see the [{{ TF }} provider documentation]({{ tf-provider-resources-link }}/mdb_clickhouse_cluster). + For more information, see the [{{ TF }} provider documentation]({{ tf-provider-resources-link }}/mdb_clickhouse_cluster). - {% include [Terraform timeouts](../../_includes/mdb/mch/terraform/timeouts.md) %} + {% include [Terraform timeouts](../../_includes/mdb/mch/terraform/timeouts.md) %} - API {#api} - To change the host class, use the [update](../api-ref/Cluster/update.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Update](../api-ref/grpc/Cluster/update.md) gRPC API call and provide the following in the request: + To change the host class, use the [update](../api-ref/Cluster/update.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Update](../api-ref/grpc/Cluster/update.md) gRPC API call and provide the following in the request: - * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](./cluster-list.md#list-clusters). - * Required values in the `configSpec.clickhouse.resources.resourcePresetId` parameter (`configSpec.zookeeper.resources.resourcePresetId` for ZooKeeper). + * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](./cluster-list.md#list-clusters). + * Required values in the `configSpec.clickhouse.resources.resourcePresetId` parameter (`configSpec.zookeeper.resources.resourcePresetId` for ZooKeeper). - To request a list of supported values, use the [list](../api-ref/ResourcePreset/list.md) method for the `ResourcePreset` resources. + To request a [list](../api-ref/ResourcePreset/list.md) of supported values, use the list method for the `ResourcePreset` resources. - * List of settings to update, in the `updateMask` parameter. + * List of settings to update, in the `updateMask` parameter. - {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} + {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} {% endlist %} @@ -189,86 +189,86 @@ In clusters with {{ CK }}, {{ ZK }} hosts cannot be used. To learn more, see [Re - Management console {#console} - To increase the cluster storage size: + To increase the cluster storage size: - 1. In the [management console]({{ link-console-main }}), go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. - 1. Select the cluster and click **{{ ui-key.yacloud.mdb.cluster.overview.button_action-edit }}** in the top panel. - 1. Under **{{ ui-key.yacloud.mdb.forms.section_disk }}**, specify the required value. - 1. Click **{{ ui-key.yacloud.mdb.forms.button_edit }}**. + 1. In the [management console]({{ link-console-main }}), go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. + 1. Select the cluster and click **{{ ui-key.yacloud.mdb.cluster.overview.button_action-edit }}** in the top panel. + 1. Under **{{ ui-key.yacloud.mdb.forms.section_disk }}**, specify the required value. + 1. Click **{{ ui-key.yacloud.mdb.forms.button_edit }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To increase the cluster storage size: + To increase the cluster storage size: - 1. View a description of the update cluster CLI command: + 1. View a description of the update cluster CLI command: - ```bash - {{ yc-mdb-ch }} cluster update --help - ``` + ```bash + {{ yc-mdb-ch }} cluster update --help + ``` - 1. Specify the required storage in the cluster update command (it must be at least as large as `disk_size` in the cluster properties): + 1. Specify the required storage in the cluster update command (it must be at least as large as `disk_size` in the cluster properties): - ```bash - {{ yc-mdb-ch }} cluster update \ - --clickhouse-disk-size - ``` + ```bash + {{ yc-mdb-ch }} cluster update \ + --clickhouse-disk-size + ``` - 1. To increase the storage capacity of {{ ZK }} hosts, provide the value you need in the `--zookeeper-disk-size` parameter. + 1. To increase the storage capacity of {{ ZK }} hosts, provide the value you need in the `--zookeeper-disk-size` parameter. - {{ TF }} {#tf} - To increase storage size: + To increase storage size: - 1. Open the current {{ TF }} configuration file with an infrastructure plan. + 1. Open the current {{ TF }} configuration file with an infrastructure plan. - For more information about how to create this file, see [Creating clusters](cluster-create.md). + For more information about creating this file, see [Creating clusters](cluster-create.md). - 1. In the {{ mch-name }} cluster description, change the value of the `disk_size` parameter in the `clickhouse.resources` and `zookeeper.resources` sections for {{ CH }} and {{ ZK }}, respectively: + 1. In the {{ mch-name }} cluster description, change the value of the `disk_size` parameter in the `clickhouse.resources` and `zookeeper.resources` sections for {{ CH }} and {{ ZK }} hosts, respectively: - ```hcl - resource "yandex_mdb_clickhouse_cluster" "" { - ... - clickhouse { - resources { - disk_size = - ... + ```hcl + resource "yandex_mdb_clickhouse_cluster" "" { + ... + clickhouse { + resources { + disk_size = + ... + } } - } - zookeeper { - resources { - disk_size = - ... + zookeeper { + resources { + disk_size = + ... + } } } - } - ``` + ``` - 1. Make sure the settings are correct. + 1. Make sure the settings are correct. - {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} + {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} - 1. Confirm updating the resources. + 1. Confirm updating the resources. - {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} + {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} - For more information, see the [{{ TF }} provider documentation]({{ tf-provider-resources-link }}/mdb_clickhouse_cluster). + For more information, see the [{{ TF }} provider documentation]({{ tf-provider-resources-link }}/mdb_clickhouse_cluster). - {% include [Terraform timeouts](../../_includes/mdb/mch/terraform/timeouts.md) %} + {% include [Terraform timeouts](../../_includes/mdb/mch/terraform/timeouts.md) %} - API {#api} - To increase the storage size, use the [update](../api-ref/Cluster/update.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Update](../api-ref/grpc/Cluster/update.md) gRPC API call and provide the following in the request: + To increase the storage size, use the [update](../api-ref/Cluster/update.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Update](../api-ref/grpc/Cluster/update.md) gRPC API call and provide the following in the request: - * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](./cluster-list.md#list-clusters). - * Required size of the {{ CH }} host storage in the `configSpec.clickhouse.resources.diskSize` parameter. - * Required size of the {{ ZK }} host storage in the `configSpec.zookeeper.resources.diskSize` parameter. - * List of cluster configuration fields to update in the `updateMask` parameter. + * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](./cluster-list.md#list-clusters). + * Required size of the {{ CH }} host storage in the `configSpec.clickhouse.resources.diskSize` parameter. + * Required size of the {{ ZK }} host storage in the `configSpec.zookeeper.resources.diskSize` parameter. + * List of cluster configuration fields to update in the `updateMask` parameter. - {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} + {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} {% endlist %} @@ -278,7 +278,7 @@ The {{ mch-name }} service lets enable cluster [user](./cluster-users.md#sql-use {% note alert %} -This disables user and database management through other interfaces. +This disables user and database management through standard {{ yandex-cloud }} interfaces (management console, CLI, {{ TF }}, API). Once enabled, user and database management settings for SQL cannot be disabled. @@ -289,72 +289,72 @@ Once enabled, user and database management settings for SQL cannot be disabled. - Management console {#console} - 1. Go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. - 1. Select the cluster and click **{{ ui-key.yacloud.mdb.cluster.overview.button_action-edit }}** in the top panel. - 1. To [manage users via SQL](./cluster-users.md#sql-user-management), enable the **{{ ui-key.yacloud.mdb.forms.database_field_sql-user-management }}** setting under **{{ ui-key.yacloud.mdb.forms.section_settings }}** and specify the `admin` user password. - 1. To [manage databases via SQL](./databases.md#sql-database-management), enable the **{{ ui-key.yacloud.mdb.forms.database_field_sql-user-management }}** and **{{ ui-key.yacloud.mdb.forms.database_field_sql-database-management }}** settings under **{{ ui-key.yacloud.mdb.forms.section_settings }}** and specify the `admin` user password. - 1. Click **{{ ui-key.yacloud.mdb.forms.button_edit }}**. + 1. Go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. + 1. Select the cluster and click **{{ ui-key.yacloud.mdb.cluster.overview.button_action-edit }}** in the top panel. + 1. To [manage users via SQL](./cluster-users.md#sql-user-management), enable the **{{ ui-key.yacloud.mdb.forms.database_field_sql-user-management }}** setting under **{{ ui-key.yacloud.mdb.forms.section_settings }}** and specify the `admin` user password. + 1. To [manage databases via SQL](./databases.md#sql-database-management), enable the **{{ ui-key.yacloud.mdb.forms.database_field_sql-user-management }}** and **{{ ui-key.yacloud.mdb.forms.database_field_sql-database-management }}** settings under **{{ ui-key.yacloud.mdb.forms.section_settings }}** and specify the `admin` user password. + 1. Click **{{ ui-key.yacloud.mdb.forms.button_edit }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - 1. To enable [SQL user management](./cluster-users.md#sql-user-management): + 1. To enable [SQL user management](./cluster-users.md#sql-user-management): - * set `--enable-sql-user-management` to `true`. - * Set a password for the `admin` user in the `--admin-password` parameter. + * set `--enable-sql-user-management` to `true`. + * Set a password for the `admin` user in the `--admin-password` parameter. - ```bash - {{ yc-mdb-ch }} cluster update \ - ... - --enable-sql-user-management true \ - --admin-password "" - ``` + ```bash + {{ yc-mdb-ch }} cluster update \ + ... + --enable-sql-user-management true \ + --admin-password "" + ``` - 1. To enable [SQL database management](./databases.md#sql-database-management): + 1. To enable [SQL database management](./databases.md#sql-database-management): - * Set `--enable-sql-user-management` and `--enable-sql-database-management` to `true`; - * Set a password for the `admin` user in the `--admin-password` parameter. + * Set `--enable-sql-user-management` and `--enable-sql-database-management` to `true`; + * Set a password for the `admin` user in the `--admin-password` parameter. - ```bash - {{ yc-mdb-ch }} cluster update \ - ... - --enable-sql-user-management true \ - --enable-sql-database-management true \ - --admin-password "" - ``` + ```bash + {{ yc-mdb-ch }} cluster update \ + ... + --enable-sql-user-management true \ + --enable-sql-database-management true \ + --admin-password "" + ``` - {{ TF }} {#tf} - 1. Open the current {{ TF }} configuration file with an infrastructure plan. + 1. Open the current {{ TF }} configuration file with an infrastructure plan. - For more information about how to create this file, see [Creating clusters](cluster-create.md). + For more information about creating this file, see [Creating clusters](cluster-create.md). - 1. {% include [Enable SQL user management with Terraform](../../_includes/mdb/mch/terraform/sql-management-users.md) %} + 1. {% include [Enable SQL user management with Terraform](../../_includes/mdb/mch/terraform/sql-management-users.md) %} - 1. {% include [Enable SQL database management with Terraform](../../_includes/mdb/mch/terraform/sql-management-databases.md) %} + 1. {% include [Enable SQL database management with Terraform](../../_includes/mdb/mch/terraform/sql-management-databases.md) %} - 1. Make sure the settings are correct. + 1. Make sure the settings are correct. - {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} + {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} - 1. Confirm updating the resources. + 1. Confirm updating the resources. - {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} + {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} - For more information, see the [{{ TF }} provider documentation]({{ tf-provider-mch }}). + For more information, see the [{{ TF }} provider documentation]({{ tf-provider-mch }}). - {% include [Terraform timeouts](../../_includes/mdb/mch/terraform/timeouts.md) %} + {% include [Terraform timeouts](../../_includes/mdb/mch/terraform/timeouts.md) %} - API {#api} - To enable user and database management via SQL, use the [update](../api-ref/Cluster/update.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Update](../api-ref/grpc/Cluster/update.md) gRPC API call and provide the appropriate values in the `configSpec.clickhouse.config` request parameter: + To enable user and database management via SQL, use the [update](../api-ref/Cluster/update.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Update](../api-ref/grpc/Cluster/update.md) gRPC API call and provide the appropriate values in the `configSpec.clickhouse.config` request parameter: - * `sqlUserManagement`: Set to `true` to enable [user management via SQL](cluster-users.md#sql-user-management). - * `sqlDatabaseManagement`: Set to `true` to enable [database management via SQL](databases.md#sql-database-management). User management via SQL needs to be enabled. - * `adminPassword`: Set a password for the `admin` account to use for management tasks. + * `sqlUserManagement`: Set to `true` to enable [user management through SQL](cluster-users.md#sql-user-management). + * `sqlDatabaseManagement`: Set to `true` to enable [database management through SQL](databases.md#sql-database-management). For that, you also need to enable user management through SQL. + * `adminPassword`: Set a password for the `admin` account to use for management tasks. {% endlist %} @@ -364,162 +364,162 @@ Once enabled, user and database management settings for SQL cannot be disabled. - Management console {#console} - 1. In the [management console]({{ link-console-main }}), go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. - 1. Select the cluster and click **{{ ui-key.yacloud.mdb.cluster.overview.button_action-edit }}** in the top panel. - 1. Under **{{ ui-key.yacloud.mdb.forms.section_service-settings }}**, change the additional cluster settings: + 1. In the [management console]({{ link-console-main }}), go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. + 1. Select the cluster and click **{{ ui-key.yacloud.mdb.cluster.overview.button_action-edit }}** in the top panel. + 1. Under **{{ ui-key.yacloud.mdb.forms.section_service-settings }}**, change the additional cluster settings: - {% include [mch-extra-settings](../../_includes/mdb/mch/extra-settings-web-console.md) %} + {% include [mch-extra-settings](../../_includes/mdb/mch/extra-settings-web-console.md) %} - 1. Click **{{ ui-key.yacloud.mdb.forms.button_edit }}**. + 1. Click **{{ ui-key.yacloud.mdb.forms.button_edit }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To change additional cluster settings: + To change additional cluster settings: - 1. View a description of the update cluster CLI command: + 1. View a description of the update cluster CLI command: - ```bash - {{ yc-mdb-ch }} cluster update --help - ``` + ```bash + {{ yc-mdb-ch }} cluster update --help + ``` - 1. Run the following command with a list of settings to update: + 1. Run the following command with a list of settings to update: - ```bash - {{ yc-mdb-ch }} cluster update \ - --backup-window-start \ - --datalens-access= \ - --metrika-access= \ - --serverless-access= \ - --websql-access= \ - --yandexquery-access= \ - --deletion-protection= \ - --maintenance-window type=,` - `day=,` - `hour= - ``` + ```bash + {{ yc-mdb-ch }} cluster update \ + --backup-window-start \ + --datalens-access= \ + --metrika-access= \ + --serverless-access= \ + --websql-access= \ + --yandexquery-access= \ + --deletion-protection= \ + --maintenance-window type=,` + `day=,` + `hour= + ``` - You can change the following settings: + You can change the following settings: - {% include [backup-window-start](../../_includes/mdb/cli/backup-window-start.md) %} + {% include [backup-window-start](../../_includes/mdb/cli/backup-window-start.md) %} - * `--datalens-access`: Enables access from {{ datalens-name }}. The default value is `false`. For more information about setting up a connection, see [Connecting from {{ datalens-name }}](datalens-connect.md). + * `--datalens-access`: Enables access from {{ datalens-name }}. The default value is `false`. For more information about setting up a connection, see [Connecting from {{ datalens-name }}](datalens-connect.md). - * `--metrika-access`: Enables [data import from AppMetrica to your cluster](https://appmetrica.yandex.com/docs/common/cloud/about.html). The default value is `false`. + * `--metrika-access`: Enables [data import from AppMetrica to your cluster](https://appmetrica.yandex.com/docs/common/cloud/about.html). The default value is `false`. - * `--serverless-access`: Enables cluster access from [{{ sf-full-name }}](../../functions/concepts/index.md). The default value is `false`. For more information about setting up access, see the [{{ sf-name }}](../../functions/operations/database-connection.md) documentation. + * `--serverless-access`: Enables cluster access from [{{ sf-full-name }}](../../functions/concepts/index.md). The default value is `false`. For more information about setting up access, see the [{{ sf-name }}](../../functions/operations/database-connection.md) documentation. - * `--websql-access`: Enables you to [run SQL queries](web-sql-query.md) to cluster databases from the {{ yandex-cloud }} management console using {{ websql-full-name }}. The default value is `false`. + * `--websql-access`: Enables you to [run SQL queries](web-sql-query.md) against cluster databases from the {{ yandex-cloud }} management console using {{ websql-full-name }}. The default value is `false`. - * `--yandexquery-access=true`: Enables cluster access from [{{ yq-full-name }}](../../query/concepts/index.md). This feature is at the [Preview](../../overview/concepts/launch-stages.md) stage. The default value is `false`. + * `--yandexquery-access=true`: Enables cluster access from [{{ yq-full-name }}](../../query/concepts/index.md). This feature is at the [Preview](../../overview/concepts/launch-stages.md) stage. Default value: `false`. - * {% include [deletion-protection](../../_includes/mdb/cli/deletion-protection.md) %} + * {% include [deletion-protection](../../_includes/mdb/cli/deletion-protection.md) %} - {% include [deletion-protection-limits-db](../../_includes/mdb/deletion-protection-limits-db.md) %} + {% include [deletion-protection-limits-db](../../_includes/mdb/deletion-protection-limits-db.md) %} - * `--maintenance-window`: [Maintenance window](../concepts/maintenance.md) settings (including for disabled clusters), where `type` is the maintenance type: + * `--maintenance-window`: [Maintenance window](../concepts/maintenance.md) settings (including for disabled clusters), where `type` is the maintenance type: - {% include [maintenance-window](../../_includes/mdb/cli/maintenance-window-description.md) %} + {% include [maintenance-window](../../_includes/mdb/cli/maintenance-window-description.md) %} - You can get the cluster ID and name [with a list of clusters in the folder](cluster-list.md#list-clusters). + You can get the cluster ID and name [with a list of clusters in the folder](cluster-list.md#list-clusters). - {{ TF }} {#tf} - 1. Open the current {{ TF }} configuration file with an infrastructure plan. + 1. Open the current {{ TF }} configuration file with an infrastructure plan. - For more information about how to create this file, see [Creating clusters](cluster-create.md). + For more information about creating this file, see [Creating clusters](cluster-create.md). - 1. To change the backup start time, add a `backup_window_start` block to the {{ mch-name }} cluster description: + 1. To change the backup start time, add a `backup_window_start` block to the {{ mch-name }} cluster description: - ```hcl - resource "yandex_mdb_clickhouse_cluster" "" { - ... - backup_window_start { - hours = - minutes = + ```hcl + resource "yandex_mdb_clickhouse_cluster" "" { + ... + backup_window_start { + hours = + minutes = + } + ... } - ... - } - ``` + ``` - 1. To enable cluster access from other services and [execution of SQL queries from the management console](web-sql-query.md) using {{ websql-full-name }}, change the values of the appropriate fields in the `access` section: + 1. To enable cluster access from other services and allow [running SQL queries from the management console](web-sql-query.md) using {{ websql-full-name }}, change the values of the appropriate fields in the `access` section: - ```hcl - resource "yandex_mdb_clickhouse_cluster" "" { - ... - access { - data_lens = - metrika = - serverless = - web_sql = - yandex_query = + ```hcl + resource "yandex_mdb_clickhouse_cluster" "" { + ... + access { + data_lens = + metrika = + serverless = + web_sql = + yandex_query = + } + ... } - ... - } - ``` + ``` - Where: + Where: - * `data_lens`: Access from {{ datalens-name }}, `true` or `false`. + * `data_lens`: Access from {{ datalens-name }}, `true` or `false`. - * `metrika`: Access from Yandex Metrica and AppMetrica, `true` or `false`. - * `serverless`: Access from {{ sf-name }}, `true` or `false`. + * `metrika`: Access from Yandex Metrica and AppMetrica, `true` or `false`. + * `serverless`: Access from {{ sf-name }}, `true` or `false`. - * `yandex_query`: Access from {{ yq-full-name }}, `true` or `false`. - * `web_sql`: Execution of SQL queries from the management console, `true` or `false`. + * `yandex_query`: Access from {{ yq-full-name }}, `true` or `false`. + * `web_sql`: Execution of SQL queries from the management console, `true` or `false`. - 1. {% include [Maintenance window](../../_includes/mdb/mch/terraform/maintenance-window.md) %} + 1. {% include [Maintenance window](../../_includes/mdb/mch/terraform/maintenance-window.md) %} - 1. To enable cluster protection against accidental deletion by a user of your cloud, add the `deletion_protection` field set to `true` to your cluster description: + 1. To enable cluster protection against accidental deletion by a user of your cloud, add the `deletion_protection` field set to `true` to your cluster description: - ```hcl - resource "yandex_mdb_clickhouse_cluster" "" { - ... - deletion_protection = - } - ``` + ```hcl + resource "yandex_mdb_clickhouse_cluster" "" { + ... + deletion_protection = + } + ``` - {% include [deletion-protection-limits-db](../../_includes/mdb/deletion-protection-limits-db.md) %} + {% include [deletion-protection-limits-db](../../_includes/mdb/deletion-protection-limits-db.md) %} - 1. Make sure the settings are correct. + 1. Make sure the settings are correct. - {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} + {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} - 1. Confirm updating the resources. + 1. Confirm updating the resources. - {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} + {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} - For more information, see the [{{ TF }} provider documentation]({{ tf-provider-resources-link }}/mdb_clickhouse_cluster). + For more information, see the [{{ TF }} provider documentation]({{ tf-provider-resources-link }}/mdb_clickhouse_cluster). - {% include [Terraform timeouts](../../_includes/mdb/mch/terraform/timeouts.md) %} + {% include [Terraform timeouts](../../_includes/mdb/mch/terraform/timeouts.md) %} - API {#api} - To change additional cluster settings, use the [update](../api-ref/Cluster/update.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Update](../api-ref/grpc/Cluster/update.md) gRPC API call and provide the following in the request: + To change additional cluster settings, use the [update](../api-ref/Cluster/update.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Update](../api-ref/grpc/Cluster/update.md) gRPC API call and provide the following in the request: - * Cluster ID in the `clusterId` parameter. To retrieve the ID, [get a list of clusters in the folder](./cluster-list.md#list-clusters). - * Settings for access from other services and access to SQL queries from the management console using {{ websql-full-name }} in the `configSpec.access` parameter. - * Backup window settings in the `configSpec.backupWindowStart` parameter. - * [Maintenance](../concepts/maintenance.md) window settings (including for disabled clusters) in the `maintenanceWindow` parameter. - * Cluster deletion protection settings in the `deletionProtection` parameter. + * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](./cluster-list.md#list-clusters). + * Settings for access from other services and access to SQL queries from the management console using {{ websql-full-name }} in the `configSpec.access` parameter. + * Backup window settings in the `configSpec.backupWindowStart` parameter. + * [Maintenance](../concepts/maintenance.md) window settings (including for disabled clusters) in the `maintenanceWindow` parameter. + * Cluster deletion protection settings in the `deletionProtection` parameter. - {% include [deletion-protection-limits-db](../../_includes/mdb/deletion-protection-limits-db.md) %} + {% include [deletion-protection-limits-db](../../_includes/mdb/deletion-protection-limits-db.md) %} - * List of cluster configuration fields to update in the `UpdateMask` parameter. + * List of cluster configuration fields to update in the `updateMask` parameter. - {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} + {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} {% endlist %} @@ -529,41 +529,41 @@ Once enabled, user and database management settings for SQL cannot be disabled. - Management console {#console} - 1. Go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. - 1. Click ![image](../../_assets/console-icons/ellipsis.svg) to the right of the cluster you want to move. - 1. Select **{{ ui-key.yacloud.common.move }}**. - 1. Select a folder you want to move the cluster to. - 1. Click **{{ ui-key.yacloud.mdb.dialogs.popup_button_move-cluster }}**. + 1. Go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. + 1. Click ![image](../../_assets/console-icons/ellipsis.svg) to the right of the cluster you want to move. + 1. Select **{{ ui-key.yacloud.common.move }}**. + 1. Select a folder you want to move the cluster to. + 1. Click **{{ ui-key.yacloud.mdb.dialogs.popup_button_move-cluster }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To move a cluster: + To move a cluster: - 1. View a description of the CLI move cluster command: + 1. View a description of the CLI move cluster command: - ```bash - {{ yc-mdb-ch }} cluster move --help - ``` + ```bash + {{ yc-mdb-ch }} cluster move --help + ``` - 1. Specify the destination folder in the move cluster command: + 1. Specify the destination folder in the move cluster command: - ```bash - {{ yc-mdb-ch }} cluster move \ - --destination-folder-name= - ``` + ```bash + {{ yc-mdb-ch }} cluster move \ + --destination-folder-name= + ``` - You can get the cluster ID with a [list of clusters in the folder](cluster-list.md#list-clusters). + You can get the cluster ID with a [list of clusters in the folder](cluster-list.md#list-clusters). - API {#api} - To move a cluster, use the [move](../api-ref/Cluster/move.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Move](../api-ref/grpc/Cluster/move.md) gRPC API call and provide the following in the request: + To move a cluster, use the [move](../api-ref/Cluster/move.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Move](../api-ref/grpc/Cluster/move.md) gRPC API call and provide the following in the request: - * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). - * ID of the destination folder in the `destinationFolderId` parameter. + * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). + * ID of the destination folder in the `destinationFolderId` parameter. {% endlist %} @@ -574,25 +574,25 @@ Once enabled, user and database management settings for SQL cannot be disabled. - Management console {#console} - 1. In the [management console]({{ link-console-main }}), go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. - 1. Select the cluster and click **{{ ui-key.yacloud.mdb.cluster.overview.button_action-edit }}** in the top panel. - 1. Under **{{ ui-key.yacloud.mdb.forms.section_network-settings }}**, select security groups for cluster network traffic. + 1. In the [management console]({{ link-console-main }}), go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-clickhouse }}**. + 1. Select the cluster and click **{{ ui-key.yacloud.mdb.cluster.overview.button_action-edit }}** in the top panel. + 1. Under **{{ ui-key.yacloud.mdb.forms.section_network-settings }}**, select security groups for cluster network traffic. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To edit the list of [security groups](../concepts/network.md#security-groups) for your cluster: + To edit the list of [security groups](../concepts/network.md#security-groups) for your cluster: - 1. View a description of the update cluster CLI command: + 1. View a description of the update cluster CLI command: ```bash {{ yc-mdb-ch }} cluster update --help ``` - 1. Specify the security groups in the update cluster command: + 1. Specify the security groups in the update cluster command: ```bash {{ yc-mdb-ch }} cluster update \ @@ -601,40 +601,40 @@ Once enabled, user and database management settings for SQL cannot be disabled. - {{ TF }} {#tf} - 1. Open the current {{ TF }} configuration file with an infrastructure plan. + 1. Open the current {{ TF }} configuration file with an infrastructure plan. - For more information about how to create this file, see [Creating clusters](cluster-create.md). + For more information about creating this file, see [Creating clusters](cluster-create.md). - 1. Change the value of the `security_group_ids` parameter in the cluster description: + 1. Change the value of the `security_group_ids` parameter in the cluster description: - ```hcl - resource "yandex_mdb_clickhouse_cluster" "" { - ... - security_group_ids = [ ] - } - ``` + ```hcl + resource "yandex_mdb_clickhouse_cluster" "" { + ... + security_group_ids = [ ] + } + ``` - 1. Make sure the settings are correct. + 1. Make sure the settings are correct. - {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} + {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} - 1. Confirm updating the resources. + 1. Confirm updating the resources. - {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} + {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} - For more information, see the [{{ TF }} provider documentation]({{ tf-provider-resources-link }}/mdb_clickhouse_cluster). + For more information, see the [{{ TF }} provider documentation]({{ tf-provider-resources-link }}/mdb_clickhouse_cluster). - {% include [Terraform timeouts](../../_includes/mdb/mch/terraform/timeouts.md) %} + {% include [Terraform timeouts](../../_includes/mdb/mch/terraform/timeouts.md) %} - API {#api} - To update security groups, use the [update](../api-ref/Cluster/update.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Update](../api-ref/grpc/Cluster/update.md) gRPC API call and provide the following in the request: + To update security groups, use the [update](../api-ref/Cluster/update.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Update](../api-ref/grpc/Cluster/update.md) gRPC API call and provide the following in the request: - * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). - * List of security group IDs in the `securityGroupIds` parameter. - * List of settings to update, in the `updateMask` parameter. + * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). + * List of security group IDs in the `securityGroupIds` parameter. + * List of settings to update, in the `updateMask` parameter. - {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} + {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} {% endlist %} @@ -651,19 +651,19 @@ You may need to additionally [set up security groups](connect/index.md#configuri - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To change [hybrid storage settings](../concepts/storage.md#hybrid-storage-settings): + To change [hybrid storage settings](../concepts/storage.md#hybrid-storage-settings): - 1. View a description of the update cluster CLI command: + 1. View a description of the update cluster CLI command: ```bash {{ yc-mdb-ch }} cluster update --help ``` - 1. If hybrid storage is disabled in the cluster, enable it: + 1. If hybrid storage is disabled in the cluster, enable it: ```bash {{ yc-mdb-ch }} cluster update \ @@ -672,14 +672,14 @@ You may need to additionally [set up security groups](connect/index.md#configuri {% include [Hybrid Storage cannot be switched off](../../_includes/mdb/mch/hybrid-storage-cannot-be-switched-off.md) %} - 1. Provide a list of settings to update: + 1. Provide a list of settings to update: ```bash {{ yc-mdb-ch }} cluster update \ --cloud-storage-data-cache= \ - --cloud-storage-data-cache-max-size= \ + --cloud-storage-data-cache-max-size= \ --cloud-storage-move-factor= \ - --cloud-storage-prefer-not-to-merge= + --cloud-storage-prefer-not-to-merge= ``` You can change the following settings: @@ -688,20 +688,20 @@ You may need to additionally [set up security groups](connect/index.md#configuri - API {#api} - To change hybrid storage settings, use the [update](../api-ref/Cluster/update.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Update](../api-ref/grpc/Cluster/update.md) gRPC API call and provide the following in the request: + To change hybrid storage settings, use the [update](../api-ref/Cluster/update.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Update](../api-ref/grpc/Cluster/update.md) gRPC API call and provide the following in the request: - * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). - * `true` value in the `configSpec.cloudStorage.enabled` parameter if hybrid storage is not enabled. + * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). + * `true` value in the `configSpec.cloudStorage.enabled` parameter if hybrid storage is not enabled. - {% include [Hybrid Storage cannot be switched off](../../_includes/mdb/mch/hybrid-storage-cannot-be-switched-off.md) %} + {% include [Hybrid Storage cannot be switched off](../../_includes/mdb/mch/hybrid-storage-cannot-be-switched-off.md) %} - * The [hybrid storage settings](../concepts/storage.md#hybrid-storage-settings) in the `configSpec.cloudStorage` parameters: + * The [hybrid storage settings](../concepts/storage.md#hybrid-storage-settings) in the `configSpec.cloudStorage` parameters: {% include [Hybrid Storage settings API](../../_includes/mdb/mch/hybrid-storage-settings-api.md) %} - * List of settings to update, in the `updateMask` parameter. + * List of settings to update, in the `updateMask` parameter. - {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} + {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} {% endlist %} diff --git a/en/managed-clickhouse/toc.yaml b/en/managed-clickhouse/toc.yaml index e189b33099d..9f4e07d5ec4 100644 --- a/en/managed-clickhouse/toc.yaml +++ b/en/managed-clickhouse/toc.yaml @@ -111,7 +111,7 @@ items: href: tutorials/clickhouse-for-graphite.md - name: Saving a {{ yds-full-name }} data stream in {{ mch-name }} href: tutorials/yds-to-clickhouse.md - - name: Migrating databases from Google BigQuery + - name: Migrating a database from Google BigQuery href: tutorials/bigquery-to-clickhouse.md - name: >- Delivering data from {{ mkf-name }} using {{ data-transfer-full-name @@ -125,6 +125,8 @@ items: Loading data from {{ objstorage-full-name }} to {{ mch-name }} using {{ data-transfer-full-name }} href: tutorials/object-storage-to-clickhouse.md + - name: Migrating a database from {{ GP }} to {{ CH }} + href: tutorials/greenplum-to-clickhouse.md - name: >- Migrating a database from {{ MY }} to {{ CH }} using {{ data-transfer-full-name }} @@ -548,7 +550,7 @@ items: href: api-ref/Versions/index.md - name: List href: api-ref/Versions/list.md - - name: '{{ monitoring-name }} metrics' + - name: '{{ monitoring-full-name }} metrics' href: metrics.md - name: '{{ at-name }} events' href: at-ref.md diff --git a/en/managed-clickhouse/tutorials/greenplum-to-clickhouse.md b/en/managed-clickhouse/tutorials/greenplum-to-clickhouse.md new file mode 100644 index 00000000000..7c6f200d2af --- /dev/null +++ b/en/managed-clickhouse/tutorials/greenplum-to-clickhouse.md @@ -0,0 +1,9 @@ +--- +canonical: '{{ link-docs }}/tutorials/dataplatform/greenplum-to-clickhouse' +--- + +# Migrating a database from {{ GP }} to {{ CH }} + +{% include [article-body](../../_tutorials/dataplatform/greenplum-to-clickhouse.md) %} + +{% include [clickhouse-disclaimer](../../_includes/clickhouse-disclaimer.md) %} diff --git a/en/managed-clickhouse/tutorials/index.md b/en/managed-clickhouse/tutorials/index.md index 2ef63344883..23d236ec28b 100644 --- a/en/managed-clickhouse/tutorials/index.md +++ b/en/managed-clickhouse/tutorials/index.md @@ -17,7 +17,7 @@ description: Various {{ mch-full-name }} use cases in {{ yandex-cloud }}. * [Analyzing {{ objstorage-full-name }} logs using {{ datalens-full-name }}](storage-logs-analysis.md) * [Configuring {{ mch-name }} for Graphite](clickhouse-for-graphite.md) * [{#T}](yds-to-clickhouse.md) -* [Migrating databases from Google BigQuery](bigquery-to-clickhouse.md) +* [Migrating a database from Google BigQuery](bigquery-to-clickhouse.md) * [Delivering data from {{ mkf-name }} using {{ data-transfer-full-name }}](mkf-to-mch-migration.md) * [Migrating data from {{ yandex-direct }} using {{ sf-full-name }}, {{ objstorage-full-name }}, and {{ data-transfer-full-name }}](transfer-from-direct.md) * [{#T}](object-storage-to-clickhouse.md) @@ -25,6 +25,7 @@ description: Various {{ mch-full-name }} use cases in {{ yandex-cloud }}. * [{#T}](rdbms-to-clickhouse.md) * [{#T}](opensearch-to-clickhouse.md) * [{#T}](ydb-to-clickhouse.md) +* [{#T}](greenplum-to-clickhouse.md) To learn how to migrate {{ mch-name }} cluster hosts to a different availability zone, see [this guide](../operations/host-migration.md). diff --git a/en/managed-elasticsearch/concepts/instance-types.md b/en/managed-elasticsearch/concepts/instance-types.md index 696179633ab..20e3105e1d4 100644 --- a/en/managed-elasticsearch/concepts/instance-types.md +++ b/en/managed-elasticsearch/concepts/instance-types.md @@ -12,6 +12,7 @@ keywords: The host class determines the computing power allocated for each host with the specific role in the cluster. When you change the host class for a role in the cluster, the configuration of all hosts with this role that were previously created in the cluster changes accordingly. For more information about roles, see [Resource relationships in the service](./index.md). + The following [disk types](./storage.md) are available to hosts with the [Data node role](./hosts-roles.md): * `network-ssd` @@ -21,14 +22,13 @@ The following [disk types](./storage.md) are available to hosts with the [Data n For hosts with the Master node role, the only available storage type is network SSD (`network-ssd`). - The available storage size does not depend on the host class. For storage limitations, see [Quotas and limits](limits.md). ## Available host classes {#available-flavors} -Hosts in {{ mes-name }} clusters are deployed on {{ compute-full-name }} VMs. You can create these VMs on any standard platform supported by {{ compute-name }}. For a detailed description of the platforms, see [{#T}](../../compute/concepts/vm-platforms.md). +Hosts in {{ mes-name }} clusters are deployed on {{ compute-full-name }} VMs. You can create these VMs on any standard platform supported by {{ compute-name }}. To learn more about the platforms, see [{#T}](../../compute/concepts/vm-platforms.md). The full list of possible host configurations on each platform is provided below. @@ -38,53 +38,53 @@ The full list of possible host configurations on each platform is provided below | Host class name | Number of vCPUs | Guaranteed vCPU share | RAM, GB | Disk
size, GB | |-------------------|-----------------|---------------------------|---------|----------------------| -| **Intel Cascade Lake** | -| m2.micro | 2 | 100% | 16 | 10 - 8184 | -| m2.small | 4 | 100% | 32 | 10 - 8184 | -| m2.medium | 6 | 100% | 48 | 10 - 8184 | -| m2.large | 8 | 100% | 64 | 10 - 8184 | -| m2.xlarge | 12 | 100% | 96 | 10 - 8184 | -| m2.2xlarge | 16 | 100% | 128 | 10 - 8184 | -| m2.3xlarge | 24 | 100% | 192 | 10 - 8184 | -| m2.4xlarge | 32 | 100% | 256 | 10 - 8184 | -| m2.5xlarge | 40 | 100% | 320 | 10 - 8184 | -| m2.6xlarge | 48 | 100% | 384 | 10 - 8184 | -| m2.7xlarge | 56 | 100% | 448 | 10 - 8184 | -| m2.8xlarge | 64 | 100% | 512 | 10 - 8184 | -| s2.micro | 2 | 100% | 8 | 10 - 8184 | -| s2.small | 4 | 100% | 16 | 10 - 8184 | -| s2.medium | 8 | 100% | 32 | 10 - 8184 | -| s2.large | 12 | 100% | 48 | 10 - 8184 | -| s2.xlarge | 16 | 100% | 64 | 10 - 8184 | -| s2.2xlarge | 24 | 100% | 96 | 10 - 8184 | -| s2.3xlarge | 32 | 100% | 128 | 10 - 8184 | -| s2.4xlarge | 40 | 100% | 160 | 10 - 8184 | -| s2.5xlarge | 48 | 100% | 192 | 10 - 8184 | -| s2.6xlarge | 64 | 100% | 256 | 10 - 8184 | -| **Intel Ice Lake** | 10 - 8184 | -| s3-c2-m8 | 2 | 100% | 8 | 10 - 8184 | -| s3-c4-m16 | 4 | 100% | 16 | 10 - 8184 | -| s3-c8-m32 | 8 | 100% | 32 | 10 - 8184 | -| s3-c12-m48 | 12 | 100% | 48 | 10 - 8184 | -| s3-c16-m64 | 16 | 100% | 64 | 10 - 8184 | -| s3-c24-m96 | 24 | 100% | 96 | 10 - 8184 | -| s3-c32-m128 | 32 | 100% | 128 | 10 - 8184 | -| s3-c40-m160 | 40 | 100% | 160 | 10 - 8184 | -| s3-c48-m192 | 48 | 100% | 192 | 10 - 8184 | -| s3-c64-m256 | 64 | 100% | 256 | 10 - 8184 | -| s3-c80-m320 | 80 | 100% | 320 | 10 - 8184 | -| s3-c96-m576 | 96 | 100% | 576 | 10 - 8184 | -| m3-c2-m16 | 2 | 100% | 16 | 10 - 8184 | -| m3-c4-m32 | 4 | 100% | 32 | 10 - 8184 | -| m3-c6-m48 | 6 | 100% | 48 | 10 - 8184 | -| m3-c8-m64 | 8 | 100% | 64 | 10 - 8184 | -| m3-c12-m96 | 12 | 100% | 96 | 10 - 8184 | -| m3-c16-m128 | 16 | 100% | 128 | 10 - 8184 | -| m3-c24-m192 | 24 | 100% | 192 | 10 - 8184 | -| m3-c32-m256 | 32 | 100% | 256 | 10 - 8184 | -| m3-c40-m320 | 40 | 100% | 320 | 10 - 8184 | -| m3-c48-m384 | 48 | 100% | 384 | 10 - 8184 | -| m3-c56-m448 | 56 | 100% | 448 | 10 - 8184 | -| m3-c64-m512 | 64 | 100% | 512 | 10 - 8184 | -| m3-c80-m640 | 80 | 100% | 640 | 10 - 8184 | +| **Intel Cascade Lake** | +| m2.micro | 2 | 100% | 16 | 10 - 8184 | +| m2.small | 4 | 100% | 32 | 10 - 8184 | +| m2.medium | 6 | 100% | 48 | 10 - 8184 | +| m2.large | 8 | 100% | 64 | 10 - 8184 | +| m2.xlarge | 12 | 100% | 96 | 10 - 8184 | +| m2.2xlarge | 16 | 100% | 128 | 10 - 8184 | +| m2.3xlarge | 24 | 100% | 192 | 10 - 8184 | +| m2.4xlarge | 32 | 100% | 256 | 10 - 8184 | +| m2.5xlarge | 40 | 100% | 320 | 10 - 8184 | +| m2.6xlarge | 48 | 100% | 384 | 10 - 8184 | +| m2.7xlarge | 56 | 100% | 448 | 10 - 8184 | +| m2.8xlarge | 64 | 100% | 512 | 10 - 8184 | +| s2.micro | 2 | 100% | 8 | 10 - 8184 | +| s2.small | 4 | 100% | 16 | 10 - 8184 | +| s2.medium | 8 | 100% | 32 | 10 - 8184 | +| s2.large | 12 | 100% | 48 | 10 - 8184 | +| s2.xlarge | 16 | 100% | 64 | 10 - 8184 | +| s2.2xlarge | 24 | 100% | 96 | 10 - 8184 | +| s2.3xlarge | 32 | 100% | 128 | 10 - 8184 | +| s2.4xlarge | 40 | 100% | 160 | 10 - 8184 | +| s2.5xlarge | 48 | 100% | 192 | 10 - 8184 | +| s2.6xlarge | 64 | 100% | 256 | 10 - 8184 | +| **Intel Ice Lake** | 10 - 8184 | +| s3-c2-m8 | 2 | 100% | 8 | 10 - 8184 | +| s3-c4-m16 | 4 | 100% | 16 | 10 - 8184 | +| s3-c8-m32 | 8 | 100% | 32 | 10 - 8184 | +| s3-c12-m48 | 12 | 100% | 48 | 10 - 8184 | +| s3-c16-m64 | 16 | 100% | 64 | 10 - 8184 | +| s3-c24-m96 | 24 | 100% | 96 | 10 - 8184 | +| s3-c32-m128 | 32 | 100% | 128 | 10 - 8184 | +| s3-c40-m160 | 40 | 100% | 160 | 10 - 8184 | +| s3-c48-m192 | 48 | 100% | 192 | 10 - 8184 | +| s3-c64-m256 | 64 | 100% | 256 | 10 - 8184 | +| s3-c80-m320 | 80 | 100% | 320 | 10 - 8184 | +| s3-c96-m576 | 96 | 100% | 576 | 10 - 8184 | +| m3-c2-m16 | 2 | 100% | 16 | 10 - 8184 | +| m3-c4-m32 | 4 | 100% | 32 | 10 - 8184 | +| m3-c6-m48 | 6 | 100% | 48 | 10 - 8184 | +| m3-c8-m64 | 8 | 100% | 64 | 10 - 8184 | +| m3-c12-m96 | 12 | 100% | 96 | 10 - 8184 | +| m3-c16-m128 | 16 | 100% | 128 | 10 - 8184 | +| m3-c24-m192 | 24 | 100% | 192 | 10 - 8184 | +| m3-c32-m256 | 32 | 100% | 256 | 10 - 8184 | +| m3-c40-m320 | 40 | 100% | 320 | 10 - 8184 | +| m3-c48-m384 | 48 | 100% | 384 | 10 - 8184 | +| m3-c56-m448 | 56 | 100% | 448 | 10 - 8184 | +| m3-c64-m512 | 64 | 100% | 512 | 10 - 8184 | +| m3-c80-m640 | 80 | 100% | 640 | 10 - 8184 | diff --git a/en/managed-elasticsearch/concepts/limits.md b/en/managed-elasticsearch/concepts/limits.md index 5768890f6c9..bb20761241a 100644 --- a/en/managed-elasticsearch/concepts/limits.md +++ b/en/managed-elasticsearch/concepts/limits.md @@ -1,6 +1,6 @@ --- title: Quotas and limits in {{ mes-name }} -description: '{{ mes-name }} has limits and quotas for the number of clusters, total number of processor cores for all hosts, total amount of RAM for all hosts, and total storage for all clusters per cloud. For more information about such restrictions, read this article.' +description: '{{ mes-name }} has limits and quotas for the number of clusters, total number of processor cores for all hosts, total amount of virtual memory for all hosts, and total storage for all clusters per cloud. For more information about the service restrictions, read this article.' --- diff --git a/en/managed-gitlab/operations/approval-rules.md b/en/managed-gitlab/operations/approval-rules.md index cd4461453ba..9b4dc77ba3c 100644 --- a/en/managed-gitlab/operations/approval-rules.md +++ b/en/managed-gitlab/operations/approval-rules.md @@ -7,16 +7,16 @@ description: Follow this guide to set up approval rules. With {{ mgl-name }}, you can flexibly set up mandatory approval rules before any code can be added to the target branch of the project. For more information on how approval rules work, see [Approval rules](../concepts/approval-rules.md). -Before getting started, [create a service account](create-user.md#create) with administrator privileges and [add it to your {{ GL }} project](create-user.md#add-to-project). Assign the `Maintainer` or `Owner` [role]({{ gl.docs }}/ee/user/permissions.html) to the account, as other roles do not provide enough permissions to set up approval rules. Next, log in to the {{ GL }} instance and set up the approval rules via the service account. +Before getting started, [create a service account](create-user.md#create) with administrator privileges and [add it to your {{ GL }} project](create-user.md#add-to-project). Assign the `Maintainer` or `Owner` [role]({{ gl.docs }}/ee/user/permissions.html) to the account, as other roles do not provide enough permissions to configure approval rules. Next, log in to the {{ GL }} instance and set up the approval rules via the service account. To use approval rules: -1. [{#T}](#gitlab-token) -1. [{#T}](#enable) -1. [{#T}](#rules) -1. [{#T}](#code-ownership) (available in **Standard** and **Advanced** [configurations](../concepts/approval-rules.md#packages)) +1. [{#T}](#gitlab-token). +1. [{#T}](#enable). +1. [{#T}](#rules). +1. [{#T}](#code-ownership) (available in **Standard** and **Advanced** [configurations](../concepts/approval-rules.md#packages)). -If necessary, enable [debugging mode](#debugging) and check out the [rules for handling exceptions](#exceptions). +If required, enable [debugging mode](#debugging) and check out the [rules for handling exceptions](#exceptions). ## Create a {{ GL }} token {#gitlab-token} @@ -31,65 +31,65 @@ To create a token: 1. In the window that opens, in the **Token name** field, enter a name to easily locate the token in your {{ GL }} project. 1. In the **Expiration date** field, specify the date when the token will expire. - The default value is one month from the creation date, while the maximum lifetime is one year. The token expires at midnight UTC on the specified day. + The default value is one month from the creation date, while the maximum lifetime is one year. The token expires at midnight UTC on the specified day. 1. Under **Select scopes**, select **api**. 1. Click **Create personal access token**. - A new token will be generated. + A new token will be generated. 1. Copy and save it. Later you will not be able to copy it in {{ GL }}. ## Enable approval rules {#enable} 1. Activate the {{ GL }} setting that prevents merging changes to the target branch until all threads in a merge request are resolved: - 1. Open your project in {{ GL }}. - 1. In the left-hand menu, select **Settings** → **Merge requests**. - 1. Under **Merge checks**, select **All threads must be resolved**. - 1. Click **Save changes**. + 1. Open your project in {{ GL }}. + 1. In the left-hand menu, select **Settings** → **Merge requests**. + 1. Under **Merge checks**, select **All threads must be resolved**. + 1. Click **Save changes**. 1. Add a system hook: - 1. Open your {{ GL }} instance. - 1. In the left-hand menu, select **Search or go to** → **Admin Area**. - 1. In the left-hand menu, select **System Hooks**. - 1. Click **Add new webhook**. - 1. Specify the hook parameters: - * **URL**: `http://localhost:24080/default`. - * In the **Trigger** section, disable all options except **Merge request events**, **Push events**, and **Repository update events**. - 1. Click **Add system hook**. + 1. Open your {{ GL }} instance. + 1. In the left-hand menu, select **Search or go to** → **Admin Area**. + 1. In the left-hand menu, select **System Hooks**. + 1. Click **Add new webhook**. + 1. Specify the hook parameters: + * **URL**: `http://localhost:24080/default`. + * In the **Trigger** section, disable all options except **Merge request events**, **Push events**, and **Repository update events**. + 1. Click **Add system hook**. 1. Enable the {{ GL }} setting which allows sending messages to the local network: - 1. Open your {{ GL }} instance. - 1. In the left-hand menu, select **Search or go to** → **Admin Area**. - 1. In the left-hand menu, select **Settings** → **Network**. - 1. In the **Outbound requests** section, enable the **Allow requests to the local network from system hooks** option. - 1. In the list of IP addresses and domain names, specify the `http://localhost:24080` URL. - 1. Click **Save changes**. + 1. Open your {{ GL }} instance. + 1. In the left-hand menu, select **Search or go to** → **Admin Area**. + 1. In the left-hand menu, select **Settings** → **Network**. + 1. In the **Outbound requests** section, enable the **Allow requests to the local network from system hooks** option. + 1. In the list of IP addresses and domain names, specify the `http://localhost:24080` URL. + 1. Click **Save changes**. 1. Enable approval rules in the {{ mgl-name }} instance: - 1. In the {{ yandex-cloud }} [management console]({{ link-console-main }}), select the [folder](../../resource-manager/concepts/resources-hierarchy.md#folder) where the [{{ GL }} instance](../concepts/index.md#instance) is located. - 1. Select **{{ mgl-name }}**. - 1. Select the instance and click ![image](../../_assets/console-icons/pencil.svg) **{{ ui-key.yacloud.common.edit }}** at the top of the page. - 1. In the **{{ ui-key.yacloud.gitlab.field_approval-rules }}** field, select the approval rule [configuration](../concepts/approval-rules.md#packages). + 1. In the {{ yandex-cloud }} [management console]({{ link-console-main }}), select the [folder](../../resource-manager/concepts/resources-hierarchy.md#folder) where the [{{ GL }} instance](../concepts/index.md#instance) is located. + 1. Select **{{ mgl-name }}**. + 1. Select the instance and click ![image](../../_assets/console-icons/pencil.svg) **{{ ui-key.yacloud.common.edit }}** at the top of the page. + 1. In the **{{ ui-key.yacloud.gitlab.field_approval-rules }}** field, select the approval rule [configuration](../concepts/approval-rules.md#packages). - {% include [note-approval-rules-pricing](../../_includes/managed-gitlab/note-approval-rules-pricing.md) %} + {% include [note-approval-rules-pricing](../../_includes/managed-gitlab/note-approval-rules-pricing.md) %} - 1. In the **{{ ui-key.yacloud.gitlab.field_approval-rules-token }}** field, specify the [token you created earlier](#gitlab-token). - 1. Click **{{ ui-key.yacloud.common.save }}**. + 1. In the **{{ ui-key.yacloud.gitlab.field_approval-rules-token }}** field, specify the [token you created earlier](#gitlab-token). + 1. Click **{{ ui-key.yacloud.common.save }}**. ## Set up the approval rules {#rules} -The approval rules for the repository are stored in the `APPROVALRULES` file in the root directory. The configuration is read from the [default branch]({{ gl.docs }}/ee/user/project/repository/branches/default.html) when running the instance and is automatically loaded at file update. +The approval rules for the repository are stored in the `APPROVALRULES` file in the root directory. The configuration is read from the [default branch]({{ gl.docs }}/ee/user/project/repository/branches/default.html) when running the instance and is automatically loaded when you modify the file. The file consists of two sections: * `ApprovalRules`: Describes the rules. -* `BranchGroups`: Describes what branches the rules apply to. +* `BranchGroups`: Describes which branches the rules apply to. -The `APPROVALRULES` file structure is as follows: +The structure of the `APPROVALRULES` file is as follows: ```text ApprovalRules: - : - approvers: - - + approvers: + - ... groups: - @@ -108,14 +108,14 @@ BranchGroups: Where: -* `approvers`: {{ GL }} user who can approve the merge request. -* `groups`: {{ GL }} group whose users can approve the merge request. -* `branches`: Branch the updates of which require approval. +* `approvers`: Name of the {{ GL }} user who can approve the merge request. +* `groups`: Name of the {{ GL }} group whose users can approve the merge request. +* `branches`: Branch with updates that require approval. * `rules`: Rule applied to the specified branches. -You can use the `*` wildcard instead of user names and in branch names. +You may use the `*` wildcard symbol instead of usernames and in branch names. -> For example, to apply the Four Eyes Principle to the repository master branch, add the following to the `APPROVALRULES` file: +> For example, to apply the _four-eyes principle_ to the repository master branch, add the following to the `APPROVALRULES` file: > > ```text > ApprovalRules: @@ -136,13 +136,13 @@ You can use the `*` wildcard instead of user names and in branch names. The feature is available in **Standard** and **Advanced** [configurations](../concepts/approval-rules.md#packages). -The Code Ownership settings for the repository are stored in the `CODEOWNERS` file in the root directory. The configuration is read from the [default branch]({{ gl.docs }}/ee/user/project/repository/branches/default.html) when running the instance and is automatically loaded at file update. +The code ownership settings for the repository are stored in the `CODEOWNERS` file in the root directory. The configuration is read from the [default branch]({{ gl.docs }}/ee/user/project/repository/branches/default.html) when running the instance and is automatically loaded when you modify the file. The file structure supports the [{{ GL }} syntax](https://docs.gitlab.com/ee/user/project/codeowners/reference.html), except for the use of user subgroups and email addresses as user IDs. {% note info %} -If multiple records in the `CODEOWNERS` file concurrently include the same file or directory, the rules from the most recent record apply. +If multiple records in the `CODEOWNERS` file include the same file or directory at once, the rules from the most recent record apply. {% endnote %} @@ -174,8 +174,8 @@ Issues related to the `APPROVALRULES` file are handled as follows: * If the file is missing from the repository, no approval rules apply to the repository's merge requests. * If the file is available but is configured incorrectly: - * An email notification of the error is sent to users with the `Maintainer` role. - * All merge requests of the repository are blocked. + * Users with the `Maintainer` role get an email notification about the error. + * All merge requests of the repository are blocked. ### Overriding the rules {#force-merge} diff --git a/en/managed-gitlab/operations/instance/instance-list.md b/en/managed-gitlab/operations/instance/instance-list.md index 9977fa287fd..7eefda9e079 100644 --- a/en/managed-gitlab/operations/instance/instance-list.md +++ b/en/managed-gitlab/operations/instance/instance-list.md @@ -14,7 +14,7 @@ You can get detailed information about each [{{ GL }} instance](../../concepts/i ## Getting detailed information about an instance {#get} -Instance details: +Instance details include: * Domain. * Status. * Resources: RAM, vCPU, storage size. @@ -34,12 +34,25 @@ Instance details: The list shows operations with instances and resources linked to them. +All actions with {{ mgl-name }} instances are logged as a list of operations. Each operation is assigned a unique ID. + {% list tabs group=instructions %} - Management console {#console} - 1. In the management console, select the [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder) where the {{ GL }} instance is located. + To get a list of operations for a specific instance: + + 1. In the [management console]({{ link-console-main }}), open the folder with the cluster. 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-gitlab }}**. - 1. Click the instance name and select the ![image](../../../_assets/console-icons/list-check.svg) **{{ ui-key.yacloud.common.operations-key-value }}** tab. + 1. In the left-hand panel, select ![image](../../../_assets/console-icons/server.svg) **{{ ui-key.yacloud.gitlab.switch_instances }}**. + 1. Select the instance you need. + 1. Go to the ![image](../../../_assets/console-icons/list-check.svg) **{{ ui-key.yacloud.common.operations-key-value }}** panel for the selected cluster. + + You will see the list of operations with the selected instance. + +{% endlist %} + + +#### See also {#see-also} -{% endlist %} \ No newline at end of file +* [{#T}](../../../api-design-guide/concepts/about-async.md) \ No newline at end of file diff --git a/en/managed-gitlab/operations/instance/instance-update.md b/en/managed-gitlab/operations/instance/instance-update.md index f9b011480b4..21300997d59 100644 --- a/en/managed-gitlab/operations/instance/instance-update.md +++ b/en/managed-gitlab/operations/instance/instance-update.md @@ -8,16 +8,25 @@ After creating a [{{ GL }} instance](../../concepts/index.md#instance), you can - Management console {#console} - 1. In the management console, select the [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder) where the [{{ GL }} instance](../../concepts/index.md#instance) is located. - 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-gitlab }}**. - 1. Select the instance and click ![image](../../../_assets/console-icons/pencil.svg) **{{ ui-key.yacloud.common.edit }}** at the top of the page. - 1. Under **{{ ui-key.yacloud.compute.group.overview.section_base }}**: + 1. In the management console, select the [folder](../../../resource-manager/concepts/resources-hierarchy.md#folder) where the [{{ GL }} instance](../../concepts/index.md#instance) is located. + 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-gitlab }}**. + 1. Select the instance and click ![image](../../../_assets/console-icons/pencil.svg) **{{ ui-key.yacloud.common.edit }}** at the top of the page. + 1. Under **{{ ui-key.yacloud.compute.group.overview.section_base }}**: * Specify a new instance name and description. + * Add [tags](../../../resource-manager/concepts/labels.md) to break instances into logical groups. * Set or remove instance protection against accidental deletion by the user. - 1. Under **{{ ui-key.yacloud.gitlab.label_configuration-section }}**, change the retention period for automatic backups (in days). + 1. Under **{{ ui-key.yacloud.gitlab.label_configuration-section }}**: - 1. Click **{{ ui-key.yacloud.common.save }}**. + * Change the automatic backup retention period, in days. + * Select the appropriate [configuration](../../concepts/approval-rules.md#packages) for approval rules. + + {% include [note-approval-rules-pricing](../../../_includes/managed-gitlab/note-approval-rules-pricing.md) %} + + * To activate the approval rules, specify a [{{ GL }} token](../approval-rules.md#gitlab-token). + + 1. Under **{{ ui-key.yacloud.gitlab.label_additional-section }}**, enable or disable deletion for untagged images. This setting affects the amount of free disk space on the instance. + 1. Click **{{ ui-key.yacloud.common.save }}**. {% endlist %} diff --git a/en/managed-greenplum/api-ref/Cluster/streamLogs.md b/en/managed-greenplum/api-ref/Cluster/streamLogs.md index 896fd2792e2..ab652200f46 100644 --- a/en/managed-greenplum/api-ref/Cluster/streamLogs.md +++ b/en/managed-greenplum/api-ref/Cluster/streamLogs.md @@ -64,7 +64,7 @@ To work with values in this field, use the APIs described in the In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || || recordToken | **string** -Record token. Set `recordToken` to the [StreamLogs.nextRecordToken](#yandex.cloud.mdb.greenplum.v1.StreamLogRecord) returned by the previous [StreamLogs](#StreamLogs) request to start streaming from the next log record. || +Record token. Set `recordToken` to the [StreamLogs.next_record_token] returned by the previous [StreamLogs](#StreamLogs) request to start streaming from the next log record. || || filter | **string** A filter expression that filters resources listed in the response. @@ -106,9 +106,9 @@ One of the requested log records. || This token allows you to continue streaming logs starting from the exact same record. -To do that, specify value of `nextRecordToken` as the value for [StreamLogs.recordToken](#yandex.cloud.mdb.greenplum.v1.StreamClusterLogsRequest) parameter in the next [StreamLogs](#StreamLogs) request. +To do that, specify value of `nextRecordToken` as the value for [StreamLogs.record_token] parameter in the next [StreamLogs](#StreamLogs) request. -This value is interchangeable with [ListLogs.nextPageToken](/docs/managed-greenplum/api-ref/Backup/list#yandex.cloud.mdb.greenplum.v1.ListBackupsResponse) from [ListLogs](/docs/managed-greenplum/api-ref/Cluster/listLogs#ListLogs) method. || +This value is interchangeable with [ListLogs.next_page_token] from [ListLogs](/docs/managed-greenplum/api-ref/Cluster/listLogs#ListLogs) method. || |# ## LogRecord {#yandex.cloud.mdb.greenplum.v1.LogRecord} diff --git a/en/managed-greenplum/api-ref/grpc/Cluster/streamLogs.md b/en/managed-greenplum/api-ref/grpc/Cluster/streamLogs.md index f36d8e44700..8fb16f4b1c9 100644 --- a/en/managed-greenplum/api-ref/grpc/Cluster/streamLogs.md +++ b/en/managed-greenplum/api-ref/grpc/Cluster/streamLogs.md @@ -56,7 +56,7 @@ If this field is not set, all existing logs are sent as well as the new ones as In essence it has `tail -f` semantics. || || recordToken | **string** -Record token. Set `recordToken` to the [StreamLogs.nextRecordToken](#yandex.cloud.mdb.greenplum.v1.StreamLogRecord) returned by the previous [StreamLogs](#StreamLogs) request to start streaming from the next log record. || +Record token. Set `recordToken` to the [StreamLogs.next_record_token] returned by the previous [StreamLogs](#StreamLogs) request to start streaming from the next log record. || || filter | **string** A filter expression that filters resources listed in the response. @@ -96,9 +96,9 @@ One of the requested log records. || This token allows you to continue streaming logs starting from the exact same record. -To do that, specify value of `nextRecordToken` as the value for [StreamLogs.recordToken](#yandex.cloud.mdb.greenplum.v1.StreamClusterLogsRequest) parameter in the next [StreamLogs](#StreamLogs) request. +To do that, specify value of `nextRecordToken` as the value for [StreamLogs.record_token] parameter in the next [StreamLogs](#StreamLogs) request. -This value is interchangeable with [ListLogs.nextPageToken](/docs/managed-greenplum/api-ref/grpc/Backup/list#yandex.cloud.mdb.greenplum.v1.ListBackupsResponse) from [ListLogs](/docs/managed-greenplum/api-ref/grpc/Cluster/listLogs#ListLogs) method. || +This value is interchangeable with [ListLogs.next_page_token] from [ListLogs](/docs/managed-greenplum/api-ref/grpc/Cluster/listLogs#ListLogs) method. || |# ## LogRecord {#yandex.cloud.mdb.greenplum.v1.LogRecord} diff --git a/en/managed-greenplum/concepts/backup.md b/en/managed-greenplum/concepts/backup.md index 25f886e4b41..4b424cdd74a 100644 --- a/en/managed-greenplum/concepts/backup.md +++ b/en/managed-greenplum/concepts/backup.md @@ -1,5 +1,6 @@ # Backups in {{ mgp-name }} + {{ mgp-short-name }} supports automatic and manual database backups. {{ mgp-short-name }} enables you to restore your cluster to a specific _recovery point_ where the data is consistent. This feature is known as Point-in-Time-Recovery (PITR). Recovery points are created every hour. When you specify a time to recover data for, the service will use the backup closest to that point in time. When recovering the selected cluster backup, records from write-ahead logs (WALs) will be added to the backup data up to the closest recovery point. @@ -8,25 +9,25 @@ For example, if the backup was created on November 10, 2022, 12:00:00 UTC, the c PITR mode is enabled by default. It supports automatic backups only. -To restore a cluster from a backup, follow [this guide](../operations/cluster-backups.md#restore). You can also restore your cluster to move its hosts to a different availability zone. You may need to do this, for example, if your cluster hosts reside in the `{{ region-id }}-c` availability zone which is to be [deprecated](/blog/posts/2023/08/new-availability-zone). +To restore a cluster from a backup, follow [this guide](../operations/cluster-backups.md#restore). You can also restore your cluster to move its hosts to a different availability zone. You may need to do this, e.g., if your hosts reside in the `{{ region-id }}-c` availability zone which is to be [deprecated](/blog/posts/2023/08/new-availability-zone). ## Creating backups {#size} The first and every second automatic backup, as well as all manually created backups are full backups of all databases. Other backups are incremental and store only the data that has changed since the previous backup to save space. -A backup is automatically created every day. You cannot disable automatic backups. However, for such backups, you can specify a time interval during which the backup will start when you [create](../operations/cluster-create.md) or [update](../operations/update.md#change-additional-settings) a cluster. The default time is `22:00 - 23:00` UTC (Coordinated Universal Time). +A backup is automatically created every day. You cannot disable automatic backups. However, for such backups, you can specify a time interval during which the backup will start when you [create](../operations/cluster-create.md) or [update](../operations/update.md#change-additional-settings) a cluster. The default time is `22:00 - 23:00` UTC (Coordinated Universal Time). After a backup is created, it is compressed for storage. Append-optimized tables use data deduplication technology: newly added data or old data last archived more than 30 days ago is copied. The backup size does not include the deduplicated part size, so the displayed value can be significantly smaller than the data size in the cluster. -Backups are only created on running clusters. If you do not use a {{ mgp-short-name }} cluster 24/7, check the [backup start time settings](../operations/update.md#change-additional-settings). +Backups are only created on running clusters. If you are not using your {{ mgp-short-name }} cluster 24/7, check the [settings of backup start time](../operations/update.md#change-additional-settings). For more information about creating a backup manually, see [Managing backups](../operations/cluster-backups.md#create-backup). ## Storing backups {#storage} -Specifics of storing backups in {{ mgp-name }}: +Storing backups in {{ mgp-name }}: -* Backups are stored in object storage as binary files and encrypted using [GPG](https://en.wikipedia.org/wiki/GNU_Privacy_Guard). Each cluster has its own encryption keys. +* Backups are stored in object storage as binary files and are encrypted using [GPG](https://en.wikipedia.org/wiki/GNU_Privacy_Guard). Each cluster has its own encryption keys. * {% include [backup-wal](../../_includes/mdb/mgp/backup-wal.md) %} diff --git a/en/managed-greenplum/concepts/index.md b/en/managed-greenplum/concepts/index.md index f89cb95de26..9db7a14a76d 100644 --- a/en/managed-greenplum/concepts/index.md +++ b/en/managed-greenplum/concepts/index.md @@ -1,6 +1,7 @@ # Resource relationships -The main entity used in the {{ mgp-name }} service is a _database cluster_. + +The main entity used in {{ mgp-name }} is a _database cluster_. Each cluster consists of database hosts, which are virtual machines with DBMS servers deployed on them. A {{ mgp-name }} cluster contains: @@ -18,23 +19,23 @@ Segment hosts have standalone DBMS's (_segments_) deployed on them. They store d The number of segments is the same for each host. When [expanding a cluster](../operations/hosts/cluster-expand.md), you can increase the number of segments. They will be added to all hosts — both new and existing ones. You cannot add segments to existing hosts without expanding the cluster. -All {{ mgp-name }} cluster hosts are located in a single availability zone: `{{ region-id }}-a`, `{{ region-id }}-b`, or `{{ region-id }}-d`. You cannot create hosts in `{{ region-id }}-c`, for it is being [discontinued](/blog/posts/2023/08/new-availability-zone). If you have hosts located in this availability zone, [restore your cluster from a backup](../operations/cluster-backups.md#restore). While restoring the cluster, specify a different availability zone. +All {{ mgp-name }} cluster hosts are placed in the same availability zone, `{{ region-id }}-a`, `{{ region-id }}-b`, or `{{ region-id }}-d`. You cannot create hosts in `{{ region-id }}-c` as it is to be [discontinued](/blog/posts/2023/08/new-availability-zone). If you have hosts located in this availability zone, [restore your cluster from a backup](../operations/cluster-backups.md#restore). While restoring the cluster, specify a different availability zone. VMs for cluster hosts can be hosted on: * _Regular {{ yandex-cloud }} hosts_: - These are physical servers for hosting cluster VMs. They are randomly selected from a pool of available hosts that meet the selected cluster configuration. + These are physical servers for hosting cluster VMs. They are randomly selected from a pool of available hosts that meet the selected cluster configuration. * _Dedicated {{ yandex-cloud }} hosts_: - These are physical servers that only host your VMs. VMs on dedicated hosts have all features of regular VMs; additionally, they are physically isolated from other users' VMs. + These are physical servers that only host your VMs. VMs on dedicated hosts have all features of regular VMs; additionally, they are physically isolated from other users' VMs. - Dedicated hosts are selected from _dedicated host groups_ specified when creating a cluster. + Dedicated hosts are selected from _dedicated host groups_ specified when creating a cluster. - For more information, see [{#T}](../../compute/concepts/dedicated-host.md). + For more information, see [{#T}](../../compute/concepts/dedicated-host.md). When creating a cluster, specify: @@ -42,8 +43,8 @@ When creating a cluster, specify: * _Host class_: Template for deploying cluster hosts. For a list of available host classes and their characteristics, see [Host classes](instance-types.md). * _Environment_: Environment where the cluster will be deployed: - * `PRODUCTION`: For stable versions of your apps. - * `PRESTABLE`: For testing purposes. The prestable environment is similar to the production environment and likewise covered by the SLA, but it is the first to get new functionalities, improvements, and bug fixes. In the prestable environment, you can test compatibility of new versions with your application. + * `PRODUCTION`: For stable versions of your apps. + * `PRESTABLE`: For testing purposes. The prestable environment is similar to the production environment and likewise covered by the SLA, but it is the first to get new functionalities, improvements, and bug fixes. In the prestable environment, you can test compatibility of new versions with your application. {% include [monitoring-access](../../_includes/mdb/monitoring-access.md) %} diff --git a/en/managed-greenplum/concepts/instance-types.md b/en/managed-greenplum/concepts/instance-types.md index e22edbc9454..5d7cf276955 100644 --- a/en/managed-greenplum/concepts/instance-types.md +++ b/en/managed-greenplum/concepts/instance-types.md @@ -1,12 +1,13 @@ # {{ GP }} host classes + The host class determines the computing power allocated for each host in a cluster. In a {{ mgp-name }} cluster, the classes of master hosts and segment hosts may differ. Once a cluster is created, you cannot change its host classes. For master hosts, the host class determines which [disk types](./storage.md) are available: -* **s2**, **i2**: `local-ssd` and `network-ssd-nonreplicated`. -* **s3**, **i3**: `network-ssd`, `network-hdd`, `local-ssd`, and `network-ssd-nonreplicated`. +* **s2**, **i2**: `local-ssd` and `network-ssd-nonreplicated` +* **s3**, **i3**: `network-ssd`, `network-hdd`, `local-ssd`, and `network-ssd-nonreplicated` For segment hosts, the following disk types are available: @@ -28,18 +29,18 @@ Configuration types: | Host class name | Number of vCPUs | vCPU performance | RAM, GB | Disk
size, GB | |-------------------|----------------:|:-----------------------:|--------:|----------------------| -| **Intel Cascade Lake** | -| s2.medium | 8 | 100% | 32 | 93 - 8184 | -| s2.large | 12 | 100% | 48 | 93 - 8184 | -| i2.2xlarge | 16 | 100% | 128 | 93 - 8184 | -| i2.4xlarge | 32 | 100% | 256 | 93 - 8184 | -| i2.5xlarge | 40 | 100% | 320 | 93 - 8184 | -| **Intel Ice Lake** | -| s3-c8-m32 | 8 | 100% | 32 | 10 - 8192 | -| s3-c12-m48 | 12 | 100% | 48 | 10 - 8192 | -| i3-c16-m128 | 16 | 100% | 128 | 10 - 8192 | -| i3-c32-m256 | 32 | 100% | 256 | 10 - 8192 | -| i3-c40-m320 | 40 | 100% | 320 | 10 - 8192 | +| **Intel Cascade Lake** | +| s2.medium | 8 | 100% | 32 | 93 - 8184 | +| s2.large | 12 | 100% | 48 | 93 - 8184 | +| i2.2xlarge | 16 | 100% | 128 | 93 - 8184 | +| i2.4xlarge | 32 | 100% | 256 | 93 - 8184 | +| i2.5xlarge | 40 | 100% | 320 | 93 - 8184 | +| **Intel Ice Lake** | +| s3-c8-m32 | 8 | 100% | 32 | 10 - 8192 | +| s3-c12-m48 | 12 | 100% | 48 | 10 - 8192 | +| i3-c16-m128 | 16 | 100% | 128 | 10 - 8192 | +| i3-c32-m256 | 32 | 100% | 256 | 10 - 8192 | +| i3-c40-m320 | 40 | 100% | 320 | 10 - 8192 | {% include [greenplum-trademark](../../_includes/mdb/mgp/trademark.md) %} diff --git a/en/managed-greenplum/concepts/limits.md b/en/managed-greenplum/concepts/limits.md index 0758e1bb5e2..667d6836351 100644 --- a/en/managed-greenplum/concepts/limits.md +++ b/en/managed-greenplum/concepts/limits.md @@ -1,12 +1,13 @@ --- title: Quotas and limits in {{ mgp-full-name }} -description: '{{ mpg-full-name }} has quotas and limits. For more information about the service restrictions, read this article.' +description: '{{ mgp-full-name }} has quotas and limits. For more information about the service restrictions, read this article.' editable: false --- # Quotas and limits in {{ mgp-name }} + {{ mgp-name }} has the following limits: {% include [quotes-limits-def.md](../../_includes/quotes-limits-def.md) %} diff --git a/en/managed-greenplum/concepts/network.md b/en/managed-greenplum/concepts/network.md index c9b74ffdba6..1efd2b87e50 100644 --- a/en/managed-greenplum/concepts/network.md +++ b/en/managed-greenplum/concepts/network.md @@ -37,7 +37,6 @@ Once you create a cluster, you cannot request or disable public addresses. ## Security groups {#security-groups} - {% note tip %} When connecting to a cluster from the same cloud network, [configure security groups](../operations/connect.md#configuring-security-groups) both for the cluster and the connecting host. @@ -46,7 +45,7 @@ When connecting to a cluster from the same cloud network, [configure security gr Specifics of working with security groups: -* To connect to a cluster, you [need rules](../operations/connect.md#configuring-security-groups) that allow traffic between the cluster and the connecting host, even if they are assigned to the same security group. +* To connect to a cluster, you [need rules](../operations/connect.md#configuring-security-groups) that allow traffic between the cluster and the connecting host, even if they are in the same security group. * Security group settings affect the ability to connect to the cluster, its performance, and the network connectivity between its hosts. diff --git a/en/managed-greenplum/concepts/storage.md b/en/managed-greenplum/concepts/storage.md index 788440e48fa..5c78bfab66c 100644 --- a/en/managed-greenplum/concepts/storage.md +++ b/en/managed-greenplum/concepts/storage.md @@ -1,6 +1,7 @@ # Disk types in {{ mgp-name }} + {{ mgp-name }} allows you to use network and local storage drives for database clusters. Network drives are based on network blocks, which are virtual disks in the {{ yandex-cloud }} infrastructure. Local disks are physically located on the cluster servers. {% include [storage-type](../../_includes/mdb/mgp/storage-type.md) %} @@ -25,7 +26,7 @@ If any host storage is more than 95% full, the cluster will switch to read-only In this mode, the `INSERT`, `DELETE`, or `UPDATE` queries result in an error. -### Monitoring the switch to read-only mode {#read-only-monitor} +### Monitoring the transition to read-only mode {#read-only-monitor} To monitor storage usage on cluster hosts, configure alerts in {{ monitoring-full-name }}: diff --git a/en/managed-greenplum/operations/cluster-backups.md b/en/managed-greenplum/operations/cluster-backups.md index 2a0dd2a93bd..529de36caf5 100644 --- a/en/managed-greenplum/operations/cluster-backups.md +++ b/en/managed-greenplum/operations/cluster-backups.md @@ -91,6 +91,7 @@ You can view your existing [backups](../concepts/backup.md) and restore clusters ## Restoring clusters from backups {#restore} + The Point-in-Time Recovery (PITR) technology enables you to restore cluster state to any recovery point created after saving a backup. For more information, see [Backups](../concepts/backup.md). When you restore a cluster from a backup, you create a new cluster with the backup data. If the folder has insufficient [resources](../concepts/limits.md) to create such a cluster, you will not be able to restore from the backup. @@ -203,7 +204,7 @@ If you set the current time as the recovery time, the new cluster will match the * `--segment-disk-type`: Segment host [disk type](../concepts/storage.md). * `--segment-host-count`: Number of segment hosts. * `--segment-in-host`: Number of [segments](../concepts/index.md) per host. - * `--restore-only`: (Optional) Comma-separated list of DBs and tables to restore from the backup. Supported formats: `//`, `/
` and ``. You may use the `*` wildcard symbol as well. If you omit this parameter, the whole cluster will be restored. + * `--restore-only`: (Optional) Comma-separated list of DBs and tables to restore from the backup. Supported formats: `//
`, `/
`, and ``. You may use the `*` wildcard symbol as well. If you omit this parameter, the whole cluster will be restored. * `--zone-id`: [Availability zone](../../overview/concepts/geo-scope.md). @@ -215,12 +216,12 @@ If you set the current time as the recovery time, the new cluster will match the To restore a cluster from a backup, use the [restore](../api-ref/Cluster/restore.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Restore](../api-ref/grpc/Cluster/restore.md) gRPC API call and provide the following in the request: - * Backup ID in the `backupId` parameter. To find out the ID, [retrieve a list of cluster backups](#list-backups). + * Backup ID in the `backupId` parameter. To find out the ID, [get a list of cluster backups](#list-backups). * Time point to which you want to restore the cluster, in the `time` parameter. By default, the cluster will be restored from a backup. * Number of segment hosts in the `segmentHostCount` parameter. * Number of [segments](../concepts/index.md) per host in the `segmentInHost` parameter. * Name of the new cluster that will contain the data recovered from the backup, in the `name` parameter. It must be unique within the folder. - * (Optional) Comma-separated list of DBs and tables to restore from the backup, in the `restoreOnly` parameter. Supported formats: `//
`, `/
` and ``. You may use the `*` wildcard symbol as well. If you omit this parameter, the whole cluster will be restored. + * (Optional) Comma-separated list of DBs and tables to restore from the backup, in the `restoreOnly` parameter. Supported formats: `//
`, `/
`, and ``. You may use the `*` wildcard symbol as well. If you omit this parameter, the whole cluster will be restored. By default, the cluster is restored to the same folder where the backup is stored. To restore the cluster to a different folder, specify its ID in the `folderId` parameter. diff --git a/en/managed-greenplum/operations/cluster-create.md b/en/managed-greenplum/operations/cluster-create.md index 5451cb86597..8498af73bd7 100644 --- a/en/managed-greenplum/operations/cluster-create.md +++ b/en/managed-greenplum/operations/cluster-create.md @@ -1,5 +1,6 @@ # Creating a {{ GP }} cluster + A {{ mgp-name }} cluster consists of master hosts that accept client queries and segment hosts that provide data processing and storage capability. Available disk types [depend](../concepts/storage.md) on the selected [host class](../concepts/instance-types.md). @@ -65,7 +66,7 @@ To create a {{ mgp-name }} cluster, you need the [{{ roles-vpc-user }}](../../vp {% note info %} - The names `admin`, `gpadmin`, [mdb_admin](../concepts/cluster-users.md#mdb_admin), `mdb_replication`, `monitor`, `none`, `postgres`, `public`, and `repl` are reserved for {{ mgp-name }}. You cannot create users with these names. + Such names as `admin`, `gpadmin`, [mdb_admin](../concepts/cluster-users.md#mdb_admin), `mdb_replication`, `monitor`, `none`, `postgres`, `public`, and `repl` are reserved for {{ mgp-name }}. You cannot create users with these names. {% endnote %} @@ -79,6 +80,7 @@ To create a {{ mgp-name }} cluster, you need the [{{ roles-vpc-user }}](../../vp {% include [Maintenance window](../../_includes/mdb/console/maintenance-window-description.md) %} * {% include [Datalens access](../../_includes/mdb/console/datalens-access.md) %} + * {% include [Deletion protection](../../_includes/mdb/console/deletion-protection.md) %} @@ -182,7 +184,7 @@ To create a {{ mgp-name }} cluster, you need the [{{ roles-vpc-user }}](../../vp * `PRODUCTION`: For stable versions of your apps. * `PRESTABLE`: For testing purposes. The prestable environment is similar to the production environment and likewise covered by the SLA, but it is the first to get new functionalities, improvements, and bug fixes. In the prestable environment, you can test compatibility of new versions with your application. * `--network-name`: [Network name](../../vpc/concepts/network.md#network). - * `--user-name`: Username. It may contain Latin letters, numbers, hyphens, and underscores, but must begin with a letter, number, or underscore. It must be from 1 to 32 characters long. + * `--user-name`: Username. It may contain Latin letters, numbers, hyphens, and underscores and must start with a letter, number, or underscore. It must be from 1 to 32 characters long. * `--user-password`: Password. It must be from 8 to 128 characters long. * `--master-config` and `--segment-config`: Master and segment host configuration: * `resource-id`: [Host class](../concepts/instance-types.md). @@ -194,7 +196,7 @@ To create a {{ mgp-name }} cluster, you need the [{{ roles-vpc-user }}](../../vp * `network-ssd-nonreplicated`. * `--zone-id`: [Availability zone](../../overview/concepts/geo-scope.md). - * `--subnet-id`: [Subnet ID](../../vpc/concepts/network.md#subnet). Specify if two or more subnets are created in the selected availability zone. + * `--subnet-id`: [Subnet ID](../../vpc/concepts/network.md#subnet). You need to specify the ID if the selected availability zone has two or more subnets. * `--assign-public-ip`: Flag used if [public access](../concepts/network.md#public-access-to-a-host) to the hosts is required, `true` or `false`. * `--security-group-ids`: List of [security group](../../vpc/concepts/security-groups.md) IDs. * `--deletion-protection`: Cluster deletion protection, `true` or `false`. @@ -251,6 +253,7 @@ To create a {{ mgp-name }} cluster, you need the [{{ roles-vpc-user }}](../../vp * `--datalens-access`: Access from {{ datalens-full-name }}, `true` or `false`. + - {{ TF }} {#tf} @@ -275,7 +278,6 @@ To create a {{ mgp-name }} cluster, you need the [{{ roles-vpc-user }}](../../vp ```hcl resource "yandex_vpc_network" "" { name = "" } - resource "yandex_vpc_subnet" "" { name = "" zone = "" @@ -303,7 +305,6 @@ To create a {{ mgp-name }} cluster, you need the [{{ roles-vpc-user }}](../../vp master_host_count = segment_host_count = segment_in_host = - master_subcluster { resources { resource_preset_id = "" @@ -311,7 +312,6 @@ To create a {{ mgp-name }} cluster, you need the [{{ roles-vpc-user }}](../../vp disk_type_id = "" } } - segment_subcluster { resources { resource_preset_id = "" @@ -339,7 +339,7 @@ To create a {{ mgp-name }} cluster, you need the [{{ roles-vpc-user }}](../../vp Enabled cluster deletion protection will not prevent a manual connection with the purpose to delete database contents. - For more details about resources you can create using {{ TF }}, see [the provider documentation]({{ tf-provider-mgp }}). + For more information about the resources you can create with {{ TF }}, see the [provider documentation]({{ tf-provider-mgp }}). 1. Check that the {{ TF }} configuration files are correct: @@ -355,7 +355,7 @@ To create a {{ mgp-name }} cluster, you need the [{{ roles-vpc-user }}](../../vp To create a {{ mgp-name }} cluster, use the [create](../api-ref/Cluster/create.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Create](../api-ref/grpc/Cluster/create.md) gRPC API call and provide the following in the request: - * ID of the folder where the cluster should be placed, in the `folderId` parameter. + * ID of the folder to host the cluster, in the `folderId` parameter. * Cluster name in the `name` parameter. * Cluster environment in the `environment` parameter. * {{ GP }} version in the `config.version` parameter. @@ -375,9 +375,11 @@ To create a {{ mgp-name }} cluster, you need the [{{ roles-vpc-user }}](../../vp * Public access settings in the `assignPublicIp` parameter. * Backup window settings in the `config.backupWindowStart` parameter. * Settings for access from [{{ datalens-full-name }}](../../datalens/concepts/index.md) in the `config.access.dataLens` parameter. + + * Settings for access from [{{ data-transfer-full-name }}](../../data-transfer/) in the `config.access.dataTransfer` parameter. * [Maintenance window](../concepts/maintenance.md) settings (including for disabled clusters) in the `maintenanceWindow` parameter. - * [DBMS settings](../concepts/settings-list.md#dbms-cluster-settings) in the `configSpec.greenplumConfig_` parameter. + * [DBMS settings](../concepts/settings-list.md#dbms-cluster-settings) in `configSpec.greenplumConfig_`. * [Routine maintenance operations](../concepts/maintenance.md#regular-ops) settings in the `configSpec.backgroundActivities.analyzeAndVacuum` parameter. * Cluster deletion protection settings in the `deletionProtection` parameter. @@ -387,7 +389,7 @@ To create a {{ mgp-name }} cluster, you need the [{{ roles-vpc-user }}](../../vp ## Creating a cluster copy {#duplicate} -You can create an {{ GP }} cluster with the settings of another one you previously created. To do so, you need to import the configuration of the source {{ GP }} cluster to {{ TF }}. This way, you can either create an identical copy or use the imported configuration as the baseline and modify it as needed. Importing a configuration is a good idea when the source {{ GP }} cluster has a lot of settings and you need to create a similar one. +You can create a {{ GP }} cluster with the settings of another one you previously created. To do so, you need to import the configuration of the source {{ GP }} cluster to {{ TF }}. This way you can either create an identical copy or use the imported configuration as the baseline and modify it as needed. Importing a configuration is a good idea when the source {{ GP }} cluster has a lot of settings and you need to create a similar one. To create an {{ GP }} cluster copy: @@ -469,21 +471,21 @@ To create an {{ GP }} cluster copy: Create a {{ mgp-name }} cluster with the following test specifications: - * Name: `gp-cluster`. - * Version: `{{ versions.cli.latest }}`. - * Environment: `PRODUCTION`. - * Network: `default`. - * User: `user1`. - * Password: `user1user1`. - * With master and segment hosts: + * Name: `gp-cluster` + * Version: `{{ versions.cli.latest }}` + * Environment: `PRODUCTION` + * Network: `default` + * User: `user1` + * Password: `user1user1` + * Master and segment hosts: * Class: `s2.medium` * With 100 GB local SSD (`local-ssd`) storage - * Availability zone: `{{ region-id }}-a`; subnet: `{{ subnet-id }}`. - * With public access to hosts. - * Security group: `{{ security-group }}`. - * With protection against accidental cluster deletion. + * Availability zone: `{{ region-id }}-a`; subnet: `{{ subnet-id }}` + * With public access to hosts + * Security group: `{{ security-group }}` + * With protection against accidental cluster deletion Run the following command: diff --git a/en/managed-greenplum/operations/cluster-list.md b/en/managed-greenplum/operations/cluster-list.md index 6be8b9dc59e..2a2748011c0 100644 --- a/en/managed-greenplum/operations/cluster-list.md +++ b/en/managed-greenplum/operations/cluster-list.md @@ -8,23 +8,23 @@ You can request detailed information about each {{ mgp-name }} cluster you creat - Management console {#console} - Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-greenplum }}**. + Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-greenplum }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To request a list of {{ GP }} clusters in a folder, run the following command: + To request a list of {{ GP }} clusters in a folder, run the following command: - ```bash - {{ yc-mdb-gp }} cluster list - ``` + ```bash + {{ yc-mdb-gp }} cluster list + ``` - API {#api} - To get a list of DB clusters in a folder, use the [list](../api-ref/Cluster/list.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/List](../api-ref/grpc/Cluster/list.md) gRPC API call. + To get a list of DB clusters in a folder, use the [list](../api-ref/Cluster/list.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/List](../api-ref/grpc/Cluster/list.md) gRPC API call. {% endlist %} @@ -34,60 +34,151 @@ You can request detailed information about each {{ mgp-name }} cluster you creat - Management console {#console} - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-greenplum }}**. - 1. Click the cluster name. + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-greenplum }}**. + 1. Click the cluster name. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To get information about a {{ GP }} cluster, run the following command: + To get information about a {{ GP }} cluster, run the following command: - ```bash - {{ yc-mdb-gp }} cluster get - ``` + ```bash + {{ yc-mdb-gp }} cluster get + ``` - You can request the cluster ID and name with a [list of clusters in the folder](#list-clusters). + You can request the cluster ID and name with a [list of clusters in the folder](#list-clusters). - API {#api} - To get cluster details, use the [get](../api-ref/Cluster/get.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Get](../api-ref/grpc/Cluster/get.md) gRPC API call and provide the cluster ID in the `clusterId` request parameter. + To get cluster details, use the [get](../api-ref/Cluster/get.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Get](../api-ref/grpc/Cluster/get.md) gRPC API call and provide the cluster ID in the request. - You can get the cluster ID with a [list of clusters in the folder](#list-clusters). + You can get the cluster ID with a [list of clusters in the folder](#list-clusters). {% endlist %} -## Viewing a list of operations in a cluster {#list-operations} +## Viewing operations with clusters {#list-operations} + +All actions with {{ mgp-name }} clusters are logged as a list of operations. Each operation is assigned a unique ID. + +### Getting a list of operations {#get-operations} {% list tabs group=instructions %} - Management console {#console} - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-greenplum }}**. - 1. Click the cluster name and select the ![operations.svg](../../_assets/console-icons/list-check.svg) **{{ ui-key.yacloud.common.operations-key-value }}** tab. + To get a list of operations for a cluster: + + 1. In the [management console]({{ link-console-main }}), open the folder with the cluster. + 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-greenplum }}**. + 1. In the left-hand panel, select ![image](../../_assets/console-icons/cubes-3.svg) **{{ ui-key.yacloud.mdb.clusters.label_title }}**. + 1. Select the cluster you need. + 1. Go to the ![image](../../_assets/console-icons/list-check.svg) **{{ ui-key.yacloud.common.operations-key-value }}** panel for the selected cluster. + + You will see a list of operations with the selected cluster. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} + + {% include [default-catalogue](../../_includes/default-catalogue.md) %} + + To get a list of operations for a {{ mgp-name }} cluster, run this command: + + ```bash + yc managed-greenplum cluster list-operations + ``` - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + Result: - To get a list of operations, run the following command: + ```text + +----------------------+---------------------+----------------------+---------------------+--------+--------------------------+ + | ID | CREATED AT | CREATED BY | MODIFIED AT | STATUS | DESCRIPTION | + +----------------------+---------------------+----------------------+---------------------+--------+--------------------------+ + | dqh0ntf6batm******** | 2024-09-07 16:36:46 | aje9k8luj4qf******** | 2024-09-07 16:44:12 | DONE | Create Greenplum cluster | + +----------------------+---------------------+----------------------+---------------------+--------+--------------------------+ + ``` - ```bash - {{ yc-mdb-gp }} cluster list-operations - ``` + You can get the cluster ID and name with a [list of clusters in the folder](#list-clusters). - You can request the cluster ID and name with a [list of clusters in the folder](#list-clusters). + By default, information about operations is provided as text. To get detailed information, specify the `yaml` or `json` output data format using the `--format` flag: + + ```bash + yc managed-greenplum cluster list-operations c9qk2926qqu9******** --format yaml + ``` + + Result: + + ```text + - id: dqh0ntf6batm******** + description: Create Greenplum cluster + created_at: "2024-09-07T16:36:46.816682Z" + created_by: aje9k8luj4qf******** + modified_at: "2024-09-07T16:44:12.944302Z" + done: true + metadata: + '@type': type.googleapis.com/yandex.cloud.mdb.greenplum.v1.CreateClusterMetadata + cluster_id: c9q13q0acgv7******** + response: + '@type': type.googleapis.com/google.rpc.Status + message: OK + ``` - API {#api} - To get a list of operations, use the [listOperations](../api-ref/Cluster/listOperations.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/ListOperations](../api-ref/grpc/Cluster/listOperations.md) gRPC API call and provide the cluster ID in the `clusterId` request parameter. + Use the [listOperations](../api-ref/Cluster/listOperations.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/ListOperations](../api-ref/grpc/Cluster/listOperations.md) gRPC API call and provide the cluster ID in the request. - You can get the cluster ID with a [list of clusters in the folder](#list-clusters). + You can get the cluster ID with a [list of clusters in the folder](#list-clusters). {% endlist %} +### Getting detailed information about an operation {#get-operations-info} + +1. [Get a list of operations](#get-operations) for the cluster. +1. Copy the ID of the operation. +1. Get detailed information about the operation: + + {% list tabs group=instructions %} + + - CLI {#cli} + + {% include [cli-install](../../_includes/cli-install.md) %} + + {% include [default-catalogue](../../_includes/default-catalogue.md) %} + + Run this command: + + ```bash + yc operation get + ``` + + Result: + + ```text + id: dqh0ntf6batm******** + description: Create Greenplum cluster + created_at: "2024-09-07T16:36:46.816682Z" + created_by: aje9k8luj4qf******** + modified_at: "2024-09-07T16:44:12.944302Z" + done: true + metadata: + '@type': type.googleapis.com/yandex.cloud.mdb.greenplum.v1.CreateClusterMetadata + cluster_id: c9q13q0acgv7******** + response: + '@type': type.googleapis.com/yandex.cloud.mdb.greenplum.v1.Cluster + ... + ``` + + - API {#api} + + Use the [get](../api-ref/Cluster/get.md) REST API method for the [Operation](../api-ref/Operation/index.md) resource or the [OperationService/Get](../api-ref/grpc/Operation/get.md) gRPC API call and provide the operation ID in the request. + + {% endlist %} + +### See also {#see-also} + +* [{#T}](../../api-design-guide/concepts/about-async.md) + {% include [greenplum-trademark](../../_includes/mdb/mgp/trademark.md) %} diff --git a/en/managed-greenplum/operations/connect.md b/en/managed-greenplum/operations/connect.md index 067b9fe0d10..2d372c159b3 100644 --- a/en/managed-greenplum/operations/connect.md +++ b/en/managed-greenplum/operations/connect.md @@ -11,9 +11,13 @@ You can connect to a cluster: ## Configuring security groups {#configuring-security-groups} -{% include [sg-rules](../../_includes/mdb/sg-rules-connect.md) %} +You can assign one or more security groups to a {{ mgp-name }} cluster. To connect to a cluster, security groups must include rules allowing traffic on {{ port-mgp }} port from certain IP addresses or other security groups. -To ensure {{ mgp-name }} cluster functionality and network connectivity between its hosts, you need at least one cluster security group to include rules allowing any incoming and outgoing traffic from any IPs using any protocol. +{% note info %} + +A security group assigned to a cluster controls traffic between the cluster and other cloud or external resources. You do not need to configure interaction between cluster hosts as it is controlled by a separate system security group. + +{% endnote %} Rule settings depend on the connection method you select: @@ -25,17 +29,31 @@ Rule settings depend on the connection method you select: - From a VM in {{ yandex-cloud }} {#cloud} - 1. {% include [Cluster security group rules](../../_includes/mdb/mgp/cluster-sg-rules.md) %} + 1. Add the following rules to the cluster security group: + + 1. For incoming traffic: + + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-port-range }}**: `{{ port-mgp }}`. + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-protocol }}**: `{{ ui-key.yacloud.common.label_tcp }}`. + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-source }}**: `{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-sg-type }}`. + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-sg-type }}**: If your cluster and VM are in the same security group, select `{{ ui-key.yacloud.vpc.network.security-groups.forms.value_sg-rule-sg-type-self }}` (`Self`). Otherwise, specify the VM security group. + + 1. For outgoing traffic: - 1. [Configure the security group](../../vpc/operations/security-group-add-rule.md) where the VM is located to enable connections to the VM and traffic between the VM and the cluster hosts. + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-port-range }}**: `{{ port-any }}`. + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-protocol }}**: `{{ ui-key.yacloud.vpc.network.security-groups.forms.value_any }}` (`Any`). + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-source }}**: `{{ ui-key.yacloud.vpc.network.security-groups.forms.value_sg-rule-destination-cidr }}`. + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-cidr-blocks }}**: `0.0.0.0/0`. + + This rule enables {{ mgp-name }} to use external data sources, e.g., PXF or GPFDIST. - For example, you can set the following rules for a VM: + 1. [Configure the security group](../../vpc/operations/security-group-add-rule.md) where the VM is located to allow connections to the VM and traffic between the VM and the cluster hosts. * For incoming traffic: * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-port-range }}**: `22`. * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-protocol }}**: `{{ ui-key.yacloud.common.label_tcp }}`. * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-source }}**: `{{ ui-key.yacloud.vpc.network.security-groups.forms.value_sg-rule-destination-cidr }}`. - * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-cidr-blocks }}**: `0.0.0.0/0`. + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-cidr-blocks }}**: Range of addresses to connect from. This rule allows you to connect to a VM over SSH. @@ -163,7 +181,7 @@ Create a new server connection: 1. In the **Parameters** tab: - * Set **SSL mode** to `verify-full`. + * Set the **SSL mode** parameter to `verify-full`. * Add a new **Root certificate** parameter and specify the path to the saved SSL certificate file in it. 1. Click **Save** to save the server connection settings. diff --git a/en/managed-greenplum/operations/hosts/host-migration.md b/en/managed-greenplum/operations/hosts/host-migration.md index 32108ef38ed..aa524aeb167 100644 --- a/en/managed-greenplum/operations/hosts/host-migration.md +++ b/en/managed-greenplum/operations/hosts/host-migration.md @@ -4,6 +4,7 @@ All {{ mgp-name }} cluster hosts are located in the same {{ yandex-cloud }} [ava {% include [zone-d-disk-restrictions](../../../_includes/mdb/ru-central1-d-local-ssd.md) %} + ## Specifics of migration in {{ data-transfer-full-name }} {#data-transfer} If your cluster acts as an [endpoint](../../../data-transfer/concepts/index.md#endpoint) at data transfer using {{ data-transfer-name }}: diff --git a/en/managed-greenplum/operations/update.md b/en/managed-greenplum/operations/update.md index e00e6403b2d..52f1da9685f 100644 --- a/en/managed-greenplum/operations/update.md +++ b/en/managed-greenplum/operations/update.md @@ -5,19 +5,20 @@ description: Follow this guide to change {{ GP }} cluster settings. # Updating {{ GP }} cluster settings + After creating a cluster, you can: -* [{#T}](#change-name-and-description) +* [{#T}](#change-name-and-description). -* [{#T}](#change-public-access) +* [{#T}](#change-public-access). -* [{#T}](#change-additional-settings) +* [{#T}](#change-additional-settings). -* [{#T}](#change-gp-settings) +* [{#T}](#change-gp-settings). -* [{#T}](#change-resource-preset) +* [{#T}](#change-resource-preset). -* [{#T}](#change-disk-size) +* [{#T}](#change-disk-size). * [Configure {{ GP }} servers according to the {{ GP }} documentation](#change-gp-settings). @@ -31,32 +32,32 @@ If you use [external data sources](../concepts/external-tables.md) for PXF opera - Management console {#console} - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-greenplum }}**. - 1. Select the cluster and click **{{ ui-key.yacloud.mdb.cluster.overview.button_action-edit }}** at the top of the page. - 1. Under **{{ ui-key.yacloud.mdb.forms.section_base }}**, enter a new name and description for the cluster. - 1. Click **{{ ui-key.yacloud.common.save }}**. + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-greenplum }}**. + 1. Select the cluster and click **{{ ui-key.yacloud.mdb.cluster.overview.button_action-edit }}** at the top of the page. + 1. Under **{{ ui-key.yacloud.mdb.forms.section_base }}**, enter a new name and description for the cluster. + 1. Click **{{ ui-key.yacloud.common.save }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To change the name and description of a {{ GP }} cluster: + To change the name and description of a {{ GP }} cluster: - 1. View the current name (`name`) and description (`description`) of the cluster: + 1. View the current `name` and `description` of the cluster: - ```bash - {{ yc-mdb-gp }} cluster get - ``` + ```bash + {{ yc-mdb-gp }} cluster get + ``` - 1. View a description of the update cluster configuration CLI command: + 1. View a description of the update cluster configuration CLI command: ```bash {{ yc-mdb-gp }} cluster update --help ``` - 1. Enter a new name and description for the cluster: + 1. Enter a new name and description for the cluster: ```bash {{ yc-mdb-gp }} cluster update \ @@ -66,14 +67,14 @@ If you use [external data sources](../concepts/external-tables.md) for PXF opera - API {#api} - To change a cluster's name and description, use the [update](../api-ref/Cluster/update.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Update](../api-ref/grpc/Cluster/update.md) gRPC API call and provide the following in the request: + To change a cluster's name and description, use the [update](../api-ref/Cluster/update.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Update](../api-ref/grpc/Cluster/update.md) gRPC API call and provide the following in the request: - * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). - * A new name in the `name` parameter. - * A new description in the `description` parameter. - * List of cluster configuration fields to update in the `updateMask` parameter (in this case, `name` and `description`). + * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). + * New name in the `name` parameter. + * New description in the `description` parameter. + * List of updatable cluster configuration fields in the `updateMask` parameter (in this case, `name`, `description`). - {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} + {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} {% endlist %} @@ -83,26 +84,26 @@ If you use [external data sources](../concepts/external-tables.md) for PXF opera - Management console {#console} - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ mgp-name }}**. - 1. Select the cluster and click **{{ ui-key.yacloud.mdb.cluster.overview.button_action-edit }}** at the top of the page. - 1. Under **{{ ui-key.yacloud.mdb.forms.section_network-settings }}**, enable or disable **{{ ui-key.yacloud.mdb.hosts.dialog.field_public_ip }}**. - 1. Click **{{ ui-key.yacloud.common.save }}**. + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ mgp-name }}**. + 1. Select the cluster and click **{{ ui-key.yacloud.mdb.cluster.overview.button_action-edit }}** at the top of the page. + 1. Under **{{ ui-key.yacloud.mdb.forms.section_network-settings }}**, enable or disable **{{ ui-key.yacloud.mdb.hosts.dialog.field_public_ip }}**. + 1. Click **{{ ui-key.yacloud.common.save }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To сhange the public access setting {{ GP }}: + To change the public access setting {{ GP }}: - 1. View a description of the update cluster configuration CLI command: + 1. View a description of the update cluster configuration CLI command: ```bash {{ yc-mdb-gp }} cluster update --help ``` - 1. Configure public access in the `--assign-public-ip` parameter: + 1. Configure public access in the `--assign-public-ip` parameter: ```bash {{ yc-mdb-gp }} cluster update \ @@ -113,13 +114,13 @@ If you use [external data sources](../concepts/external-tables.md) for PXF opera - API {#api} - Use the [update](../api-ref/Cluster/update.md) API method and include the following in the request: + Use the [update](../api-ref/Cluster/update.md) API method and include the following in the request: - * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). - * Public access setting in the `config.assignPublicIp` parameter. - * List of cluster configuration fields to update in the `updateMask` parameter (in this case, `name` and `description`). + * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). + * Public access settings in the `config.assignPublicIp` parameter. + * List of updatable cluster configuration fields in the `updateMask` parameter (in this case, `name`, `description`). - {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} + {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} {% endlist %} @@ -138,105 +139,109 @@ If you enabled public access to the cluster but cannot access it from the inter - Management console {#console} - 1. Go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-greenplum }}**. - 1. Select the cluster and click **{{ ui-key.yacloud.mdb.cluster.overview.button_action-edit }}** in the top panel. - 1. Change additional cluster settings: + 1. Go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-greenplum }}**. + 1. Select the cluster and click **{{ ui-key.yacloud.mdb.cluster.overview.button_action-edit }}** in the top panel. + 1. Change additional cluster settings: - * {% include [Backup time](../../_includes/mdb/console/backup-time.md) %} - * **{{ ui-key.yacloud.mdb.forms.maintenance-window-type }}**: [Maintenance window](../concepts/maintenance.md) settings: + * {% include [Backup time](../../_includes/mdb/console/backup-time.md) %} + * **{{ ui-key.yacloud.mdb.forms.maintenance-window-type }}**: [Maintenance](../concepts/maintenance.md) settings: - {% include [Maintenance window](../../_includes/mdb/console/maintenance-window-description.md) %} + {% include [Maintenance window](../../_includes/mdb/console/maintenance-window-description.md) %} - * {% include [Datalens access](../../_includes/mdb/console/datalens-access.md) %} + * {% include [Datalens access](../../_includes/mdb/console/datalens-access.md) %} + - * {% include [Deletion protection](../../_includes/mdb/console/deletion-protection.md) %} + * {% include [Deletion protection](../../_includes/mdb/console/deletion-protection.md) %} - {% include [Deletion protection limits](../../_includes/mdb/deletion-protection-limits-db.md) %} + {% include [Deletion protection limits](../../_includes/mdb/deletion-protection-limits-db.md) %} - * **{{ ui-key.yacloud.greenplum.section_cloud-storage }}**: Activates the {{ yandex-cloud }} [{{ YZ }} extension](https://github.com/yezzey-gp/yezzey/). This extension is used to export [AO and AOCO tables](../tutorials/yezzey.md) from disks within the {{ mgp-name }} cluster to a cold storage in {{ objstorage-full-name }}. This way, the data will be stored in a service bucket in a compressed and encrypted form. This is a [more cost-efficient storage method](../../storage/pricing.md). + * **{{ ui-key.yacloud.greenplum.section_cloud-storage }}**: Activates the {{ yandex-cloud }} [{{ YZ }} extension](https://github.com/yezzey-gp/yezzey/). This extension is used to export [AO and AOCO tables](../tutorials/yezzey.md) from disks within the {{ mgp-name }} cluster to a cold storage in {{ objstorage-full-name }}. This way, the data will be stored in a service bucket in a compressed and encrypted form. This is a [more cost-efficient storage method](../../storage/pricing.md). - You cannot disable this option after you save your cluster settings. + You cannot disable this option after you save your cluster settings. - {% note info %} + {% note info %} - This feature is at the [Preview](../../overview/concepts/launch-stages.md) stage and is free of charge. + This feature is at the [Preview](../../overview/concepts/launch-stages.md) stage and is free of charge. - {% endnote %} + {% endnote %} - * **{{ ui-key.yacloud.mdb.forms.section_pooler }}**: Operation mode and parameters of the [connection pooler](../concepts/pooling.md): + * **{{ ui-key.yacloud.mdb.forms.section_pooler }}**: Operation mode and parameters of the [connection pooler](../concepts/pooling.md): - {% include [Pooling mode](../../_includes/mdb/mgp/pooling-mode.md) %} + {% include [Pooling mode](../../_includes/mdb/mgp/pooling-mode.md) %} - 1. Click **{{ ui-key.yacloud.common.save }}**. + 1. Click **{{ ui-key.yacloud.common.save }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To change additional cluster settings: + To change additional cluster settings: - 1. View a description of the update cluster CLI command: + 1. View a description of the update cluster CLI command: - ```bash - {{ yc-mdb-gp }} cluster update --help - ``` + ```bash + {{ yc-mdb-gp }} cluster update --help + ``` - 1. Run the following command with a list of settings to update: + 1. Run the following command with a list of settings to update: - ```bash - {{ yc-mdb-gp }} cluster update \ - --backup-window-start \ - --datalens-access= \ - --maintenance-window type=,` - `day=,` - `hour= \ - --assign-public-ip= \ - --deletion-protection= - ``` + ```bash + {{ yc-mdb-gp }} cluster update \ + --backup-window-start \ + --datalens-access= \ + --maintenance-window type=,` + `day=,` + `hour= \ + --assign-public-ip= \ + --deletion-protection= + ``` - You can change the following settings: + You can change the following settings: - {% include [backup-window-start](../../_includes/mdb/cli/backup-window-start.md) %} + {% include [backup-window-start](../../_includes/mdb/cli/backup-window-start.md) %} - * `--datalens-access`: Enables [{{ datalens-full-name }}](../../datalens/concepts/index.md) access. The default value is `false`. + * `--datalens-access`: Enables access from [{{ datalens-full-name }}](../../datalens/concepts/index.md). The default value is `false`. + - * `--maintenance-window`: [Maintenance window](../concepts/maintenance.md) settings (including for disabled clusters), where `type` is the maintenance type: + * `--maintenance-window`: [Maintenance window](../concepts/maintenance.md) settings (including for disabled clusters), where `type` is the maintenance type: - {% include [maintenance-window](../../_includes/mdb/cli/maintenance-window-description.md) %} + {% include [maintenance-window](../../_includes/mdb/cli/maintenance-window-description.md) %} - * `--assign-public-ip`: Cluster accessibility from the internet. + * `--assign-public-ip`: Cluster accessibility from the internet. - * {% include [Deletion protection](../../_includes/mdb/cli/deletion-protection.md) %} + * {% include [Deletion protection](../../_includes/mdb/cli/deletion-protection.md) %} - {% include [Deletion protection limits db](../../_includes/mdb/deletion-protection-limits-db.md) %} + {% include [Deletion protection limits db](../../_includes/mdb/deletion-protection-limits-db.md) %} - You can [retrieve the cluster name with a list of clusters in the folder](cluster-list.md#list-clusters). + You can [get the cluster name with a list of clusters in the folder](cluster-list.md#list-clusters). - API {#api} - To change additional cluster settings, use the [update](../api-ref/Cluster/update.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Update](../api-ref/grpc/Cluster/update.md) gRPC API call and provide the following in the request: + To change additional cluster settings, use the [update](../api-ref/Cluster/update.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Update](../api-ref/grpc/Cluster/update.md) gRPC API call and provide the following in the request: + + * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). + * Public access settings in the `config.assignPublicIp` parameter. + * Backup window settings in the `config.backupWindowStart` parameter. + * Settings for access from [{{ datalens-full-name }}](../../datalens/concepts/index.md) in the `config.access.dataLens` parameter. + - * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). - * Public access settings in the `config.assignPublicIp` parameter. - * Backup window settings in the `config.backupWindowStart` parameter. - * Settings for access from [{{ datalens-full-name }}](../../datalens/concepts/index.md) in the `config.access.dataLens` parameter. - * [Maintenance window](../concepts/maintenance.md) settings (including for disabled clusters) in the `maintenanceWindow` parameter. - * Cluster deletion protection settings in the `deletionProtection` parameter. + * [Maintenance window](../concepts/maintenance.md) settings (including for disabled clusters) in the `maintenanceWindow` parameter. + * Cluster deletion protection settings in the `deletionProtection` parameter. - {% include [Deletion protection limits](../../_includes/mdb/deletion-protection-limits-db.md) %} + {% include [Deletion protection limits](../../_includes/mdb/deletion-protection-limits-db.md) %} - * List of cluster configuration fields to update in the `UpdateMask` parameter. + * List of cluster configuration fields to update in the `updateMask` parameter. - {% include [note-api-updatemask](../../_includes/note-api-updatemask.md) %} + {% include [note-api-updatemask](../../_includes/note-api-updatemask.md) %} {% endlist %} @@ -248,29 +253,29 @@ You can edit your cluster's [scheduled maintenance operations](../concepts/maint - Management console {#console} - 1. Go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-greenplum }}**. - 1. Select the cluster and click **{{ ui-key.yacloud.mdb.cluster.overview.button_action-edit }}** in the top panel. - 1. Under **{{ ui-key.yacloud.greenplum.section_background-activities }}**, change the parameters: + 1. Go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-greenplum }}**. + 1. Select the cluster and click **{{ ui-key.yacloud.mdb.cluster.overview.button_action-edit }}** in the top panel. + 1. Under **{{ ui-key.yacloud.greenplum.section_background-activities }}**, change the parameters: - {% include [background activities](../../_includes/mdb/mgp/background-activities-console.md) %} + {% include [background activities](../../_includes/mdb/mgp/background-activities-console.md) %} - 1. Click **{{ ui-key.yacloud.common.save }}**. + 1. Click **{{ ui-key.yacloud.common.save }}**. - API {#api} - To edit your cluster's scheduled maintenance operations settings, use the REST API [update](../api-ref/Cluster/update.md) method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Update](../api-ref/grpc/Cluster/update.md) gRPC API call, and provide the following in the request: + To edit your cluster's scheduled maintenance operations settings, use the REST API [update](../api-ref/Cluster/update.md) method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Update](../api-ref/grpc/Cluster/update.md) gRPC API call, and provide the following in the request: - * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). - * New parameter values for the `configSpec.backgroundActivities.analyzeAndVacuum` object: + * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). + * New parameter values for the `configSpec.backgroundActivities.analyzeAndVacuum` object: - * `start.hours`: Start hour of the `VACUUM` operation in UTC. Valid values: from `0` to `23`, with `19` by default. - * `start.minutes`: Start minute of the `VACUUM` operation in UTC. Valid values: from `0` to `59`, with `0` by default. - * `vacuumTimeout`: Maximum duration of the `VACUUM` operation, in seconds. Valid values: from `7,200` to `86,399`, with `36,000` by default. As soon as this period expires, `VACUUM` will be forced to terminate. - * `analyzeTimeout`: Maximum duration of the `ANALYZE` operation, in seconds. Valid values: from `7,200` to `86,399`, with `36,000` by default. As soon as this period expires, the `ANALYZE` operation will be forced to terminate. + * `start.hours`: Start hour of the `VACUUM` operation in UTC. The values range from `0` to `23`, the default one is `19`. + * `start.minutes`: Start minute of the `VACUUM` operation in UTC. The values range from `0` to `59`, the default one is `0`. + * `vacuumTimeout`: Maximum duration of the `VACUUM` operation, in seconds. The values range from `7200` to `86399`, the default one is `36000`. As soon as this period expires, the `VACUUM` operation will be forced to terminate. + * `analyzeTimeout`: Maximum duration of the `ANALYZE` operation, in seconds. The values range from `7200` to `86399`, the default one is `36000`. As soon as this period expires, the `ANALYZE` operation will be forced to terminate. - * List of cluster configuration fields to update in the `UpdateMask` parameter. + * List of cluster configuration fields to update in the `updateMask` parameter. - {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} + {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} {% endlist %} @@ -282,35 +287,35 @@ You can change the DBMS settings of the hosts in your cluster. - Management console {#console} - 1. Go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-greenplum }}**. - 1. Select the cluster and click **{{ ui-key.yacloud.mdb.cluster.overview.button_action-edit }}** in the top panel. - 1. Change the [{{ GP }} settings](../concepts/settings-list.md) by clicking **{{ ui-key.yacloud.mdb.forms.button_configure-settings }}** under **{{ ui-key.yacloud.mdb.forms.section_settings }}**. - 1. Click **{{ ui-key.yacloud.component.mdb.settings.popup_settings-submit }}**. - 1. Click **{{ ui-key.yacloud.common.save }}**. + 1. Go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-greenplum }}**. + 1. Select the cluster and click **{{ ui-key.yacloud.mdb.cluster.overview.button_action-edit }}** in the top panel. + 1. Change the [{{ GP }} settings](../concepts/settings-list.md) by clicking **{{ ui-key.yacloud.mdb.forms.button_configure-settings }}** under **{{ ui-key.yacloud.mdb.forms.section_settings }}**. + 1. Click **{{ ui-key.yacloud.component.mdb.settings.popup_settings-submit }}**. + 1. Click **{{ ui-key.yacloud.common.save }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To change the [{{ GP }} DBMS settings](../concepts/settings-list.md): + To change the [{{ GP }} DBMS settings](../concepts/settings-list.md): - 1. View the full list of settings specified for the cluster: + 1. View the full list of settings specified for the cluster: - ```bash - {{ yc-mdb-gp }} cluster get - ``` + ```bash + {{ yc-mdb-gp }} cluster get + ``` - 1. View a description of the update cluster configuration CLI command: + 1. View a description of the update cluster configuration CLI command: ```bash {{ yc-mdb-gp }} cluster update-config --help ``` - 1. Set the required parameter values: + 1. Set the required parameter values: - All supported parameters are listed in the [request format for the update method](../api-ref/Cluster/update.md), in the `greenplumConfig_` field. To specify a parameter name in the CLI call, convert the name from lowerCamelCase to snake_case. For example, the `maxConnections` parameter from an API call must be converted to `max_connections` for the CLI command: + All supported parameters are listed in the [request format for the update method](../api-ref/Cluster/update.md), in the `greenplumConfig_` field. To specify a parameter name in the CLI call, convert its name from lowerCamelCase to snake_case. For example, convert the `maxConnections` parameter from an API request to `max_connections` for the CLI command: ```bash {{ yc-mdb-gp }} cluster update-config \ @@ -321,12 +326,12 @@ You can change the DBMS settings of the hosts in your cluster. - API {#api} - To change {{ GP }} settings, use the [update](../api-ref/Cluster/update.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Update](../api-ref/grpc/Cluster/update.md) gRPC API call and provide the following in the request: + To change {{ GP }} settings, use the [update](../api-ref/Cluster/update.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Update](../api-ref/grpc/Cluster/update.md) gRPC API call and provide the following in the request: - * New settings in the `configSpec.greenplumConfig_` parameter. - * List of cluster configuration fields to update in the `updateMask` parameter. + * New values in the `configSpec.greenplumConfig_` parameter. + * List of cluster configuration fields to update in the `updateMask` parameter. - {% include [note-api-updatemask](../../_includes/note-api-updatemask.md) %} + {% include [note-api-updatemask](../../_includes/note-api-updatemask.md) %} {% endlist %} @@ -343,69 +348,69 @@ We recommend changing the host class only when the cluster has no active workloa - Management console {#console} - 1. Go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-greenplum }}**. - 1. Select the cluster and click ![image](../../_assets/console-icons/pencil.svg) **{{ ui-key.yacloud.mdb.cluster.overview.button_action-edit }}** in the top panel. - 1. Under **{{ ui-key.yacloud.mdb.forms.section_resource }}**, select the required class for {{ GP }} master hosts or segment hosts. - 1. Click **{{ ui-key.yacloud.mdb.forms.button_edit }}**. + 1. Go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-greenplum }}**. + 1. Select a cluster and click ![image](../../_assets/console-icons/pencil.svg) **{{ ui-key.yacloud.mdb.cluster.overview.button_action-edit }}** in the top panel. + 1. Under **{{ ui-key.yacloud.mdb.forms.section_resource }}**, select the required class for {{ GP }} master hosts or segment hosts. + 1. Click **{{ ui-key.yacloud.mdb.forms.button_edit }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To change the [host class](../concepts/instance-types.md) for the cluster: + To change the [host class](../concepts/instance-types.md) for the cluster: - 1. View a description of the update cluster CLI command: + 1. View a description of the update cluster CLI command: ```bash {{ yc-mdb-gp }} cluster update --help ``` - 1. Request a list of available classes (the `ZONE IDS` column specifies the availability zones where you can select the appropriate class): - * For master hosts: + 1. Request a list of available classes (the `ZONE IDS` column lists the availability zones where you can select the appropriate class): + * For master hosts: - ```bash - {{ yc-mdb-gp }} resource-preset list master - ``` + ```bash + {{ yc-mdb-gp }} resource-preset list master + ``` - * For segment hosts: + * For segment hosts: - ```bash - {{ yc-mdb-gp }} resource-preset list segment - ``` + ```bash + {{ yc-mdb-gp }} resource-preset list segment + ``` - ```text - +-------------+--------------------------------+--------------------------------+-------+----------+--------------------+---------------------+ - | ID | ZONE IDS | DISK TYPES | CORES | MEMORY | HOST COUNT DIVIDER | MAX SEGMENT IN HOST | - +-------------+--------------------------------+--------------------------------+-------+----------+--------------------+---------------------+ - | i2.2xlarge | {{ region-id }}-a, {{ region-id }}-b | local-ssd, | 16 | 128.0 GB | 1 | 0 | - | | | network-ssd-nonreplicated | | | | | - | ... | - +-------------+--------------------------------+--------------------------------+-------+----------+--------------------+---------------------+ - ``` + ```text + +-------------+--------------------------------+--------------------------------+-------+----------+--------------------+---------------------+ + | ID | ZONE IDS | DISK TYPES | CORES | MEMORY | HOST COUNT DIVIDER | MAX SEGMENT IN HOST | + +-------------+--------------------------------+--------------------------------+-------+----------+--------------------+---------------------+ + | i2.2xlarge | {{ region-id }}-a, {{ region-id }}-b | local-ssd, | 16 | 128.0 GB | 1 | 0 | + | | | network-ssd-nonreplicated | | | | | + | ... | + +-------------+--------------------------------+--------------------------------+-------+----------+--------------------+---------------------+ + ``` - 1. Specify the required classes in the cluster update command: + 1. Specify the required classes in the cluster update command: ```bash {{ yc-mdb-gp }} cluster update \ - --master-config resource-id= \ - --segment-config resource-id= + --master-config resource-id= \ + --segment-config resource-id= ``` {{ mgp-short-name }} will run the update host class command for the cluster. - {{ TF }} {#tf} - 1. Open the current {{ TF }} configuration file with an infrastructure plan. + 1. Open the current {{ TF }} configuration file with an infrastructure plan. - For more information about how to create this file, see [Creating clusters](cluster-create.md). + For more information about creating this file, see [Creating clusters](cluster-create.md). For a complete list of available {{ mgp-name }} cluster configuration fields, see the [{{ TF }} provider documentation]({{ tf-provider-mgp }}). - 1. In the {{ mgp-name }} cluster description, change the `resource_preset_id` attribute value under `master_subcluster.resources` or `segment_subcluster.resources`: + 1. In the {{ mgp-name }} cluster description, change the `resource_preset_id` attribute value under `master_subcluster.resources` or `segment_subcluster.resources`: ```hcl resource "yandex_mdb_greenplum_cluster" "" { @@ -424,11 +429,11 @@ We recommend changing the host class only when the cluster has no active workloa } ``` - 1. Make sure the settings are correct. + 1. Make sure the settings are correct. {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} - 1. Confirm updating the resources. + 1. Confirm updating the resources. {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} @@ -436,13 +441,13 @@ We recommend changing the host class only when the cluster has no active workloa - API {#api} - To change the class of cluster hosts, use the [update](../api-ref/Cluster/update.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Update](../api-ref/grpc/Cluster/update.md) gRPC API call and provide the following in the request: + To change the class of cluster hosts, use the [update](../api-ref/Cluster/update.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Update](../api-ref/grpc/Cluster/update.md) gRPC API call and provide the following in the request: - * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](./cluster-list.md#list-clusters). - * Master host class ID in the `masterConfig.resources.resourcePresetId` parameter or segment host class ID in the `segmentConfig.resources.resourcePresetId` parameter. You can get a list of supported values by using the [list](../api-ref/ResourcePreset/list.md) method for the `ResourcePreset` resource. - * List of settings you need to update (in this case, `masterConfig.resources.resourcePresetId` or `segmentConfig.resources.resourcePresetId`) in the `updateMask` parameter. + * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](./cluster-list.md#list-clusters). + * Master host class ID in the `masterConfig.resources.resourcePresetId` parameter or segment host class ID in the `segmentConfig.resources.resourcePresetId` parameter. You can get a list of supported values by using the [list](../api-ref/ResourcePreset/list.md) method for the `ResourcePreset`. + * List of settings to update (in this case, `masterConfig.resources.resourcePresetId` or `segmentConfig.resources.resourcePresetId`) in the `updateMask` parameter. - {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} + {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} {% endlist %} @@ -454,24 +459,24 @@ We recommend changing the host class only when the cluster has no active workloa - Management console {#console} - To increase the cluster storage size: + To increase the cluster storage size: - 1. In the [management console]({{ link-console-main }}), select the folder with the cluster you need. - 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-greenplum }}**. - 1. Select the cluster you need. - 1. At the top of the page, click **{{ ui-key.yacloud.mdb.cluster.overview.button_action-edit }}**. - 1. Edit the settings in the **{{ ui-key.yacloud.mdb.forms.section_storage }}** section. - 1. Click **{{ ui-key.yacloud.common.save }}**. + 1. In the [management console]({{ link-console-main }}), select the folder with the cluster you need. + 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-greenplum }}**. + 1. Select the cluster you need. + 1. At the top of the page, click **{{ ui-key.yacloud.mdb.cluster.overview.button_action-edit }}**. + 1. Edit the settings in the **{{ ui-key.yacloud.mdb.forms.section_storage }}** section. + 1. Click **{{ ui-key.yacloud.common.save }}**. - API {#api} - To increase the cluster storage size, use the [update](../api-ref/Cluster/update.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Update](../api-ref/grpc/Cluster/update.md) gRPC API call and provide the following in the request: + To increase the cluster storage size, use the [update](../api-ref/Cluster/update.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Update](../api-ref/grpc/Cluster/update.md) gRPC API call and provide the following in the request: - * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](./cluster-list.md#list-clusters). - * New master and segment host storage size in the `masterConfig.resources.diskSize` and `segmentConfig.resources.diskSize` parameters. - * List of cluster configuration fields to update in the `UpdateMask` parameter. + * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](./cluster-list.md#list-clusters). + * New master and segment host storage size in the `masterConfig.resources.diskSize` and `segmentConfig.resources.diskSize` parameters. + * List of cluster configuration fields to update in the `updateMask` parameter. - {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} + {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} {% endlist %} diff --git a/en/managed-greenplum/pricing/index.md b/en/managed-greenplum/pricing/index.md index 5e3b0d12c96..e278c453344 100644 --- a/en/managed-greenplum/pricing/index.md +++ b/en/managed-greenplum/pricing/index.md @@ -42,7 +42,7 @@ There are different ways to calculate the cost depending on the [host type](../c -You can the supported resource configurations in the [Host classes](../concepts/instance-types.md) section. For vCPU and RAM prices, see the [Prices](#prices) section. +You can find the supported resource configurations in the [Host classes](../concepts/instance-types.md) section. For the vCPU and RAM prices, see [Prices](#prices). The minimum billing unit is one minute (for example, 1.5 minutes of host operation cost the same as 2 minutes). You do not pay for the time when the {{ GP }} host is unable to perform its main functions. @@ -53,14 +53,14 @@ You pay for the following: * Storage allocated for clusters. - * You can only order storage on local SSD disks (`local-ssd`) for clusters with two master hosts: + * You can only order local SSD storage (`local-ssd`) for clusters with two master hosts: * For Intel Cascade Lake: In increments of 100 GB. * For Intel Ice Lake: In increments of {{ local-ssd-v3-step }}. - * You can only order storage on non-replicated SSDs (`network-ssd-nonreplicated`) in 93 GB increments for clusters with two master hosts. + * Non-replicated SSD (`network-ssd-nonreplicated`) storage can only be ordered for clusters with two master hosts, in increments of 93 GB. To pay less for storage, export [AO and AOCO tables](../tutorials/yezzey.md) from disks within the {{ mgp-name }} cluster to a cold storage in {{ objstorage-full-name }}. The data will be stored in a service bucket in a compressed and encrypted form, which is more cost-efficient. The cost of such storage is calculated based on the [{{ objstorage-name }} pricing policy](../../storage/pricing.md). @@ -79,9 +79,9 @@ The price covers one month of use based on 720 hours per month. The minimum bill The cost of using a cluster with the following parameters for 30 days: -* **Standard hosts**: Three hosts of the `s3-c8-m32` class: Intel Ice Lake, 8 × 100% vCPU, 32 GB RAM. +* **Standard hosts**: Three `s3-c8-m32` hosts: Intel Ice Lake, 8 × 100% vCPU, 32 GB RAM. * **Storage for standard hosts**: 100 GB of network HDD storage. -* **Dedicated hosts**: Three hosts of the `s2.medium` class: Intel Cascade Lake, 8 × 100% vCPU, 32 GB RAM. +* **Dedicated hosts**: Three `s2.medium` hosts: Intel Cascade Lake, 8 × 100% vCPU, 32 GB RAM. * **Storage for dedicated hosts**: 50 GB of local SSD storage. @@ -97,7 +97,7 @@ The cost of using a cluster with the following parameters for 30 days: {% note info %} -CVoS discount is only available for certain types of resources. For non-supported resources, CVoS columns feature dashes under [Prices](#prices). Currently, you cannot order storage, web traffic, and computing resources for dedicated hosts this way. +CVoS discount is only available for certain types of resources. A dash in the relevant CVoS columns under [Prices](#prices) means the resource is not supported. Currently, you cannot order storage, web traffic, and computing resources for dedicated hosts this way. {% endnote %} @@ -129,11 +129,11 @@ The price of local SSD storage (`local-ssd`) also depends on the host type. The cost calculation will be different depending on the [host configuration](../concepts/instance-types.md): -* For hosts i2 and i3 (`io-optimized`), the cost is made up of the price for {{ mgp-name }} host computing resources (see the table below) and the [price for software-accelerated network use](../../compute/pricing.md#software-accelerated-network). +* For i2 and i3 hosts (`io-optimized`), the cost is made up of the price for {{ mgp-name }} host computing resources (see the table below) and [the price for software-accelerated network usage](../../compute/pricing.md#software-accelerated-network). * For hosts with other configurations, you only pay for their computing resources: -**Costs per hour** +**Prices per hour** diff --git a/en/managed-greenplum/toc.yaml b/en/managed-greenplum/toc.yaml index 7ade36e6702..1e714d03869 100644 --- a/en/managed-greenplum/toc.yaml +++ b/en/managed-greenplum/toc.yaml @@ -93,17 +93,17 @@ items: items: - name: All tutorials href: tutorials/index.md - - name: Migrating databases to {{ mgp-name }} + - name: Migrating a database to {{ mgp-name }} href: tutorials/data-migration.md - name: >- Creating an external table from a {{ objstorage-full-name }} bucket table using a configuration file href: tutorials/config-server-for-s3.md - - name: Migrating databases from {{ GP }} to {{ PG }} + - name: Migrating a database from {{ GP }} to {{ PG }} href: tutorials/greenplum-to-postgresql.md - - name: Migrating databases from {{ GP }} to {{ CH }} + - name: Migrating a database from {{ GP }} to {{ CH }} href: tutorials/greenplum-to-clickhouse.md - - name: Migrating databases from {{ MY }} to {{ GP }} + - name: Migrating a database from {{ MY }} to {{ GP }} href: tutorials/mmy-to-mgp.md - name: >- Exporting {{ GP }} data to a cold storage in {{ objstorage-full-name diff --git a/en/managed-greenplum/tutorials/index.md b/en/managed-greenplum/tutorials/index.md index 73e1041e0b7..8779a7520d6 100644 --- a/en/managed-greenplum/tutorials/index.md +++ b/en/managed-greenplum/tutorials/index.md @@ -12,9 +12,11 @@ description: Various {{ mgp-full-name }} use cases in {{ yandex-cloud }}. * [{#T}](mmy-to-mgp.md) * [Exporting cluster data to a cold storage in {{ objstorage-full-name }}](yezzey.md) * [{#T}](object-storage-to-greenplum.md) +* [{#T}](./managed-kafka-to-greenplum.md) ## Delivering data using {{ data-transfer-name }} {#data-transfer} * [From {{ KF }} to {{ GP }}](managed-kafka-to-greenplum.md) To migrate cluster hosts to a different availability zone, [restore a cluster from a backup](../operations/cluster-backups.md#restore). When restoring the cluster, specify the appropriate availability zone. + diff --git a/en/managed-greenplum/tutorials/mmy-to-mgp.md b/en/managed-greenplum/tutorials/mmy-to-mgp.md index 78c8563752f..d6bb0ed399e 100644 --- a/en/managed-greenplum/tutorials/mmy-to-mgp.md +++ b/en/managed-greenplum/tutorials/mmy-to-mgp.md @@ -1,5 +1,6 @@ --- noIndex: true +canonical: '{{ link-docs }}/tutorials/dataplatform/mmy-to-mgp' --- # Migrating data from {{ mmy-full-name }} to {{ mgp-name }} using {{ data-transfer-full-name }} diff --git a/en/managed-greenplum/tutorials/object-storage-to-greenplum.md b/en/managed-greenplum/tutorials/object-storage-to-greenplum.md index 597f82c3c60..b5a02524891 100644 --- a/en/managed-greenplum/tutorials/object-storage-to-greenplum.md +++ b/en/managed-greenplum/tutorials/object-storage-to-greenplum.md @@ -1,5 +1,6 @@ --- noIndex: true +canonical: '{{ link-docs }}/tutorials/dataplatform/object-storage-to-greenplum' --- # Loading data from {{ objstorage-full-name }} to {{ mgp-name }} using {{ data-transfer-full-name }} diff --git a/en/managed-greenplum/tutorials/yezzey.md b/en/managed-greenplum/tutorials/yezzey.md index 8ff2b177bce..c58425e1bc0 100644 --- a/en/managed-greenplum/tutorials/yezzey.md +++ b/en/managed-greenplum/tutorials/yezzey.md @@ -1,4 +1,8 @@ -# Exporting {{ GP }} data to cold storage in {{ objstorage-full-name }} +--- +canonical: '{{ link-docs }}/tutorials/dataplatform/greenplum-yezzey' +--- + +# Exporting {{ GP }} data to a cold storage in {{ objstorage-full-name }} {% include notitle [greenplum-yezzey.md](../../_tutorials/dataplatform/mgp/greenplum-yezzey.md) %} diff --git a/en/managed-kafka/concepts/limits.md b/en/managed-kafka/concepts/limits.md index e3719fe2a5d..564884e9394 100644 --- a/en/managed-kafka/concepts/limits.md +++ b/en/managed-kafka/concepts/limits.md @@ -1,6 +1,6 @@ --- title: Quotas and limits in {{ mkf-name }} -description: '{{ mkf-name }} has limits and quotas on the number of clusters, total number of processor cores for all broker hosts, total amount of virtual memory for all broker hosts, and total storage for all clusters per cloud. For more information about the service restrictions, read this article.' +description: '{{ mkf-name }} has limits and quotas for the number of clusters, total number of processor cores for all broker hosts, total amount of virtual memory for all broker hosts, and total storage for all clusters per cloud. For more information about the service restrictions, read this article.' editable: false --- diff --git a/en/managed-kafka/operations/cluster-list.md b/en/managed-kafka/operations/cluster-list.md index 23cc43c4283..10afca782bf 100644 --- a/en/managed-kafka/operations/cluster-list.md +++ b/en/managed-kafka/operations/cluster-list.md @@ -13,38 +13,38 @@ You can request detailed information about each {{ mkf-name }} cluster you creat - Management console {#console} - 1. In the [management console]({{ link-console-main }}), go to the appropriate folder. - 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-kafka }}**. + 1. In the [management console]({{ link-console-main }}), go to the relevant folder. + 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-kafka }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To request a list of {{ KF }} clusters in the default folder, run the command: + To request a list of {{ KF }} clusters in the default folder, run the command: - ``` - {{ yc-mdb-kf }} cluster list - ``` + ``` + {{ yc-mdb-kf }} cluster list + ``` - Result: + Result: - ``` - +----------------------+----------+---------------------+--------+---------+ - | ID | NAME | CREATED AT | HEALTH | STATUS | - +----------------------+----------+---------------------+--------+---------+ - | c9qaruvk2mma******** | kafka750 | 2020-12-18 05:21:27 | ALIVE | RUNNING | - | ... | - +----------------------+----------+---------------------+--------+---------+ - ``` + ``` + +----------------------+----------+---------------------+--------+---------+ + | ID | NAME | CREATED AT | HEALTH | STATUS | + +----------------------+----------+---------------------+--------+---------+ + | c9qaruvk2mma******** | kafka750 | 2020-12-18 05:21:27 | ALIVE | RUNNING | + | ... | + +----------------------+----------+---------------------+--------+---------+ + ``` - API {#api} - To get a list of DB clusters in a folder, use the [list](../api-ref/Cluster/list.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/List](../api-ref/grpc/Cluster/list.md) gRPC API call and provide the folder ID in the `folderId` request parameter. + To get a list of DB clusters in a folder, use the [list](../api-ref/Cluster/list.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/List](../api-ref/grpc/Cluster/list.md) gRPC API call and provide the folder ID in the `folderId` request parameter. - The response will contain cluster names and IDs. + The response will contain cluster names and IDs. {% endlist %} @@ -55,65 +55,152 @@ You can request detailed information about each {{ mkf-name }} cluster you creat - Management console {#console} - 1. In the [management console]({{ link-console-main }}), go to the appropriate folder. - 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-kafka }}**. - 1. Click the cluster name. + 1. In the [management console]({{ link-console-main }}), go to the relevant folder. + 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-kafka }}**. + 1. Click the cluster name. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To get information about an {{ KF }} cluster, run the following command: + To get information about an {{ KF }} cluster, run the following command: - ``` - {{ yc-mdb-kf }} cluster get - ``` + ``` + {{ yc-mdb-kf }} cluster get + ``` - You can request the cluster ID and name with a [list of clusters in the folder](#list-clusters). + You can request the cluster ID and name with a [list of clusters in the folder](#list-clusters). - API {#api} - To get cluster details, use the [get](../api-ref/Cluster/get.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Get](../api-ref/grpc/Cluster/get.md) gRPC API call and provide the cluster ID in the `clusterId` request parameter. + To get cluster details, use the [get](../api-ref/Cluster/get.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Get](../api-ref/grpc/Cluster/get.md) gRPC API call and provide the cluster ID in the request. - To find out the cluster ID, [get a list of clusters in the folder](#list-clusters). + To find out the cluster ID, [get a list of clusters in the folder](#list-clusters). {% endlist %} -## Viewing a list of operations in a cluster {#list-operations} +## Viewing operations with clusters {#list-operations} -{% include [list-operations-about](../../_includes/mdb/mkf-list-operations-about.md) %} +All actions with {{ mkf-name }} clusters are logged as a list of operations. Each operation is assigned a unique ID. + +### Getting a list of operations {#get-operations} {% list tabs group=instructions %} - Management console {#console} - 1. In the [management console]({{ link-console-main }}), go to the appropriate folder. - 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-kafka }}**. - 1. Click the cluster name. - 1. Go to the **{{ ui-key.yacloud.common.operations-key-value }}** tab. + To get a list of operations for a cluster: + + 1. In the [management console]({{ link-console-main }}), open the folder with the cluster. + 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-kafka }}**. + 1. In the left-hand panel, select ![image](../../_assets/console-icons/cubes-3.svg) **{{ ui-key.yacloud.mdb.clusters.label_title }}**. + 1. Select the cluster you need. + 1. Go to the ![image](../../_assets/console-icons/list-check.svg) **{{ ui-key.yacloud.common.operations-key-value }}** panel for the selected cluster. + + You will see a list of operations with the selected cluster. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} + + {% include [default-catalogue](../../_includes/default-catalogue.md) %} + + To get a list of operations for a {{ mkf-name }} cluster, run this command: + + ```bash + yc managed-kafka cluster list-operations + ``` - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + Result: - To get a list of operations, run the following command: + ```text + +----------------------+---------------------+----------------------+---------------------+--------+-----------------------------+ + | ID | CREATED AT | CREATED BY | MODIFIED AT | STATUS | DESCRIPTION | + +----------------------+---------------------+----------------------+---------------------+--------+-----------------------------+ + | dqh0ntf6batm******** | 2024-09-07 16:36:46 | aje9k8luj4qf******** | 2024-09-07 16:44:12 | DONE | Create Apache Kafka cluster | + +----------------------+---------------------+----------------------+---------------------+--------+-----------------------------+ + ``` - ``` - {{ yc-mdb-kf }} cluster list-operations - ``` + You can get the cluster ID and name with a [list of clusters in the folder](#list-clusters). - You can request the cluster ID and name with a [list of clusters in the folder](#list-clusters). + By default, information about operations is provided as text. To get detailed information, specify the `yaml` or `json` output data format using the `--format` flag: + ```bash + yc managed-kafka cluster list-operations c9qk2926qqu9******** --format yaml + ``` + + Result: + + ```text + - id: dqh0ntf6batm******** + description: Create Apache Kafka cluster + created_at: "2024-09-07T16:36:46.816682Z" + created_by: aje9k8luj4qf******** + modified_at: "2024-09-07T16:44:12.944302Z" + done: true + metadata: + '@type': type.googleapis.com/yandex.cloud.mdb.kafka.v1.CreateClusterMetadata + cluster_id: c9q13q0acgv7******** + response: + '@type': type.googleapis.com/google.rpc.Status + message: OK + ``` - API {#api} - To get a list of operations, use the [listOperations](../api-ref/Cluster/listOperations.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/ListOperations](../api-ref/grpc/Cluster/listOperations.md) gRPC API call. + Use the [listOperations](../api-ref/Cluster/listOperations.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/ListOperations](../api-ref/grpc/Cluster/listOperations.md) gRPC API call and provide the cluster ID in the request. + You can get the cluster ID with a [list of clusters in the folder](#list-clusters). {% endlist %} + +### Getting detailed information about an operation {#get-operations-info} + +1. [Get a list of operations](#get-operations) for a cluster. +1. Copy the ID of the operation. +1. Get detailed information about the operation: + + {% list tabs group=instructions %} + + - CLI {#cli} + + {% include [cli-install](../../_includes/cli-install.md) %} + + {% include [default-catalogue](../../_includes/default-catalogue.md) %} + + Run this command: + + ```bash + yc operation get + ``` + + Result: + + ```text + id: dqh0ntf6batm******** + description: Create Apache Kafka cluster + created_at: "2024-09-07T16:36:46.816682Z" + created_by: aje9k8luj4qf******** + modified_at: "2024-09-07T16:44:12.944302Z" + done: true + metadata: + '@type': type.googleapis.com/yandex.cloud.mdb.kafka.v1.CreateClusterMetadata + cluster_id: c9q13q0acgv7******** + response: + '@type': type.googleapis.com/yandex.cloud.mdb.kafka.v1.Cluster + ... + ``` + + - API {#api} + + Use the [get](../api-ref/Cluster/get.md) REST API method for the [Operation](../api-ref/Operation/index.md) resource or the [OperationService/Get](../api-ref/grpc/Operation/get.md) gRPC API call and provide the operation ID in the request. + + {% endlist %} + +### See also {#see-also} + +* [{#T}](../../api-design-guide/concepts/about-async.md) diff --git a/en/managed-kafka/operations/connect/code-examples.md b/en/managed-kafka/operations/connect/code-examples.md index 5ff083c0000..8d176315120 100644 --- a/en/managed-kafka/operations/connect/code-examples.md +++ b/en/managed-kafka/operations/connect/code-examples.md @@ -18,13 +18,13 @@ Before connecting, [configure security groups](index.md#configuring-security-gro Examples were tested in the following environment: -* {{ yandex-cloud }} virtual machine running Ubuntu 20.04 LTS -* Bash: `5.0.16` -* Python: `3.8.2`, pip3: `20.0.2` -* Node.JS: `10.19.0`, npm: `6.14.4` -* OpenJDK: `11.0.8`, Maven: `3.6.3` -* Go: `1.13.8` -* mono-complete: `6.8.0.105` +* {{ yandex-cloud }} virtual machine running Ubuntu 20.04 LTS. +* Bash: `5.0.16`. +* Python: `3.8.2`, pip3: `20.0.2`. +* Node.JS: `10.19.0`, npm: `6.14.4`. +* OpenJDK: `11.0.8`, Maven: `3.6.3`. +* Go: `1.13.8`. +* mono-complete: `6.8.0.105`. ## C# {#csharp} @@ -60,7 +60,7 @@ Before connecting: ``` -1. Copy `App.csproj` to the directories of the producer application and consumer application: +1. Copy `App.csproj` to the producer and consumer application directories: ```bash cp App.csproj producer/App.csproj && cp App.csproj consumer/App.csproj @@ -593,6 +593,7 @@ Before connecting: certs.AppendCertsFromPEM(pemData) conf.Net.TLS.Enable = true + conf.Net.TLS.Config = &tls.Config{ RootCAs: certs, } @@ -667,6 +668,7 @@ Before connecting: certs.AppendCertsFromPEM(pemData) conf.Net.TLS.Enable = true + conf.Net.TLS.Config = &tls.Config{ RootCAs: certs, } @@ -1121,7 +1123,7 @@ Before connecting: ## Node.js {#nodejs} -Before connecting, install the dependencies: +Before connecting, install the following dependencies: ```bash sudo apt update && sudo apt install -y nodejs npm && \ @@ -1332,7 +1334,7 @@ npm install node-rdkafka ## Python (kafka-python) {#kafka-python} -Before connecting, install the dependencies: +Before connecting, install the following dependencies: ```bash sudo apt update && sudo apt install -y python3 python3-pip libsnappy-dev && \ @@ -1455,7 +1457,7 @@ pip3 install kafka-python lz4 python-snappy crc32c ## Python (confluent-kafka) {#confluent-kafka-python} -Before connecting, install the dependencies: +Before connecting, install the following dependencies: ```bash pip install confluent_kafka @@ -1479,6 +1481,7 @@ pip install confluent_kafka 'bootstrap.servers': ':9092', 'security.protocol': 'SASL_PLAINTEXT', 'sasl.mechanism': 'SCRAM-SHA-512', + 'sasl.username': '', 'sasl.password': '', 'error_cb': error_callback, } diff --git a/en/managed-kafka/release-notes.md b/en/managed-kafka/release-notes.md index ae0a8e8eb0d..84cc6d68a35 100644 --- a/en/managed-kafka/release-notes.md +++ b/en/managed-kafka/release-notes.md @@ -9,23 +9,23 @@ description: This section contains {{ mkf-name }} release notes. ## July 2024 {#jule-2024} -* Added automatic increase of disk size. In the [cluster settings](./operations/cluster-update.md), the user can set the disk storage usage threshold and maximum disk size. Upon reaching the threshold, the disk size will automatically increase in fixed increments up to its maximum. You can choose to immediately increase the disk size or to increase it during the next maintenance window. +Added automatic increase of disk size. In the [cluster settings](./operations/cluster-update.md), the user can set the disk storage usage threshold and maximum disk size. Upon reaching the threshold, the disk size will automatically increase in fixed increments up to its maximum. You can choose to immediately increase the disk size or to increase it during the next maintenance window. ## March 2024 {#mar-2024} -* Now you can [replace the availability zone](./operations/host-migration.md) for {{ mkf-name }} clusters. +Now you can [replace the availability zone](./operations/host-migration.md) for {{ mkf-name }} clusters. ## Q4 2023 {#q4-2023} -* New {{ KF }} version 3.5.1 is available in the `PRODUCTION` environment. For more information about revisions, see the [{{ KF }} 3.5.0 documentation](https://archive.apache.org/dist/kafka/3.5.0/RELEASE_NOTES.html) and the [{{ KF }} 3.5.1 documentation](https://archive.apache.org/dist/kafka/3.5.1/RELEASE_NOTES.html). {{ tag-con }} {{ tag-cli }} {{ tag-tf }} +New {{ KF }} version 3.5.1 is available in the `PRODUCTION` environment. For more information about revisions, see the [{{ KF }} 3.5.0 documentation](https://archive.apache.org/dist/kafka/3.5.0/RELEASE_NOTES.html) and the [{{ KF }} 3.5.1 documentation](https://archive.apache.org/dist/kafka/3.5.1/RELEASE_NOTES.html). {{ tag-con }} {{ tag-cli }} {{ tag-tf }} ## Q2 2023 {#q2-2023} -* New {{ KF }} version 3.4 is available in the `PRODUCTION` environment. For more information about revisions, see the [{{ KF }} documentation](https://archive.apache.org/dist/kafka/3.4.0/RELEASE_NOTES.html). {{ tag-con }} {{ tag-cli }} {{ tag-tf }} +New {{ KF }} version 3.4 is available in the `PRODUCTION` environment. For more information about revisions, see the [{{ KF }} documentation](https://archive.apache.org/dist/kafka/3.4.0/RELEASE_NOTES.html). {{ tag-con }} {{ tag-cli }} {{ tag-tf }} ## Q1 2023 {#q1-2023} -* New {{ KF }} version 3.3 is available in the `PRODUCTION` environment. {{ tag-con }} {{ tag-cli }} {{ tag-tf }} +New {{ KF }} version 3.3 is available in the `PRODUCTION` environment. {{ tag-con }} {{ tag-cli }} {{ tag-tf }} ## Q4 2022 {#q4-2022} @@ -54,4 +54,4 @@ description: This section contains {{ mkf-name }} release notes. ## Q1 2022 {#q1-2022} -* A new version is available: {{ KF }} 3.0. +A new version is available: {{ KF }} 3.0. diff --git a/en/managed-kubernetes/index.yaml b/en/managed-kubernetes/index.yaml index 7dd447a8f51..5647bcf0a31 100644 --- a/en/managed-kubernetes/index.yaml +++ b/en/managed-kubernetes/index.yaml @@ -43,7 +43,7 @@ links: href: concepts/ - title: API reference description: HTTP API method descriptions - href: api-ref/ + href: managed-kubernetes/api-ref/ - title: Quotas and limits description: Technical and organizational limitations of the service href: concepts/limits diff --git a/en/managed-kubernetes/operations/kubernetes-cluster/kubernetes-cluster-create.md b/en/managed-kubernetes/operations/kubernetes-cluster/kubernetes-cluster-create.md index c0357811a0d..19b72013eec 100644 --- a/en/managed-kubernetes/operations/kubernetes-cluster/kubernetes-cluster-create.md +++ b/en/managed-kubernetes/operations/kubernetes-cluster/kubernetes-cluster-create.md @@ -24,7 +24,7 @@ To create a cluster with no internet access, see [{#T}](../../tutorials/k8s-clus 1. If you do not have any [subnets](../../../vpc/concepts/network.md#subnet) yet, [create them](../../../vpc/operations/subnet-create.md) in the [availability zones](../../../overview/concepts/geo-scope.md) where your {{ managed-k8s-name }} cluster and [node group](../../concepts/index.md#node-group) will be created. 1. Create [service accounts](../../../iam/operations/sa/create.md): * Service account with the `k8s.clusters.agent` [role](../../security/index.md#yc-api) for the folder where the {{ managed-k8s-name }} cluster is created. This service account will be used to create the resources required for the {{ managed-k8s-name }} cluster. - * Service account with the [{{ roles-cr-puller }}](../../../container-registry/security/index.md#choosing-roles) role for the folder containing the [Docker image](../../../container-registry/concepts/docker-image.md) [registry](../../../container-registry/concepts/registry.md). Nodes will pull the required Docker images from the registry on behalf of this account. + * Service account with the [{{ roles-cr-puller }}](../../../container-registry/security/index.md#choosing-roles) role for the folder containing the [Docker image](../../../container-registry/concepts/registry.md) [registry](../../../container-registry/concepts/docker-image.md). Nodes will pull the required Docker images from the registry on behalf of this account. You can use the same service account for both operations. @@ -52,7 +52,7 @@ To create a cluster with no internet access, see [{#T}](../../tutorials/k8s-clus To create a cluster: - 1. Specify the {{ managed-k8s-name }} cluster parameters in the create command (the example shows only some of the parameters): + 1. Specify the {{ managed-k8s-name }} cluster parameters in the create command (the example below does not list all possible parameters): ```bash {{ yc-k8s }} cluster create \ @@ -90,7 +90,7 @@ To create a cluster with no internet access, see [{#T}](../../tutorials/k8s-clus {% include [security-groups-alert](../../../_includes/managed-kubernetes/security-groups-alert.md) %} * `--service-account-id`: Unique ID of the [service account](../../../iam/concepts/users/service-accounts.md) for the resources. This service account will be used to create the resources required for the {{ managed-k8s-name }} cluster. - * `--node-service-account-id`: Unique ID of the service account for the [nodes](../../concepts/index.md#node-group). Nodes will pull the required [Docker images](../../../container-registry/concepts/docker-image.md) from the [registry](../../../container-registry/concepts/registry.md) on behalf of this account. + * `--node-service-account-id`: Unique ID of the service account for the [nodes](../../concepts/index.md#node-group). Nodes will pull the required [Docker images](../../../container-registry/concepts/registry.md) from the [registry](../../../container-registry/concepts/docker-image.md) on behalf of this account. * `--daily-maintenance-window`: [Maintenance](../../concepts/release-channels-and-updates.md#updates) window settings. Result: diff --git a/en/managed-kubernetes/operations/node-connect-ssh.md b/en/managed-kubernetes/operations/node-connect-ssh.md index fdfae62b555..16b45f755dc 100644 --- a/en/managed-kubernetes/operations/node-connect-ssh.md +++ b/en/managed-kubernetes/operations/node-connect-ssh.md @@ -305,7 +305,7 @@ The credentials for connecting over SSH will be completely overwritten. You will * Node group ID in the `nodeGroupId` parameter. - * `updateMask` set to `nodeTemplate.metadata`. + * `updateMask` parameter set to `nodeTemplate.metadata`. {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} @@ -443,7 +443,7 @@ You can connect to a {{ managed-k8s-name }} node over SSH once it is started (wi If this is your first time connecting to a {{ managed-k8s-name }} node, you may get an unknown host warning: ```bash - The authenticity of host '130.193.40.101 (130.193.40.101)' cannot be established. + The authenticity of host '130.193.40.101 (130.193.40.101)' can't be established. ECDSA key fingerprint is SHA256:PoaSwqxRc8g6iOXtiH7ayGHpSN0MXwUfWHk********. Are you sure you want to continue connecting (yes/no)? ``` diff --git a/en/managed-kubernetes/operations/volumes/dynamic-create-pv.md b/en/managed-kubernetes/operations/volumes/dynamic-create-pv.md index abf436af989..9cba986f3a9 100644 --- a/en/managed-kubernetes/operations/volumes/dynamic-create-pv.md +++ b/en/managed-kubernetes/operations/volumes/dynamic-create-pv.md @@ -62,7 +62,7 @@ You can use a [{{ objstorage-full-name }}](../../../storage/) [bucket](../../../ persistentvolumeclaim/pvc-dynamic created ``` -1. View the new `PersistentVolumeClaim` object's info: +1. View the information about the new `PersistentVolumeClaim` object: ```bash kubectl describe persistentvolumeclaim pvc-dynamic @@ -121,7 +121,7 @@ You can use a [{{ objstorage-full-name }}](../../../storage/) [bucket](../../../ pod/pod created ``` -1. View information about the pod created: +1. View the information about the new pod: ```bash kubectl describe pod pod diff --git a/en/managed-kubernetes/operations/volumes/s3-csi-integration.md b/en/managed-kubernetes/operations/volumes/s3-csi-integration.md index f65d0670cb2..ff4c4b2125f 100644 --- a/en/managed-kubernetes/operations/volumes/s3-csi-integration.md +++ b/en/managed-kubernetes/operations/volumes/s3-csi-integration.md @@ -287,7 +287,7 @@ To use {{ CSI }} with a static `PersistentVolume`: accessModes: - ReadWriteMany claimRef: - namespace: defalt + namespace: default name: csi-s3-pvc-static csi: driver: ru.yandex.s3.csi diff --git a/en/managed-kubernetes/operations/volumes/static-create-pv.md b/en/managed-kubernetes/operations/volumes/static-create-pv.md index 9482d13c5b7..b46b2d54bd6 100644 --- a/en/managed-kubernetes/operations/volumes/static-create-pv.md +++ b/en/managed-kubernetes/operations/volumes/static-create-pv.md @@ -223,7 +223,7 @@ You can use a {{ objstorage-full-name }} [bucket](../../../storage/concepts/buck ``` For more information about the specification, see the [{{ k8s }} documentation](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/). -1. Run the following command: +1. Run this command: ```bash kubectl create -f test-pod.yaml @@ -235,7 +235,7 @@ You can use a {{ objstorage-full-name }} [bucket](../../../storage/concepts/buck pod/test-pod created ``` -1. View information about the pod created: +1. View the information about the new pod: ```bash kubectl describe pod test-pod diff --git a/en/managed-kubernetes/tutorials/time-slicing-gpu.md b/en/managed-kubernetes/tutorials/time-slicing-gpu.md index 618d475cd00..6d00f1e8cd4 100644 --- a/en/managed-kubernetes/tutorials/time-slicing-gpu.md +++ b/en/managed-kubernetes/tutorials/time-slicing-gpu.md @@ -109,7 +109,7 @@ If you no longer need the resources you created, [delete them](#clear-out). {% endlist %} -## Text Time-Slicing GPUs functionality {#check-time-slicing} +## Test Time-Slicing GPUs functionality {#check-time-slicing} 1. Create a test app: 1. Save the following app creation specification to a YAML file named `nvidia-plugin-test.yml`. diff --git a/en/managed-mongodb/concepts/storage.md b/en/managed-mongodb/concepts/storage.md index 33f4dc10b5a..38e637e948f 100644 --- a/en/managed-mongodb/concepts/storage.md +++ b/en/managed-mongodb/concepts/storage.md @@ -9,7 +9,7 @@ The number of hosts you can create together with a {{ MG }} cluster depends on the selected disk type: -* With local SSD (`local-ssd`) or non-replicated SSD (`network-ssd-nonreplicated`) storage, you can create a cluster with three or more hosts. +* When using storage on local SSDs (`local-ssd`) or non-replicated SSDs (`network-ssd-nonreplicated`), you can create a cluster with three or more hosts. This cluster will be fault-tolerant. @@ -24,19 +24,19 @@ For more information about limits on the number of hosts per cluster or [shard]( {% include [mmg-readonly-safeguard.md](../../_includes/mdb/mmg-readonly-safeguard.md) %} -After switching to read-only mode: +After a transition to read-only mode: * Write queries stop being allowed on the host. You can only make read queries. -* If the host was a primary replica before switching to read-only mode, this role will be automatically assigned to another cluster host, as the primary replica role requires permission to write to the disk. +* If the host was a [primary replica](replication.md) before switching to read-only mode, this role will be automatically assigned to another cluster host, because the primary replica role requires permission to write to the disk. -If the amount of data in the cluster keeps growing, all hosts will switch to read-only mode, one by one, and the cluster will stop accepting data to write. +If the amount of data in the cluster keeps growing, all hosts will switch to read-only mode one by one and the cluster will stop accepting data to write. -### Maintaining the health of a cluster {#read-only-solutions} +### Maintaining a cluster in operable condition {#read-only-solutions} -To make sure your cluster is healthy when the host switches to read-only mode: -* [Increase the disk space on the host](../operations/update.md#change-disk-size). Once there is enough space on the host, {{ yandex-cloud }} will disable read-only mode automatically. -* [Add more shards to the cluster](../operations/shards.md#add-shard). Read-only mode will not be removed on this host, but the cluster will be able to continue working normally as long as there is free disk space on the other shards. -* Ask [support]({{ link-console-support }}) to temporarily suspend the read-only mode on this host to manually delete some of the data. +To keep your cluster up and running as the host is switching over to read-only: +* [Increase the disk space on the host](../operations/update.md#change-disk-size). Once there is enough space on the host, {{ yandex-cloud }} will clear read-only mode automatically. +* [Add more shards to the cluster](../operations/shards.md#add-shard). The read-only mode will not be cleared on this host, but the cluster will be able to keep working normally as long as there is free disk space on the other shards. +* Ask [support]({{ link-console-support }}) to temporarily suspend read-only mode on this host to manually delete some of the data. {% note alert %} diff --git a/en/managed-mongodb/operations/cluster-backups.md b/en/managed-mongodb/operations/cluster-backups.md index 3f98e04d36a..b4d4589a5c9 100644 --- a/en/managed-mongodb/operations/cluster-backups.md +++ b/en/managed-mongodb/operations/cluster-backups.md @@ -11,7 +11,7 @@ You can create [backups](../concepts/backup.md) and restore clusters from existi ## Restoring clusters from backups {#restore} -The Point-in-Time Recovery (PITR) technology allows you to restore your cluster to any state in the time interval between the oldest backup and the archiving of the most recent oplog collection. For more information, see [Backups](../concepts/backup.md). +The Point-in-Time Recovery (PITR) technology allows you to restore your cluster to any state in the time interval between the oldest backup and the archiving of the most recent [oplog](https://www.mongodb.com/docs/manual/core/replica-set-oplog/) collection. For more information, see [Backups](../concepts/backup.md). For example, if the backup operation ended on August 10, 2020 at 12:00:00 UTC, the current date is August 15, 2020, 19:00:00 UTC, and the most recent oplog collection was saved on August 15, 2020, 18:50:00 UTC, the cluster can be restored to any state between August 10, 2020, 12:00:01 UTC and August 15, 2020, 18:50:00 UTC, inclusive. @@ -138,7 +138,7 @@ When restored to the current state, the new cluster will match the state of: To restore an existing cluster from a backup, use the [restore](../api-ref/Cluster/restore.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Restore](../api-ref/grpc/Cluster/restore.md) gRPC API call and provide the following in the request: - * ID of the backup you need, in the `backupId` parameter. To find out the ID, [retrieve a list of cluster backups](#list-backups). + * ID of the backup you need, in the `backupId` parameter. To find out the ID, [get a list of cluster backups](#list-backups). * Name of the new cluster that will contain the data recovered from the backup, in the `name` parameter. It must be unique within the folder. In the `recoveryTargetSpec.timestamp` parameter, specify the time point to restore the {{ MG }} cluster to, in [UNIX time](https://en.wikipedia.org/wiki/Unix_time) format. If you do not specify the parameter, the cluster will be restored to when the backup was completed. @@ -198,7 +198,7 @@ When restored to the current state, the new cluster will match the state of: To get a list of cluster backups: 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. - 1. Click the name of the cluster you need and select the ![image](../../_assets/console-icons/archive.svg)**{{ ui-key.yacloud.mongodb.cluster.switch_backups }}** tab. + 1. Click the name of the cluster you need and select the ![image](../../_assets/console-icons/archive.svg) **{{ ui-key.yacloud.mongodb.cluster.switch_backups }}** tab. To get a list of all backups in a folder: @@ -303,9 +303,9 @@ Create a new {{ mmg-name }} cluster from a backup with the following test charac * Environment: `PRODUCTION`. * Network: `{{ network-name }}`. * One `{{ host-class }}` host in the `{{ region-id }}-a` availability zone and `b0rcctk2rvtr********` subnet. -* Network SSD storage (`{{ disk-type-example }}`): 20 GB. +* Network SSD storage (`{{ disk-type-example }}`): 20 GB. * With databases and users that existed in the cluster at the time of recovery. - + {% list tabs group=instructions %} diff --git a/en/managed-mongodb/operations/cluster-create.md b/en/managed-mongodb/operations/cluster-create.md index a57fb48e586..45e07a2b3b7 100644 --- a/en/managed-mongodb/operations/cluster-create.md +++ b/en/managed-mongodb/operations/cluster-create.md @@ -1,6 +1,6 @@ # Creating a {{ MG }} cluster -A {{ MG }} cluster is one or more database hosts between which you can configure replication. Replication is enabled by default in any cluster consisting of more than one host (the primary host accepts write requests and asynchronously duplicates changes in the secondary hosts). +A {{ MG }} cluster is one or more database hosts across which you can configure [replication](../concepts/replication.md). Replication is enabled by default in any cluster consisting of more than one host, where the primary host accepts write requests and asynchronously replicates the changes in the secondary hosts. {% note info %} @@ -22,105 +22,105 @@ To create a {{ mmg-name }} cluster, you need the [{{ roles-vpc-user }}](../../vp - Management console {#console} - To create a {{ mmg-name }} cluster: + To create a {{ mmg-name }} cluster: - 1. In the [management console]({{ link-console-main }}), select the folder where you want to create a DB cluster. + 1. In the [management console]({{ link-console-main }}), select the folder where you want to create a DB cluster. - 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. + 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. - 1. Click **{{ ui-key.yacloud.mdb.clusters.button_create }}**. + 1. Click **{{ ui-key.yacloud.mdb.clusters.button_create }}**. - 1. Under **{{ ui-key.yacloud.mdb.forms.section_base }}**: + 1. Under **{{ ui-key.yacloud.mdb.forms.section_base }}**: - * Enter a name in the **{{ ui-key.yacloud.mdb.forms.base_field_name }}** field. It must be unique within the folder. + * Enter a name in the **{{ ui-key.yacloud.mdb.forms.base_field_name }}** field. The cluster name must be unique within the cloud. * (Optional) Enter a cluster **{{ ui-key.yacloud.mdb.forms.base_field_description }}**. * Select the environment where you want to create the cluster (you cannot change the environment once the cluster is created): - * `PRODUCTION`: For stable versions of your apps. - * `PRESTABLE`: For testing purposes. The prestable environment is similar to the production environment and likewise covered by the SLA, but it is the first to get new functionalities, improvements, and bug fixes. In the prestable environment, you can test compatibility of new versions with your application. + * `PRODUCTION`: For stable versions of your apps. + * `PRESTABLE`: For testing purposes. The prestable environment is similar to the production environment and likewise covered by the SLA, but it is the first to get new features, improvements, and bug fixes. In the prestable environment, you can test compatibility of new versions with your application. * Specify the DBMS version. - 1. {% include [mmg-settings-host-class](../../_includes/mdb/mmg/settings-host-class.md) %} + 1. {% include [mmg-settings-host-class](../../_includes/mdb/mmg/settings-host-class.md) %} - 1. Under **{{ ui-key.yacloud.mdb.forms.section_disk }}**: + 1. Under **{{ ui-key.yacloud.mdb.forms.section_disk }}**: * Select the [disk type](../concepts/storage.md). - {% include [storages-type-no-change](../../_includes/mdb/storages-type-no-change.md) %} + {% include [storages-type-no-change](../../_includes/mdb/storages-type-no-change.md) %} - {% include [storages-step-settings](../../_includes/mdb/settings-storages.md) %} + {% include [storages-step-settings](../../_includes/mdb/settings-storages.md) %} - * Select the storage size to be used for data and backups. For more information on how backups take up storage space, see [Backups](../concepts/backup.md). + * Select the storage size to be used for data and backups. For more information on how backups consume storage space, see [Backups](../concepts/backup.md). - 1. Under **{{ ui-key.yacloud.mdb.forms.section_database }}**, specify the DB attributes: + 1. Under **{{ ui-key.yacloud.mdb.forms.section_database }}**, specify the DB attributes: * DB name. - {% include [db-name-limits](../../_includes/mdb/mmg/note-info-db-name-limits.md) %} + {% include [db-name-limits](../../_includes/mdb/mmg/note-info-db-name-limits.md) %} - * Username + * Username. * User password. The password must be at least 8 characters long. - 1. Under **{{ ui-key.yacloud.mdb.forms.section_network }}**, select: + 1. Under **{{ ui-key.yacloud.mdb.forms.section_network }}**, select: * Cloud network for the cluster. * Security groups for the cluster network traffic. You may also need to [set up security groups](connect/index.md#configuring-security-groups) to connect to the cluster. - 1. Under **{{ ui-key.yacloud.mdb.forms.section_host }}**, add the DB hosts created with the cluster: + 1. Under **{{ ui-key.yacloud.mdb.forms.section_host }}**, add the DB hosts created with the cluster: - * Click **{{ ui-key.yacloud.mdb.forms.button_add-host }}**. - * Select the [availability zone](../../overview/concepts/geo-scope.md). - * Select the [subnet](../../vpc/concepts/network.md#subnet) in the specified availability zone. If there is no subnet, create one. - * If the host must be available outside {{ yandex-cloud }}, enable **{{ ui-key.yacloud.mdb.hosts.dialog.field_public_ip }}**. You cannot change this setting after you create a host. + * Click **{{ ui-key.yacloud.mdb.forms.button_add-host }}**. + * Select an [availability zone](../../overview/concepts/geo-scope.md). + * Select a [subnet](../../vpc/concepts/network.md#subnet) in the specified availability zone. If there is no subnet, create one. + * If the host must be available outside {{ yandex-cloud }}, enable **{{ ui-key.yacloud.mdb.hosts.dialog.field_public_ip }}**. You cannot change this setting after you create a host. + + To ensure fault tolerance, you need at least 3 hosts for `local-ssd` and `network-ssd-nonreplicated` disk types. For more information, see [Storage](../concepts/storage.md). - To ensure fault tolerance, you need at least 3 hosts for `local-ssd` and `network-ssd-nonreplicated` disk types. For more information, see [Storage](../concepts/storage.md). - - By default, hosts are created in different availability zones. See the [host management](hosts.md). - - 1. Configure additional cluster settings, if required: + By default, hosts are created in different availability zones. Read more about [host management](hosts.md). + + 1. Configure additional cluster settings, if required: {% include [mmg-extra-settings](../../_includes/mdb/mmg-extra-settings.md) %} - 1. Configure the [DBMS settings](../concepts/settings-list.md#dbms-cluster-settings), if required. + 1. Configure the [DBMS settings](../concepts/settings-list.md#dbms-cluster-settings), if required. {% include [mmg-settings-dependence](../../_includes/mdb/mmg/note-info-settings-dependence.md) %} - 1. Click **{{ ui-key.yacloud.mdb.clusters.button_create }}**. + 1. Click **{{ ui-key.yacloud.mdb.clusters.button_create }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To create a {{ mmg-name }} cluster: + To create a {{ mmg-name }} cluster: - 1. Check whether the folder has any subnets for the cluster hosts: + 1. Check whether the folder has any subnets for the cluster hosts: - ```bash - yc vpc subnet list - ``` + ```bash + yc vpc subnet list + ``` - If there are no subnets in the folder, [create the required subnets](../../vpc/operations/subnet-create.md) in {{ vpc-short-name }}. + If there are no subnets in the folder, [create the required subnets](../../vpc/operations/subnet-create.md) in {{ vpc-short-name }}. - 1. View a description of the create cluster CLI command: + 1. View a description of the create cluster CLI command: ```bash {{ yc-mdb-mg }} cluster create --help ``` - 1. Specify the cluster parameters in the create command (the example shows only some of the parameters): + 1. Specify the cluster parameters in the create command (the example below does not list all possible parameters): ```bash @@ -135,7 +135,7 @@ To create a {{ mmg-name }} cluster, you need the [{{ roles-vpc-user }}](../../vp --user name=,password= \ --database name= \ --mongod-disk-type \ - --mongod-disk-size \ + --mongod-disk-size \ --performance-diagnostics= \ --deletion-protection= ``` @@ -145,7 +145,7 @@ To create a {{ mmg-name }} cluster, you need the [{{ roles-vpc-user }}](../../vp Where: - * `--environment`: `prestable` or `production`. + * `--environment`: Environment, `prestable` or `production`. * `--host`: Host parameters: @@ -155,10 +155,10 @@ To create a {{ mmg-name }} cluster, you need the [{{ roles-vpc-user }}](../../vp * `--mongod-disk-type`: Disk type. - {% include [storages-type-no-change](../../_includes/mdb/storages-type-no-change.md) %} + {% include [storages-type-no-change](../../_includes/mdb/storages-type-no-change.md) %} - * `--performance-diagnostics`: Enable performance diagnostics for the cluster, `true` or `false`. + * `--performance-diagnostics`: Enables cluster performance diagnostics, `true` or `false`. * `--deletion-protection`: Cluster deletion protection, `true` or `false`. {% include [db-name-limits](../../_includes/mdb/mmg/note-info-db-name-limits.md) %} @@ -173,107 +173,107 @@ To create a {{ mmg-name }} cluster, you need the [{{ roles-vpc-user }}](../../vp - {{ TF }} {#tf} - {% include [terraform-definition](../../_tutorials/_tutorials_includes/terraform-definition.md) %} + {% include [terraform-definition](../../_tutorials/_tutorials_includes/terraform-definition.md) %} - {% include [terraform-install](../../_includes/terraform-install.md) %} + {% include [terraform-install](../../_includes/terraform-install.md) %} - To create a {{ mmg-name }} cluster: + To create a {{ mmg-name }} cluster: - 1. In the configuration file, describe the parameters of the resources you want to create: + 1. In the configuration file, describe the parameters of the resources you want to create: - * Database cluster: Description of the cluster and its hosts. + * Database cluster: Description of the cluster and its hosts. - * {% include [Terraform network description](../../_includes/mdb/terraform/network.md) %} + * {% include [Terraform network description](../../_includes/mdb/terraform/network.md) %} - * {% include [Terraform subnet description](../../_includes/mdb/terraform/subnet.md) %} + * {% include [Terraform subnet description](../../_includes/mdb/terraform/subnet.md) %} - Here is an example of the configuration file structure: + Here is an example of the configuration file structure: - ```hcl - resource "yandex_mdb_mongodb_cluster" "" { - name = "" - environment = "" - network_id = "" - security_group_ids = [ "" ] - deletion_protection = + ```hcl + resource "yandex_mdb_mongodb_cluster" "" { + name = "" + environment = "" + network_id = "" + security_group_ids = [ "" ] + deletion_protection = - cluster_config { - version = "<{{ MG }}_version>" - } + cluster_config { + version = "<{{ MG }}_version>" + } - resources_mongod { - resource_preset_id = "" - disk_type_id = "" - disk_size = - } + resources_mongod { + resource_preset_id = "" + disk_type_id = "" + disk_size = + } - host { - zone_id = "" - subnet_id = "" - assign_public_ip = - } - } + host { + zone_id = "" + subnet_id = "" + assign_public_ip = + } + } - resource "yandex_mdb_mongodb_database" "" { - cluster_id = "" - name = "" - } + resource "yandex_mdb_mongodb_database" "" { + cluster_id = "" + name = "" + } - resource "yandex_mdb_mongodb_user" "" { - cluster_id = - name = "" - password = "" - permission { - database_name = "" - roles = [ "" ] - } - depends_on = [ - yandex_mdb_mongodb_database. - ] - } + resource "yandex_mdb_mongodb_user" "" { + cluster_id = + name = "" + password = "" + permission { + database_name = "" + roles = [ "" ] + } + depends_on = [ + yandex_mdb_mongodb_database. + ] + } - resource "yandex_vpc_network" "" { name = "" } + resource "yandex_vpc_network" "" { name = "" } - resource "yandex_vpc_subnet" "" { - name = "" - zone = "" - network_id = "" - v4_cidr_blocks = [""] - } - ``` + resource "yandex_vpc_subnet" "" { + name = "" + zone = "" + network_id = "" + v4_cidr_blocks = [""] + } + ``` - Where: + Where: - * `environment`: Environment, `PRESTABLE` or `PRODUCTION`. + * `environment`: Environment, `PRESTABLE` or `PRODUCTION`. - * `host`: Host parameters: - * `zone_id`: Availability zone. - * `subnet_id`: ID of a subnet in the selected availability zone. - * `assign_public_ip`: Public access to the host, `true` or `false`. + * `host`: Host parameters: + * `zone_id`: Availability zone. + * `subnet_id`: ID of a subnet in the selected availability zone. + * `assign_public_ip`: Public access to the host, `true` or `false`. - * `deletion_protection`: Cluster deletion protection, `true` or `false`. - * `version`: {{ MG }} {{ versions.tf.str }}. + * `deletion_protection`: Cluster deletion protection, `true` or `false`. + * `version`: {{ MG }} version, {{ versions.tf.str }}. - {% include [db-name-limits](../../_includes/mdb/mmg/note-info-db-name-limits.md) %} + {% include [db-name-limits](../../_includes/mdb/mmg/note-info-db-name-limits.md) %} - {% include [deletion-protection-limits-db](../../_includes/mdb/deletion-protection-limits-db.md) %} + {% include [deletion-protection-limits-db](../../_includes/mdb/deletion-protection-limits-db.md) %} - {% include [Maintenance window](../../_includes/mdb/mmg/terraform/maintenance-window.md) %} + {% include [Maintenance window](../../_includes/mdb/mmg/terraform/maintenance-window.md) %} - For more information about the resources you can create with {{ TF }}, see the [provider documentation]({{ tf-provider-mmg }}). + For more information about the resources you can create with {{ TF }}, see the [provider documentation]({{ tf-provider-mmg }}). - 1. Make sure the settings are correct. + 1. Make sure the settings are correct. {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} - 1. Create a cluster. + 1. Create a cluster. {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} @@ -283,41 +283,41 @@ To create a {{ mmg-name }} cluster, you need the [{{ roles-vpc-user }}](../../vp - API {#api} - To create a {{ mmg-name }} cluster, use the [create](../api-ref/Cluster/create.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Create](../api-ref/grpc/Cluster/create.md) gRPC API call and provide the following in the request: + To create a {{ mmg-name }} cluster, use the [create](../api-ref/Cluster/create.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Create](../api-ref/grpc/Cluster/create.md) gRPC API call and provide the following in the request: - * ID of the folder where the cluster should be placed, in the `folderId` parameter. - * Cluster name in the `name` parameter. - * Cluster environment in the `environment` parameter. - * Network ID in the `networkId` parameter. - * Cluster configuration in the `configSpec` parameter. - * Configuration of the cluster hosts in one or more `hostSpecs` parameters. + * ID of the folder to host the cluster, in the `folderId` parameter. + * Cluster name in the `name` parameter. + * Cluster environment in the `environment` parameter. + * Network ID in the `networkId` parameter. + * Cluster configuration in the `configSpec` parameter. + * Configuration of the cluster hosts in one or more `hostSpecs` parameters. - * [Security group](../concepts/network.md#security-groups) IDs in the `securityGroupIds` parameter. + * [Security group](../concepts/network.md#security-groups) IDs in the `securityGroupIds` parameter. - * Database configuration in one or more `databaseSpecs` parameters. + * Database configuration in one or more `databaseSpecs` parameters. {% include [db-name-limits](../../_includes/mdb/mmg/note-info-db-name-limits.md) %} - * User settings in one or more `userSpecs` parameters. - * Cluster deletion protection settings in the `deletionProtection` parameter. + * User settings in one or more `userSpecs` parameters. + * Cluster deletion protection settings in the `deletionProtection` parameter. - {% include [deletion-protection-limits-db](../../_includes/mdb/deletion-protection-limits-data.md) %} + {% include [deletion-protection-limits-db](../../_includes/mdb/deletion-protection-limits-data.md) %} {% endlist %} {% note warning %} -If you specified security group IDs when creating a cluster, you may also need to [configure security groups](connect/index.md#configuring-security-groups) to connect to the cluster. +If you specified security group IDs when creating a cluster, you may also need to additionally [configure security groups](connect/index.md#configuring-security-groups) to connect to the cluster. {% endnote %} ## Creating a cluster copy {#duplicate} -You can create a {{ MG }} cluster with the settings of another one created earlier. To do so, you need to import the configuration of the source {{ MG }} cluster to {{ TF }}. Thus you can either create an identical copy or use the imported configuration as the baseline and modify it as needed. Importing is a convenient option when the source {{ MG }} cluster has lots of settings and you need to create a similar one. +You can create a {{ MG }} cluster with the settings of another one you previously created. To do so, you need to import the configuration of the source {{ MG }} cluster to {{ TF }}. This way, you can either create an identical copy or use the imported configuration as the baseline and modify it as needed. Importing a configuration is a good idea when the source {{ MG }} cluster has a lot of settings and you need to create a similar one. To create a {{ MG }} cluster copy: @@ -325,69 +325,69 @@ To create a {{ MG }} cluster copy: - {{ TF }} {#tf} - 1. {% include [terraform-install-without-setting](../../_includes/mdb/terraform/install-without-setting.md) %} - 1. {% include [terraform-authentication](../../_includes/mdb/terraform/authentication.md) %} - 1. {% include [terraform-setting](../../_includes/mdb/terraform/setting.md) %} - 1. {% include [terraform-configure-provider](../../_includes/mdb/terraform/configure-provider.md) %} + 1. {% include [terraform-install-without-setting](../../_includes/mdb/terraform/install-without-setting.md) %} + 1. {% include [terraform-authentication](../../_includes/mdb/terraform/authentication.md) %} + 1. {% include [terraform-setting](../../_includes/mdb/terraform/setting.md) %} + 1. {% include [terraform-configure-provider](../../_includes/mdb/terraform/configure-provider.md) %} - 1. In the same working directory, place a `.tf` file with the following contents: + 1. In the same working directory, place a `.tf` file with the following contents: - ```hcl - resource "yandex_mdb_mongodb_cluster" "old" { } - ``` + ```hcl + resource "yandex_mdb_mongodb_cluster" "old" { } + ``` - 1. Write the ID of the initial {{ MG }} cluster to the environment variable: + 1. Write the ID of the initial {{ MG }} cluster to the environment variable: - ```bash - export MONGODB_CLUSTER_ID= - ``` + ```bash + export MONGODB_CLUSTER_ID= + ``` - You can request the ID with a [list of clusters in the folder](../../managed-mongodb/operations/cluster-list.md#list-clusters). + You can request the ID with a [list of clusters in the folder](../../managed-mongodb/operations/cluster-list.md#list-clusters). - 1. Import the settings of the initial {{ MG }} cluster into the {{ TF }} configuration: + 1. Import the settings of the initial {{ MG }} cluster into the {{ TF }} configuration: - ```bash - terraform import yandex_mdb_mongodb_cluster.old ${MONGODB_CLUSTER_ID} - ``` + ```bash + terraform import yandex_mdb_mongodb_cluster.old ${MONGODB_CLUSTER_ID} + ``` - 1. Get the imported configuration: + 1. Get the imported configuration: - ```bash - terraform show - ``` + ```bash + terraform show + ``` - 1. Copy it from the terminal and paste it into the `.tf` file. - 1. Place the file in the new `imported-cluster` directory. - 1. Modify the copied configuration so that you can create a new cluster from it: + 1. Copy it from the terminal and paste it into the `.tf` file. + 1. Place the file in the new `imported-cluster` directory. + 1. Modify the copied configuration so that you can create a new cluster from it: - * Specify a new cluster name in the `resource` string and the `name` parameter. - * Delete the `created_at`, `health`, `id`, `sharded`, and `status` parameters. - * In the `host` sections, delete the `health` and `name` parameters. - * If the `maintenance_window` section specifies the `type = "ANYTIME"` parameter value, delete the `hour` parameter. - * Delete all `user` sections (if any). You can add database users using the separate `yandex_mdb_mongodb_user` resource. - * (Optional) Make further modifications if you are looking for more customization. + * Specify the new cluster name in the `resource` string and the `name` parameter. + * Delete `created_at`, `health`, `id`, `sharded`, and `status`. + * In the `host` sections, delete `health` and `name`. + * If the `maintenance_window` section has `type = "ANYTIME"`, delete the `hour` parameter. + * Delete all `user` sections (if any). You can add database users using the separate `yandex_mdb_mongodb_user` resource. + * Optionally, make further changes if you need to customize the configuration. - 1. In the `imported-cluster` directory, [get the authentication data](../../tutorials/infrastructure-management/terraform-quickstart.md#get-credentials). + 1. [Get the authentication credentials](../../tutorials/infrastructure-management/terraform-quickstart.md#get-credentials) in the `imported-cluster` directory. - 1. In the same directory, [configure and initialize a provider](../../tutorials/infrastructure-management/terraform-quickstart.md#configure-provider). There is no need to create a provider configuration file manually, you can [download it](https://github.com/yandex-cloud-examples/yc-terraform-provider-settings/blob/main/provider.tf). + 1. In the same directory, [configure and initialize a provider](../../tutorials/infrastructure-management/terraform-quickstart.md#configure-provider). There is no need to create a provider configuration file manually, you can [download it](https://github.com/yandex-cloud-examples/yc-terraform-provider-settings/blob/main/provider.tf). - 1. Place the configuration file in the `imported-cluster` directory and [specify the parameter values](../../tutorials/infrastructure-management/terraform-quickstart.md#configure-provider). If you did not add the authentication credentials to environment variables, specify them in the configuration file. + 1. Place the configuration file in the `imported-cluster` directory and [specify the parameter values](../../tutorials/infrastructure-management/terraform-quickstart.md#configure-provider). If you did not add the authentication credentials to environment variables, specify them in the configuration file. - 1. Check that the {{ TF }} configuration files are correct: + 1. Check that the {{ TF }} configuration files are correct: - ```bash - terraform validate - ``` + ```bash + terraform validate + ``` - If there are any errors in the configuration files, {{ TF }} will point them out. + If there are any errors in the configuration files, {{ TF }} will point them out. - 1. Create the required infrastructure: + 1. Create the required infrastructure: - {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} + {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} - {% include [explore-resources](../../_includes/mdb/terraform/explore-resources.md) %} + {% include [explore-resources](../../_includes/mdb/terraform/explore-resources.md) %} - {% include [Terraform timeouts](../../_includes/mdb/mmg/terraform/timeouts.md) %} + {% include [Terraform timeouts](../../_includes/mdb/mmg/terraform/timeouts.md) %} {% endlist %} @@ -399,345 +399,185 @@ To create a {{ MG }} cluster copy: - CLI {#cli} - To create a cluster with a single host, provide a single `--host` parameter. + To create a cluster with a single host, provide a single `--host` parameter. - Create a {{ mmg-name }} cluster with the following test characteristics: + Create a {{ mmg-name }} cluster with the following test specifications: - * Name: `mymg` - * Environment: `Production` - * Network: `{{ network-name }}` - * Security group ID: `{{ security-group }}` - * `{{ host-class }}` host in the `b0rcctk2rvtr********` subnet in the `{{ region-id }}-a` availability zone: 1 - * Network SSD storage (`{{ disk-type-example }}`): 20 GB - * User: `user1`, with the `user1user1` password - * Database: `db1` - * Protection against accidental cluster deletion: Enabled + * Name: `mymg` + * Environment: `production` + * Network: `{{ network-name }}` + * Security group ID: `{{ security-group }}` + * Host: `{{ host-class }}`, subnet: `b0rcctk2rvtr********`, availability zone: `{{ region-id }}-a` + * Network SSD storage (`{{ disk-type-example }}`): 20 GB + * User: `user1`, password: `user1user1` + * Database: `db1` + * Protection against accidental cluster deletion: Enabled - Run the following command: + Run the following command: - ```bash - {{ yc-mdb-mg }} cluster create \ - --name mymg \ - --environment production \ - --network-name {{ network-name }} \ - --security-group-ids {{ security-group }} \ - --mongod-resource-preset {{ host-class }} \ - --host zone-id={{ region-id }}-a,subnet-id=b0rcctk2rvtr******** \ - --mongod-disk-size 20 \ - --mongod-disk-type {{ disk-type-example }} \ - --user name=user1,password=user1user1 \ - --database name=db1 \ - --deletion-protection=true - ``` + ```bash + {{ yc-mdb-mg }} cluster create \ + --name mymg \ + --environment production \ + --network-name {{ network-name }} \ + --security-group-ids {{ security-group }} \ + --mongod-resource-preset {{ host-class }} \ + --host zone-id={{ region-id }}-a,subnet-id=b0rcctk2rvtr******** \ + --mongod-disk-size 20 \ + --mongod-disk-type {{ disk-type-example }} \ + --user name=user1,password=user1user1 \ + --database name=db1 \ + --deletion-protection=true + ``` - {{ TF }} {#tf} - Create a {{ mmg-name }} cluster and a network for it with the following test characteristics: + Create a {{ mmg-name }} cluster and a network for it with the following test specifications: - * Name: `mymg` - * Version: `{{ versions.tf.latest }}` - * Environment: `PRODUCTION`. - * Cloud ID: `{{ tf-cloud-id }}`. - * Folder ID: `{{ tf-folder-id }}` - * Network: `mynet`. - * Host class: `{{ host-class }}` - * Number of `host` blocks: 1 - * Subnet: `mysubnet`. Network settings: + * Name: `mymg`. + * Version: `{{ versions.tf.latest }}`. + * Environment: `PRODUCTION`. + * Cloud ID: `{{ tf-cloud-id }}`. + * Folder ID: `{{ tf-folder-id }}`. + * Network: `mynet`. + * Host class: `{{ host-class }}`. + * Number of `host` blocks: One. + * Subnet: `mysubnet`. Network settings: - * Availability zone: `{{ region-id }}-a`. - * Range: `10.5.0.0/24` + * Availability zone: `{{ region-id }}-a`. + * Range: `10.5.0.0/24`. - * Security group: `mymg-sg`. The group rules allow TCP connections to the cluster from the internet via port `{{ port-mmg }}`. - - - * Network SSD storage: `{{ disk-type-example }}` - * Storage size: 20 GB - * User: `user1` - * Password: `user1user1` - * Database: `db1` - * Protection against accidental cluster deletion: Enabled - - Configuration file for a single-host cluster: - - - - ```hcl - resource "yandex_mdb_mongodb_cluster" "mymg" { - name = "mymg" - environment = "PRODUCTION" - network_id = yandex_vpc_network.mynet.id - security_group_ids = [ yandex_vpc_security_group.mymg-sg.id ] - deletion_protection = true - - cluster_config { - version = "{{ versions.tf.latest }}" - } - - resources_mongod { - resource_preset_id = "{{ host-class }}" - disk_type_id = "{{ disk-type-example }}" - disk_size = 20 - } - - host { - zone_id = "{{ region-id }}-a" - subnet_id = yandex_vpc_subnet.mysubnet.id - } - } - - resource "yandex_mdb_mongodb_database" "db1" { - cluster_id = yandex_mdb_mongodb_cluster.mymg.id - name = "db1" - } - - resource "yandex_mdb_mongodb_user" "user1" { - cluster_id = yandex_mdb_mongodb_cluster.mymg.id - name = "user1" - password = "user1user1" - permission { - database_name = "db1" - } - depends_on = [ - yandex_mdb_mongodb_database.db1 - ] - } - - resource "yandex_vpc_network" "mynet" { - name = "mynet" - } - - resource "yandex_vpc_security_group" "mymg-sg" { - name = "mymg-sg" - network_id = yandex_vpc_network.mynet.id - - ingress { - description = "MongoDB" - port = {{ port-mmg }} - protocol = "TCP" - v4_cidr_blocks = [ "0.0.0.0/0" ] - } - } - - resource "yandex_vpc_subnet" "mysubnet" { - name = "mysubnet" - zone = "{{ region-id }}-a" - network_id = yandex_vpc_network.mynet.id - v4_cidr_blocks = ["10.5.0.0/24"] - } - ``` - - - - -{% endlist %} - -### Creating sharded clusters {#creating-a-sharded-cluster} - -You can create {{ mmg-name }} clusters with [standard](#std-sharding) or [advanced](#adv-sharding) sharding. For more information about sharding types, see [Sharding management](../concepts/sharding.md#shard-management). - -#### Standard sharding {#std-sharding} - -Create a {{ mmg-name }} cluster and a network for it with multiple hosts: + * Security group: `mymg-sg`. The group rules allow TCP connections to the cluster from the internet via port `{{ port-mmg }}`. -* One `MONGOD` host. -* Three `MONGOINFRA` hosts. -Cluster test specifications: + * Network SSD storage: `{{ disk-type-example }}`. + * Storage size: 20 GB. + * User: `user1`. + * Password: `user1user1`. + * Database: `db1`. + * Protection against accidental cluster deletion: Enabled. -* Name: `mymg` -* Environment: `PRODUCTION`. -* Protection against accidental cluster deletion: Enabled -* Version: `{{ versions.tf.latest }}` -* Database: `db1` -* User: `user1` -* Password: `user1user1` -* `MONGOD` host class: `{{ host-class }}` -* `MONGOINFRA` host class: `c3-c2-m4` -* Network SSD storage: `{{ disk-type-example }}` -* Storage size: 10 GB - -Network characteristics: + Configuration file for a single-host cluster: -* Network: `mynet`. -* Security group: `mymg-sg` with the `{{ security-group }}` ID. In {{ TF }}, a group is created with the rule allowing TCP connections to the cluster from the internet on port `{{ port-mmg }}`. -* Subnet: `mysubnet`. -* Availability zone: `{{ region-id }}-a`. -* Range: `10.5.0.0/24` (only for {{ TF }}) -{% list tabs group=instructions %} + ```hcl + resource "yandex_mdb_mongodb_cluster" "mymg" { + name = "mymg" + environment = "PRODUCTION" + network_id = yandex_vpc_network.mynet.id + security_group_ids = [ yandex_vpc_security_group.mymg-sg.id ] + deletion_protection = true -- CLI {#cli} + cluster_config { + version = "{{ versions.tf.latest }}" + } - To create a {{ mmg-name }} cluster with standard sharding, run this command: - - ```bash - {{ yc-mdb-mg }} cluster create \ - --name mymg \ - --environment production \ - --deletion-protection=true \ - --mongodb-version {{ versions.cli.latest }} \ - --database name=db1 \ - --user name=user1,password=user1user1 \ - --mongod-resource-preset {{ host-class }} \ - --mongod-disk-type {{ disk-type-example }} \ - --mongod-disk-size 10 \ - --host type=mongod,` - `zone-id={{ region-id }}-a,` - `subnet-name=mysubnet \ - --mongoinfra-resource-preset c3-c2-m4 \ - --mongoinfra-disk-type {{ disk-type-example }} \ - --mongoinfra-disk-size 10 \ - --host type=mongoinfra,` - `zone-id={{ region-id }}-a,` - `subnet-name=mysubnet \ - --host type=mongoinfra,` - `zone-id={{ region-id }}-a,` - `subnet-name=mysubnet \ - --host type=mongoinfra,` - `zone-id={{ region-id }}-a,` - `subnet-name=mysubnet \ - --network-name mynet \ - --security-group-ids {{ security-group }} - ``` + resources_mongod { + resource_preset_id = "{{ host-class }}" + disk_type_id = "{{ disk-type-example }}" + disk_size = 20 + } -- {{ TF }} {#tf} + host { + zone_id = "{{ region-id }}-a" + subnet_id = yandex_vpc_subnet.mysubnet.id + } + } - The configuration file for a cluster with standard sharding is as follows: + resource "yandex_mdb_mongodb_database" "db1" { + cluster_id = yandex_mdb_mongodb_cluster.mymg.id + name = "db1" + } - ```hcl - resource "yandex_mdb_mongodb_cluster" "mymg" { - name = "mymg" - environment = "PRODUCTION" - network_id = yandex_vpc_network.mynet.id - security_group_ids = [ yandex_vpc_security_group.mymg-sg.id ] - deletion_protection = true + resource "yandex_mdb_mongodb_user" "user1" { + cluster_id = yandex_mdb_mongodb_cluster.mymg.id + name = "user1" + password = "user1user1" + permission { + database_name = "db1" + } + depends_on = [ + yandex_mdb_mongodb_database.db1 + ] + } - cluster_config { - version = "{{ versions.tf.latest }}" - } + resource "yandex_vpc_network" "mynet" { + name = "mynet" + } - resources_mongod { - resource_preset_id = "{{ host-class }}" - disk_type_id = "{{ disk-type-example }}" - disk_size = 10 - } + resource "yandex_vpc_security_group" "mymg-sg" { + name = "mymg-sg" + network_id = yandex_vpc_network.mynet.id - resources_mongoinfra { - resource_preset_id = "c3-c2-m4" - disk_type_id = "{{ disk-type-example }}" - disk_size = 10 - } + ingress { + description = "MongoDB" + port = {{ port-mmg }} + protocol = "TCP" + v4_cidr_blocks = [ "0.0.0.0/0" ] + } + } - host { - zone_id = "{{ region-id }}-a" - subnet_id = yandex_vpc_subnet.mysubnet.id - type = "mongod" - } + resource "yandex_vpc_subnet" "mysubnet" { + name = "mysubnet" + zone = "{{ region-id }}-a" + network_id = yandex_vpc_network.mynet.id + v4_cidr_blocks = ["10.5.0.0/24"] + } + ``` - host { - zone_id = "{{ region-id }}-a" - subnet_id = yandex_vpc_subnet.mysubnet.id - type = "mongoinfra" - } - host { - zone_id = "{{ region-id }}-a" - subnet_id = yandex_vpc_subnet.mysubnet.id - type = "mongoinfra" - } - host { - zone_id = "{{ region-id }}-a" - subnet_id = yandex_vpc_subnet.mysubnet.id - type = "mongoinfra" - } - resource "yandex_mdb_mongodb_database" "db1" { - cluster_id = yandex_mdb_mongodb_cluster.mymg.id - name = "db1" - } - - resource "yandex_mdb_mongodb_user" "user1" { - cluster_id = yandex_mdb_mongodb_cluster.mymg.id - name = "user1" - password = "user1user1" - permission { - database_name = "db1" - } - depends_on = [ - yandex_mdb_mongodb_database.db1 - ] - } - - resource "yandex_vpc_network" "mynet" { - name = "mynet" - } - - resource "yandex_vpc_security_group" "mymg-sg" { - name = "mymg-sg" - network_id = yandex_vpc_network.mynet.id - - ingress { - description = "MongoDB" - port = {{ port-mmg }} - protocol = "TCP" - v4_cidr_blocks = [ "0.0.0.0/0" ] - } - } +{% endlist %} - resource "yandex_vpc_subnet" "mysubnet" { - name = "mysubnet" - zone = "{{ region-id }}-a" - network_id = yandex_vpc_network.mynet.id - v4_cidr_blocks = ["10.5.0.0/24"] - } - ``` +### Creating sharded clusters {#creating-a-sharded-cluster} -{% endlist %} +You can create {{ mmg-name }} clusters with [standard](#std-sharding) or [advanced](#adv-sharding) sharding. For more information about sharding types, see [Sharding management](../concepts/sharding.md#shard-management). -#### Advanced sharding {#adv-sharding} +#### Standard sharding {#std-sharding} Create a {{ mmg-name }} cluster and a network for it with multiple hosts: -* One `MONGOD` host. -* Two `MONGOS` hosts. -* Three `MONGOCFG` hosts. +* One `MONGOD` host +* Three `MONGOINFRA` hosts Cluster test specifications: -* Name: `mymg` +* Name: `mymg`. * Environment: `PRODUCTION`. -* Protection against accidental cluster deletion: Enabled -* Version: `{{ versions.tf.latest }}` -* Database: `db1` -* User: `user1` -* Password: `user1user1` -* Host class: `{{ host-class }}`. -* Network SSD storage: `{{ disk-type-example }}` -* Storage size: 10 GB +* Protection against accidental cluster deletion: Enabled. +* Version: `{{ versions.tf.latest }}`. +* Database: `db1`. +* User: `user1`. +* Password: `user1user1`. +* `MONGOD` host class: `{{ host-class }}`. +* `MONGOINFRA` host class: `c3-c2-m4`. +* Network SSD storage: `{{ disk-type-example }}`. +* Storage size: 10 GB. Network specifications: * Network: `mynet`. -* Security group: `mymg-sg` with the `{{ security-group }}` ID. In {{ TF }}, a group is created with the rule allowing TCP connections to the cluster from the internet on port `{{ port-mmg }}`. +* Security group: `mymg-sg` with `{{ security-group }}` ID. In {{ TF }}, a group is created with the rule allowing TCP connections to the cluster from the internet on port `{{ port-mmg }}`. + * Subnet: `mysubnet`. * Availability zone: `{{ region-id }}-a`. -* Range: `10.5.0.0/24` (only for {{ TF }}) +* Range: `10.5.0.0/24` (only for {{ TF }}). {% list tabs group=instructions %} - CLI {#cli} - To create a {{ mmg-name }} cluster with extended sharding, run this command: + To create a {{ mmg-name }} cluster with standard sharding, run this command: - ```bash - {{ yc-mdb-mg }} cluster create \ + ```bash + {{ yc-mdb-mg }} cluster create \ --name mymg \ --environment production \ --deletion-protection=true \ @@ -750,141 +590,301 @@ Network specifications: --host type=mongod,` `zone-id={{ region-id }}-a,` `subnet-name=mysubnet \ - --mongos-resource-preset {{ host-class }} \ - --mongos-disk-type {{ disk-type-example }} \ - --mongos-disk-size 10 \ - --host type=mongos,` - `zone-id={{ region-id }}-a,` - `subnet-name=mysubnet \ - --host type=mongos,` - `zone-id={{ region-id }}-a,` - `subnet-name=mysubnet \ - --mongocfg-resource-preset {{ host-class }} \ - --mongocfg-disk-type {{ disk-type-example }} \ - --mongocfg-disk-size 10 \ - --host type=mongocfg,` + --mongoinfra-resource-preset c3-c2-m4 \ + --mongoinfra-disk-type {{ disk-type-example }} \ + --mongoinfra-disk-size 10 \ + --host type=mongoinfra,` `zone-id={{ region-id }}-a,` `subnet-name=mysubnet \ - --host type=mongocfg,` + --host type=mongoinfra,` `zone-id={{ region-id }}-a,` `subnet-name=mysubnet \ - --host type=mongocfg,` + --host type=mongoinfra,` `zone-id={{ region-id }}-a,` `subnet-name=mysubnet \ --network-name mynet \ --security-group-ids {{ security-group }} - ``` + ``` - {{ TF }} {#tf} - The configuration file for a cluster with advanced sharding is as follows: + The configuration file for a cluster with standard sharding is as follows: + + ```hcl + resource "yandex_mdb_mongodb_cluster" "mymg" { + name = "mymg" + environment = "PRODUCTION" + network_id = yandex_vpc_network.mynet.id + security_group_ids = [ yandex_vpc_security_group.mymg-sg.id ] + deletion_protection = true + + cluster_config { + version = "{{ versions.tf.latest }}" + } + + resources_mongod { + resource_preset_id = "{{ host-class }}" + disk_type_id = "{{ disk-type-example }}" + disk_size = 10 + } + + resources_mongoinfra { + resource_preset_id = "c3-c2-m4" + disk_type_id = "{{ disk-type-example }}" + disk_size = 10 + } + + host { + zone_id = "{{ region-id }}-a" + subnet_id = yandex_vpc_subnet.mysubnet.id + type = "mongod" + } + + host { + zone_id = "{{ region-id }}-a" + subnet_id = yandex_vpc_subnet.mysubnet.id + type = "mongoinfra" + } + + host { + zone_id = "{{ region-id }}-a" + subnet_id = yandex_vpc_subnet.mysubnet.id + type = "mongoinfra" + } + + host { + zone_id = "{{ region-id }}-a" + subnet_id = yandex_vpc_subnet.mysubnet.id + type = "mongoinfra" + } + + resource "yandex_mdb_mongodb_database" "db1" { + cluster_id = yandex_mdb_mongodb_cluster.mymg.id + name = "db1" + } + + resource "yandex_mdb_mongodb_user" "user1" { + cluster_id = yandex_mdb_mongodb_cluster.mymg.id + name = "user1" + password = "user1user1" + permission { + database_name = "db1" + } + depends_on = [ + yandex_mdb_mongodb_database.db1 + ] + } + + resource "yandex_vpc_network" "mynet" { + name = "mynet" + } + + resource "yandex_vpc_security_group" "mymg-sg" { + name = "mymg-sg" + network_id = yandex_vpc_network.mynet.id + + ingress { + description = "MongoDB" + port = {{ port-mmg }} + protocol = "TCP" + v4_cidr_blocks = [ "0.0.0.0/0" ] + } + } + + resource "yandex_vpc_subnet" "mysubnet" { + name = "mysubnet" + zone = "{{ region-id }}-a" + network_id = yandex_vpc_network.mynet.id + v4_cidr_blocks = ["10.5.0.0/24"] + } + ``` - ```hcl - resource "yandex_mdb_mongodb_cluster" "mymg" { - name = "mymg" - environment = "PRODUCTION" - network_id = yandex_vpc_network.mynet.id - security_group_ids = [ yandex_vpc_security_group.mymg-sg.id ] - deletion_protection = true +{% endlist %} - cluster_config { - version = "{{ versions.tf.latest }}" - } +#### Advanced sharding {#adv-sharding} - resources_mongod { - resource_preset_id = "{{ host-class }}" - disk_type_id = "{{ disk-type-example }}" - disk_size = 10 - } +Create a {{ mmg-name }} cluster and a network for it with multiple hosts: - resources_mongos { - resource_preset_id = "{{ host-class }}" - disk_type_id = "{{ disk-type-example }}" - disk_size = 10 - } +* One `MONGOD` host +* Two `MONGOS` hosts +* Three `MONGOCFG` hosts - resources_mongocfg { - resource_preset_id = "{{ host-class }}" - disk_type_id = "{{ disk-type-example }}" - disk_size = 10 - } +Cluster test specifications: - host { - zone_id = "{{ region-id }}-a" - subnet_id = yandex_vpc_subnet.mysubnet.id - type = "mongod" - } +* Name: `mymg`. +* Environment: `PRODUCTION`. +* Protection against accidental cluster deletion: Enabled. +* Version: `{{ versions.tf.latest }}`. +* Database: `db1`. +* User: `user1`. +* Password: `user1user1`. +* Host class: `{{ host-class }}`. +* Network SSD storage: `{{ disk-type-example }}`. +* Storage size: 10 GB. - host { - zone_id = "{{ region-id }}-a" - subnet_id = yandex_vpc_subnet.mysubnet.id - type = "mongos" - } +Network specifications: - host { - zone_id = "{{ region-id }}-a" - subnet_id = yandex_vpc_subnet.mysubnet.id - type = "mongos" - } +* Network: `mynet`. +* Security group: `mymg-sg` with `{{ security-group }}` ID. In {{ TF }}, a group is created with the rule allowing TCP connections to the cluster from the internet on port `{{ port-mmg }}`. +* Subnet: `mysubnet`. +* Availability zone: `{{ region-id }}-a`. +* Range: `10.5.0.0/24` (only for {{ TF }}). - host { - zone_id = "{{ region-id }}-a" - subnet_id = yandex_vpc_subnet.mysubnet.id - type = "mongocfg" - } +{% list tabs group=instructions %} - host { - zone_id = "{{ region-id }}-a" - subnet_id = yandex_vpc_subnet.mysubnet.id - type = "mongocfg" - } +- CLI {#cli} - host { - zone_id = "{{ region-id }}-a" - subnet_id = yandex_vpc_subnet.mysubnet.id - type = "mongocfg" - } - } - - resource "yandex_mdb_mongodb_database" "db1" { - cluster_id = yandex_mdb_mongodb_cluster.mymg.id - name = "db1" - } - - resource "yandex_mdb_mongodb_user" "user1" { - cluster_id = yandex_mdb_mongodb_cluster.mymg.id - name = "user1" - password = "user1user1" - permission { - database_name = "db1" - } - depends_on = [ - yandex_mdb_mongodb_database.db1 - ] - } - - resource "yandex_vpc_network" "mynet" { - name = "mynet" - } - - resource "yandex_vpc_security_group" "mymg-sg" { - name = "mymg-sg" - network_id = yandex_vpc_network.mynet.id - - ingress { - description = "MongoDB" - port = {{ port-mmg }} - protocol = "TCP" - v4_cidr_blocks = [ "0.0.0.0/0" ] - } - } - - resource "yandex_vpc_subnet" "mysubnet" { - name = "mysubnet" - zone = "{{ region-id }}-a" - network_id = yandex_vpc_network.mynet.id - v4_cidr_blocks = ["10.5.0.0/24"] - } - ``` + To create a {{ mmg-name }} cluster with advanced sharding, run this command: + + ```bash + {{ yc-mdb-mg }} cluster create \ + --name mymg \ + --environment production \ + --deletion-protection=true \ + --mongodb-version {{ versions.cli.latest }} \ + --database name=db1 \ + --user name=user1,password=user1user1 \ + --mongod-resource-preset {{ host-class }} \ + --mongod-disk-type {{ disk-type-example }} \ + --mongod-disk-size 10 \ + --host type=mongod,` + `zone-id={{ region-id }}-a,` + `subnet-name=mysubnet \ + --mongos-resource-preset {{ host-class }} \ + --mongos-disk-type {{ disk-type-example }} \ + --mongos-disk-size 10 \ + --host type=mongos,` + `zone-id={{ region-id }}-a,` + `subnet-name=mysubnet \ + --host type=mongos,` + `zone-id={{ region-id }}-a,` + `subnet-name=mysubnet \ + --mongocfg-resource-preset {{ host-class }} \ + --mongocfg-disk-type {{ disk-type-example }} \ + --mongocfg-disk-size 10 \ + --host type=mongocfg,` + `zone-id={{ region-id }}-a,` + `subnet-name=mysubnet \ + --host type=mongocfg,` + `zone-id={{ region-id }}-a,` + `subnet-name=mysubnet \ + --host type=mongocfg,` + `zone-id={{ region-id }}-a,` + `subnet-name=mysubnet \ + --network-name mynet \ + --security-group-ids {{ security-group }} + ``` + +- {{ TF }} {#tf} + + The configuration file for a cluster with advanced sharding is as follows: + + ```hcl + resource "yandex_mdb_mongodb_cluster" "mymg" { + name = "mymg" + environment = "PRODUCTION" + network_id = yandex_vpc_network.mynet.id + security_group_ids = [ yandex_vpc_security_group.mymg-sg.id ] + deletion_protection = true + + cluster_config { + version = "{{ versions.tf.latest }}" + } + + resources_mongod { + resource_preset_id = "{{ host-class }}" + disk_type_id = "{{ disk-type-example }}" + disk_size = 10 + } + + resources_mongos { + resource_preset_id = "{{ host-class }}" + disk_type_id = "{{ disk-type-example }}" + disk_size = 10 + } + + resources_mongocfg { + resource_preset_id = "{{ host-class }}" + disk_type_id = "{{ disk-type-example }}" + disk_size = 10 + } + + host { + zone_id = "{{ region-id }}-a" + subnet_id = yandex_vpc_subnet.mysubnet.id + type = "mongod" + } + + host { + zone_id = "{{ region-id }}-a" + subnet_id = yandex_vpc_subnet.mysubnet.id + type = "mongos" + } + + host { + zone_id = "{{ region-id }}-a" + subnet_id = yandex_vpc_subnet.mysubnet.id + type = "mongos" + } + + host { + zone_id = "{{ region-id }}-a" + subnet_id = yandex_vpc_subnet.mysubnet.id + type = "mongocfg" + } + + host { + zone_id = "{{ region-id }}-a" + subnet_id = yandex_vpc_subnet.mysubnet.id + type = "mongocfg" + } + + host { + zone_id = "{{ region-id }}-a" + subnet_id = yandex_vpc_subnet.mysubnet.id + type = "mongocfg" + } + } + + resource "yandex_mdb_mongodb_database" "db1" { + cluster_id = yandex_mdb_mongodb_cluster.mymg.id + name = "db1" + } + + resource "yandex_mdb_mongodb_user" "user1" { + cluster_id = yandex_mdb_mongodb_cluster.mymg.id + name = "user1" + password = "user1user1" + permission { + database_name = "db1" + } + depends_on = [ + yandex_mdb_mongodb_database.db1 + ] + } + + resource "yandex_vpc_network" "mynet" { + name = "mynet" + } + + resource "yandex_vpc_security_group" "mymg-sg" { + name = "mymg-sg" + network_id = yandex_vpc_network.mynet.id + + ingress { + description = "MongoDB" + port = {{ port-mmg }} + protocol = "TCP" + v4_cidr_blocks = [ "0.0.0.0/0" ] + } + } + + resource "yandex_vpc_subnet" "mysubnet" { + name = "mysubnet" + zone = "{{ region-id }}-a" + network_id = yandex_vpc_network.mynet.id + v4_cidr_blocks = ["10.5.0.0/24"] + } + ``` {% endlist %} diff --git a/en/managed-mongodb/operations/cluster-list.md b/en/managed-mongodb/operations/cluster-list.md index 385f5c28ba0..f7a75069b3e 100644 --- a/en/managed-mongodb/operations/cluster-list.md +++ b/en/managed-mongodb/operations/cluster-list.md @@ -7,106 +7,194 @@ description: You can request detailed information about each {{ mmg-short-name } You can request detailed information about each {{ mmg-short-name }} cluster you created. - ## Getting a list of database clusters in a folder {#list-clusters} {% list tabs group=instructions %} - Management console {#console} - Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. + Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To request a list of {{ MG }} clusters in the default folder, run this command: + To request a list of {{ MG }} clusters in the default folder, run the command: - ```bash - yc managed-mongodb cluster list - ``` + ```bash + yc managed-mongodb cluster list + ``` - Result: + Result: - ```text - +----------------------+------------+-----------------------------+--------+---------+ - | ID | NAME | CREATED AT | HEALTH | STATUS | - +----------------------+------------+-----------------------------+--------+---------+ - | c9wlk4v14uq7******** | mymg | 2018-11-02T10:04:14.645214Z | ALIVE | RUNNING | - | ... | - +----------------------+------------+-----------------------------+--------+---------+ - ``` + ```text + +----------------------+------------+-----------------------------+--------+---------+ + | ID | NAME | CREATED AT | HEALTH | STATUS | + +----------------------+------------+-----------------------------+--------+---------+ + | c9wlk4v14uq7******** | mymg | 2018-11-02T10:04:14.645214Z | ALIVE | RUNNING | + | ... | + +----------------------+------------+-----------------------------+--------+---------+ + ``` - API {#api} - To get a list of DB clusters in a folder, use the [list](../api-ref/Cluster/list.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/List](../api-ref/grpc/Cluster/list.md) gRPC API call and provide the folder ID in the `folderId` request parameter. + To get a list of DB clusters in a folder, use the [list](../api-ref/Cluster/list.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/List](../api-ref/grpc/Cluster/list.md) gRPC API call and provide the folder ID in the `folderId` request parameter. {% endlist %} - ## Getting detailed information about a cluster {#get-cluster} {% list tabs group=instructions %} - Management console {#console} - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. - 1. Click the cluster name. + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. + 1. Click the cluster name. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To get information about a {{ MG }} cluster, run the following command: + To get information about the {{ MG }} cluster, run the following command: - ```bash - {{ yc-mdb-mg }} cluster get - ``` + ```bash + {{ yc-mdb-mg }} cluster get + ``` - You can request the cluster ID and name with a [list of clusters in the folder](#list-clusters). + You can request the cluster ID and name with a [list of clusters in the folder](#list-clusters). - API {#api} - To get cluster details, use the [get](../api-ref/Cluster/get.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Get](../api-ref/grpc/Cluster/get.md) gRPC API call and provide the cluster ID in the `clusterId` request parameter. + To get cluster details, use the [get](../api-ref/Cluster/get.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Get](../api-ref/grpc/Cluster/get.md) gRPC API call and provide the cluster ID in the `clusterId` request parameter. You can get the cluster ID with a [list of clusters in the folder](#list-clusters). {% endlist %} -## Viewing a list of operations in a cluster {#list-operations} +## Viewing operations with clusters {#list-operations} -{% include [list-operations-about](../../_includes/mdb/list-operations-about.md) %} +All actions with {{ mmg-name }} clusters are logged as a list of operations. Each operation is assigned a unique ID. + +### Getting a list of operations {#get-operations} {% list tabs group=instructions %} - Management console {#console} - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. - 1. Click the cluster name. - 1. In the left-hand panel, select ![image](../../_assets/console-icons/list-check.svg) **{{ ui-key.yacloud.mongodb.cluster.switch_operations }}**. + To view operations with all {{ mmg-name }} clusters, in the left-hand panel, select ![image](../../_assets/console-icons/list-check.svg) **{{ ui-key.yacloud.mongodb.switch_operations }}**. In the list that opens, you will also see operations with the resources that were deleted. + + You can get a list of operations for a cluster: + + 1. In the [management console]({{ link-console-main }}), open the folder with the cluster. + 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. + 1. In the left-hand panel, select ![image](../../_assets/console-icons/cubes-3.svg) **{{ ui-key.yacloud.mongodb.switch_list }}**. + 1. Select the cluster you need. + 1. Go to the ![image](../../_assets/console-icons/list-check.svg) **{{ ui-key.yacloud.mongodb.switch_operations }}** panel for the selected cluster. + + You will see a list of operations with the selected cluster. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} + + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + To get a list of operations for a {{ mmg-name }} cluster, run this command: - To get a list of operations, run the following command: + ```bash + yc managed-mongodb cluster list-operations + ``` - ```bash - {{ yc-mdb-mg }} cluster list-operations - ``` + Result: - You can request the cluster ID and name with a [list of clusters in the folder](#list-clusters). + ```text + +----------------------+---------------------+----------------------+---------------------+--------+------------------------+ + | ID | CREATED AT | CREATED BY | MODIFIED AT | STATUS | DESCRIPTION | + +----------------------+---------------------+----------------------+---------------------+--------+------------------------+ + | c9ql1rfrqk4u******** | 2024-09-07 16:37:10 | aje9k8luj4qf******** | 2024-09-07 16:44:28 | DONE | Create MongoDB cluster | + +----------------------+---------------------+----------------------+---------------------+--------+------------------------+ + ``` + + You can get the cluster ID and name with a [list of clusters in the folder](#list-clusters). + + By default, information about operations is provided as text. To get detailed information, specify the `yaml` or `json` output data format using the `--format` flag: + + ```bash + yc managed-mongodb cluster list-operations c9qk2926qqu9******** --format yaml + ``` + + Result: + + ```text + - id: c9ql1rfrqk4u******** + description: Create MongoDB cluster + created_at: "2024-09-07T16:37:10.533508Z" + created_by: aje9k8luj4qf******** + modified_at: "2024-09-07T16:44:28.147771Z" + done: true + metadata: + '@type': type.googleapis.com/yandex.cloud.mdb.mongodb.v1.CreateClusterMetadata + cluster_id: c9q8tmbam8co******** + response: + '@type': type.googleapis.com/google.rpc.Status + message: OK + ``` - API {#api} - To get a list of operations, use the [listOperations](../api-ref/Cluster/listOperations.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/ListOperations](../api-ref/grpc/Cluster/listOperations.md) gRPC API call and provide the cluster ID in the `clusterId` request parameter. + Use the [listOperations](../api-ref/Cluster/listOperations.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/ListOperations](../api-ref/grpc/Cluster/listOperations.md) gRPC API call and provide the cluster ID in the request. -You can get the cluster ID with a [list of clusters in the folder](#list-clusters). + You can get the cluster ID with a [list of clusters in the folder](#list-clusters). {% endlist %} + +### Getting detailed information about an operation {#get-operations-info} + +1. [Get a list of operations](#get-operations) for the cluster. +1. Copy the ID of the operation. +1. Get detailed information about the operation: + + {% list tabs group=instructions %} + + - CLI {#cli} + + {% include [cli-install](../../_includes/cli-install.md) %} + + {% include [default-catalogue](../../_includes/default-catalogue.md) %} + + Run this command: + + ```bash + yc operation get + ``` + + Result: + + ```text + id: c9ql1rfrqk4u******** + description: Create MongoDB cluster + created_at: "2024-09-07T16:37:10.533508Z" + created_by: aje9k8luj4qf******** + modified_at: "2024-09-07T16:44:28.147771Z" + done: true + metadata: + '@type': type.googleapis.com/yandex.cloud.mdb.mongodb.v1.CreateClusterMetadata + cluster_id: c9q8tmbam8co******** + response: + '@type': type.googleapis.com/yandex.cloud.mdb.mongodb.v1.Cluster + ... + ``` + + - API {#api} + + Use the [get](../api-ref/Cluster/get.md) REST API method for the [Operation](../api-ref/Operation/index.md) resource or the [OperationService/Get](../api-ref/grpc/Operation/get.md) gRPC API call and provide the operation ID in the request. + + {% endlist %} + +### See also {#see-also} + +* [{#T}](../../api-design-guide/concepts/about-async.md) diff --git a/en/managed-mongodb/operations/cluster-users.md b/en/managed-mongodb/operations/cluster-users.md index 390d10c0c73..189e560f813 100644 --- a/en/managed-mongodb/operations/cluster-users.md +++ b/en/managed-mongodb/operations/cluster-users.md @@ -1,6 +1,6 @@ --- -title: '{{ MG }} user management in {{ mmg-full-name }}' -description: In this tutorial, you will learn how to add and remove users, as well as manage their individual settings in the {{ MG }} database management service. +title: Managing {{ MG }} users in {{ mmg-full-name }} +description: In this tutorial, you will learn how to add and remove users, as well as manage each user’s settings in the {{ MG }} database management service. --- # Managing {{ MG }} users @@ -13,29 +13,29 @@ You can add and delete users as well as manage their individual settings and dat - Management console {#console} - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. - 1. Click the name of the cluster you need and select the ![image](../../_assets/console-icons/persons.svg) **{{ ui-key.yacloud.mongodb.cluster.switch_users }}** tab. + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. + 1. Click the name of the cluster you need and select the ![image](../../_assets/console-icons/persons.svg) **{{ ui-key.yacloud.mongodb.cluster.switch_users }}** tab. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To get a list of cluster users, run the following command: + To get a list of cluster users, run the following command: - ``` - {{ yc-mdb-mg }} user list \ - --cluster-name - ``` + ``` + {{ yc-mdb-mg }} user list \ + --cluster-name + ``` - You can request the cluster name with a [list of clusters in the folder](cluster-list.md#list-clusters). + You can request the cluster name with a [list of clusters in the folder](cluster-list.md#list-clusters). - API {#api} - To get a list of users, use the [list](../api-ref/User/list.md) REST API method for the [User](../api-ref/User/index.md) resource or the [UserService/List](../api-ref/grpc/User/list.md) gRPC API call and provide the cluster ID in the `clusterId` request parameter. + To get a list of users, use the [list](../api-ref/User/list.md) REST API method for the [User](../api-ref/User/index.md) resource or the [UserService/List](../api-ref/grpc/User/list.md) gRPC API call and provide the cluster ID in the `clusterId` request parameter. - You can get the cluster ID with a [list of clusters in the folder](cluster-list.md#list-clusters). + You can get the cluster ID with a [list of clusters in the folder](cluster-list.md#list-clusters). {% endlist %} @@ -44,98 +44,98 @@ You can add and delete users as well as manage their individual settings and dat {% list tabs group=instructions %} - Management console {#console} + + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. + 1. Click the name of the cluster you need and select the ![image](../../_assets/console-icons/persons.svg) **{{ ui-key.yacloud.mongodb.cluster.switch_users }}** tab. - 1. Click the cluster name and select the ![image](../../_assets/console-icons/persons.svg) **{{ ui-key.yacloud.mongodb.cluster.switch_users }}** tab. + 1. Click **{{ ui-key.yacloud.mdb.cluster.users.action_add-user }}**. - 1. Click **{{ ui-key.yacloud.mdb.cluster.users.action_add-user }}**. - - 1. Enter the DB user name and password. + 1. Enter the DB user name and password. {% include [user-name-and-password-limits](../../_includes/mdb/mmg/note-info-user-name-and-pass-limits.md) %} - 1. Configure the [roles](../concepts/users-and-roles.md) for the user: + 1. Configure the [roles](../concepts/users-and-roles.md) for the user: - 1. Click **{{ ui-key.yacloud.mdb.dialogs.button_add-database }}** and select the database where you want to grant a role. - 1. Add roles using ![image](../../_assets/console-icons/plus.svg). + 1. Click **{{ ui-key.yacloud.mdb.dialogs.button_add-database }}** and select the database where you want to grant a role. + 1. Add roles using ![image](../../_assets/console-icons/plus.svg). - You can grant multiple roles to a user in different databases. + You can grant multiple roles to a user in different databases. - 1. Click **{{ ui-key.yacloud.mdb.cluster.users.popup-add_button_add }}**. + 1. Click **{{ ui-key.yacloud.mdb.cluster.users.popup-add_button_add }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To create a user in a cluster: + To create a user in a cluster: - 1. See the description of the create user CLI command: + 1. See the description of the create user CLI command: - ``` - {{ yc-mdb-mg }} user create --help - ``` + ``` + {{ yc-mdb-mg }} user create --help + ``` - 1. Specify the user properties in the create command: - ``` - {{ yc-mdb-mg }} user create \ - --cluster-name \ - --password \ - --permission database=,role=,role=,... \ - --permission database=,role=,... - ``` + 1. Specify the user properties in the create command: + ``` + {{ yc-mdb-mg }} user create \ + --cluster-name \ + --password \ + --permission database=,role=,role=,... \ + --permission database=,role=,... + ``` - {% include [user-name-and-password-limits](../../_includes/mdb/mmg/note-info-user-name-and-pass-limits.md) %} + {% include [user-name-and-password-limits](../../_includes/mdb/mmg/note-info-user-name-and-pass-limits.md) %} - You can request the cluster name with a [list of clusters in the folder](cluster-list.md#list-clusters). + You can request the cluster name with a [list of clusters in the folder](cluster-list.md#list-clusters). - {{ TF }} {#tf} - 1. Open the current {{ TF }} configuration file with an infrastructure plan. + 1. Open the current {{ TF }} configuration file with an infrastructure plan. - For more information about how to create this file, see [Creating clusters](cluster-create.md). + For more information about creating this file, see [Creating clusters](cluster-create.md). - 1. Add the `yandex_mdb_mongodb_user` resource: + 1. Add the `yandex_mdb_mongodb_user` resource: - ```hcl - resource "yandex_mdb_mongodb_user" "" { - cluster_id = - name = "" - password = "" - permission { - database_name = "" - roles = [ "" ] + ```hcl + resource "yandex_mdb_mongodb_user" "" { + cluster_id = + name = "" + password = "" + permission { + database_name = "" + roles = [ "" ] + } } - } - ``` + ``` - Where `database_name` is the name of the DB the access is granted to. + Where `database_name` is the name of the DB you want to grant access to. - {% include [user-name-and-password-limits](../../_includes/mdb/mmg/note-info-user-name-and-pass-limits.md) %} + {% include [user-name-and-password-limits](../../_includes/mdb/mmg/note-info-user-name-and-pass-limits.md) %} - 1. Make sure the settings are correct. + 1. Make sure the settings are correct. - {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} + {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} - 1. Confirm updating the resources. + 1. Confirm updating the resources. - {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} + {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} - For more information, see the [{{ TF }} provider documentation]({{ tf-provider-resources-link }}/mdb_mongodb_user). + For more information, see the [{{ TF }} provider documentation]({{ tf-provider-resources-link }}/mdb_mongodb_user). - API {#api} + + To create a user, use the [create](../api-ref/User/create.md) REST API method for the [User](../api-ref/User/index.md) resource or the [UserService/Create](../api-ref/grpc/User/create.md) gRPC API call and provide the following in the request: - To create a user, use the [create](../api-ref/User/create.md) REST API method for the [User](../api-ref/User/index.md) resource or the [UserService/Create](../api-ref/grpc/User/create.md) gRPC API call and provide the following in the request: - - * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). - * User settings in the `userSpec` parameter: - * Username in the `name` parameter. - * User password in the `password` parameter. - * Database permissions (one or more `permissions` parameters, one for each database): - * Database name in the `databaseName` parameter. To find out the name, [get a list of databases in the cluster](databases.md#list-db). - * Database permissions in the `roles` parameter. + * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). + * User settings in the `userSpec` parameter: + * Username in the `name` parameter. + * User password in the `password` parameter. + * Database access permissions (one or more `permissions` parameters, one for each database): + * Database name in the `databaseName` parameter. To find out the name, [get a list of databases in the cluster](databases.md#list-db). + * Database access permissions in the `roles` parameter. {% endlist %} @@ -145,128 +145,128 @@ You can add and delete users as well as manage their individual settings and dat - Management console {#console} - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. - 1. Click the cluster name and select the ![image](../../_assets/console-icons/persons.svg) **{{ ui-key.yacloud.mongodb.cluster.switch_users }}** tab. + 1. Click the name of the cluster you need and select the ![image](../../_assets/console-icons/persons.svg) **{{ ui-key.yacloud.mongodb.cluster.switch_users }}** tab. - 1. To edit a user password, click ![image](../../_assets/console-icons/ellipsis.svg) in the required user row and select **{{ ui-key.yacloud.mdb.cluster.users.button_action-password }}**. + 1. To edit a user password, click ![image](../../_assets/console-icons/ellipsis.svg) in the row with the user you need and select **{{ ui-key.yacloud.mdb.cluster.users.button_action-password }}**. - {% include [password-limits](../../_includes/mdb/mch/note-info-password-limits.md) %} + {% include [password-limits](../../_includes/mdb/mch/note-info-password-limits.md) %} - 1. To change the user's [roles](../concepts/users-and-roles.md): + 1. To change the user's [roles](../concepts/users-and-roles.md): - 1. Click ![image](../../_assets/console-icons/ellipsis.svg) next to the user and select **{{ ui-key.yacloud.mdb.cluster.users.button_action-update }}**. - 1. To add a role, click ![image](../../_assets/console-icons/plus.svg) next to the appropriate database and select the role. - 1. To delete a role, click ![image](../../_assets/console-icons/xmark.svg) next to the role name. + 1. Click ![image](../../_assets/console-icons/ellipsis.svg) in the row with the user you need and select **{{ ui-key.yacloud.mdb.cluster.users.button_action-update }}**. + 1. To add a role, click ![image](../../_assets/console-icons/plus.svg) next to the appropriate database and select the role. + 1. To delete a role, click ![image](../../_assets/console-icons/xmark.svg) next to the role name. - 1. Click **{{ ui-key.yacloud.mdb.dialogs.popup_button_save }}**. + 1. Click **{{ ui-key.yacloud.mdb.dialogs.popup_button_save }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To change a user's password or list of roles: + To change a user's password or list of roles: - 1. See the description of the CLI's update user command: + 1. See the description of the CLI's update user command: - ``` - {{ yc-mdb-mg }} user update --help - ``` + ``` + {{ yc-mdb-mg }} user update --help + ``` - 1. Specify the user properties in the update command: - ``` - {{ yc-mdb-mg }} user update \ - --cluster-name \ - --password \ - --permission database=,role=,role=,... \ - --permission database=,role=,... - ``` + 1. Specify the user properties in the update command: + ``` + {{ yc-mdb-mg }} user update \ + --cluster-name \ + --password \ + --permission database=,role=,role=,... \ + --permission database=,role=,... + ``` - {% include [password-limits](../../_includes/mdb/mch/note-info-password-limits.md) %} + {% include [password-limits](../../_includes/mdb/mch/note-info-password-limits.md) %} - To grant a user access to a database with a defined list of roles: + To grant a user access to a database with a defined list of roles: - 1. View a description of the CLI command to grant users permissions: + 1. View a description of the CLI command to grant users permissions: - ``` - {{ yc-mdb-mg }} user grant-permission --help - ``` + ``` + {{ yc-mdb-mg }} user grant-permission --help + ``` - 1. Specify the properties of the user in the grant permissions command: + 1. Specify the properties of the user in the grant permissions command: - ```bash - {{ yc-mdb-mg }} user grant-permission \ - --cluster-name \ - --database \ - --role - ``` + ```bash + {{ yc-mdb-mg }} user grant-permission \ + --cluster-name \ + --database \ + --role + ``` - To revoke user database access: + To revoke user database access: - 1. View a description of the CLI command to revoke users' permissions: + 1. View a description of the CLI command to revoke users' permissions: - ``` - {{ yc-mdb-mg }} user revoke-permission --help - ``` + ``` + {{ yc-mdb-mg }} user revoke-permission --help + ``` - 1. Specify the properties of the user in the revoke permissions command: + 1. Specify the properties of the user in the revoke permissions command: - ```bash - {{ yc-mdb-mg }} user revoke-permission \ - --cluster-name \ - --database - ``` + ```bash + {{ yc-mdb-mg }} user revoke-permission \ + --cluster-name \ + --database + ``` - This command completely blocks the user's access to the specified database. + This command denies the user all access to the specified database. - You can request the cluster name with a [list of clusters in the folder](cluster-list.md#list-clusters), the DB name with a [list of databases in the cluster](databases.md#list-db), and the user's name with a [list of users in the cluster](cluster-users.md#list-users). + You can get the cluster name with the [list of clusters in the folder](cluster-list.md#list-clusters), the DB name, with the [list of databases in the cluster](databases.md#list-db), and the user's name, with the [list of users in the cluster](cluster-users.md#list-users). - {{ TF }} {#tf} - 1. Open the current {{ TF }} configuration file with an infrastructure plan. + 1. Open the current {{ TF }} configuration file with an infrastructure plan. - For more information about how to create this file, see [Creating clusters](cluster-create.md). + For more information about creating this file, see [Creating clusters](cluster-create.md). - 1. Find the `yandex_mdb_mongodb_user` resource. - 1. Change the `password` field value and field values under `permission`: + 1. Find the `yandex_mdb_mongodb_user` resource. + 1. Update the `password` field value and field values under `permission`: - ```hcl - resource "yandex_mdb_mongodb_user" "" { - cluster_id = - name = "" - password = "" - permission { - database_name = "" - roles = [ "" ] + ```hcl + resource "yandex_mdb_mongodb_user" "" { + cluster_id = + name = "" + password = "" + permission { + database_name = "" + roles = [ "" ] + } } - } - ``` - - {% include [password-limits](../../_includes/mdb/mch/note-info-password-limits.md) %} + ``` - 1. Make sure the settings are correct. + {% include [password-limits](../../_includes/mdb/mch/note-info-password-limits.md) %} - {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} + 1. Make sure the settings are correct. + + {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} - 1. Confirm updating the resources. + 1. Confirm updating the resources. - {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} + {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} - For more information, see the [{{ TF }} provider documentation]({{ tf-provider-resources-link }}/mdb_mongodb_user). + For more information, see the [{{ TF }} provider documentation]({{ tf-provider-resources-link }}/mdb_mongodb_user). - API {#api} - To update a user, use the [update](../api-ref/User/update.md) REST API method for the [User](../api-ref/User/index.md) resource or the [UserService/Update](../api-ref/grpc/User/update.md) gRPC API call and provide the following in the request: + To update a user, use the [update](../api-ref/User/update.md) REST API method for the [User](../api-ref/User/index.md) resource or the [UserService/Update](../api-ref/grpc/User/update.md) gRPC API call and provide the following in the request: - * ID of the cluster in which the user is located, in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). - * Username in the `userName` parameter. To find out the name, [get a list of users in the cluster](cluster-users.md#list-users). - * Name of the database for which you want to change the list of user roles in the `permissions.databaseName` parameter. To find out the name, [get a list of databases in the cluster](databases.md#list-db). - * Array of the new list of user roles in the `permissions.roles` parameter. - * List of user settings to be updated, in the `updateMask` parameter. + * ID of the cluster in which the user is located, in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). + * Username in the `userName` parameter. To find out the name, [get a list of users in the cluster](cluster-users.md#list-users). + * Name of the database for which you want to update the list of user roles, in the `permissions.databaseName` parameter. To find out the name, [get a list of databases in the cluster](databases.md#list-db). + * Array with the new list of user roles in the `permissions.roles` parameter. + * List of user settings to update, in the `updateMask` parameter. - {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} + {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} {% endlist %} @@ -275,50 +275,50 @@ You can add and delete users as well as manage their individual settings and dat {% list tabs group=instructions %} - Management console {#console} - - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. - 1. Click the cluster name and select the ![image](../../_assets/console-icons/persons.svg) **{{ ui-key.yacloud.mongodb.cluster.switch_users }}** tab. - 1. Click ![image](../../_assets/console-icons/ellipsis.svg) next to the user and select **{{ ui-key.yacloud.mdb.clusters.button_action-delete }}**. + + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. + 1. Click the name of the cluster you need and select the ![image](../../_assets/console-icons/persons.svg) **{{ ui-key.yacloud.mongodb.cluster.switch_users }}** tab. + 1. Click ![image](../../_assets/console-icons/ellipsis.svg) in the row with the user you need and select **{{ ui-key.yacloud.mdb.clusters.button_action-delete }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To remove a user, run: + To remove a user, run: - ``` - {{ yc-mdb-mg }} user delete \ - --cluster-name - ``` + ``` + {{ yc-mdb-mg }} user delete \ + --cluster-name + ``` - You can request the cluster name with a [list of clusters in the folder](cluster-list.md#list-clusters). + You can request the cluster name with a [list of clusters in the folder](cluster-list.md#list-clusters). - {{ TF }} {#tf} - 1. Open the current {{ TF }} configuration file with an infrastructure plan. + 1. Open the current {{ TF }} configuration file with an infrastructure plan. - For more information about how to create this file, see [Creating clusters](cluster-create.md). + For more information about creating this file, see [Creating clusters](cluster-create.md). - 1. Delete the `yandex_mdb_mongodb_user` resource with the description of the user you need. + 1. Delete the `yandex_mdb_mongodb_user` resource with the description of the user you need. - 1. Make sure the settings are correct. + 1. Make sure the settings are correct. - {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} + {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} - 1. Confirm updating the resources. + 1. Confirm updating the resources. - {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} + {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} - For more information, see the [{{ TF }} provider documentation]({{ tf-provider-resources-link }}/mdb_mongodb_user). + For more information, see the [{{ TF }} provider documentation]({{ tf-provider-resources-link }}/mdb_mongodb_user). - API {#api} - To delete a user, use the [delete](../api-ref/User/delete.md) REST API method for the [User](../api-ref/User/index.md) resource or the [UserService/Delete](../api-ref/grpc/User/delete.md) gRPC API call and provide the following in the request: + To delete a user, use the [delete](../api-ref/User/delete.md) REST API method for the [User](../api-ref/User/index.md) resource or the [UserService/Delete](../api-ref/grpc/User/delete.md) gRPC API call and provide the following in the request: - * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). - * Username to delete in the `userName` parameter. To find out the name, [get a list of users in the cluster](#list-users). + * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). + * Name of the user to delete in the `userName` parameter. To find out the name, [get a list of users in the cluster](#list-users). {% endlist %} diff --git a/en/managed-mongodb/operations/cluster-version-update.md b/en/managed-mongodb/operations/cluster-version-update.md index 96290bb18f8..264de14d673 100644 --- a/en/managed-mongodb/operations/cluster-version-update.md +++ b/en/managed-mongodb/operations/cluster-version-update.md @@ -14,8 +14,8 @@ After upgrading, you cannot roll a cluster back to the previous version. Make sure this does not affect your applications: 1. See the {{ MG }} [changelog](https://docs.mongodb.com/manual/release-notes/) to check how updates might affect your applications. -1. Try upgrading the version on a test cluster. You can deploy it from a backup of the main cluster. -1. [Create a backup](cluster-backups.md) of the main cluster directly before the version upgrade. +1. Try upgrading the version on a test cluster. You can [deploy it from a backup](cluster-backups.md#restore) of the main cluster. +1. [Create a backup](cluster-backups.md#create-backup) of the main cluster directly before the version upgrade. ## Upgrading a cluster {#start-update} @@ -51,7 +51,7 @@ Make sure this does not affect your applications: --mongodb-version= ``` - When the update starts, the cluster status will switch to **UPDATING**. Wait for the operation to complete and then check the cluster version. + As soon as you run the upgrade, the cluster status will change to **UPDATING**. Wait for the operation to complete and then check the cluster version. 1. After the upgrade, all MongoDB features that are not backward-compatible with the previous version will be disabled. To remove this restriction, run this command: diff --git a/en/managed-mongodb/operations/connect/index.md b/en/managed-mongodb/operations/connect/index.md index 1aac0b29af4..40fd3797a30 100644 --- a/en/managed-mongodb/operations/connect/index.md +++ b/en/managed-mongodb/operations/connect/index.md @@ -1,9 +1,9 @@ --- -title: Pre-configuration for connection to a {{ MG }} cluster in {{ mmg-full-name }} -description: Follow this guide to prepare for connection to a database in a {{ MG }} cluster. +title: Pre-configuring {{ MG }} cluster connection in {{ mmg-full-name }} +description: Follow this guide to pre-configure a connection to a database in a {{ MG }} cluster. --- -# Pre-configuration for connection to a {{ MG }} cluster +# Pre-configuring a connection to a {{ MG }} cluster You can connect to {{ mmg-short-name }} cluster hosts: @@ -36,47 +36,47 @@ Rule settings depend on the connection method you select: - Over the internet {#internet} - [Configure all the cluster security groups](../../../vpc/operations/security-group-add-rule.md) to allow incoming traffic from any IP address on port `{{ port-mmg }}` for an unsharded cluster or on port `{{ port-mmg-sharded }}` for a [sharded](../shards.md) one. To do this, create the following rule for incoming traffic: + [Configure all the cluster security groups](../../../vpc/operations/security-group-add-rule.md) to allow incoming traffic from any IP address on port `{{ port-mmg }}` for an unsharded cluster or on port `{{ port-mmg-sharded }}` for a [sharded](../shards.md) one. To do this, create the following rule for incoming traffic: - * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-port-range }}**: - * `{{ port-mmg }}` for a non-sharded cluster - * `{{ port-mmg-sharded }}` for a sharded cluster - * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-protocol }}**: `{{ ui-key.yacloud.common.label_tcp }}` - * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-source }}**: `{{ ui-key.yacloud.vpc.network.security-groups.forms.value_sg-rule-destination-cidr }}` - * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-cidr-blocks }}**: `0.0.0.0/0` + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-port-range }}**: + * `{{ port-mmg }}` for a non-sharded cluster + * `{{ port-mmg-sharded }}` for a sharded cluster + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-protocol }}**: `{{ ui-key.yacloud.common.label_tcp }}` + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-source }}**: `{{ ui-key.yacloud.vpc.network.security-groups.forms.value_sg-rule-destination-cidr }}` + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-cidr-blocks }}**: `0.0.0.0/0` - From a VM in {{ yandex-cloud }} {#cloud} - 1. [Configure all the cluster security groups](../../../vpc/operations/security-group-add-rule.md) to allow incoming traffic from the security group where your VM is located on port `{{ port-mmg }}` for an unsharded cluster and on port `{{ port-mmg-sharded }}` for a [sharded](../shards.md) one. To do this, create the following rule for incoming traffic in these groups: + 1. [Configure all the cluster security groups](../../../vpc/operations/security-group-add-rule.md) to allow incoming traffic from the security group where your VM is located on port `{{ port-mmg }}` for an unsharded cluster and on port `{{ port-mmg-sharded }}` for a [sharded](../shards.md) one. To do this, create the following rule for incoming traffic in these groups: - * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-port-range }}**: - * `{{ port-mmg }}` for a non-sharded cluster - * `{{ port-mmg-sharded }}` for a sharded cluster - * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-protocol }}**: `{{ ui-key.yacloud.common.label_tcp }}` - * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-source }}**: `{{ ui-key.yacloud.vpc.network.security-groups.forms.value_sg-rule-destination-sg }}` - * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-sg-type }}**: Security group assigned to the VM. If it is the same as the group being configured, specify `{{ ui-key.yacloud.vpc.network.security-groups.forms.value_sg-rule-sg-type-self }}` (`Self`). + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-port-range }}**: + * `{{ port-mmg }}` for a non-sharded cluster + * `{{ port-mmg-sharded }}` for a sharded cluster + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-protocol }}**: `{{ ui-key.yacloud.common.label_tcp }}` + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-source }}**: `{{ ui-key.yacloud.vpc.network.security-groups.forms.value_sg-rule-destination-sg }}` + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-sg-type }}**: Security group assigned to the VM. If it is the same as the configured group, specify `{{ ui-key.yacloud.vpc.network.security-groups.forms.value_sg-rule-sg-type-self }}` (`Self`). + + 1. [Configure the security group](../../../vpc/operations/security-group-add-rule.md) where the VM is located to enable connections to the VM and traffic between the VM and the cluster hosts. - 1. [Configure the security group](../../../vpc/operations/security-group-add-rule.md) where the VM is located to enable connections to the VM and traffic between the VM and the cluster hosts. + For example, you can set the following rules for a VM: - For example, you can set the following rules for a VM: + * For incoming traffic: - * For incoming traffic: + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-port-range }}**: `{{ port-ssh }}` + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-protocol }}**: `{{ ui-key.yacloud.common.label_tcp }}` + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-source }}**: `{{ ui-key.yacloud.vpc.network.security-groups.forms.value_sg-rule-destination-cidr }}` + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-cidr-blocks }}**: `0.0.0.0/0` - * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-port-range }}**: `{{ port-ssh }}` - * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-protocol }}**: `{{ ui-key.yacloud.common.label_tcp }}` - * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-source }}**: `{{ ui-key.yacloud.vpc.network.security-groups.forms.value_sg-rule-destination-cidr }}` - * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-cidr-blocks }}**: `0.0.0.0/0` + This rule allows you to connect to a VM over SSH. - This rule allows you to connect to the VM over SSH. + * For outgoing traffic: - * For outgoing traffic: + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-port-range }}**: `{{ port-any }}`. + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-protocol }}**: `{{ ui-key.yacloud.vpc.network.security-groups.forms.value_any }}` (`Any`) + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-source }}**: `{{ ui-key.yacloud.vpc.network.security-groups.forms.value_sg-rule-destination-cidr }}` + * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-cidr-blocks }}**: `0.0.0.0/0` - * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-port-range }}**: `{{ port-any }}` - * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-protocol }}**: `{{ ui-key.yacloud.vpc.network.security-groups.forms.value_any }}` - * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-source }}**: `{{ ui-key.yacloud.vpc.network.security-groups.forms.value_sg-rule-destination-cidr }}` - * **{{ ui-key.yacloud.vpc.network.security-groups.forms.field_sg-rule-cidr-blocks }}**: `0.0.0.0/0` - - This rule allows all outgoing traffic, thus enabling you not only to connect to the cluster but also to install the certificates and utilities your VM needs for the connection. + This rule allows all outgoing traffic, thus enabling you not only to connect to the cluster but also to install the certificates and utilities your VM needs for the connection. {% endlist %} @@ -104,12 +104,14 @@ To connect to public {{ MG }} hosts, get an SSL certificate: To connect to a host, you need its fully qualified domain name ([FQDN](../../concepts/network.md#hostname)). You can obtain it in one of the following ways: * [Request a list of cluster hosts](../hosts.md#list-hosts). -* In the [management console]({{ link-console-main }}), copy the command for connecting to the cluster. This command contains the host FQDN. To get the command, go to the cluster page and click **{{ ui-key.yacloud.mdb.clusters.button_action-connect }}**. -* Look up the FQDN in the management console: +* Look up the FQDN in the [management console]({{ link-console-main }}): + + 1. Go to the cluster page. + 1. Go to **{{ ui-key.yacloud.mdb.cluster.hosts.label_title }}**. + 1. Copy the **{{ ui-key.yacloud.mdb.cluster.hosts.host_column_name }}** column value. + +* In the management console, copy the command for connecting to the cluster. This command contains the host FQDN. To get the command, go to the cluster page and click **{{ ui-key.yacloud.mdb.clusters.button_action-connect }}**. - 1. Go to the cluster page. - 1. Go to **{{ ui-key.yacloud.mdb.cluster.hosts.label_title }}**. - 1. Copy the **{{ ui-key.yacloud.mdb.cluster.hosts.host_column_name }}** column value. ## Connection limits {#connection-limits} diff --git a/en/managed-mongodb/operations/databases.md b/en/managed-mongodb/operations/databases.md index 1bec316d7bd..c7808c00b03 100644 --- a/en/managed-mongodb/operations/databases.md +++ b/en/managed-mongodb/operations/databases.md @@ -8,29 +8,29 @@ You can add and remove databases, as well as view information about them. - Management console {#console} - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. - 1. Click the cluster name and select the **{{ ui-key.yacloud.mongodb.cluster.switch_databases }}** tab. + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. + 1. Click the name of the cluster you need and select the **{{ ui-key.yacloud.mongodb.cluster.switch_databases }}** tab. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To get a list of databases in a cluster, run the command: + To get a list of databases in a cluster, run the command: - ```bash - {{ yc-mdb-mg }} database list - --cluster-name - ``` + ```bash + {{ yc-mdb-mg }} database list + --cluster-name + ``` - You can request the cluster name with a [list of clusters in the folder](cluster-list.md#list-clusters). + You can request the cluster name with a [list of clusters in the folder](cluster-list.md#list-clusters). - API {#api} - To get a list of cluster databases, use the [list](../api-ref/Database/list.md) REST API method for the [Database](../api-ref/Database/index.md) resource or the [DatabaseService/List](../api-ref/grpc/Database/list.md) gRPC API call and provide the cluster ID in the `clusterId` request parameter. + To get a list of cluster databases, use the [list](../api-ref/Database/list.md) REST API method for the [Database](../api-ref/Database/index.md) resource or the [DatabaseService/List](../api-ref/grpc/Database/list.md) gRPC API call and provide the cluster ID in the `clusterId` request parameter. - You can get the cluster ID with a [list of clusters in the folder](cluster-list.md#list-clusters). + You can get the cluster ID with a [list of clusters in the folder](cluster-list.md#list-clusters). {% endlist %} @@ -42,72 +42,72 @@ You can add and remove databases, as well as view information about them. - Management console {#console} - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. - 1. Click the cluster name. - 1. Select the **{{ ui-key.yacloud.mongodb.cluster.switch_databases }}** tab. - 1. Click **{{ ui-key.yacloud.mdb.cluster.databases.action_add-database }}**. - 1. Enter the database name and click **{{ ui-key.yacloud.mdb.dialogs.popup-add-db_button_add }}**. + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. + 1. Click the cluster name. + 1. Select the **{{ ui-key.yacloud.mongodb.cluster.switch_databases }}** tab. + 1. Click **{{ ui-key.yacloud.mdb.cluster.databases.action_add-database }}**. + 1. Enter the database name and click **{{ ui-key.yacloud.mdb.dialogs.popup-add-db_button_add }}**. {% include [db-name-limits](../../_includes/mdb/mmg/note-info-db-name-limits.md) %} - 1. [Authorize](cluster-users.md#updateuser) the appropriate cluster users for access to the database created. + 1. [Assign roles](cluster-users.md#updateuser) to allow access to the created database to the appropriate cluster users. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - Run the create database command and set the name of the new database: + Run the create database command and set the name of the new database: - ```bash - {{ yc-mdb-mg }} database create - --cluster-name - ``` + ```bash + {{ yc-mdb-mg }} database create + --cluster-name + ``` - {% include [db-name-limits](../../_includes/mdb/mmg/note-info-db-name-limits.md) %} + {% include [db-name-limits](../../_includes/mdb/mmg/note-info-db-name-limits.md) %} - You can request the cluster name with a [list of clusters in the folder](cluster-list.md#list-clusters). + You can request the cluster name with a [list of clusters in the folder](cluster-list.md#list-clusters). - {{ mmg-short-name }} runs the create database operation. + {{ mmg-short-name }} runs the create database operation. - [Authorize](cluster-users.md#updateuser) the appropriate cluster users for access to the database created. + [Authorize](cluster-users.md#updateuser) the appropriate cluster users for access to the database created. - {{ TF }} {#tf} - 1. Open the current {{ TF }} configuration file with an infrastructure plan. + 1. Open the current {{ TF }} configuration file with an infrastructure plan. - For more information about how to create this file, see [Creating clusters](cluster-create.md). + For more information about creating this file, see [Creating clusters](cluster-create.md). - 1. Add the `yandex_mdb_mongodb_database` resource: + 1. Add the `yandex_mdb_mongodb_database` resource: - ```hcl - resource "yandex_mdb_mongodb_database" "" { - cluster_id = "" - name = "" - } - ``` + ```hcl + resource "yandex_mdb_mongodb_database" "" { + cluster_id = "" + name = "" + } + ``` - {% include [db-name-limits](../../_includes/mdb/mmg/note-info-db-name-limits.md) %} + {% include [db-name-limits](../../_includes/mdb/mmg/note-info-db-name-limits.md) %} - 1. Make sure the settings are correct. + 1. Make sure the settings are correct. - {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} + {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} - 1. Confirm updating the resources. + 1. Confirm updating the resources. - {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} + {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} - For more information, see the [{{ TF }} provider documentation]({{ tf-provider-resources-link }}/mdb_mongodb_database). + For more information, see the [{{ TF }} provider documentation]({{ tf-provider-resources-link }}/mdb_mongodb_database). - API {#api} - To create a new database in a cluster, use the [create](../api-ref/Database/create.md) REST API method for the [Database](../api-ref/Database/index.md) resource or the [DatabaseService/Create](../api-ref/grpc/Database/create.md) gRPC API call and provide the following in the request: + To create a new database in a cluster, use the [create](../api-ref/Database/create.md) REST API method for the [Database](../api-ref/Database/index.md) resource or the [DatabaseService/Create](../api-ref/grpc/Database/create.md) gRPC API call and provide the following in the request: - * ID of the cluster where you want to create a database, in the `clusterId` parameter. To retrieve the ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). - * Database settings in the `databaseSpec` parameter. + * ID of the cluster where you want to create a database, in the `clusterId` parameter. To retrieve the ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). + * Database settings in the `databaseSpec` parameter. - To allow access to the created database, use the [update](../api-ref/User/update.md) REST API method for the [User](../api-ref/User/index.md) resource or the [UserService/Update](../api-ref/grpc/User/update.md) gRPC API call. + To allow access to the created database, use the [update](../api-ref/User/update.md) REST API method for the [User](../api-ref/User/index.md) resource or the [UserService/Update](../api-ref/grpc/User/update.md) gRPC API call. {% endlist %} @@ -117,49 +117,49 @@ You can add and remove databases, as well as view information about them. - Management console {#console} - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. - 1. Click the cluster name and open the **{{ ui-key.yacloud.mongodb.cluster.switch_databases }}** tab. - 1. Click the ![image](../../_assets/console-icons/ellipsis.svg) icon in the same row as the DB and select **{{ ui-key.yacloud.mdb.cluster.databases.button_action-remove }}**. + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. + 1. Click the cluster name and open the **{{ ui-key.yacloud.mongodb.cluster.switch_databases }}** tab. + 1. Click ![image](../../_assets/console-icons/ellipsis.svg) in the row with the DB you need and select **{{ ui-key.yacloud.mdb.cluster.databases.button_action-remove }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To delete a database, run the command: + To delete a database, run the command: - ```bash - {{ yc-mdb-mg }} database delete - --cluster-name - ``` + ```bash + {{ yc-mdb-mg }} database delete + --cluster-name + ``` - You can request the cluster name with a [list of clusters in the folder](cluster-list.md#list-clusters). + You can request the cluster name with a [list of clusters in the folder](cluster-list.md#list-clusters). - {{ TF }} {#tf} - 1. Open the current {{ TF }} configuration file with an infrastructure plan. + 1. Open the current {{ TF }} configuration file with an infrastructure plan. - For more information about how to create this file, see [Creating clusters](cluster-create.md). + For more information about creating this file, see [Creating clusters](cluster-create.md). - 1. Delete the `yandex_mdb_mongodb_database` resource with the name of the database you want to delete. + 1. Delete the `yandex_mdb_mongodb_database` resource with the name of the database you want to delete. - 1. Make sure the settings are correct. + 1. Make sure the settings are correct. - {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} + {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} - 1. Confirm updating the resources. + 1. Confirm updating the resources. - {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} + {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} - For more information, see the [{{ TF }} provider documentation]({{ tf-provider-resources-link }}/mdb_mongodb_database). + For more information, see the [{{ TF }} provider documentation]({{ tf-provider-resources-link }}/mdb_mongodb_database). - API {#api} - To delete a database, use the [delete](../api-ref/Database/delete.md) REST API method for the [Database](../api-ref/Database/index.md) resource or the [DatabaseService/Delete](../api-ref/grpc/Database/delete.md) gRPC API call and provide the following in the request: + To delete a database, use the [delete](../api-ref/Database/delete.md) REST API method for the [Database](../api-ref/Database/index.md) resource or the [DatabaseService/Delete](../api-ref/grpc/Database/delete.md) gRPC API call and provide the following in the request: - * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md). - * Database name in the `databaseName` parameter. + * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md). + * Database name in the `databaseName` parameter. {% endlist %} diff --git a/en/managed-mongodb/operations/host-migration.md b/en/managed-mongodb/operations/host-migration.md index e0da34b9282..b3d71009dda 100644 --- a/en/managed-mongodb/operations/host-migration.md +++ b/en/managed-mongodb/operations/host-migration.md @@ -2,7 +2,7 @@ {{ mmg-name }} cluster hosts reside in [availability zones](../../overview/concepts/geo-scope.md) {{ yandex-cloud }}. To move hosts from one availability zone to another: -1. [Create a subnet](../../vpc/operations/subnet-create.md) in the availability zone you want to move cluster hosts to. +1. [Create a subnet](../../vpc/operations/subnet-create.md) in the availability zone you want to move your hosts to. 1. Add a host to your cluster: {% list tabs group=instructions %} @@ -11,7 +11,7 @@ 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. 1. Click the name of the {{ mmg-name }} cluster you need and go to the **{{ ui-key.yacloud.mdb.cluster.switch_hosts }}** tab. - 1. Click ![image](../../_assets/console-icons/plus.svg) **{{ ui-key.yacloud.mdb.cluster.hosts.action_add-host }}**. + 1. Click ![image](../../_assets/console-icons/plus.svg) **{{ ui-key.yacloud.mdb.cluster.hosts.action_add-host }}**. 1. Specify the host parameters: * Availability zone to which you want to move the hosts. @@ -34,14 +34,14 @@ --host type=,` `zone-id=,` `subnet-id=,` - `assign-public-ip= + `assign-public-ip= ``` Command specifics: * You can retrieve the cluster name with a [list of clusters in the folder](cluster-list.md#list-clusters). - * The `type` parameter may take the following values: `mongod`, `mongos`, `mongocfg`, or `mongoinfra`. The host type depends on the [sharding type](../concepts/sharding.md#shard-management). - * In the `zone-id` parameter, specify the availability zone you want to move the hosts to. + * Possible `type` values: `mongod`, `mongos`, `mongocfg`, or `mongoinfra`. The host type depends on the [sharding type](../concepts/sharding.md#shard-management). + * In the `zone-id` parameter, specify the availability zone you are moving the hosts to. - {{ TF }} {#tf} @@ -54,13 +54,13 @@ type = "" zone_id = "" subnet_id = "" - assign_public_ip = + assign_public_ip = ... } } ``` - The `type` parameter may take the following values: `MONGOD`, `MONGOINFRA`, `MONGOS`, or `MONGOCFG`. The host type depends on the [sharding type](../concepts/sharding.md#shard-management). + Possible `type` values: `MONGOD`, `MONGOINFRA`, `MONGOS`, or `MONGOCFG`. The host type depends on the [sharding type](../concepts/sharding.md#shard-management). In the `zone` parameter, specify the availability zone you are moving the hosts to. @@ -91,6 +91,8 @@ The FQDN is specified in the command output under `NAME`. + To learn how to get a host FQDN in the [management console]({{ link-console-main }}), see [this guide](connect/index.md#get-fqdn). + 1. Delete the hosts in the source availability zone: {% list tabs group=instructions %} diff --git a/en/managed-mongodb/operations/hosts.md b/en/managed-mongodb/operations/hosts.md index 389a2eeee36..871d744810e 100644 --- a/en/managed-mongodb/operations/hosts.md +++ b/en/managed-mongodb/operations/hosts.md @@ -8,107 +8,107 @@ You can add and remove [cluster hosts](../concepts/index.md), resync the hosts, - Management console {#console} - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. - 1. Click the name of the {{ mmg-name }} cluster. - 1. Select the **{{ ui-key.yacloud.mdb.cluster.switch_hosts }}** tab. + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. + 1. Click the name of the {{ mmg-name }} cluster. + 1. Select the **{{ ui-key.yacloud.mdb.cluster.switch_hosts }}** tab. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To get a list of {{ mmg-name }} cluster hosts, run this command: + To get a list of {{ mmg-name }} cluster hosts, run this command: - ```bash - {{ yc-mdb-mg }} host list \ - --cluster-name - ``` + ```bash + {{ yc-mdb-mg }} host list \ + --cluster-name + ``` - Result: + Result: - ```text - +----------------------------+----------------------+--------+------------+--------------+----------+---------------+-----------+ - | NAME | CLUSTER ID | TYPE | SHARD NAME | ROLE | HEALTH | ZONE ID | PUBLIC IP | - +----------------------------+----------------------+--------+------------+--------------+----------+---------------+-----------+ - | rc1b...{{ dns-zone }} | c9qp71dk1q1w******** | MONGOD | rs01 | PRIMARY | ALIVE | {{ region-id }}-b | false | - | rc1a...{{ dns-zone }} | c9qp71dk1q1w******** | MONGOD | rs01 | SECONDARY | ALIVE | {{ region-id }}-a | false | - +----------------------------+----------------------+--------+------------+--------------+----------+---------------+-----------+ - ``` + ```text + +----------------------------+----------------------+--------+------------+--------------+----------+---------------+-----------+ + | NAME | CLUSTER ID | TYPE | SHARD NAME | ROLE | HEALTH | ZONE ID | PUBLIC IP | + +----------------------------+----------------------+--------+------------+--------------+----------+---------------+-----------+ + | rc1b...{{ dns-zone }} | c9qp71dk1q1w******** | MONGOD | rs01 | PRIMARY | ALIVE | {{ region-id }}-b | false | + | rc1a...{{ dns-zone }} | c9qp71dk1q1w******** | MONGOD | rs01 | SECONDARY | ALIVE | {{ region-id }}-a | false | + +----------------------------+----------------------+--------+------------+--------------+----------+---------------+-----------+ + ``` - You can request the {{ mmg-name }} cluster name with a [list of clusters in the folder](cluster-list.md#list-clusters). + You can request the {{ mmg-name }} cluster name with a [list of clusters in the folder](cluster-list.md#list-clusters). - API {#api} - To get a list of {{ mmg-name }} cluster hosts, use the [listHosts](../api-ref/Cluster/listHosts.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/ListHosts](../api-ref/grpc/Cluster/listHosts.md) gRPC API call and provide the cluster ID in the `clusterId` request parameter. + To get a list of {{ mmg-name }} cluster hosts, use the [listHosts](../api-ref/Cluster/listHosts.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/ListHosts](../api-ref/grpc/Cluster/listHosts.md) gRPC API call and provide the cluster ID in the `clusterId` request parameter. - You can get the cluster ID with a [list of clusters in the folder](cluster-list.md#list-clusters). + You can get the cluster ID with a [list of clusters in the folder](cluster-list.md#list-clusters). {% endlist %} ## Adding a host {#add-host} -The number of hosts in {{ mmg-name }} clusters is limited by the CPU and RAM quotas available to DB clusters in your [cloud](../../resource-manager/concepts/resources-hierarchy.md#cloud). To check the resources in use, open the [Quotas]({{ link-console-quotas }}) page and find **{{ mmg-name }}**. +The number of hosts in {{ mmg-name }} clusters is limited by the CPU and RAM quotas available to DB clusters in your [cloud](../../resource-manager/concepts/resources-hierarchy.md#cloud). To check the resources currently in use, open the [Quotas]({{ link-console-quotas }}) page and find **{{ mmg-name }}**. You can add different types of hosts to a {{ mmg-name }} cluster. Their number depends on the [sharding type](../concepts/sharding.md#shard-management): {#hosts-table} -| Sharding type | MONGOD | MONGOINFRA | MONGOS | MONGOCFG | +Sharding type | MONGOD | MONGOINFRA | MONGOS | MONGOCFG --- | --- | --- | --- | --- -| No sharding | ⩾ 1 | — | — | — | -| Standard | ⩾ 1 | ⩾ 3 | — | — | -| Advanced | ⩾ 1 | — | ⩾ 2 | ⩾ 3 | +No sharding | ⩾ 1 | — | — | — +Standard | ⩾ 1 | ⩾ 3 | — | — +Advanced | ⩾ 1 | — | ⩾ 2 | ⩾ 3 {% list tabs group=instructions %} - Management console {#console} - To add a host to your {{ mmg-name }} cluster: - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. - 1. Click the name of the {{ mmg-name }} cluster you need and go to the **{{ ui-key.yacloud.mdb.cluster.switch_hosts }}** tab. - 1. Click **{{ ui-key.yacloud.mdb.cluster.hosts.action_add-host }}**. - 1. Specify the host parameters: - * [Availability zone](../../overview/concepts/geo-scope.md). - * [Subnet](../../vpc/concepts/network.md#subnet) (if the required subnet is not on the list, create it). - * Select **{{ ui-key.yacloud.mdb.hosts.dialog.field_public_ip }}** if the host must be accessible from outside {{ yandex-cloud }}. You cannot change this setting after you create a host. - * Host type and shard name, if sharding is enabled for the {{ mmg-name }} cluster. - 1. Click **{{ ui-key.yacloud.mdb.hosts.dialog.button_choose }}**. + To add a host to your {{ mmg-name }} cluster: + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. + 1. Click the name of the {{ mmg-name }} cluster you need and go to the **{{ ui-key.yacloud.mdb.cluster.switch_hosts }}** tab. + 1. Click **{{ ui-key.yacloud.mdb.cluster.hosts.action_add-host }}**. + 1. Specify the host parameters: + * [Availability zone](../../overview/concepts/geo-scope.md). + * [Subnet](../../vpc/concepts/network.md#subnet) (if the required subnet is not on the list, create it). + * Select **{{ ui-key.yacloud.mdb.hosts.dialog.field_public_ip }}** if the host must be accessible from outside {{ yandex-cloud }}. You cannot change this setting after you create a host. + * Host type and shard name, if sharding is enabled for the {{ mmg-name }} cluster. + 1. Click **{{ ui-key.yacloud.mdb.hosts.dialog.button_choose }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To add a host to your {{ mmg-name }} cluster: - 1. Request a list of {{ mmg-name }} cluster subnets to select a [subnet](../../vpc/concepts/network.md#subnet) for the new host: + To add a host to your {{ mmg-name }} cluster: + 1. Request a list of {{ mmg-name }} cluster subnets to select a [subnet](../../vpc/concepts/network.md#subnet) for the new host: - ```bash - yc vpc subnet list - ``` + ```bash + yc vpc subnet list + ``` - Result: - - ```text - +----------------------+-----------+-----------------------+---------------+------------------+ - | ID | NAME | NETWORK ID | ZONE | RANGE | - +----------------------+-----------+-----------------------+---------------+------------------+ - | b0cl69a2b4c6******** | default-d | enp6rq72rndgr******** | {{ region-id }}-d | [172.16.0.0/20] | - | e2lkj9qwe762******** | default-b | enp6rq72rndgr******** | {{ region-id }}-b | [10.10.0.0/16] | - | e9b0ph42bn96******** | a-2 | enp6rq72rndgr******** | {{ region-id }}-a | [172.16.32.0/20] | - | e9b9v22r88io******** | default-a | enp6rq72rndgr******** | {{ region-id }}-a | [172.16.16.0/20] | - +----------------------+-----------+-----------------------+---------------+------------------+ - ``` + Result: - If the required subnet is not on the list, create it. - 1. View a description of the CLI command for adding a host: + ```text + +----------------------+-----------+-----------------------+---------------+------------------+ + | ID | NAME | NETWORK ID | ZONE | RANGE | + +----------------------+-----------+-----------------------+---------------+------------------+ + | b0cl69a2b4c6******** | default-d | enp6rq72rndgr******** | {{ region-id }}-d | [172.16.0.0/20] | + | e2lkj9qwe762******** | default-b | enp6rq72rndgr******** | {{ region-id }}-b | [10.10.0.0/16] | + | e9b0ph42bn96******** | a-2 | enp6rq72rndgr******** | {{ region-id }}-a | [172.16.32.0/20] | + | e9b9v22r88io******** | default-a | enp6rq72rndgr******** | {{ region-id }}-a | [172.16.16.0/20] | + +----------------------+-----------+-----------------------+---------------+------------------+ + ``` - ```bash - {{ yc-mdb-mg }} host add --help - ``` + If the required subnet is not in the list, create it. + 1. View a description of the CLI command for adding a host: - 1. Run the add host command: + ```bash + {{ yc-mdb-mg }} host add --help + ``` + + 1. Run the add host command: ```bash {{ yc-mdb-mg }} host add \ @@ -120,88 +120,88 @@ You can add different types of hosts to a {{ mmg-name }} cluster. Their number d Where `assign-public-ip` is public access to the host, `true` or `false`. - {{ mmg-name }} will run the add host operation. + {{ mmg-name }} will run the add host operation. - The subnet ID should be specified if the [availability zone](../../overview/concepts/geo-scope.md) contains multiple subnets; otherwise, {{ mmg-name }} automatically selects the sole subnet. You can request the {{ mmg-name }} cluster name with a [list of clusters in the folder](cluster-list.md#list-clusters). + The subnet ID should be specified if the [availability zone](../../overview/concepts/geo-scope.md) contains multiple subnets; otherwise, {{ mmg-name }} automatically selects the sole subnet. You can request the {{ mmg-name }} cluster name with a [list of clusters in the folder](cluster-list.md#list-clusters). - {{ TF }} {#tf} - To add a host to your {{ mmg-name }} cluster: - 1. Open the current {{ TF }} configuration file with an infrastructure plan. - - For more information about how to create this file, see [Creating clusters](cluster-create.md). - 1. Add the following to the {{ mmg-name }} cluster description: - * Resources corresponding to the sharding type, if you are adding a host to a sharded cluster: - * `resources_mongoinfra`: For standard sharding. - * `resources_mongos` and `resources_mongocfg`: For advanced sharding. - * The `host` section. - - ```hcl - resource "yandex_mdb_mongodb_cluster" "" { - ... - resources_mongod { - resource_preset_id = "" - disk_type_id = "" - disk_size = - } - - resources_mongoinfra { # Add this for standard sharding. - resource_preset_id = "" - disk_type_id = "" - disk_size = - } - - resources_mongos { # Add this for advanced sharding. - resource_preset_id = "" - disk_type_id = "" - disk_size = - } - - resources_mongocfg { # Add this for advanced sharding. - resource_preset_id = "" - disk_type_id = "" - disk_size = - } - - host { - role = "" - zone_id = "" - subnet_id = "" - assign_public_ip = - shard_name = "" - type = "" - ... - } - } - ``` - - Where: - - * `host`: Host parameters: - * `role`: Replica type, `PRIMARY` or `SECONDARY`. - * `zone_id`: Availability zone. - * `subnet_id`: ID of a subnet in the selected availability zone. - * `assign_public_ip`: Public access to the host, `true` or `false`. - * `shard_name`: Name of the shard in a sharded cluster. - * `type`: Type of the host in a sharded cluster: `MONGOD`, `MONGOINFRA`, `MONGOS`, or `MONGOCFG`. - - 1. Make sure the settings are correct. - - {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} - - 1. Confirm updating the resources. - - {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} - - For more information, see the [{{ TF }} provider documentation]({{ tf-provider-resources-link }}/mdb_mongodb_cluster). - - {% include [Terraform timeouts](../../_includes/mdb/mmg/terraform/timeouts.md) %} + To add a host to your {{ mmg-name }} cluster: + 1. Open the current {{ TF }} configuration file with an infrastructure plan. + + For more information about creating this file, see [Creating clusters](cluster-create.md). + 1. Add the following to the {{ mmg-name }} cluster description: + * Resources corresponding to the sharding type, if you are adding a host to a sharded cluster: + * `resources_mongoinfra` for standard sharding. + * `resources_mongos` and `resources_mongocfg` for advanced sharding. + * `host` block. + + ```hcl + resource "yandex_mdb_mongodb_cluster" "" { + ... + resources_mongod { + resource_preset_id = "" + disk_type_id = "" + disk_size = + } + + resources_mongoinfra { # Add for standard sharding. + resource_preset_id = "" + disk_type_id = "" + disk_size = + } + + resources_mongos { # Add for advanced sharding. + resource_preset_id = "" + disk_type_id = "" + disk_size = + } + + resources_mongocfg { # Add for advanced sharding. + resource_preset_id = "" + disk_type_id = "" + disk_size = + } + + host { + role = "" + zone_id = "" + subnet_id = "" + assign_public_ip = + shard_name = "" + type = "" + ... + } + } + ``` + + Where: + + * `host`: Host parameters: + * `role`: Replica type (`PRIMARY` or `SECONDARY`). + * `zone_id`: Availability zone. + * `subnet_id`: ID of a subnet in the selected availability zone. + * `assign_public_ip`: Public access to the host, `true` or `false`. + * `shard_name`: Shard name in a sharded cluster. + * `type`: Host type in a sharded cluster, `MONGOD`, `MONGOINFRA`, `MONGOS`, or `MONGOCFG`. + + 1. Make sure the settings are correct. + + {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} + + 1. Confirm updating the resources. + + {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} + + For more information, see the [{{ TF }} provider documentation]({{ tf-provider-resources-link }}/mdb_mongodb_cluster). + + {% include [Terraform timeouts](../../_includes/mdb/mmg/terraform/timeouts.md) %} - API {#api} - To add a host to a cluster, use the [addHosts](../api-ref/Cluster/addHosts.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/AddHosts](../api-ref/grpc/Cluster/addHosts.md) gRPC API call and provide the following in the request: - * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). - * New host settings in one or more `hostSpecs` parameters. + To add a host to a cluster, use the [addHosts](../api-ref/Cluster/addHosts.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/AddHosts](../api-ref/grpc/Cluster/addHosts.md) gRPC API call and provide the following in the request: + * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). + * New host settings in one or more `hostSpecs` parameters. {% endlist %} @@ -229,51 +229,51 @@ From a [sharded {{ mmg-name }} cluster](../operations/shards.md#enable), you may - Management console {#console} - To remove a host from a {{ mmg-name }} cluster: - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. - 1. Click the name of the {{ mmg-name }} cluster you need and select the **{{ ui-key.yacloud.mdb.cluster.switch_hosts }}** tab. - 1. Click the ![image](../../_assets/console-icons/ellipsis.svg) icon in the required host row and select **{{ ui-key.yacloud.common.delete }}**. - 1. In the window that opens, check **Delete host** and click **{{ ui-key.yacloud.mdb.cluster.hosts.popup-confirm_button }}**. + To remove a host from a {{ mmg-name }} cluster: + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. + 1. Click the name of the {{ mmg-name }} cluster you need and select the **{{ ui-key.yacloud.mdb.cluster.switch_hosts }}** tab. + 1. Click ![image](../../_assets/console-icons/ellipsis.svg) in the host row and select **{{ ui-key.yacloud.common.delete }}**. + 1. In the window that opens, check **Delete host** and click **{{ ui-key.yacloud.mdb.cluster.hosts.popup-confirm_button }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To remove a host from the {{ mmg-name }} cluster, run: + To remove a host from the {{ mmg-name }} cluster, run: - ```bash - {{ yc-mdb-mg }} host delete - --cluster-name - ``` + ```bash + {{ yc-mdb-mg }} host delete + --cluster-name + ``` - You can request the host name with a list of [{{ mmg-name }} cluster hosts](#list-hosts) and the cluster name with a [list of clusters in the folder](cluster-list.md#list-clusters). + You can request the host name with a list of [{{ mmg-name }} cluster hosts](#list-hosts) and the cluster name with a [list of clusters in the folder](cluster-list.md#list-clusters). - {{ TF }} {#tf} - To remove a host from a {{ mmg-name }} cluster: - 1. Open the current {{ TF }} configuration file with an infrastructure plan. + To remove a host from a {{ mmg-name }} cluster: + 1. Open the current {{ TF }} configuration file with an infrastructure plan. - For more information about how to create this file, see [Creating clusters](cluster-create.md). - 1. Delete the corresponding `host` block from the {{ mmg-name }} cluster description. - 1. Make sure the settings are correct. + For more information about creating this file, see [Creating clusters](cluster-create.md). + 1. Delete the corresponding `host` block from the {{ mmg-name }} cluster description. + 1. Make sure the settings are correct. - {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} + {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} - 1. Type `yes` and press **Enter**. + 1. Type `yes` and press **Enter**. - {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} + {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} - For more information, see the [{{ TF }} provider documentation]({{ tf-provider-resources-link }}/mdb_mongodb_cluster). + For more information, see the [{{ TF }} provider documentation]({{ tf-provider-resources-link }}/mdb_mongodb_cluster). - {% include [Terraform timeouts](../../_includes/mdb/mmg/terraform/timeouts.md) %} + {% include [Terraform timeouts](../../_includes/mdb/mmg/terraform/timeouts.md) %} - API {#api} - To delete a host, use the [deleteHosts](../api-ref/Cluster/deleteHosts.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/DeleteHosts](../api-ref/grpc/Cluster/deleteHosts.md) gRPC API call and provide the following in the request: - * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). - * Name(s) of the host(s) to delete in the `hostNames` parameter. + To delete a host, use the [deleteHosts](../api-ref/Cluster/deleteHosts.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/DeleteHosts](../api-ref/grpc/Cluster/deleteHosts.md) gRPC API call and provide the following in the request: + * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). + * Name or array of names of hosts to delete in the `hostNames` parameter. {% endlist %} @@ -298,31 +298,31 @@ During this operation: - Management console {#console} - To forcibly resync a host: - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. - 1. Click the name of the {{ mmg-name }} cluster you need and select the **{{ ui-key.yacloud.mdb.cluster.switch_hosts }}** tab. - 1. Click the ![image](../../_assets/console-icons/ellipsis.svg) icon in the required host row and select **{{ ui-key.yacloud.mdb.clusters.button_action-resetup }}**. + To forcibly resync a host: + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. + 1. Click the name of the {{ mmg-name }} cluster you need and select the **{{ ui-key.yacloud.mdb.cluster.switch_hosts }}** tab. + 1. Click ![image](../../_assets/console-icons/ellipsis.svg) in the host row and select **{{ ui-key.yacloud.mdb.clusters.button_action-resetup }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To forcibly resync a host, run the following command: + To forcibly resync a host, run the following command: - ```bash - {{ yc-mdb-mg }} hosts resetup - --cluster-name - ``` + ```bash + {{ yc-mdb-mg }} hosts resetup + --cluster-name + ``` - You can get the host name with a [list of hosts in the folder](hosts.md#list-hosts). You can request the {{ mmg-name }} cluster name with a [list of clusters in the folder](cluster-list.md#list-clusters). + You can get the host name with a [list of hosts in the folder](hosts.md#list-hosts). You can request the {{ mmg-name }} cluster name with a [list of clusters in the folder](cluster-list.md#list-clusters). - API {#api} - To resync a host, use the [resetupHosts](../api-ref/Cluster/resetupHosts.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/ResetupHosts](../api-ref/grpc/Cluster/resetupHosts.md) gRPC API call and provide the following in the request: - * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md). - * Host name, in the `hostNames` parameter. To find out the name, [get a list of hosts in the cluster](#list-hosts). + To resync a host, use the [resetupHosts](../api-ref/Cluster/resetupHosts.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/ResetupHosts](../api-ref/grpc/Cluster/resetupHosts.md) gRPC API call and provide the following in the request: + * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md). + * Host name in the `hostNames` parameter. To find out the name, [get a list of hosts in the cluster](#list-hosts). {% endlist %} @@ -344,23 +344,31 @@ You can only restart one host at a time. {% list tabs group=instructions %} +- Management console {#console} + + To restart a host: + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. + 1. Click the name of the {{ mmg-name }} cluster you need and select the **{{ ui-key.yacloud.mdb.cluster.switch_hosts }}** tab. + 1. Click ![image](../../_assets/console-icons/ellipsis.svg) in the host row and select **{{ ui-key.yacloud.mdb.cluster.hosts.action_restart-host }}**. + 1. Confirm the host restart. + - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To restart a host, run the command: + To restart a host, run the command: - ```bash - {{ yc-mdb-mg }} hosts restart \ - --cluster-name - ``` + ```bash + {{ yc-mdb-mg }} hosts restart \ + --cluster-name + ``` - API {#api} - To restart a host, use the [restartHosts](../api-ref/Cluster/restartHosts.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/RestartHosts](../api-ref/grpc/Cluster/restartHosts.md) gRPC API call and provide the following in the request: - * {{ mmg-name }} cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md). - * Host name, in the `hostNames` parameter. To find out the name, [get a list of hosts in the cluster](#list-hosts). + To restart a host, use the [restartHosts](../api-ref/Cluster/restartHosts.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/RestartHosts](../api-ref/grpc/Cluster/restartHosts.md) gRPC API call and provide the following in the request: + * {{ mmg-name }} cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md). + * Host name in the `hostNames` parameter. To find out the name, [get a list of hosts in the cluster](#list-hosts). {% endlist %} diff --git a/en/managed-mongodb/operations/monitoring.md b/en/managed-mongodb/operations/monitoring.md index 58776853eeb..05fd4fd73a9 100644 --- a/en/managed-mongodb/operations/monitoring.md +++ b/en/managed-mongodb/operations/monitoring.md @@ -28,7 +28,7 @@ The following charts will open on the page: * **Average operation time per host**: Average time of operation execution by each host (in microseconds). * **Average operations time on primary**: Average operation execution time on primary replicas (in microseconds). * **Average operations time on secondaries**: Average operation execution time on secondary replicas (in microseconds). -* **CPU usage per host**: vCPU usage per host (as a ratio of the number of vCPU cores). +* **CPU usage per host**: vCPU utilization per host (as a ratio of the number of vCPU cores). * **CPU usage per host, top 5 hosts**: 5 hosts with the highest vCPU utilization (%). * **Configured oplog size per host**: Size of the oplog on each cluster host (in GB). * **Connections per host**: Average number of connections to each host. @@ -55,14 +55,14 @@ The following charts will open on the page: * **Queries on primary**: Average number of each type of query on primary replicas. * **Read operations count, top 5 collections**: 5 collections with the longest time spent in reads. * **Readers/writers active queue per host, top 5**: Total size of the 5 largest queues for each host: - * With read requests - * With write requests + * With read requests + * With write requests * **Replicated queries**: Average number of replicated queries in the cluster. -* **Replication lag per host and write_concern wait**: Replication lag on each host and waiting time for [write concern](https://docs.mongodb.com/manual/reference/write-concern/) (in seconds). +* **Replication lag per host and write_concern wait**: Replication lag on each host and waiting time for [write confirmation](https://docs.mongodb.com/manual/reference/write-concern/) (in seconds). * **Scan and order per host**: Number of data sorts without index usage on each host. * **Scanned / returned**: Shows the following ratios: - * `scanned_docs / returned_docs`: Documents scanned to documents returned. - * `scanned_keys / returned_docs`: Index keys scanned to documents returned. + * `scanned_docs / returned_docs`: Documents scanned to documents returned. + * `scanned_keys / returned_docs`: Index keys scanned to documents returned. * **TTL indexes activity**: Total number of [TTL indexes](https://docs.mongodb.com/manual/core/index-ttl/). * **Total operations count on cluster**: Total number of operations performed in the cluster. * **Total operations time on cluster**: Total operation execution time in the cluster (in milliseconds). @@ -98,22 +98,22 @@ This page displays charts showing the load on an individual host in the cluster: - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the folder with the cluster you want to configure alerts for. + 1. In the [management console]({{ link-console-main }}), select the folder with the cluster you want to configure alerts for. - 1. In the list of services, select ![image](../../_assets/console-icons/display-pulse.svg) **{{ ui-key.yacloud.iam.folder.dashboard.label_monitoring }}**. + 1. In the list of services, select ![image](../../_assets/console-icons/display-pulse.svg) **{{ ui-key.yacloud.iam.folder.dashboard.label_monitoring }}**. - 1. Under **{{ ui-key.yacloud_monitoring.dashboard.tab.service-dashboards }}**, select: + 1. Under **{{ ui-key.yacloud_monitoring.dashboard.tab.service-dashboards }}**, select: - * **{{ mmg-name }}** to configure cluster alerts. - * **{{ mmg-name }} — Host Overview** to configure host alerts. + * **{{ mmg-name }}** to configure cluster alerts. + * **{{ mmg-name }} — Host Overview** to configure host alerts. - 1. In the chart you need, click ![options](../../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud_monitoring.alert.button_create-alert }}**. + 1. In the chart you need, click ![options](../../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud_monitoring.alert.button_create-alert }}**. - 1. If the chart shows multiple metrics, select a data query to generate a metric and click **{{ ui-key.yacloud_monitoring.dialog.confirm.button_continue }}**. You can learn more about the query language in the [{{ monitoring-full-name }} documentation](../../monitoring/concepts/querying.md). + 1. If the chart shows multiple metrics, select a data query to generate a metric and click **{{ ui-key.yacloud_monitoring.dialog.confirm.button_continue }}**. You can learn more about the query language in the [{{ monitoring-full-name }} documentation](../../monitoring/concepts/querying.md). - 1. Set the `{{ ui-key.yacloud_monitoring.alert.status_alarm }}` and `{{ ui-key.yacloud_monitoring.alert.status_warn }}` thresholds to trigger an alert. + 1. Set the `{{ ui-key.yacloud_monitoring.alert.status_alarm }}` and `{{ ui-key.yacloud_monitoring.alert.status_warn }}` threshold values to trigger the alert. - 1. Click **{{ ui-key.yacloud_monitoring.alert.button_create-alert }}**. + 1. Click **{{ ui-key.yacloud_monitoring.alert.button_create-alert }}**. {% endlist %} @@ -121,11 +121,11 @@ This page displays charts showing the load on an individual host in the cluster: The recommended thresholds are as follows: -| Metric | Parameter | `{{ ui-key.yacloud_monitoring.alert.status_alarm }}` | `{{ ui-key.yacloud_monitoring.alert.status_warn }}` | +| Metric | Parameter | `{{ ui-key.yacloud_monitoring.alert.status_alarm }}` | `{{ ui-key.yacloud_monitoring.alert.status_warn }}` | |---------------------------------|:-------------------------------:|:----------------------------------------------------:|:---------------------------------------------------:| -| DB write availability | `can_write` | `Equals 0` | — | -| Replication delay | `replset_status-replicationLag` | `180` | `30` | -| Storage space used | `disk.used_bytes` | 90% of the storage size | 70% of the storage size | +| DB write availability | `can_write` | `Equals 0` | — | +| Replication delay | `replset_status-replicationLag` | `180` | `30` | +| Storage space used | `disk.used_bytes` | 90% of the storage size | 70% of the storage size | For the `disk.used_bytes` metric, the `{{ ui-key.yacloud_monitoring.alert.status_alarm }}` and `{{ ui-key.yacloud_monitoring.alert.status_warn }}` thresholds are only set in bytes. For example, the recommended values for a 100 GB disk are as follows: @@ -135,26 +135,26 @@ For the `disk.used_bytes` metric, the `{{ ui-key.yacloud_monitoring.alert.status You can view the current storage size in the [detailed information about the cluster](cluster-list.md#get-cluster). For a complete list of supported metrics, see the [{{ monitoring-name }} documentation](../../monitoring/metrics-ref/managed-mongodb-ref.md). -### Monitoring the switch to read-only mode {#read-only-alert} +### Monitoring the transition to read-only mode {#read-only-alert} To monitor storage usage on cluster hosts and get notifications when free space is about to run out: 1. [Create an alert](../../monitoring/operations/alert/create-alert.md). 1. Add the `disk.free_bytes` status metric. - To do this, create a query in the query builder: + To do this, create a query in the query builder: - `service=managed-mongodb` → `name=disk.free_bytes` → `host=*` → `resource_id=*` → `resource_type=cluster`. + `service=managed-mongodb` → `name=disk.free_bytes` → `host=*` → `resource_id=*` → `resource_type=cluster`. 1. Set the alert threshold values in the alert settings: * **{{ ui-key.yacloud_monitoring.alert.label_trigger-condition }}**: Set the `{{ ui-key.yacloud_monitoring.alert.title_comparison-lte }}` condition for the size of free disk space to trigger an alert. - The recommended threshold values depending on the storage size are as follows: + The recommended threshold values depending on the storage size are as follows: - | Storage size, GB | `{{ ui-key.yacloud_monitoring.alert.status_alarm }}` | `{{ ui-key.yacloud_monitoring.alert.status_warn }}` | - |---------------------|-------------|------------------| - | ⩽ 600 | `1G` (1 GB) | `1500M` (1.5 GB) | - | > 600 | `6G` (6 GB) | `10G` (10 GB) | + | Storage size, GB | `{{ ui-key.yacloud_monitoring.alert.status_alarm }}` | `{{ ui-key.yacloud_monitoring.alert.status_warn }}` | + |---------------------|-------------|------------------| + | ⩽ 600 | `1G`: 1 GB | `1500M`: 1.5 GB | + | > 600 | `6G`: 6 GB | `10G`: 10 GB | * **{{ ui-key.yacloud.mdb.cluster.overview.section_additional }}** → **{{ ui-key.yacloud_monitoring.service.field.function }}**: Select `{{ ui-key.yacloud_monitoring.alert.title_aggregation-min }}` (a minimum metric value for the period). diff --git a/en/managed-mongodb/operations/performance-diagnostics.md b/en/managed-mongodb/operations/performance-diagnostics.md index 02801270c69..cc345448870 100644 --- a/en/managed-mongodb/operations/performance-diagnostics.md +++ b/en/managed-mongodb/operations/performance-diagnostics.md @@ -12,7 +12,7 @@ This feature is at the [Preview stage](../../overview/concepts/launch-stages.md) ## Enabling statistics collection {#activate-stats-collector} -To use the diagnostics tool, enable statistics collection when [creating a cluster](cluster-create.md) or [updating its settings](update.md#change-additional-settings). By default, statistics are only collected for queries longer than 300 ms. If required, [update the DBMS settings](update.md#change-mongod-config) to change the time threshold for collecting slow query statistics in the `slowOpThreshold` [parameter](../concepts/settings-list.md#setting-slow-op-threshold). +To use the diagnostics tool, enable statistics collection when [creating a cluster](cluster-create.md) or [updating its settings](update.md#change-additional-settings). By default, statistics are only collected for queries longer than 300 ms. If required, in [DBMS settings](update.md#change-mongod-config), change the time threshold for collecting slow query statistics in the `slowOpThreshold` [parameter](../concepts/settings-list.md#setting-slow-op-threshold). ## Getting profiling data {#get-profiling} @@ -21,27 +21,29 @@ For read/write and some other DB queries (such as `aggregate`), you can view the - A chart with metrics for the selected data segment. You can hide or show individual categories in the chart by clicking on the category name in the chart legend. - Table with statistics by query type. +To get data: + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. 1. Click the cluster name and select the **{{ ui-key.yacloud.mongodb.cluster.switch_diagnostics }}** → **{{ ui-key.yacloud.mdb.cluster.diagnostics.label_profiling }}** tab. 1. Specify the time interval and, if necessary, set filters. 1. Select: * Data segment: - * `FORM`: By query type. - * `HOSTNAME`: By shard [PRIMARY hosts](../concepts/replication.md). - * `NAMESPACE`: By collection name. - * `SHARD`: By [shard](../concepts/sharding.md). - * `USER`: By user. - * Data aggregation parameter: - * `COUNT`: Number of queries. - * `DOCUMENTS_EXAMINED`: Number of documents in the collection scanned during the query. - * `DOCUMENTS_RETURNED`: Number of returned documents. - * `DURATION`: Query execution duration. - * `KEYS_EXAMINED`: Number of index keys scanned during the query. - * `RESPONSE_LENGTH`: Size of the document returned as the query result. + * `FORM`: By query type + * `HOSTNAME`: By shard [PRIMARY host](../concepts/replication.md) + * `NAMESPACE`: By collection name + * `SHARD`: By [shard](../concepts/sharding.md) + * `USER`: By user + * Data grouping parameter: + * `COUNT`: Number of queries. + * `DOCUMENTS_EXAMINED`: Number of the collection documents scanned when executing the query. + * `DOCUMENTS_RETURNED`: Number of returned documents. + * `DURATION`: Query execution duration. + * `KEYS_EXAMINED`: Number of index keys scanned when executing the query. + * `RESPONSE_LENGTH`: Size of the document returned as a result of the query. * Aggregation function of the selected parameter: - * `AVG`: Average value. - * `SUM`: Sum. + * `AVG`: Average value + * `SUM`: Sum For more information about what statistics you can get, see the [{{ MG }} documentation](https://docs.mongodb.com/manual/reference/database-profiler/#output-reference). diff --git a/en/managed-mongodb/operations/shards.md b/en/managed-mongodb/operations/shards.md index 9caba912f95..b8e45db3a38 100644 --- a/en/managed-mongodb/operations/shards.md +++ b/en/managed-mongodb/operations/shards.md @@ -2,13 +2,13 @@ You can [create a sharded](cluster-create.md#creating-a-sharded-cluster) cluster or [enable sharding](#enable) later. After that, you can [add and configure shards](#add-shard). -Make sure that your shards consist of at least three `MONGOD` hosts to ensure higher availability. We do not recommend sharding small collections: query processing is faster with a standard replica cluster. +Make sure your shards consist of at least three `MONGOD` hosts for higher availability. We do not recommend sharding small collections: query processing is faster with a standard replica cluster. {% note alert %} After [cluster sharding](../concepts/sharding.md) is enabled: -* You can't disable sharding: the cluster will always maintain a minimum number of `MONGOS`, `MONGOCFG`, or `MONGOINFRA` hosts depending on the [sharding type](../concepts/sharding.md#shard-management). -* For accessing the databases, only use the `MONGOS` or `MONGOINFRA` hosts that route queries to shards. For this purpose, edit host addresses in your application code accordingly. +* There is no way to disable sharding. The cluster will always maintain a minimum number of `MONGOS`, `MONGOCFG`, or `MONGOINFRA` hosts depending on the [sharding type](../concepts/sharding.md#shard-management). +* To access databases, use only the `MONGOS` or `MONGOINFRA` hosts that route queries to shards. For this purpose, edit host addresses in your application code accordingly. {% endnote %} @@ -32,211 +32,208 @@ Sharding is [not supported](../concepts/sharding.md#shard-management) for hosts - Management console {#console} - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. - 1. Click the cluster name and open the **{{ ui-key.yacloud.mongodb.cluster.switch_shards }}** tab. - 1. Click **{{ ui-key.yacloud.mdb.cluster.shards.button_sharding-enable }}**. - 1. Select a sharding type: - * **{{ ui-key.yacloud.mongodb.cluster.shards.label_standard }}**: Using a `MONGOINFRA` host. + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. + 1. Click the cluster name and open the **{{ ui-key.yacloud.mongodb.cluster.switch_shards }}** tab. + 1. Click **{{ ui-key.yacloud.mdb.cluster.shards.button_sharding-enable }}**. + 1. Select a sharding type: + * **{{ ui-key.yacloud.mongodb.cluster.shards.label_standard }}**: Based on `MONGOINFRA` hosts. + * **{{ ui-key.yacloud.mongodb.cluster.shards.label_custom }}**: Based on `MONGOS` and `MONGOCFG` hosts. - * **{{ ui-key.yacloud.mongodb.cluster.shards.label_custom }}**: Using `MONGOS` and `MONGOCFG` hosts. + For more information, see [Sharding](../concepts/sharding.md). + {% note warning %} - For more information, see [Sharding](../concepts/sharding.md). + After you enable sharding, you can't change its type. - {% note warning %} + {% endnote %} - After you enable sharding, you can't change its type. + 1. Set the parameters of the hosts that will provide access to the sharded data. + 1. Click **{{ ui-key.yacloud.mongodb.cluster.shards.button_enable_sharding }}**. - {% endnote %} - - 1. Set the parameters of the hosts that will provide access to the sharded data. - 1. Click **{{ ui-key.yacloud.mongodb.cluster.shards.button_enable_sharding }}**. - - The cluster will start updating, with the requested hosts and first shard of the cluster created. + The cluster will start updating, with the requested hosts and first shard of the cluster created. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} - - {% include [default-catalogue](../../_includes/default-catalogue.md) %} - - * To enable standard cluster sharding using `MONGOINFRA` hosts, run the command (the list of supported parameters in the example is not exhaustive): - - ```bash - {{ yc-mdb-mg }} cluster enable-sharding \ - --cluster-name= \ - --host type=mongoinfra,` - `zone-id=,` - `subnet-name= \ - --host type=mongoinfra,` - `zone-id=,` - `subnet-name= \ - --host type=mongoinfra,` - `zone-id=,` - `subnet-name= \ - --mongoinfra resource-preset=,` - `disk-size=,` - `disk-type= - ``` - - Where: - * `--cluster-name`: Cluster name that you can request with a [list of clusters in the folder](cluster-list.md#list). - * `--host`: Host parameters: - * `type`: Host type (`MONGOINFRA`). - * `zone-id`: [Availability zone](../../overview/concepts/geo-scope.md). - * `subnet-name`: [Name of the subnet](../../vpc/concepts/network.md#subnet). - * `--mongoinfra`: `MONGOINFRA` host parameters: - * `resource-preset`: [Host class](../concepts/instance-types.md). - * `disk-size`: Storage size in GB. - * `disk-type`: [Disk type](../concepts/storage.md). - - * To enable advanced cluster sharding using `MONGOS` and `MONGOCFG` hosts, run the command (the list of supported parameters in the example is not exhaustive): - - ```bash - {{ yc-mdb-mg }} cluster enable-sharding \ - --cluster-name= \ - --host type=mongos,` - `zone-id=,` - `subnet-name= \ - --host type=mongos,` - `zone-id=,` - `subnet-name= \ - --mongos resource-preset=,` - `disk-size=,` - `disk-type= \ - --host type=mongocfg,` - `zone-id=,` - `subnet-name= \ - --host type=mongocfg,` - `zone-id=,` - `subnet-name= \ - --host type=mongocfg,` - `zone-id=,` - `subnet-name= \ - --mongocfg resource-preset=,` - `disk-size=,` - `disk-type= - ``` - - Where: - * `--cluster-name`: Cluster name that you can request with a [list of clusters in the folder](cluster-list.md#list). - * `--host`: Host parameters: - * `type`: The type (`MONGOS` or `MONGOCFG`). - * `zone-id`: [Availability zone](../../overview/concepts/geo-scope.md). - * `subnet-name`: [Name of the subnet](../../vpc/concepts/network.md#subnet). - * `--mongos`: `MONGOS` host parameters: - * `resource-preset`: [Host class](../concepts/instance-types.md). - * `disk-size`: Storage size in GB. - * `disk-type`: [Disk type](../concepts/storage.md). - * `--mongocfg`: `MONGOCFG` host parameters: - * `resource-preset`: [Host class](../concepts/instance-types.md). - * `disk-size`: Storage size in GB. - * `disk-type`: [Disk type](../concepts/storage.md). + {% include [cli-install](../../_includes/cli-install.md) %} + + {% include [default-catalogue](../../_includes/default-catalogue.md) %} + + * To enable standard cluster sharding using `MONGOINFRA` hosts, run this command (the list of supported parameters in the example is not exhaustive): + + ```bash + {{ yc-mdb-mg }} cluster enable-sharding \ + --cluster-name= \ + --host type=mongoinfra,` + `zone-id=,` + `subnet-name= \ + --host type=mongoinfra,` + `zone-id=,` + `subnet-name= \ + --host type=mongoinfra,` + `zone-id=,` + `subnet-name= \ + --mongoinfra resource-preset=,` + `disk-size=,` + `disk-type= + ``` + + Where: + * `--cluster-name`: Cluster name you can get with a [list of clusters in the folder](cluster-list.md#list). + * `--host`: Host parameters: + * `type`: Type (`MONGOINFRA`). + * `zone-id`: [Availability zone](../../overview/concepts/geo-scope.md). + * `subnet-name`: [Subnet name](../../vpc/concepts/network.md#subnet). + * `--mongoinfra`: `MONGOINFRA` host parameters: + * `resource-preset`: [Host class](../concepts/instance-types.md). + * `disk-size`: Storage size in GB. + * `disk-type`: [Disk type](../concepts/storage.md). + + * To enable advanced cluster sharding using `MONGOS` and `MONGOCFG` hosts, run this command (the list of supported parameters in the example is not exhaustive): + + ```bash + {{ yc-mdb-mg }} cluster enable-sharding \ + --cluster-name= \ + --host type=mongos,` + `zone-id=,` + `subnet-name= \ + --host type=mongos,` + `zone-id=,` + `subnet-name= \ + --mongos resource-preset=,` + `disk-size=,` + `disk-type= \ + --host type=mongocfg,` + `zone-id=,` + `subnet-name= \ + --host type=mongocfg,` + `zone-id=,` + `subnet-name= \ + --host type=mongocfg,` + `zone-id=,` + `subnet-name= \ + --mongocfg resource-preset=,` + `disk-size=,` + `disk-type= + ``` + + Where: + * `--cluster-name`: Cluster name you can get with a [list of clusters in the folder](cluster-list.md#list). + * `--host`: Host parameters: + * `type`: Type (`MONGOS` or `MONGOCFG`). + * `zone-id`: [Availability zone](../../overview/concepts/geo-scope.md). + * `subnet-name`: [Subnet name](../../vpc/concepts/network.md#subnet). + * `--mongos`: `MONGOS` host parameters: + * `resource-preset`: [Host class](../concepts/instance-types.md). + * `disk-size`: Storage size in GB. + * `disk-type`: [Disk type](../concepts/storage.md). + * `--mongocfg`: `MONGOCFG` host parameters: + * `resource-preset`: [Host class](../concepts/instance-types.md). + * `disk-size`: Storage size in GB. + * `disk-type`: [Disk type](../concepts/storage.md). - {{ TF }} {#tf} - 1. {% include [update-provider-version](../../_includes/mdb/mmg/terraform/update-provider-version.md) %} + 1. {% include [update-provider-version](../../_includes/mdb/mmg/terraform/update-provider-version.md) %} - 1. Open the current {{ TF }} configuration file with an infrastructure plan. + 1. Open the current {{ TF }} configuration file with an infrastructure plan. - For information on how to create this file, see [Creating a cluster](cluster-create.md). + For information on how to create this file, see [Creating a cluster](cluster-create.md). - 1. Add additional resources to the configuration file. + 1. Add additional resources to the configuration file. - {% cut "For standard sharding of the cluster using `MONGOINFRA` hosts" %} + {% cut "For standard sharding of the cluster using `MONGOINFRA` hosts" %} - ```hcl - resources_mongoinfra { - resource_preset_id = "" - disk_type_id = "" - disk_size = - } - - host { - zone_id = "" - subnet_id = "" - type = "mongoinfra" - } + ```hcl + resources_mongoinfra { + resource_preset_id = "" + disk_type_id = "" + disk_size = + } - host { - zone_id = "" - subnet_id = "" - type = "mongoinfra" - } + host { + zone_id = "" + subnet_id = "" + type = "mongoinfra" + } - host { - zone_id = "" - subnet_id = "" - type = "mongoinfra" - } - ``` + host { + zone_id = "" + subnet_id = "" + type = "mongoinfra" + } - {% endcut %} + host { + zone_id = "" + subnet_id = "" + type = "mongoinfra" + } + ``` - {% cut "For advanced sharding of the cluster using `MONGOS` and `MONGOCFG` hosts" %} + {% endcut %} + {% cut "For advanced sharding of the cluster using `MONGOS` and `MONGOCFG` hosts" %} - ```hcl - resources_mongos { - resource_preset_id = "" - disk_type_id = "" - disk_size = - } + ```hcl + resources_mongos { + resource_preset_id = "" + disk_type_id = "" + disk_size = + } - resources_mongocfg { - resource_preset_id = "" - disk_type_id = "" - disk_size = - } + resources_mongocfg { + resource_preset_id = "" + disk_type_id = "" + disk_size = + } - host { - zone_id = "" - subnet_id = "" - type = "mongos" - } + host { + zone_id = "" + subnet_id = "" + type = "mongos" + } - host { - zone_id = "" - subnet_id = "" - type = "mongos" - } + host { + zone_id = "" + subnet_id = "" + type = "mongos" + } - host { - zone_id = "" - subnet_id = "" - type = "mongocfg" - } + host { + zone_id = "" + subnet_id = "" + type = "mongocfg" + } - host { - zone_id = "" - subnet_id = "" - type = "mongocfg" - } + host { + zone_id = "" + subnet_id = "" + type = "mongocfg" + } - host { - zone_id = "" - subnet_id = "" - type = "mongocfg" - } - ``` + host { + zone_id = "" + subnet_id = "" + type = "mongocfg" + } + ``` - {% endcut %} + {% endcut %} - 1. Make sure the settings are correct. + 1. Make sure the settings are correct. - {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} + {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} - 1. Confirm updating the resources. + 1. Confirm updating the resources. - {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} + {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} For more information, see the [{{ TF }} provider documentation]({{ tf-provider-mmg }}). - API {#api} - To enable cluster sharding, use the [enableSharding](../api-ref/Cluster/enableSharding.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/EnableSharding](../api-ref/grpc/Cluster/enableSharding.md) gRPC API call and provide the cluster ID in the `clusterId` request parameter. + To enable cluster sharding, use the [enableSharding](../api-ref/Cluster/enableSharding.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/EnableSharding](../api-ref/grpc/Cluster/enableSharding.md) gRPC API call and provide the cluster ID in the `clusterId` request parameter. - You can get the cluster ID with a [list of clusters in the folder](cluster-list.md#list-clusters). + You can get the cluster ID with a [list of clusters in the folder](cluster-list.md#list-clusters). {% endlist %} @@ -246,124 +243,124 @@ Sharding is [not supported](../concepts/sharding.md#shard-management) for hosts - Management console {#console} - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. - 1. Click the cluster name and open the **{{ ui-key.yacloud.mongodb.cluster.switch_shards }}** tab. + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. + 1. Click the cluster name and open the **{{ ui-key.yacloud.mongodb.cluster.switch_shards }}** tab. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To get a list of shards in a cluster, run the following command: + To get a list of shards in a cluster, run the following command: - ```bash - {{ yc-mdb-mg }} shards list --cluster-name - ``` + ```bash + {{ yc-mdb-mg }} shards list --cluster-name + ``` - Result: + Result: - ```text - +------+ - | NAME | - +------+ - | rs01 | - | rs02 | - +------+ - ``` + ```text + +------+ + | NAME | + +------+ + | rs01 | + | rs02 | + +------+ + ``` - You can request the cluster name with a [list of clusters in the folder](cluster-list.md#list-clusters). + You can request the cluster name with a [list of clusters in the folder](cluster-list.md#list-clusters). - API {#api} - To get a list of cluster shards, use the [listShards](../api-ref/Cluster/listShards.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/ListShards](../api-ref/grpc/Cluster/listShards.md) gRPC API call and provide the cluster ID in the `clusterId` request parameter. + To get a list of cluster shards, use the [listShards](../api-ref/Cluster/listShards.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/ListShards](../api-ref/grpc/Cluster/listShards.md) gRPC API call and provide the cluster ID in the `clusterId` request parameter. - You can get the cluster ID with a [list of clusters in the folder](cluster-list.md#list-clusters). + You can get the cluster ID with a [list of clusters in the folder](cluster-list.md#list-clusters). {% endlist %} ## Creating a shard {#add-shard} -The number of shards in {{ mmg-name }} clusters is limited by the CPU and RAM quotas available to DB clusters in your cloud. To check the resources in use, open the [Quotas]({{ link-console-quotas }}) page and find **{{ mmg-full-name }}**. +The number of shards in {{ mmg-name }} clusters is limited by the CPU and RAM quotas available to DB clusters in your cloud. To check the resources currently in use, open the [Quotas]({{ link-console-quotas }}) page and find **{{ mmg-full-name }}**. {% list tabs group=instructions %} - Management console {#console} - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. - 1. Click the cluster name and open the **{{ ui-key.yacloud.mongodb.cluster.switch_shards }}** tab. - 1. Click **{{ ui-key.yacloud.mdb.cluster.shards.action_add-shard }}**. - 1. Enter a name for the shard and add the number of hosts you need. - 1. Click **{{ ui-key.yacloud.mdb.forms.button_create-shard }}**. + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. + 1. Click the cluster name and open the **{{ ui-key.yacloud.mongodb.cluster.switch_shards }}** tab. + 1. Click **{{ ui-key.yacloud.mdb.cluster.shards.action_add-shard }}**. + 1. Enter a name for the shard and add the number of hosts you need. + 1. Click **{{ ui-key.yacloud.mdb.forms.button_create-shard }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To create a shard, run the command below (not all the supported parameters are listed): + To create a shard, run the command below (not all the supported parameters are listed): - ```bash - {{ yc-mdb-mg }} shards add \ - --cluster-name= \ - --host zone-id=,` - `subnet-name= - ``` + ```bash + {{ yc-mdb-mg }} shards add \ + --cluster-name= \ + --host zone-id=,` + `subnet-name= + ``` - Where: - * `--cluster-name`: Cluster name that you can request with a [list of clusters in the folder](cluster-list.md#list-clusters). - * `--host`: Host parameters: - * `zone-id`: [Availability zone](../../overview/concepts/geo-scope.md). - * `subnet-name`: [Name of the subnet](../../vpc/concepts/network.md#subnet). + Where: + * `--cluster-name`: Cluster name you can get with a [list of clusters in the folder](cluster-list.md#list-clusters). + * `--host`: Host parameters: + * `zone-id`: [Availability zone](../../overview/concepts/geo-scope.md). + * `subnet-name`: [Subnet name](../../vpc/concepts/network.md#subnet). - {{ TF }} {#tf} - 1. {% include [update-provider-version](../../_includes/mdb/mmg/terraform/update-provider-version.md) %} + 1. {% include [update-provider-version](../../_includes/mdb/mmg/terraform/update-provider-version.md) %} - 1. Open the current {{ TF }} configuration file with an infrastructure plan. + 1. Open the current {{ TF }} configuration file with an infrastructure plan. - For information on how to create this file, see [Creating a cluster](cluster-create.md). + For information on how to create this file, see [Creating a cluster](cluster-create.md). - 1. Add to the {{ mmg-name }} cluster description the required number of `host` blocks of the `MONGOD` type set in the `type` parameter and the shard name specified in the `shard_name` parameter: + 1. Add to the {{ mmg-name }} cluster description the required number of `host` blocks with `MONGOD` in the `type` parameter and shard name in the `shard_name` parameter: - ```hcl - resource "yandex_mdb_mongodb_cluster" "" { - ... - host { - zone_id = "" - subnet_id = "" - type = "mongod" - shard_name = "" - } - } - ``` + ```hcl + resource "yandex_mdb_mongodb_cluster" "" { + ... + host { + zone_id = "" + subnet_id = "" + type = "mongod" + shard_name = "" + } + } + ``` - 1. Make sure the settings are correct. + 1. Make sure the settings are correct. - {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} + {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} - 1. Confirm updating the resources. + 1. Confirm updating the resources. - {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} + {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} For more information, see the [{{ TF }} provider documentation]({{ tf-provider-mmg }}). - API {#api} - To create a shard, use the [addShard](../api-ref/Cluster/addShard.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/AddShard](../api-ref/grpc/Cluster/addShard.md) gRPC API call and provide the following in the request: + To create a shard, use the [addShard](../api-ref/Cluster/addShard.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/AddShard](../api-ref/grpc/Cluster/addShard.md) gRPC API call and provide the following in the request: - * Cluster ID in the `clusterId` parameter. - * Name of the shard in the `shardName` parameter. - * Shard host configuration in the array of `hostSpecs` parameters. + * Cluster ID in the `clusterId` parameter. + * Shard name in the `shardName` parameter. + * Shard host configuration in the array of `hostSpecs` parameters. - You can get the shard name with a [list of cluster shards](#list-shards) and the cluster ID with a [list of clusters in the folder](cluster-list.md#list-clusters). + You can get the shard name with a [list of cluster shards](#list-shards) and the cluster ID with a [list of clusters in the folder](cluster-list.md#list-clusters). {% endlist %} ## Deleting a shard {#delete-shard} -You can delete a shard from a {{ MG }} cluster if it is not the only shard in it. To replace the only shard in a cluster, first create a new shard and then remove the old one. +You can delete a shard from a {{ MG }} cluster if it is not the only shard there. To replace the only shard in a cluster, first create a new shard and then remove the old one. {% note info %} @@ -375,48 +372,48 @@ The [removeShard](https://docs.mongodb.com/manual/reference/command/removeShard/ - Management console {#console} - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. - 1. Click the cluster name and open the **{{ ui-key.yacloud.mongodb.cluster.switch_shards }}** tab. - 1. Click the ![image](../../_assets/console-icons/ellipsis.svg) icon in the required shard row and select **{{ ui-key.yacloud.mdb.clusters.button_action-delete }}**. - 1. In the window that opens, click **{{ ui-key.yacloud.mdb.cluster.shards.popup-confirm_button_delete }}**. + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. + 1. Click the cluster name and open the **{{ ui-key.yacloud.mongodb.cluster.switch_shards }}** tab. + 1. Click the ![image](../../_assets/console-icons/ellipsis.svg) icon in the shard row and select **{{ ui-key.yacloud.mdb.clusters.button_action-delete }}**. + 1. In the window that opens, click **{{ ui-key.yacloud.mdb.cluster.shards.popup-confirm_button_delete }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To delete a shard from the cluster, run: + To delete a shard from the cluster, run: - ```bash - {{ yc-mdb-mg }} shards delete \ - --cluster-name= - ``` + ```bash + {{ yc-mdb-mg }} shards delete \ + --cluster-name= + ``` - You can request the shard name with a [list of cluster shards](#list-shards) and the cluster name with a [list of clusters in a folder](cluster-list.md#list-clusters). + You can request the shard name with a [list of cluster shards](#list-shards) and the cluster name with a [list of clusters in a folder](cluster-list.md#list-clusters). - {{ TF }} {#tf} - 1. Open the current {{ TF }} configuration file with an infrastructure plan. + 1. Open the current {{ TF }} configuration file with an infrastructure plan. - For information on how to create this file, see [Creating a cluster](cluster-create.md). + For information on how to create this file, see [Creating a cluster](cluster-create.md). - 1. Delete all shard-related `host` sections from the {{ mmg-name }} cluster description. - 1. Make sure the settings are correct. + 1. Delete all shard-related `host` sections from the {{ mmg-name }} cluster description. + 1. Make sure the settings are correct. - {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} + {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} - 1. Type `yes` and press **Enter**. + 1. Type `yes` and press **Enter**. - {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} + {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} For more information, see the [{{ TF }} provider documentation]({{ tf-provider-mmg }}). - API {#api} - To delete a shard, use the [deleteShard](../api-ref/Cluster/deleteShard.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/DeleteShard](../api-ref/grpc/Cluster/deleteShard.md) gRPC API call and provide the following in the request: + To delete a shard, use the [deleteShard](../api-ref/Cluster/deleteShard.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/DeleteShard](../api-ref/grpc/Cluster/deleteShard.md) gRPC API call and provide the following in the request: - * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). - * Name of the shard to delete in the `shardName` parameter. + * Cluster ID in the `clusterId` parameter. To find out the cluster ID, [get a list of clusters in the folder](cluster-list.md#list-clusters). + * Name of the shard you are deleting in the `shardName` parameter. {% endlist %} \ No newline at end of file diff --git a/en/managed-mongodb/operations/update.md b/en/managed-mongodb/operations/update.md index 8051d4387c2..97e301d54dd 100644 --- a/en/managed-mongodb/operations/update.md +++ b/en/managed-mongodb/operations/update.md @@ -30,7 +30,7 @@ To move a cluster to a different availability zone, follow [this guide](host-mig When changing the host class: * Your single-host cluster will be unavailable for a few minutes with database connections terminated. -* A multi-host cluster will get a new primary replica. Its hosts will be stopped and updated one by one. Once stopped, a host will be unavailable for a few minutes. +* A multi-host cluster will get a new [primary replica](../concepts/replication.md). Its hosts will be stopped and updated one by one. Once stopped, a host will be unavailable for a few minutes. We recommend changing the host class only when the cluster has no active workload. @@ -366,7 +366,7 @@ You can change the DBMS settings of the hosts in your cluster. Changing the retention period affects both new automatic backups and existing backups. - For example, if the original retention period was 7 days and the remaining lifetime of a separate automatic backup is 1 day, then when the retention period increases to 9 days, the remaining lifetime of this backup becomes 3 days. + For example, if the original retention period is 7 days, and the remaining lifetime of a separate automatic backup is 1 day, then increasing the retention period to 9 days will change the remaining lifetime of this backup to 3 days. {% include [backup-window-start](../../_includes/mdb/cli/backup-window-start.md) %} @@ -380,7 +380,7 @@ You can change the DBMS settings of the hosts in your cluster. {% include [deletion-protection-limits](../../_includes/mdb/deletion-protection-limits-db.md) %} - You can [get](cluster-list.md#list-clusters) the cluster ID and name with a list of clusters in the folder. + You can get the cluster ID and name with a [list of clusters](cluster-list.md#list-clusters) in the folder. - {{ TF }} {#tf} @@ -475,7 +475,7 @@ You can change the DBMS settings of the hosts in your cluster. - Management console {#console} 1. Go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mongodb }}**. - 1. Click ![image](../../_assets/console-icons/ellipsis.svg) to the right of the row with the cluster you want to move. + 1. Click ![image](../../_assets/console-icons/ellipsis.svg) to the right of the cluster you want to move. 1. Select **{{ ui-key.yacloud.mdb.dialogs.popup_button_move-cluster }}**. 1. Select a folder you want to move the cluster to. 1. Click **{{ ui-key.yacloud.mdb.dialogs.popup_button_move-cluster }}**. diff --git a/en/managed-mongodb/pricing.md b/en/managed-mongodb/pricing.md index 9abd3f8fc10..af2f3fd495b 100644 --- a/en/managed-mongodb/pricing.md +++ b/en/managed-mongodb/pricing.md @@ -6,7 +6,7 @@ editable: false -This section presents {{ mmg-name }} pricing [rules](#rules) and [effective prices](#prices) for its resources. +In this section, you can find the {{ mmg-name }} pricing [policy](#rules) and [effective prices](#prices) for its resources. {% include [use-calculator](../_includes/pricing/use-calculator.md) %} @@ -28,7 +28,7 @@ The {{ mmg-name }} usage cost is based on: ### DB host usage {#rules-hosts-uptime} -Host operation cost is charged per hour based on what computing resources you allocate for it. The supported resource configurations are described in the [Host classes](concepts/instance-types.md) section, and vCPU and RAM prices, in the [Prices](#prices) section. +Host operation cost is charged per hour based on what computing resources you allocate for it. You can find the supported resource configurations in the [Host classes](concepts/instance-types.md) section. For the vCPU and RAM prices, see [Prices](#prices). The minimum billing unit is one minute (for example, 1.5 minutes of host operation cost the same as 2 minutes). You do not pay for the time when the {{ MG }} host is unable to perform its main functions. @@ -85,7 +85,7 @@ Calculation for the storage cost and total cost: {% include [pricing-diff-regions](../_includes/pricing-diff-regions.md) %} -All prices below do not include VAT. +Prices are net of VAT. {% include [pricing-month-term](../_includes/mdb/pricing-month-term.md) %} diff --git a/en/managed-mongodb/quickstart.md b/en/managed-mongodb/quickstart.md index ee9edab7989..1c41f9fb321 100644 --- a/en/managed-mongodb/quickstart.md +++ b/en/managed-mongodb/quickstart.md @@ -1,5 +1,5 @@ --- -title: How to get started with {{ mmg-full-name }} +title: Getting started with {{ mmg-full-name }} description: Follow this guide to create and set up a {{ MG }} cluster. --- @@ -18,7 +18,7 @@ To get started with the service: {% include [create-folder](../_includes/create-folder.md) %} -1. [Make sure](../iam/operations/roles/get-assigned-roles.md) your account has the [{{ roles-vpc-user }}](../vpc/security/index.md#vpc-user) role and [{{ roles.mmg.editor }} role or higher](security/index.md#roles-list) for creating a cluster. +1. [Make sure](../iam/operations/roles/get-assigned-roles.md) your account has the [{{ roles-vpc-user }}](../vpc/security/index.md#vpc-user) role and the [{{ roles.mmg.editor }} role or higher](security/index.md#roles-list) for creating a cluster. 1. You can connect to DB clusters from both inside and outside {{ yandex-cloud }}: * To connect to a DB cluster from inside {{ yandex-cloud }}, create a VM in the same cloud network as the DB cluster (with [Linux](../compute/quickstart/quick-create-linux.md)). @@ -53,7 +53,7 @@ To get started with the service: ## Connect to the DB {#connect} -1. If using security groups for a cloud network, [configure](operations/connect/index.md#configuring-security-groups) them to enable all relevant traffic between the cluster and the connecting host. +1. If you are using security groups for a cloud network, [configure](operations/connect/index.md#configuring-security-groups) them to enable all relevant traffic between the cluster and the connecting host. 1. Get an SSL certificate: @@ -64,6 +64,8 @@ To get started with the service: {% include [default-connstring-old](../_includes/mdb/mmg/default-connstring-old.md) %} + To learn how to get a host FQDN, see [this guide](operations/connect/index.md#get-fqdn). + ## What's next {#whats-next} * Read about [service concepts](concepts/index.md). diff --git a/en/managed-mongodb/tutorials/mongodb-versions.md b/en/managed-mongodb/tutorials/mongodb-versions.md index 4a725a20164..5d4a5eb0a3a 100644 --- a/en/managed-mongodb/tutorials/mongodb-versions.md +++ b/en/managed-mongodb/tutorials/mongodb-versions.md @@ -1,5 +1,6 @@ --- noIndex: true +canonical: '{{ link-docs }}/tutorials/dataplatform/mongodb-versions' --- # Migrating a {{ mmg-name }} cluster from version 4.4 to 6.0 using {{ data-transfer-full-name }} diff --git a/en/managed-mysql/api-ref/Cluster/streamLogs.md b/en/managed-mysql/api-ref/Cluster/streamLogs.md index 7ea18154787..74f7b8718e1 100644 --- a/en/managed-mysql/api-ref/Cluster/streamLogs.md +++ b/en/managed-mysql/api-ref/Cluster/streamLogs.md @@ -76,7 +76,7 @@ Set `recordToken` to the [StreamLogRecord.nextRecordToken](#yandex.cloud.mdb.mys A filter expression that selects clusters logs listed in the response. The expression must specify: -1. The field name. Currently filtering can be applied to the [LogRecord.logs.hostname](/docs/compute/api-ref/Instance/create#yandex.cloud.compute.v1.CreateInstanceRequest) field. +1. The field name. Currently filtering can be applied to the [LogRecord.logs.hostname] field. 2. An `=` operator. 3. The value in double quotes (`"`). Must be 3-63 characters long and match the regular expression `[a-z][-a-z0-9]{1,61}[a-z0-9]`. Examples of a filter: `message.hostname='node1.db.cloud.yandex.net'` || diff --git a/en/managed-mysql/api-ref/grpc/Cluster/streamLogs.md b/en/managed-mysql/api-ref/grpc/Cluster/streamLogs.md index 4b9387ac376..29a6105ea7d 100644 --- a/en/managed-mysql/api-ref/grpc/Cluster/streamLogs.md +++ b/en/managed-mysql/api-ref/grpc/Cluster/streamLogs.md @@ -68,7 +68,7 @@ Set `recordToken` to the [StreamLogRecord.nextRecordToken](#yandex.cloud.mdb.mys A filter expression that selects clusters logs listed in the response. The expression must specify: -1. The field name. Currently filtering can be applied to the [LogRecord.logs.hostname](/docs/compute/api-ref/grpc/Instance/create#yandex.cloud.compute.v1.CreateInstanceRequest) field. +1. The field name. Currently filtering can be applied to the [LogRecord.logs.hostname] field. 2. An `=` operator. 3. The value in double quotes (`"`). Must be 3-63 characters long and match the regular expression `[a-z][-a-z0-9]{1,61}[a-z0-9]`. Examples of a filter: `message.hostname='node1.db.cloud.yandex.net'` || diff --git a/en/managed-mysql/concepts/limits.md b/en/managed-mysql/concepts/limits.md index 42a60550ccd..6c74e7e008b 100644 --- a/en/managed-mysql/concepts/limits.md +++ b/en/managed-mysql/concepts/limits.md @@ -12,8 +12,7 @@ editable: false {% include [quotes-limits-def.md](../../_includes/quotes-limits-def.md) %} - {% include [increase-quotas.md](../../_includes/increase-quotas.md) %} - {% include [mmy-limits.md](../../_includes/mdb/mmy-limits.md) %} + diff --git a/en/managed-mysql/operations/cluster-backups.md b/en/managed-mysql/operations/cluster-backups.md index 3ab6ffeaf9e..21ac4ad875c 100644 --- a/en/managed-mysql/operations/cluster-backups.md +++ b/en/managed-mysql/operations/cluster-backups.md @@ -52,7 +52,7 @@ You can create backups and restore clusters from existing backups, including poi To get a list of backups for all the {{ mmy-name }} clusters in the folder, use the [list](../api-ref/Backup/list.md) REST API method for the [Backup](../api-ref/Backup/index.md) resource or the [BackupService/List](../api-ref/grpc/Backup/list.md) gRPC API call and provide the folder ID in the `folderId` parameter of your request. - {% include [note-api-get-cluster-id](../../_includes/mdb/mmy/note-api-get-cluster-id.md) %} + {% include [note-api-get-cluster-id](../../_includes/mdb/mmy/note-api-get-cluster-id.md) %} {% endlist %} @@ -130,7 +130,7 @@ You can create backups and restore clusters from existing backups, including poi To create a backup, use the [backup](../api-ref/Cluster/backup.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Backup](../api-ref/grpc/Cluster/get.md#yandex.cloud.mdb.mysql.v1.Backup) gRPC API call and provide the cluster ID in the `clusterId` parameter of your request. - {% include [note-api-get-cluster-id](../../_includes/mdb/mmy/note-api-get-cluster-id.md) %} + {% include [note-api-get-cluster-id](../../_includes/mdb/mmy/note-api-get-cluster-id.md) %} {% endlist %} @@ -342,7 +342,7 @@ For a new cluster, you should set all the parameters that are required at creati {{ TF }} will create the new cluster. The databases and users are deployed from the backup. - For more information, see the [{{ TF }} provider documentation]({{ tf-provider-mmy }}). + For more information, see the [{{ TF }} provider documentation]({{ tf-provider-mmy }}). {% include [Terraform timeouts](../../_includes/mdb/mmy/terraform/timeouts.md) %} @@ -350,7 +350,7 @@ For a new cluster, you should set all the parameters that are required at creati To restore a cluster from a backup, use the [restore](../api-ref/Cluster/restore.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Restore](../api-ref/grpc/Cluster/restore.md) gRPC API call and provide the following in the request: - * Backup ID in the `backupId` parameter. To find out the ID, [retrieve a list of cluster backups](#list-backups). + * Backup ID in the `backupId` parameter. To find out the ID, [get a list of cluster backups](#list-backups). * Time point to which you want to restore the cluster, in the `time` parameter. * Name of the new cluster that will contain the data recovered from the backup, in the `name` parameter. It must be unique within the folder. @@ -412,7 +412,7 @@ For a new cluster, you should set all the parameters that are required at creati {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} - For more information, see the [{{ TF }} provider documentation]({{ tf-provider-mmy }}). + For more information, see the [{{ TF }} provider documentation]({{ tf-provider-mmy }}). {% include [Terraform timeouts](../../_includes/mdb/mmy/terraform/timeouts.md) %} diff --git a/en/managed-mysql/operations/cluster-list.md b/en/managed-mysql/operations/cluster-list.md index 47fc40d748d..d4889d271cf 100644 --- a/en/managed-mysql/operations/cluster-list.md +++ b/en/managed-mysql/operations/cluster-list.md @@ -7,106 +7,194 @@ description: You can request detailed information about each {{ mmy-short-name } You can request detailed information about each {{ mmy-short-name }} cluster you created. - ## Getting a list of database clusters in a folder {#list-clusters} {% list tabs group=instructions %} - Management console {#console} - Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mysql }}**. + Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mysql }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To request a list of {{ MY }} clusters in the default folder, run the command: + To request a list of {{ MY }} clusters in the default folder, run the command: - ``` - {{ yc-mdb-my }} cluster list - ``` + ``` + {{ yc-mdb-my }} cluster list + ``` - Result: + Result: - ``` - +----------------------+--------------+---------------------+--------+---------+ - | ID | NAME | CREATED AT | HEALTH | STATUS | - +----------------------+--------------+---------------------+--------+---------+ - | c9q5k4ve76js******** | mysql-test | 2019-07-09 11:05:25 | ALIVE | RUNNING | - | ... | - +----------------------+--------------+---------------------+--------+---------+ - ``` + ``` + +----------------------+--------------+---------------------+--------+---------+ + | ID | NAME | CREATED AT | HEALTH | STATUS | + +----------------------+--------------+---------------------+--------+---------+ + | c9q5k4ve76js******** | mysql-test | 2019-07-09 11:05:25 | ALIVE | RUNNING | + | ... | + +----------------------+--------------+---------------------+--------+---------+ + ``` - API {#api} - To get a list of DB clusters in a folder, use the [list](../api-ref/Cluster/list.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/List](../api-ref/grpc/Cluster/list.md) gRPC API call and provide the folder ID in the `folderId` request parameter. + To get a list of DB clusters in a folder, use the [list](../api-ref/Cluster/list.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/List](../api-ref/grpc/Cluster/list.md) gRPC API call and provide the folder ID in the `folderId` request parameter. {% endlist %} - ## Getting detailed information about a cluster {#get-cluster} {% list tabs group=instructions %} - Management console {#console} - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mysql }}**. - 1. Click the cluster name. + 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mysql }}**. + 1. Click the cluster name. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To get information about a {{ MY }} cluster, run the following command: + To get information about a {{ MY }} cluster, run the following command: - ``` - {{ yc-mdb-my }} cluster get - ``` + ``` + {{ yc-mdb-my }} cluster get + ``` - You can request the cluster ID and name with a [list of clusters in the folder](#list-clusters). + You can request the cluster ID and name with a [list of clusters in the folder](#list-clusters). - API {#api} - To get cluster details, use the [get](../api-ref/Cluster/get.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Get](../api-ref/grpc/Cluster/get.md) gRPC API call and provide the cluster ID in the `clusterId` request parameter. + To get cluster details, use the [get](../api-ref/Cluster/get.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Get](../api-ref/grpc/Cluster/get.md) gRPC API call and provide the cluster ID in the request. - {% include [note-api-get-cluster-id](../../_includes/mdb/mmy/note-api-get-cluster-id.md) %} + {% include [note-api-get-cluster-id](../../_includes/mdb/mmy/note-api-get-cluster-id.md) %} {% endlist %} -## Viewing a list of operations in a cluster {#list-operations} +## Viewing operations with clusters {#list-operations} -{% include [list-operations-about](../../_includes/mdb/list-operations-about.md) %} +All actions with {{ mmy-name }} clusters are logged as a list of operations. Each operation is assigned a unique ID. + +### Getting a list of operations {#get-operations} {% list tabs group=instructions %} - Management console {#console} - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mysql }}**. - 1. Click the cluster name. - 1. In the left-hand panel, select ![image](../../_assets/console-icons/list-check.svg) **{{ ui-key.yacloud.mysql.cluster.switch_operations }}**. + To view operations with all {{ mmy-name }} clusters, in the left-hand panel, select ![image](../../_assets/console-icons/list-check.svg) **{{ ui-key.yacloud.mysql.switch_operations }}**. In the list that opens, you will also see operations with the resources that were deleted. + + You can get a list of operations for a cluster: + + 1. In the [management console]({{ link-console-main }}), open the folder with the cluster. + 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-mysql }}**. + 1. In the left-hand panel, select ![image](../../_assets/console-icons/cubes-3.svg) **{{ ui-key.yacloud.mysql.switch_list }}**. + 1. Select the cluster you need. + 1. Go to the ![image](../../_assets/console-icons/list-check.svg) **{{ ui-key.yacloud.mysql.switch_operations }}** panel for the selected cluster. + + You will see a list of operations with the selected cluster. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} + + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + To get a list of operations for a {{ mmy-name }} cluster, run this command: - To get a list of operations, run the following command: + ```bash + yc managed-mysql cluster list-operations + ``` - ``` - {{ yc-mdb-my }} cluster list-operations - ``` + Result: - You can request the cluster ID and name with a [list of clusters in the folder](#list-clusters). + ```text + +----------------------+---------------------+----------------------+---------------------+--------+----------------------+ + | ID | CREATED AT | CREATED BY | MODIFIED AT | STATUS | DESCRIPTION | + +----------------------+---------------------+----------------------+---------------------+--------+----------------------+ + | c5m7ll6pq3j8******** | 2024-08-08 19:05:42 | mdb-maintainer | 2024-08-15 19:20:05 | DONE | Modify MySQL cluster | + | c5mb0no66172******** | 2024-06-19 12:48:40 | mdb-maintainer | 2024-06-26 12:50:14 | DONE | Modify MySQL cluster | + | c5m6of9he7op******** | 2023-11-13 19:25:21 | ajeef73j5iq9******** | 2023-11-13 19:32:00 | DONE | Create MySQL cluster | + +----------------------+---------------------+----------------------+---------------------+---- ---+----------------------+ + ``` + + {% include [list of clusters in the folder](../../_includes/mdb/mmy/note-api-get-cluster-id.md) %} + + By default, information about operations is provided as text. To get detailed information, specify the `yaml` or `json` output data format using the `--format` flag: + + ```bash + yc managed-mysql cluster list-operations c9qk2926qqu9******** --format yaml + ``` + + Result: + + ```text + - id: c9ql6o8jm80n******** + description: Create MySQL cluster + created_at: "2024-08-06T05:47:26.423618Z" + created_by: ajej2i98kcjd******** + modified_at: "2024-08-06T05:58:36.571719Z" + done: true + metadata: + '@type': type.googleapis.com/yandex.cloud.mdb.mysql.v1.CreateClusterMetadata + cluster_id: c9qnfo2eh7js******** + ... + ``` - API {#api} - To get a list of cluster operations, use the [listOperations](../api-ref/Cluster/listOperations.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/ListOperations](../api-ref/grpc/Cluster/listOperations.md) gRPC API call and provide the cluster ID in the `clusterId` request parameter. + Use the [listOperations](../api-ref/Cluster/listOperations.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/ListOperations](../api-ref/grpc/Cluster/listOperations.md) gRPC API call and provide the cluster ID in the request. - {% include [note-api-get-cluster-id](../../_includes/mdb/mmy/note-api-get-cluster-id.md) %} + {% include [list of clusters in the folder](../../_includes/mdb/mmy/note-api-get-cluster-id.md) %} {% endlist %} + +### Getting detailed information about an operation {#get-operations-info} + +1. [Get a list of operations](#get-operations) for the cluster. +1. Copy the ID of the operation. +1. Get detailed information about the operation: + + {% list tabs group=instructions %} + + - CLI {#cli} + + {% include [cli-install](../../_includes/cli-install.md) %} + + {% include [default-catalogue](../../_includes/default-catalogue.md) %} + + Run this command: + + ```bash + yc operation get + ``` + + Result: + + ```text + id: c9ql6o8jm80n******** + description: Create MySQL cluster + created_at: "2024-08-06T05:47:26.423618Z" + created_by: ajej2i98kcjd******** + modified_at: "2024-08-06T05:58:36.571719Z" + done: true + metadata: + '@type': type.googleapis.com/yandex.cloud.mdb.mysql.v1.CreateClusterMetadata + cluster_id: c9qnfo2eh7js******** + response: + '@type': type.googleapis.com/yandex.cloud.mdb.mysql.v1.Cluster + ... + ``` + + - API {#api} + + Use the [get](../api-ref/Cluster/get.md) REST API method for the [Operation](../api-ref/Operation/index.md) resource or the [OperationService/Get](../api-ref/grpc/Operation/get.md) gRPC API call and provide the operation ID in the request. + + {% endlist %} + +### See also {#see-also} + +* [{#T}](../../api-design-guide/concepts/about-async.md) diff --git a/en/managed-mysql/tutorials/mmy-to-mgp.md b/en/managed-mysql/tutorials/mmy-to-mgp.md index 1645e6cc06d..2791b655c1f 100644 --- a/en/managed-mysql/tutorials/mmy-to-mgp.md +++ b/en/managed-mysql/tutorials/mmy-to-mgp.md @@ -1,5 +1,6 @@ --- noIndex: true +canonical: '{{ link-docs }}/tutorials/dataplatform/mmy-to-mgp' --- # Migrating data from {{ mmy-name }} to {{ mgp-full-name }} using {{ data-transfer-full-name }} diff --git a/en/managed-opensearch/api-ref/Cluster/deleteBackup.md b/en/managed-opensearch/api-ref/Cluster/deleteBackup.md new file mode 100644 index 00000000000..551efae4529 --- /dev/null +++ b/en/managed-opensearch/api-ref/Cluster/deleteBackup.md @@ -0,0 +1,137 @@ +--- +editable: false +sourcePath: en/_api-ref/mdb/opensearch/v1/api-ref/Cluster/deleteBackup.md +--- + +# Managed Service for OpenSearch API, REST: Cluster.DeleteBackup {#DeleteBackup} + +Delete backup for the specified OpenSearch cluster. + +## HTTP request + +``` +DELETE https://{{ api-host-mdb }}/managed-opensearch/v1/clusters/{clusterId}/backups/{backupId} +``` + +## Path parameters + +#| +||Field | Description || +|| clusterId | **string** + +Required field. Required. ID of the OpenSearch cluster. || +|| backupId | **string** + +Required field. Required. ID of the backup to delete. || +|# + +## Response {#yandex.cloud.operation.Operation} + +**HTTP Code: 200 - OK** + +```json +{ + "id": "string", + "description": "string", + "createdAt": "string", + "createdBy": "string", + "modifiedAt": "string", + "done": "boolean", + "metadata": { + "clusterId": "string", + "backupId": "string" + }, + // Includes only one of the fields `error` + "error": { + "code": "integer", + "message": "string", + "details": [ + "object" + ] + } + // end of the list of possible fields +} +``` + +An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). + +#| +||Field | Description || +|| id | **string** + +ID of the operation. || +|| description | **string** + +Description of the operation. 0-256 characters long. || +|| createdAt | **string** (date-time) + +Creation timestamp. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| createdBy | **string** + +ID of the user or service account who initiated the operation. || +|| modifiedAt | **string** (date-time) + +The time when the Operation resource was last modified. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| done | **boolean** + +If the value is `false`, it means the operation is still in progress. +If `true`, the operation is completed, and either `error` or `response` is available. || +|| metadata | **[DeleteBackupMetadata](#yandex.cloud.mdb.opensearch.v1.DeleteBackupMetadata)** + +Service-specific metadata associated with the operation. +It typically contains the ID of the target resource that the operation is performed on. +Any method that returns a long-running operation should document the metadata type, if any. || +|| error | **[Status](#google.rpc.Status)** + +The error result of the operation in case of failure or cancellation. + +Includes only one of the fields `error`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|# + +## DeleteBackupMetadata {#yandex.cloud.mdb.opensearch.v1.DeleteBackupMetadata} + +#| +||Field | Description || +|| clusterId | **string** + +ID of the OpenSearch cluster. || +|| backupId | **string** + +ID of the backup to delete. || +|# + +## Status {#google.rpc.Status} + +The error result of the operation in case of failure or cancellation. + +#| +||Field | Description || +|| code | **integer** (int32) + +Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || +|| message | **string** + +An error message. || +|| details[] | **object** + +A list of messages that carry the error details. || +|# \ No newline at end of file diff --git a/en/managed-opensearch/api-ref/Cluster/index.md b/en/managed-opensearch/api-ref/Cluster/index.md index 3b10a84835a..a353e1a7f7b 100644 --- a/en/managed-opensearch/api-ref/Cluster/index.md +++ b/en/managed-opensearch/api-ref/Cluster/index.md @@ -17,6 +17,7 @@ A set of methods for managing OpenSearch clusters. || [Update](update.md) | Updates the specified OpenSearch cluster. || || [Delete](delete.md) | Deletes the specified OpenSearch cluster. || || [Backup](backup.md) | Creates a backup for the specified OpenSearch cluster. || +|| [DeleteBackup](deleteBackup.md) | Delete backup for the specified OpenSearch cluster. || || [Restore](restore.md) | Creates a new OpenSearch cluster using the specified backup. || || [RescheduleMaintenance](rescheduleMaintenance.md) | Reschedules a planned maintenance operation. || || [ListBackups](listBackups.md) | Returns a list of available backups for the specified OpenSearch cluster. || diff --git a/en/managed-opensearch/api-ref/Cluster/streamLogs.md b/en/managed-opensearch/api-ref/Cluster/streamLogs.md index dc0efef7afd..30d990c85c7 100644 --- a/en/managed-opensearch/api-ref/Cluster/streamLogs.md +++ b/en/managed-opensearch/api-ref/Cluster/streamLogs.md @@ -105,9 +105,9 @@ One of the requested log records. || This token allows you to continue streaming logs starting from the exact same record. -To do that, specify value of `nextRecordToken` as the value for [StreamLogs.recordToken](#yandex.cloud.mdb.opensearch.v1.StreamClusterLogsRequest) parameter in the next [StreamLogs](#StreamLogs) request. +To do that, specify value of `nextRecordToken` as the value for [StreamLogs.record_token] parameter in the next [StreamLogs](#StreamLogs) request. -This value is interchangeable with [ListLogs.nextPageToken](/docs/managed-opensearch/api-ref/Backup/list#yandex.cloud.mdb.opensearch.v1.ListBackupsResponse) from [ListLogs](/docs/managed-opensearch/api-ref/Cluster/listLogs#ListLogs) method. || +This value is interchangeable with [ListLogs.next_page_token] from [ListLogs](/docs/managed-opensearch/api-ref/Cluster/listLogs#ListLogs) method. || |# ## LogRecord {#yandex.cloud.mdb.opensearch.v1.LogRecord} diff --git a/en/managed-opensearch/api-ref/grpc/Cluster/deleteBackup.md b/en/managed-opensearch/api-ref/grpc/Cluster/deleteBackup.md new file mode 100644 index 00000000000..6fee8312910 --- /dev/null +++ b/en/managed-opensearch/api-ref/grpc/Cluster/deleteBackup.md @@ -0,0 +1,119 @@ +--- +editable: false +sourcePath: en/_api-ref-grpc/mdb/opensearch/v1/api-ref/grpc/Cluster/deleteBackup.md +--- + +# Managed Service for OpenSearch API, gRPC: ClusterService.DeleteBackup {#DeleteBackup} + +Delete backup for the specified OpenSearch cluster. + +## gRPC request + +**rpc DeleteBackup ([DeleteBackupRequest](#yandex.cloud.mdb.opensearch.v1.DeleteBackupRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** + +## DeleteBackupRequest {#yandex.cloud.mdb.opensearch.v1.DeleteBackupRequest} + +```json +{ + "clusterId": "string", + "backupId": "string" +} +``` + +#| +||Field | Description || +|| clusterId | **string** + +Required field. Required. ID of the OpenSearch cluster. || +|| backupId | **string** + +Required field. Required. ID of the backup to delete. || +|# + +## operation.Operation {#yandex.cloud.operation.Operation} + +```json +{ + "id": "string", + "description": "string", + "createdAt": "google.protobuf.Timestamp", + "createdBy": "string", + "modifiedAt": "google.protobuf.Timestamp", + "done": "bool", + "metadata": { + "clusterId": "string", + "backupId": "string" + }, + // Includes only one of the fields `error`, `response` + "error": "google.rpc.Status", + "response": "google.protobuf.Empty" + // end of the list of possible fields +} +``` + +An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). + +#| +||Field | Description || +|| id | **string** + +ID of the operation. || +|| description | **string** + +Description of the operation. 0-256 characters long. || +|| createdAt | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp)** + +Creation timestamp. || +|| createdBy | **string** + +ID of the user or service account who initiated the operation. || +|| modifiedAt | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp)** + +The time when the Operation resource was last modified. || +|| done | **bool** + +If the value is `false`, it means the operation is still in progress. +If `true`, the operation is completed, and either `error` or `response` is available. || +|| metadata | **[DeleteBackupMetadata](#yandex.cloud.mdb.opensearch.v1.DeleteBackupMetadata)** + +Service-specific metadata associated with the operation. +It typically contains the ID of the target resource that the operation is performed on. +Any method that returns a long-running operation should document the metadata type, if any. || +|| error | **[google.rpc.Status](https://cloud.google.com/tasks/docs/reference/rpc/google.rpc#status)** + +The error result of the operation in case of failure or cancellation. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|| response | **[google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty)** + +The normal response of the operation in case of success. +If the original method returns no data on success, such as Delete, +the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). +If the original method is the standard Create/Update, +the response should be the target resource of the operation. +Any method that returns a long-running operation should document the response type, if any. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|# + +## DeleteBackupMetadata {#yandex.cloud.mdb.opensearch.v1.DeleteBackupMetadata} + +#| +||Field | Description || +|| clusterId | **string** + +ID of the OpenSearch cluster. || +|| backupId | **string** + +ID of the backup to delete. || +|# \ No newline at end of file diff --git a/en/managed-opensearch/api-ref/grpc/Cluster/index.md b/en/managed-opensearch/api-ref/grpc/Cluster/index.md index e6385f95217..76166fd2202 100644 --- a/en/managed-opensearch/api-ref/grpc/Cluster/index.md +++ b/en/managed-opensearch/api-ref/grpc/Cluster/index.md @@ -17,6 +17,7 @@ A set of methods for managing OpenSearch clusters. || [Update](update.md) | Updates the specified OpenSearch cluster. || || [Delete](delete.md) | Deletes the specified OpenSearch cluster. || || [Backup](backup.md) | Creates a backup for the specified OpenSearch cluster. || +|| [DeleteBackup](deleteBackup.md) | Delete backup for the specified OpenSearch cluster. || || [Restore](restore.md) | Creates a new OpenSearch cluster using the specified backup. || || [RescheduleMaintenance](rescheduleMaintenance.md) | Reschedules a planned maintenance operation. || || [ListBackups](listBackups.md) | Returns a list of available backups for the specified OpenSearch cluster. || diff --git a/en/managed-opensearch/api-ref/grpc/Cluster/streamLogs.md b/en/managed-opensearch/api-ref/grpc/Cluster/streamLogs.md index c8a0a180550..11a75d5125f 100644 --- a/en/managed-opensearch/api-ref/grpc/Cluster/streamLogs.md +++ b/en/managed-opensearch/api-ref/grpc/Cluster/streamLogs.md @@ -95,9 +95,9 @@ One of the requested log records. || This token allows you to continue streaming logs starting from the exact same record. -To do that, specify value of `nextRecordToken` as the value for [StreamLogs.recordToken](#yandex.cloud.mdb.opensearch.v1.StreamClusterLogsRequest) parameter in the next [StreamLogs](#StreamLogs) request. +To do that, specify value of `nextRecordToken` as the value for [StreamLogs.record_token] parameter in the next [StreamLogs](#StreamLogs) request. -This value is interchangeable with [ListLogs.nextPageToken](/docs/managed-opensearch/api-ref/grpc/Backup/list#yandex.cloud.mdb.opensearch.v1.ListBackupsResponse) from [ListLogs](/docs/managed-opensearch/api-ref/grpc/Cluster/listLogs#ListLogs) method. || +This value is interchangeable with [ListLogs.next_page_token] from [ListLogs](/docs/managed-opensearch/api-ref/grpc/Cluster/listLogs#ListLogs) method. || |# ## LogRecord {#yandex.cloud.mdb.opensearch.v1.LogRecord} diff --git a/en/managed-opensearch/operations/cluster-list.md b/en/managed-opensearch/operations/cluster-list.md index e63480ae43a..f312a81a4eb 100644 --- a/en/managed-opensearch/operations/cluster-list.md +++ b/en/managed-opensearch/operations/cluster-list.md @@ -17,34 +17,34 @@ You can request detailed information about each {{ mos-name }} cluster you creat - Management console {#console} - In the [management console]({{ link-console-main }}), go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-opensearch }}**. + In the [management console]({{ link-console-main }}), go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-opensearch }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To request a list of {{ OS }} clusters in the default folder, run this command: + To request a list of {{ OS }} clusters in the default folder, run this command: - ```bash - {{ yc-mdb-os }} cluster list - ``` + ```bash + {{ yc-mdb-os }} cluster list + ``` - ```text - +----------------------+------+-----------------------------+--------+---------+ - | ID | NAME | CREATED AT | HEALTH | STATUS | - +----------------------+------+-----------------------------+--------+---------+ - | c9wlk4v14uq7******** | myos | 2023-12-19T10:04:14.645214Z | ALIVE | RUNNING | - | ... | - +----------------------+------+-----------------------------+--------+---------+ - ``` + ```text + +----------------------+------+-----------------------------+--------+---------+ + | ID | NAME | CREATED AT | HEALTH | STATUS | + +----------------------+------+-----------------------------+--------+---------+ + | c9wlk4v14uq7******** | myos | 2023-12-19T10:04:14.645214Z | ALIVE | RUNNING | + | ... | + +----------------------+------+-----------------------------+--------+---------+ + ``` - API {#api} - To get a list of clusters in a folder, use the [list](../api-ref/Cluster/list.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/List](../api-ref/grpc/Cluster/list.md) gRPC API call and provide the folder ID in the `folderId` request parameter. + To get a list of clusters in a folder, use the [list](../api-ref/Cluster/list.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/List](../api-ref/grpc/Cluster/list.md) gRPC API call and provide the folder ID in the `folderId` request parameter. - The response will contain cluster names and IDs. + The response will contain cluster names and IDs. {% endlist %} @@ -54,46 +54,149 @@ You can request detailed information about each {{ mos-name }} cluster you creat - Management console {#console} - 1. In the [management console]({{ link-console-main }}), go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-opensearch }}**. - 1. Click the cluster name. + 1. In the [management console]({{ link-console-main }}), go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-opensearch }}**. + 1. Click the cluster name. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - To get information about an {{ OS }} cluster, run the following command: + To get information about an {{ OS }} cluster, run the following command: - ```bash - {{ yc-mdb-os }} cluster get - ``` + ```bash + {{ yc-mdb-os }} cluster get + ``` - You can request the cluster name and ID with a [list of clusters in the folder](#list-clusters). + You can request the cluster name and ID with a [list of clusters in the folder](#list-clusters). - API {#api} - To get cluster details, use the [get](../api-ref/Cluster/get.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Get](../api-ref/grpc/Cluster/get.md) gRPC API call and provide the cluster ID in the `clusterId` request parameter. + To get cluster details, use the [get](../api-ref/Cluster/get.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/Get](../api-ref/grpc/Cluster/get.md) gRPC API call and provide the cluster ID in the `clusterId` request parameter. - {% include [get-cluster-id](../../_includes/managed-opensearch/get-cluster-id.md) %} + {% include [get-cluster-id](../../_includes/managed-opensearch/get-cluster-id.md) %} {% endlist %} -## Viewing a list of operations in a cluster {#list-operations} +## Viewing operations with clusters {#list-operations} -The operation list shows operations with clusters and related resources (for example, hosts and shards). +All actions with {{ mos-name }} clusters are logged as a list of operations. Each operation is assigned a unique ID. + +### Getting a list of operations {#get-operations} {% list tabs group=instructions %} - Management console {#console} - 1. Go to the [folder page]({{ link-console-main }}) and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-opensearch }}**. - 1. Click the cluster name and select the ![operations.svg](../../_assets/console-icons/list-check.svg) **{{ ui-key.yacloud.common.operations-key-value }}** tab. + To get a list of operations for a cluster: + + 1. In the [management console]({{ link-console-main }}), open the folder with the cluster. + 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-opensearch }}**. + 1. In the left-hand panel, select ![image](../../_assets/console-icons/cubes-3.svg) **{{ ui-key.yacloud.mdb.clusters.label_title }}**. + 1. Select the cluster you need. + 1. Go to the ![image](../../_assets/console-icons/list-check.svg) **{{ ui-key.yacloud.common.operations-key-value }}** panel for the selected cluster. + + You will see a list of operations with the selected cluster. + +- CLI {#cli} + + {% include [cli-install](../../_includes/cli-install.md) %} + + {% include [default-catalogue](../../_includes/default-catalogue.md) %} + + To get a list of operations for a {{ mos-name }} cluster, run this command: + + ```bash + yc managed-opensearch cluster list-operations + ``` + + Result: + + ```text + +----------------------+---------------------+----------------------+---------------------+--------+---------------------------+ + | ID | CREATED AT | CREATED BY | MODIFIED AT | STATUS | DESCRIPTION | + +----------------------+---------------------+----------------------+---------------------+--------+---------------------------+ + | dqh0ntf6batm******** | 2024-09-07 16:36:46 | aje9k8luj4qf******** | 2024-09-07 16:44:12 | DONE | Create OpenSearch cluster | + +----------------------+---------------------+----------------------+---------------------+--------+---------------------------+ + ``` + + {% include [get-cluster-id](../../_includes/managed-opensearch/get-cluster-id.md) %} + + By default, information about operations is provided as text. To get detailed information, specify the `yaml` or `json` output data format using the `--format` flag: + + ```bash + yc managed-opensearch cluster list-operations c9qk2926qqu9******** --format yaml + ``` + + Result: + + ```text + - id: dqh0ntf6batm******** + description: Create OpenSearch cluster + created_at: "2024-09-07T16:36:46.816682Z" + created_by: aje9k8luj4qf******** + modified_at: "2024-09-07T16:44:12.944302Z" + done: true + metadata: + '@type': type.googleapis.com/yandex.cloud.mdb.opensearch.v1.CreateClusterMetadata + cluster_id: c9q13q0acgv7******** + response: + '@type': type.googleapis.com/google.rpc.Status + message: OK + ``` - API {#api} - To get a list of cluster operations, use the [listOperations](../api-ref/Cluster/listOperations.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/ListOperations](../api-ref/grpc/Cluster/listOperations.md) gRPC API call and provide the cluster ID in the `clusterId` request parameter. + Use the [listOperations](../api-ref/Cluster/listOperations.md) REST API method for the [Cluster](../api-ref/Cluster/index.md) resource or the [ClusterService/ListOperations](../api-ref/grpc/Cluster/listOperations.md) gRPC API call and provide the cluster ID in the `clusterId` request parameter. - {% include [get-cluster-id](../../_includes/managed-opensearch/get-cluster-id.md) %} + {% include [get-cluster-id](../../_includes/managed-opensearch/get-cluster-id.md) %} {% endlist %} + +## Getting detailed information about an operation {#get-operations-info} + +1. [Get a list of operations](#get-operations) for the cluster. +1. Copy the operation ID. +1. Get detailed information about the operation: + + {% list tabs group=instructions %} + + - CLI {#cli} + + {% include [cli-install](../../_includes/cli-install.md) %} + + {% include [default-catalogue](../../_includes/default-catalogue.md) %} + + Run this command: + + ```bash + yc operation get + ``` + + Result: + + ```text + id: dqh0ntf6batm******** + description: Create OpenSearch cluster + created_at: "2024-09-07T16:36:46.816682Z" + created_by: aje9k8luj4qf******** + modified_at: "2024-09-07T16:44:12.944302Z" + done: true + metadata: + '@type': type.googleapis.com/yandex.cloud.mdb.opensearch.v1.CreateClusterMetadata + cluster_id: c9q13q0acgv7******** + response: + '@type': type.googleapis.com/yandex.cloud.mdb.opensearch.v1.Cluster + ... + ``` + + - API {#api} + + Use the [get](../api-ref/Cluster/get.md) REST API method for the [Operation](../api-ref/Operation/index.md) resource or the [OperationService/Get](../api-ref/grpc/Operation/get.md) gRPC API call and provide the operation ID in the request. + + {% endlist %} + +### See also {#see-also} + +* [{#T}](../../api-design-guide/concepts/about-async.md) diff --git a/en/managed-opensearch/operations/saml-authentication.md b/en/managed-opensearch/operations/saml-authentication.md index f46494caf2a..db2352c2ec8 100644 --- a/en/managed-opensearch/operations/saml-authentication.md +++ b/en/managed-opensearch/operations/saml-authentication.md @@ -2,9 +2,7 @@ Security Assertion Markup Language (SAML) is used for exchanging authentication and authorization data between two parties. With SAML, you can implement a single sign-on system (SSO) to switch between applications without re-authentication. -When using SAML and SSO, a {{ mos-name }} cluster gets information from an identity provider (IdP). - -For more information about SAML and SSO, see the [OASIS documentation](https://wiki.oasis-open.org/security/saml/). +When using SAML and SSO, a {{ mos-name }} cluster gets information from an identity provider (IdP). For more information about SAML and SSO, see the [OASIS documentation](https://wiki.oasis-open.org/security/saml/). {{ mos-name }} works with any SAML 2.0 compatible identity provider. @@ -26,24 +24,24 @@ To set up SAML authentication: You can get the cluster ID with a [list of clusters in the folder](cluster-list.md#list-clusters). - **Example:** `https://c-e4ut2....rw.{{ dns-zone }}/_opendistro/_security/saml/acs` + URL example: `https://c-e4ut2....rw.{{ dns-zone }}/_opendistro/_security/saml/acs` 1. Specify the **SP Entity ID (Audience URI)**. Use the URL with a [special cluster FQDN](connect.md#special-fqdns): ```text - https://c-rw.{{ dns-zone }} + https://c-rw.{{ dns-zone }}/ ``` - **Example:** `https://c-e4ut2....rw.{{ dns-zone }}` + URL example: `https://c-e4ut2....rw.{{ dns-zone }}/` 1. Specify the **Name ID Format**: * `email`, if you use [an identity federation with the Keycloak provider](../../organization/tutorials/federations/integration-keycloak.md). * `persistent`, for other providers. -1. Using the data provided by the IdP: +1. Get the data you need to set up SAML SSO on {{ OS }} side: * Copy the information about the Identity Provider Issuer. * Save the provider's metadata file in XML format. @@ -109,12 +107,16 @@ For more information about SAML attributes, see the [{{ OS }} documentation]({{ ## Configure roles for SSO {#roles-sso} -To access the cluster via SSO, associate the cluster roles with the SSO users on the IdP side. To do this: +To access the cluster via SSO, associate the cluster roles with the SSO users on the IdP side: -1. [Map the roles](https://opensearch.org/docs/latest/security/access-control/users-roles/) of the {{ OS }} users on the IdP side to the roles in the cluster. Perform this operation as an [`admin` user](../concepts/index.md) in one of the following ways: +1. [Map the roles](https://opensearch.org/docs/latest/security/access-control/users-roles/) of the {{ OS }} users on the IdP side to the roles in the cluster. Perform this operation as an [`admin`](../concepts/index.md) user in one of the following ways: * Using [OpenSearch Dashboards](https://opensearch.org/docs/latest/security/access-control/users-roles/#opensearch-dashboards-2). * Using the [{{ OS }} API](https://opensearch.org/docs/latest/security/access-control/api/#create-role-mapping). 1. On the IdP side, create a user that meets the role mappings defined in {{ OS }}. 1. Grant this user access to the [previously created application](#configuration-idp). To log in to {{ OS }} using the new user's credentials, go to the **{{ ui-key.yacloud.opensearch.title_opensearch-dashboards-section }}** page. + +## Examples of integration with providers {#examples} + +[{#T}](../tutorials/saml-keycloak.md). diff --git a/en/managed-opensearch/toc.yaml b/en/managed-opensearch/toc.yaml index 374c0137241..3bf88a721b8 100644 --- a/en/managed-opensearch/toc.yaml +++ b/en/managed-opensearch/toc.yaml @@ -81,6 +81,8 @@ items: Migrating data from {{ mpg-name }} to {{ mos-name }} using {{ data-transfer-full-name }} href: tutorials/postgresql-to-opensearch.md + - name: Authentication in {{ OS }} Dashboards using {{ keycloak }} + href: tutorials/saml-keycloak.md - name: Concepts items: - name: Resource relationships @@ -151,6 +153,8 @@ items: href: api-ref/grpc/Cluster/delete.md - name: Backup href: api-ref/grpc/Cluster/backup.md + - name: DeleteBackup + href: api-ref/grpc/Cluster/deleteBackup.md - name: Restore href: api-ref/grpc/Cluster/restore.md - name: RescheduleMaintenance @@ -231,6 +235,8 @@ items: href: api-ref/Cluster/delete.md - name: Backup href: api-ref/Cluster/backup.md + - name: DeleteBackup + href: api-ref/Cluster/deleteBackup.md - name: Restore href: api-ref/Cluster/restore.md - name: RescheduleMaintenance diff --git a/en/managed-opensearch/tutorials/saml-keycloak.md b/en/managed-opensearch/tutorials/saml-keycloak.md new file mode 100644 index 00000000000..49ec97a7224 --- /dev/null +++ b/en/managed-opensearch/tutorials/saml-keycloak.md @@ -0,0 +1,8 @@ +--- +noIndex: true +canonical: '{{ link-docs }}/tutorials/dataplatform/opensearch-saml-keycloak' +--- + +# Authentication in {{ OS }} Dashboards using {{ keycloak }} + +{% include [opensearch-saml-keycloak](../../_tutorials/dataplatform/opensearch-saml-keycloak.md) %} diff --git a/en/managed-postgresql/api-ref/Cluster/addHosts.md b/en/managed-postgresql/api-ref/Cluster/addHosts.md index 4a03c06a88f..659dc70c592 100644 --- a/en/managed-postgresql/api-ref/Cluster/addHosts.md +++ b/en/managed-postgresql/api-ref/Cluster/addHosts.md @@ -35,7 +35,7 @@ To get the PostgreSQL cluster ID, use a [ClusterService.List](/docs/managed-post "replicationSource": "string", "priority": "string", "configSpec": { - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", @@ -1054,6 +1054,140 @@ To get the PostgreSQL cluster ID, use a [ClusterService.List](/docs/managed-post "timezone": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" + }, + "postgresqlConfig_17": { + "recoveryMinApplyDelay": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "workMem": "string", + "tempFileLimit": "string", + "backendFlushAfter": "string", + "maxStandbyStreamingDelay": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + }, + "postgresqlConfig_17_1c": { + "recoveryMinApplyDelay": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "workMem": "string", + "tempFileLimit": "string", + "backendFlushAfter": "string", + "maxStandbyStreamingDelay": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" } // end of the list of possible fields } @@ -1116,77 +1250,87 @@ Configuration of a PostgreSQL server for the host. || Configuration for a host with PostgreSQL 9.6 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_10_1c | **[PostgresqlHostConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C)** Configuration for a host with PostgreSQL 10 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_10 | **[PostgresqlHostConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10)** Configuration for a host with PostgreSQL 10 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_11 | **[PostgresqlHostConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11)** Configuration for a host with PostgreSQL 11 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_11_1c | **[PostgresqlHostConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C)** Configuration for a host with PostgreSQL 11 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_12 | **[PostgresqlHostConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12)** Configuration for a host with PostgreSQL 12 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_12_1c | **[PostgresqlHostConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C)** Configuration for a host with PostgreSQL 12 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_13 | **[PostgresqlHostConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13)** Configuration for a host with PostgreSQL 13 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_13_1c | **[PostgresqlHostConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C)** Configuration for a host with PostgreSQL 13 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_14 | **[PostgresqlHostConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14)** Configuration for a host with PostgreSQL 14 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_14_1c | **[PostgresqlHostConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C)** Configuration for a host with PostgreSQL 14 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_15 | **[PostgresqlHostConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15)** Configuration for a host with PostgreSQL 15 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_15_1c | **[PostgresqlHostConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C)** Configuration for a host with PostgreSQL 15 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_16 | **[PostgresqlHostConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16)** Configuration for a host with PostgreSQL 16 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_16_1c | **[PostgresqlHostConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C)** Configuration for a host with PostgreSQL 16 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17 | **[PostgresqlHostConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17_1c | **[PostgresqlHostConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || |# ## PostgresqlHostConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6} @@ -3962,6 +4106,378 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# +## PostgresqlHostConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). + +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| workMem | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| debugParallelQuery | **enum** (DebugParallelQuery) + +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# + +## PostgresqlHostConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). + +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| workMem | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| debugParallelQuery | **enum** (DebugParallelQuery) + +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# + ## Response {#yandex.cloud.operation.Operation} **HTTP Code: 200 - OK** diff --git a/en/managed-postgresql/api-ref/Cluster/backup.md b/en/managed-postgresql/api-ref/Cluster/backup.md index e18b055f098..e47387ca034 100644 --- a/en/managed-postgresql/api-ref/Cluster/backup.md +++ b/en/managed-postgresql/api-ref/Cluster/backup.md @@ -64,7 +64,7 @@ To get the PostgreSQL cluster ID, use a [ClusterService.List](/docs/managed-post ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "effectiveConfig": { "maxConnections": "string", @@ -6812,6 +6812,1024 @@ To get the PostgreSQL cluster ID, use a [ClusterService.List](/docs/managed-post "passwordEncryption": "string" } }, + "postgresqlConfig_17": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, + "postgresqlConfig_17_1c": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, // end of the list of possible fields "poolerConfig": { "poolingMode": "string", @@ -6876,370 +7894,993 @@ To get the PostgreSQL cluster ID, use a [ClusterService.List](/docs/managed-post } ``` -An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). +An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). + +#| +||Field | Description || +|| id | **string** + +ID of the operation. || +|| description | **string** + +Description of the operation. 0-256 characters long. || +|| createdAt | **string** (date-time) + +Creation timestamp. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| createdBy | **string** + +ID of the user or service account who initiated the operation. || +|| modifiedAt | **string** (date-time) + +The time when the Operation resource was last modified. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| done | **boolean** + +If the value is `false`, it means the operation is still in progress. +If `true`, the operation is completed, and either `error` or `response` is available. || +|| metadata | **[BackupClusterMetadata](#yandex.cloud.mdb.postgresql.v1.BackupClusterMetadata)** + +Service-specific metadata associated with the operation. +It typically contains the ID of the target resource that the operation is performed on. +Any method that returns a long-running operation should document the metadata type, if any. || +|| error | **[Status](#google.rpc.Status)** + +The error result of the operation in case of failure or cancellation. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** + +The normal response of the operation in case of success. +If the original method returns no data on success, such as Delete, +the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). +If the original method is the standard Create/Update, +the response should be the target resource of the operation. +Any method that returns a long-running operation should document the response type, if any. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|# + +## BackupClusterMetadata {#yandex.cloud.mdb.postgresql.v1.BackupClusterMetadata} + +#| +||Field | Description || +|| clusterId | **string** + +ID of the PostgreSQL cluster that is being backed up. || +|| backupId | **string** + +ID of the PostgreSQL backup that is being created. || +|# + +## Status {#google.rpc.Status} + +The error result of the operation in case of failure or cancellation. + +#| +||Field | Description || +|| code | **integer** (int32) + +Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || +|| message | **string** + +An error message. || +|| details[] | **object** + +A list of messages that carry the error details. || +|# + +## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} + +A PostgreSQL Cluster resource. For more information, see +the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. + +#| +||Field | Description || +|| id | **string** + +ID of the PostgreSQL cluster. +This ID is assigned by MDB at creation time. || +|| folderId | **string** + +ID of the folder that the PostgreSQL cluster belongs to. || +|| createdAt | **string** (date-time) + +Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| name | **string** + +Name of the PostgreSQL cluster. +The name is unique within the folder. 1-63 characters long. || +|| description | **string** + +Description of the PostgreSQL cluster. 0-256 characters long. || +|| labels | **string** + +Custom labels for the PostgreSQL cluster as `` key:value `` pairs. +Maximum 64 per resource. || +|| environment | **enum** (Environment) + +Deployment environment of the PostgreSQL cluster. + +- `ENVIRONMENT_UNSPECIFIED` +- `PRODUCTION`: Stable environment with a conservative update policy: +only hotfixes are applied during regular maintenance. +- `PRESTABLE`: Environment with more aggressive update policy: new versions +are rolled out irrespective of backward compatibility. || +|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** + +Description of monitoring systems relevant to the PostgreSQL cluster. || +|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** + +Configuration of the PostgreSQL cluster. || +|| networkId | **string** + +ID of the network that the cluster belongs to. || +|| health | **enum** (Health) + +Aggregated cluster health. + +- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). +- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). +- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). +- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || +|| status | **enum** (Status) + +Current state of the cluster. + +- `STATUS_UNKNOWN`: Cluster state is unknown. +- `CREATING`: Cluster is being created. +- `RUNNING`: Cluster is running normally. +- `ERROR`: Cluster encountered a problem and cannot operate. +- `UPDATING`: Cluster is being updated. +- `STOPPING`: Cluster is stopping. +- `STOPPED`: Cluster stopped. +- `STARTING`: Cluster is starting. || +|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** + +Maintenance window for the cluster. || +|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** + +Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || +|| securityGroupIds[] | **string** + +User security groups || +|| deletionProtection | **boolean** + +Deletion Protection inhibits deletion of the cluster || +|| hostGroupIds[] | **string** + +Host groups hosting VMs of the cluster. || +|# + +## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} + +Monitoring system. + +#| +||Field | Description || +|| name | **string** + +Name of the monitoring system. || +|| description | **string** + +Description of the monitoring system. || +|| link | **string** + +Link to the monitoring system charts for the PostgreSQL cluster. || +|# + +## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} + +#| +||Field | Description || +|| version | **string** + +Version of PostgreSQL server software. || +|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** + +Configuration of a PostgreSQL 9.6 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** + +Configuration of a PostgreSQL 10 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** + +Configuration of a PostgreSQL 10 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** + +Configuration of a PostgreSQL 11 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** + +Configuration of a PostgreSQL 11 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** + +Configuration of a PostgreSQL 12 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** + +Configuration of a PostgreSQL 12 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** + +Configuration of a PostgreSQL 13 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** + +Configuration of a PostgreSQL 13 1C server. -#| -||Field | Description || -|| id | **string** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -ID of the operation. || -|| description | **string** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** -Description of the operation. 0-256 characters long. || -|| createdAt | **string** (date-time) +Configuration of a PostgreSQL 14 server. -Creation timestamp. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| createdBy | **string** +Configuration of a PostgreSQL 14 1C server. -ID of the user or service account who initiated the operation. || -|| modifiedAt | **string** (date-time) +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The time when the Operation resource was last modified. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Configuration of a PostgreSQL 15 server. -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| done | **boolean** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -If the value is `false`, it means the operation is still in progress. -If `true`, the operation is completed, and either `error` or `response` is available. || -|| metadata | **[BackupClusterMetadata](#yandex.cloud.mdb.postgresql.v1.BackupClusterMetadata)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** -Service-specific metadata associated with the operation. -It typically contains the ID of the target resource that the operation is performed on. -Any method that returns a long-running operation should document the metadata type, if any. || -|| error | **[Status](#google.rpc.Status)** +Configuration of a PostgreSQL 15 1C server. -The error result of the operation in case of failure or cancellation. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Includes only one of the fields `error`, `response`. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || -|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** +Configuration of a PostgreSQL 16 server. -The normal response of the operation in case of success. -If the original method returns no data on success, such as Delete, -the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). -If the original method is the standard Create/Update, -the response should be the target resource of the operation. -Any method that returns a long-running operation should document the response type, if any. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Includes only one of the fields `error`, `response`. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || +Configuration of a PostgreSQL 16 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfigSet17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfigSet17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** + +Configuration of the connection pooler. || +|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** + +Resources allocated to PostgreSQL hosts. || +|| autofailover | **boolean** + +Configuration setting which enables/disables autofailover in cluster. || +|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** + +Time to start the daily backup, in the UTC timezone. || +|| backupRetainPeriodDays | **string** (int64) + +Retention policy of automated backups. || +|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** + +Access policy to DB || +|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** + +Configuration of the performance diagnostics service. || +|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** + +Disk size autoscaling || |# -## BackupClusterMetadata {#yandex.cloud.mdb.postgresql.v1.BackupClusterMetadata} +## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} #| ||Field | Description || -|| clusterId | **string** +|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -ID of the PostgreSQL cluster that is being backed up. || -|| backupId | **string** +Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -ID of the PostgreSQL backup that is being created. || +User-defined settings for a PostgreSQL 9.6 cluster. || +|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** + +Default configuration for a PostgreSQL 9.6 cluster. || |# -## Status {#google.rpc.Status} +## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} -The error result of the operation in case of failure or cancellation. +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). #| ||Field | Description || -|| code | **integer** (int32) +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || -|| message | **string** +in bytes. || +|| tempBuffers | **string** (int64) -An error message. || -|| details[] | **object** +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -A list of messages that carry the error details. || -|# +in bytes. || +|| maintenanceWorkMem | **string** (int64) -## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -A PostgreSQL Cluster resource. For more information, see -the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. +in bytes. || +|| tempFileLimit | **string** (int64) -#| -||Field | Description || -|| id | **string** +in bytes. || +|| vacuumCostDelay | **string** (int64) -ID of the PostgreSQL cluster. -This ID is assigned by MDB at creation time. || -|| folderId | **string** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -ID of the folder that the PostgreSQL cluster belongs to. || -|| createdAt | **string** (date-time) +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. +in bytes || +|| backendFlushAfter | **string** (int64) -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| name | **string** +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Name of the PostgreSQL cluster. -The name is unique within the folder. 1-63 characters long. || -|| description | **string** +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) + +Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Description of the PostgreSQL cluster. 0-256 characters long. || -|| labels | **string** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Custom labels for the PostgreSQL cluster as `` key:value `` pairs. -Maximum 64 per resource. || -|| environment | **enum** (Environment) +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Deployment environment of the PostgreSQL cluster. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -- `ENVIRONMENT_UNSPECIFIED` -- `PRODUCTION`: Stable environment with a conservative update policy: -only hotfixes are applied during regular maintenance. -- `PRESTABLE`: Environment with more aggressive update policy: new versions -are rolled out irrespective of backward compatibility. || -|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Description of monitoring systems relevant to the PostgreSQL cluster. || -|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Configuration of the PostgreSQL cluster. || -|| networkId | **string** +in milliseconds. || +|| lockTimeout | **string** (int64) -ID of the network that the cluster belongs to. || -|| health | **enum** (Health) +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Aggregated cluster health. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). -- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). -- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). -- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || -|| status | **enum** (Status) +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Current state of the cluster. +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -- `STATUS_UNKNOWN`: Cluster state is unknown. -- `CREATING`: Cluster is being created. -- `RUNNING`: Cluster is running normally. -- `ERROR`: Cluster encountered a problem and cannot operate. -- `UPDATING`: Cluster is being updated. -- `STOPPING`: Cluster is stopping. -- `STOPPED`: Cluster stopped. -- `STARTING`: Cluster is starting. || -|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Maintenance window for the cluster. || -|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** +in bytes. || +|| deadlockTimeout | **string** (int64) -Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || -|| securityGroupIds[] | **string** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -User security groups || -|| deletionProtection | **boolean** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| sqlInheritance | **boolean** -Deletion Protection inhibits deletion of the cluster || -|| hostGroupIds[] | **string** +This option has been removed in PostgreSQL 10. || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Host groups hosting VMs of the cluster. || -|# +in milliseconds. || +|| archiveTimeout | **string** (int64) -## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# -Monitoring system. +## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} #| ||Field | Description || -|| name | **string** +|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Name of the monitoring system. || -|| description | **string** +Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Description of the monitoring system. || -|| link | **string** +User-defined settings for a PostgreSQL 10 1C cluster. || +|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Link to the monitoring system charts for the PostgreSQL cluster. || +Default configuration for a PostgreSQL 10 1C cluster. || |# -## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} +## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || -|| version | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Version of PostgreSQL server software. || -|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** +in bytes. || +|| tempBuffers | **string** (int64) -Configuration of a PostgreSQL 9.6 server. +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -Configuration of a PostgreSQL 10 1C server. +in bytes. || +|| tempFileLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| vacuumCostDelay | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Configuration of a PostgreSQL 10 server. +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes || +|| backendFlushAfter | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -Configuration of a PostgreSQL 11 server. +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -Configuration of a PostgreSQL 11 1C server. +in bytes || +|| maxWalSize | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| minWalSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) -Configuration of a PostgreSQL 12 server. +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Configuration of a PostgreSQL 12 1C server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Configuration of a PostgreSQL 13 server. +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Configuration of a PostgreSQL 13 1C server. +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| lockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Configuration of a PostgreSQL 14 server. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -Configuration of a PostgreSQL 14 1C server. +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| deadlockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -Configuration of a PostgreSQL 15 server. +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| archiveTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -Configuration of a PostgreSQL 15 1C server. +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) -Configuration of a PostgreSQL 16 server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| onlineAnalyzeEnable | **boolean** || +|| plantunerFixEmptyTable | **boolean** || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| geqo | **boolean** -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -Configuration of a PostgreSQL 16 1C server. +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) -Configuration of the connection pooler. || -|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) -Resources allocated to PostgreSQL hosts. || -|| autofailover | **boolean** +selective pressure within the population || +|| geqoSeed | **number** (double) -Configuration setting which enables/disables autofailover in cluster. || -|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) -Time to start the daily backup, in the UTC timezone. || -|| backupRetainPeriodDays | **string** (int64) +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) -Retention policy of automated backups. || -|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -Access policy to DB || -|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -Configuration of the performance diagnostics service. || -|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. -Disk size autoscaling || +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} +## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** - -User-defined settings for a PostgreSQL 9.6 cluster. || -|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Default configuration for a PostgreSQL 9.6 cluster. || +User-defined settings for a PostgreSQL 10 cluster. || +|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** + +Default configuration for a PostgreSQL 10 cluster. || |# -## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} +## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -7299,9 +8940,7 @@ in bytes || || checkpointTimeout | **string** (int64) in milliseconds. || -|| checkpointCompletionTarget | **number** (double) - -Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointCompletionTarget | **number** (double) || || checkpointFlushAfter | **string** (int64) in bytes || @@ -7454,9 +9093,6 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** - -This option has been removed in PostgreSQL 10. || || autovacuumMaxWorkers | **string** (int64) || || autovacuumVacuumCostDelay | **string** (int64) || || autovacuumVacuumCostLimit | **string** (int64) || @@ -7467,31 +9103,139 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) + +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} +## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -User-defined settings for a PostgreSQL 10 1C cluster. || -|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +User-defined settings for a PostgreSQL 11 cluster. || +|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Default configuration for a PostgreSQL 10 1C cluster. || +Default configuration for a PostgreSQL 11 cluster. || |# -## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} +## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7509,7 +9253,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -7732,6 +9475,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -7778,8 +9530,6 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || -|| onlineAnalyzeEnable | **boolean** || -|| plantunerFixEmptyTable | **boolean** || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -7809,6 +9559,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -7828,27 +9581,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} +## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -User-defined settings for a PostgreSQL 10 cluster. || -|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +User-defined settings for a PostgreSQL 11 1C cluster. || +|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Default configuration for a PostgreSQL 10 cluster. || +Default configuration for a PostgreSQL 11 1C cluster. || |# -## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} +## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7866,7 +9619,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -8071,6 +9823,7 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || || enableBitmapscan | **boolean** || || enableHashagg | **boolean** || || enableHashjoin | **boolean** || @@ -8089,6 +9842,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8140,6 +9902,7 @@ in milliseconds. || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || || maxStackDepth | **string** (int64) in bytes. || @@ -8164,6 +9927,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -8183,23 +9949,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} +## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Effective settings for a PostgreSQL 11 cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -User-defined settings for a PostgreSQL 11 cluster. || -|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +User-defined settings for a PostgreSQL 12 cluster. || +|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Default configuration for a PostgreSQL 11 cluster. || +Default configuration for a PostgreSQL 12 cluster. || |# -## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} +## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8452,6 +10218,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8549,23 +10322,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} +## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -User-defined settings for a PostgreSQL 11 1C cluster. || -|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +User-defined settings for a PostgreSQL 12 1C cluster. || +|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Default configuration for a PostgreSQL 11 1C cluster. || +Default configuration for a PostgreSQL 12 1C cluster. || |# -## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} +## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8819,6 +10592,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8917,23 +10697,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} +## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Effective settings for a PostgreSQL 12 cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -User-defined settings for a PostgreSQL 12 cluster. || -|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +User-defined settings for a PostgreSQL 13 cluster. || +|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Default configuration for a PostgreSQL 12 cluster. || +Default configuration for a PostgreSQL 13 cluster. || |# -## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} +## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9239,6 +11019,30 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -9290,23 +11094,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} +## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -User-defined settings for a PostgreSQL 12 1C cluster. || -|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +User-defined settings for a PostgreSQL 13 1C cluster. || +|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Default configuration for a PostgreSQL 12 1C cluster. || +Default configuration for a PostgreSQL 13 1C cluster. || |# -## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} +## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9613,15 +11417,36 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || -|| maxStackDepth | **string** (int64) - -in bytes. || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -9665,23 +11490,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} +## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Effective settings for a PostgreSQL 13 cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -User-defined settings for a PostgreSQL 13 cluster. || -|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +User-defined settings for a PostgreSQL 14 cluster. || +|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Default configuration for a PostgreSQL 13 cluster. || +Default configuration for a PostgreSQL 14 cluster. || |# -## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} +## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9889,7 +11714,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -9933,7 +11757,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10011,6 +11834,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10062,23 +11900,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} +## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -User-defined settings for a PostgreSQL 13 1C cluster. || -|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +User-defined settings for a PostgreSQL 14 1C cluster. || +|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Default configuration for a PostgreSQL 13 1C cluster. || +Default configuration for a PostgreSQL 14 1C cluster. || |# -## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} +## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10286,7 +12124,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -10331,7 +12168,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10409,6 +12245,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10458,23 +12309,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} +## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Effective settings for a PostgreSQL 14 cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -User-defined settings for a PostgreSQL 14 cluster. || -|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +User-defined settings for a PostgreSQL 15 cluster. || +|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Default configuration for a PostgreSQL 14 cluster. || +Default configuration for a PostgreSQL 15 cluster. || |# -## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} +## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10744,7 +12595,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -10825,6 +12677,7 @@ in milliseconds. || || maxStackDepth | **string** (int64) in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -10868,23 +12721,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} +## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -User-defined settings for a PostgreSQL 14 1C cluster. || -|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +User-defined settings for a PostgreSQL 15 1C cluster. || +|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Default configuration for a PostgreSQL 14 1C cluster. || +Default configuration for a PostgreSQL 15 1C cluster. || |# -## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} +## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11155,7 +13008,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -11234,6 +13088,10 @@ in milliseconds. || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -11277,23 +13135,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} +## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Effective settings for a PostgreSQL 15 cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -User-defined settings for a PostgreSQL 15 cluster. || -|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +User-defined settings for a PostgreSQL 16 cluster. || +|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Default configuration for a PostgreSQL 15 cluster. || +Default configuration for a PostgreSQL 16 cluster. || |# -## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} +## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11379,12 +13237,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11393,6 +13251,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11407,6 +13266,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11421,6 +13281,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11592,6 +13453,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11689,23 +13551,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} +## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -User-defined settings for a PostgreSQL 15 1C cluster. || -|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +User-defined settings for a PostgreSQL 16 1C cluster. || +|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Default configuration for a PostgreSQL 15 1C cluster. || +Default configuration for a PostgreSQL 16 1C cluster. || |# -## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} +## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11791,12 +13653,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11805,6 +13667,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11819,6 +13682,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11833,6 +13697,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12005,6 +13870,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12103,27 +13969,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} +## PostgresqlConfigSet17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| effectiveConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Effective settings for a PostgreSQL 16 cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| userConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -User-defined settings for a PostgreSQL 16 cluster. || -|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Default configuration for a PostgreSQL 16 cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12165,7 +14031,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12517,29 +14382,42 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# -## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} +## PostgresqlConfigSet17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| effectiveConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| userConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -User-defined settings for a PostgreSQL 16 1C cluster. || -|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Default configuration for a PostgreSQL 16 1C cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12581,7 +14459,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12935,6 +14812,19 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# ## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig} diff --git a/en/managed-postgresql/api-ref/Cluster/create.md b/en/managed-postgresql/api-ref/Cluster/create.md index ae91fe2b3e3..01f39795a39 100644 --- a/en/managed-postgresql/api-ref/Cluster/create.md +++ b/en/managed-postgresql/api-ref/Cluster/create.md @@ -24,7 +24,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "environment": "string", "configSpec": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "maxConnections": "string", "sharedBuffers": "string", @@ -2264,162 +2264,570 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "logAutovacuumMinDuration": "string", "passwordEncryption": "string" }, - // end of the list of possible fields - "poolerConfig": { - "poolingMode": "string", - "poolDiscard": "boolean" - }, - "resources": { - "resourcePresetId": "string", - "diskSize": "string", - "diskTypeId": "string" - }, - "autofailover": "boolean", - "backupWindowStart": { - "hours": "integer", - "minutes": "integer", - "seconds": "integer", - "nanos": "integer" - }, - "backupRetainPeriodDays": "string", - "access": { - "dataLens": "boolean", - "webSql": "boolean", - "serverless": "boolean", - "dataTransfer": "boolean", - "yandexQuery": "boolean" - }, - "performanceDiagnostics": { - "enabled": "boolean", - "sessionsSamplingInterval": "string", - "statementsSamplingInterval": "string" - }, - "diskSizeAutoscaling": { - "plannedUsageThreshold": "string", - "emergencyUsageThreshold": "string", - "diskSizeLimit": "string" - } - }, - "databaseSpecs": [ - { - "name": "string", - "owner": "string", - "lcCollate": "string", - "lcCtype": "string", - "extensions": [ - { - "name": "string", - "version": "string" - } - ], - "templateDb": "string", - "deletionProtection": "boolean" - } - ], - "userSpecs": [ - { - "name": "string", - "password": "string", - "permissions": [ - { - "databaseName": "string" - } - ], - "connLimit": "string", - "settings": { - "defaultTransactionIsolation": "string", - "lockTimeout": "string", - "logMinDurationStatement": "string", - "synchronousCommit": "string", - "tempFileLimit": "string", - "logStatement": "string", - "poolMode": "string", - "preparedStatementsPooling": "boolean", - "catchupTimeout": "string", - "walSenderTimeout": "string", - "idleInTransactionSessionTimeout": "string", - "statementTimeout": "string", - "pgaudit": { - "log": [ - "string" - ] - } - }, - "login": "boolean", - "grants": [ + "postgresqlConfig_17": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ "string" ], - "deletionProtection": "boolean", - "userPasswordEncryption": "string" - } - ], - "hostSpecs": [ - { - "zoneId": "string", - "subnetId": "string", - "assignPublicIp": "boolean", - "replicationSource": "string", - "priority": "string", - "configSpec": { - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` - "postgresqlConfig_9_6": { - "recoveryMinApplyDelay": "string", - "sharedBuffers": "string", - "tempBuffers": "string", - "workMem": "string", - "replacementSortTuples": "string", - "tempFileLimit": "string", - "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", - "maxStandbyStreamingDelay": "string", - "constraintExclusion": "string", - "cursorTupleFraction": "number", - "fromCollapseLimit": "string", - "joinCollapseLimit": "string", - "forceParallelMode": "string", - "clientMinMessages": "string", - "logMinMessages": "string", - "logMinErrorStatement": "string", - "logMinDurationStatement": "string", - "logCheckpoints": "boolean", - "logConnections": "boolean", - "logDisconnections": "boolean", - "logDuration": "boolean", - "logErrorVerbosity": "string", - "logLockWaits": "boolean", - "logStatement": "string", - "logTempFiles": "string", - "searchPath": "string", - "rowSecurity": "boolean", - "defaultTransactionIsolation": "string", - "statementTimeout": "string", - "lockTimeout": "string", - "idleInTransactionSessionTimeout": "string", - "byteaOutput": "string", - "xmlbinary": "string", - "xmloption": "string", - "ginPendingListLimit": "string", - "deadlockTimeout": "string", - "maxLocksPerTransaction": "string", - "maxPredLocksPerTransaction": "string", - "arrayNulls": "boolean", - "backslashQuote": "string", - "defaultWithOids": "boolean", - "escapeStringWarning": "boolean", - "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", - "quoteAllIdentifiers": "boolean", - "standardConformingStrings": "boolean", - "synchronizeSeqscans": "boolean", - "transformNullEquals": "boolean", - "exitOnError": "boolean", - "seqPageCost": "number", - "randomPageCost": "number", - "sqlInheritance": "boolean", - "effectiveIoConcurrency": "string", + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "postgresqlConfig_17_1c": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + // end of the list of possible fields + "poolerConfig": { + "poolingMode": "string", + "poolDiscard": "boolean" + }, + "resources": { + "resourcePresetId": "string", + "diskSize": "string", + "diskTypeId": "string" + }, + "autofailover": "boolean", + "backupWindowStart": { + "hours": "integer", + "minutes": "integer", + "seconds": "integer", + "nanos": "integer" + }, + "backupRetainPeriodDays": "string", + "access": { + "dataLens": "boolean", + "webSql": "boolean", + "serverless": "boolean", + "dataTransfer": "boolean", + "yandexQuery": "boolean" + }, + "performanceDiagnostics": { + "enabled": "boolean", + "sessionsSamplingInterval": "string", + "statementsSamplingInterval": "string" + }, + "diskSizeAutoscaling": { + "plannedUsageThreshold": "string", + "emergencyUsageThreshold": "string", + "diskSizeLimit": "string" + } + }, + "databaseSpecs": [ + { + "name": "string", + "owner": "string", + "lcCollate": "string", + "lcCtype": "string", + "extensions": [ + { + "name": "string", + "version": "string" + } + ], + "templateDb": "string", + "deletionProtection": "boolean" + } + ], + "userSpecs": [ + { + "name": "string", + "password": "string", + "permissions": [ + { + "databaseName": "string" + } + ], + "connLimit": "string", + "settings": { + "defaultTransactionIsolation": "string", + "lockTimeout": "string", + "logMinDurationStatement": "string", + "synchronousCommit": "string", + "tempFileLimit": "string", + "logStatement": "string", + "poolMode": "string", + "preparedStatementsPooling": "boolean", + "catchupTimeout": "string", + "walSenderTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "statementTimeout": "string", + "pgaudit": { + "log": [ + "string" + ] + } + }, + "login": "boolean", + "grants": [ + "string" + ], + "deletionProtection": "boolean", + "userPasswordEncryption": "string" + } + ], + "hostSpecs": [ + { + "zoneId": "string", + "subnetId": "string", + "assignPublicIp": "boolean", + "replicationSource": "string", + "priority": "string", + "configSpec": { + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` + "postgresqlConfig_9_6": { + "recoveryMinApplyDelay": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "workMem": "string", + "replacementSortTuples": "string", + "tempFileLimit": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "maxStandbyStreamingDelay": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "sqlInheritance": "boolean", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + }, + "postgresqlConfig_10_1c": { + "recoveryMinApplyDelay": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "workMem": "string", + "replacementSortTuples": "string", + "tempFileLimit": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "maxStandbyStreamingDelay": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "timezone": "string", + "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_10_1c": { + "postgresqlConfig_10": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2489,12 +2897,11 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_10": { + "postgresqlConfig_11": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", "workMem": "string", - "replacementSortTuples": "string", "tempFileLimit": "string", "backendFlushAfter": "string", "oldSnapshotThreshold": "string", @@ -2559,7 +2966,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_11": { + "postgresqlConfig_11_1c": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2628,7 +3035,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_11_1c": { + "postgresqlConfig_12": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2697,7 +3104,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_12": { + "postgresqlConfig_12_1c": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2766,7 +3173,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_12_1c": { + "postgresqlConfig_13": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2835,7 +3242,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_13": { + "postgresqlConfig_13_1c": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2904,7 +3311,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_13_1c": { + "postgresqlConfig_14": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2948,7 +3355,6 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -2973,7 +3379,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_14": { + "postgresqlConfig_14_1c": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -3041,7 +3447,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_14_1c": { + "postgresqlConfig_15": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -3109,7 +3515,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_15": { + "postgresqlConfig_15_1c": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -3177,7 +3583,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_15_1c": { + "postgresqlConfig_16": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -3190,7 +3596,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -3245,7 +3651,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_16": { + "postgresqlConfig_16_1c": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -3313,14 +3719,80 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_16_1c": { + "postgresqlConfig_17": { + "recoveryMinApplyDelay": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "workMem": "string", + "tempFileLimit": "string", + "backendFlushAfter": "string", + "maxStandbyStreamingDelay": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + }, + "postgresqlConfig_17_1c": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", "workMem": "string", "tempFileLimit": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "maxStandbyStreamingDelay": "string", "constraintExclusion": "string", "cursorTupleFraction": "number", @@ -3398,198 +3870,789 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters #| ||Field | Description || -|| folderId | **string** +|| folderId | **string** + +Required field. ID of the folder to create the PostgreSQL cluster in. || +|| name | **string** + +Required field. Name of the PostgreSQL cluster. The name must be unique within the folder. || +|| description | **string** + +Description of the PostgreSQL cluster. || +|| labels | **string** + +Custom labels for the PostgreSQL cluster as `` key:value `` pairs. Maximum 64 per resource. +For example, "project": "mvp" or "source": "dictionary". || +|| environment | **enum** (Environment) + +Required field. Deployment environment of the PostgreSQL cluster. + +- `ENVIRONMENT_UNSPECIFIED` +- `PRODUCTION`: Stable environment with a conservative update policy: +only hotfixes are applied during regular maintenance. +- `PRESTABLE`: Environment with more aggressive update policy: new versions +are rolled out irrespective of backward compatibility. || +|| configSpec | **[ConfigSpec](#yandex.cloud.mdb.postgresql.v1.ConfigSpec)** + +Required field. Configuration and resources for hosts that should be created for the PostgreSQL cluster. || +|| databaseSpecs[] | **[DatabaseSpec](#yandex.cloud.mdb.postgresql.v1.DatabaseSpec)** + +Required field. Descriptions of databases to be created in the PostgreSQL cluster. || +|| userSpecs[] | **[UserSpec](#yandex.cloud.mdb.postgresql.v1.UserSpec)** + +Required field. Descriptions of database users to be created in the PostgreSQL cluster. || +|| hostSpecs[] | **[HostSpec](#yandex.cloud.mdb.postgresql.v1.HostSpec)** + +Required field. Individual configurations for hosts that should be created for the PostgreSQL cluster. || +|| networkId | **string** + +Required field. ID of the network to create the cluster in. || +|| securityGroupIds[] | **string** + +User security groups || +|| deletionProtection | **boolean** + +Deletion Protection inhibits deletion of the cluster || +|| hostGroupIds[] | **string** + +Host groups hosting VMs of the cluster. || +|# + +## ConfigSpec {#yandex.cloud.mdb.postgresql.v1.ConfigSpec} + +#| +||Field | Description || +|| version | **string** + +Version of PostgreSQL used in the cluster. +Possible values: `9.6`, `10`, `10_1c`, `11`, `12`, `13`, `14`, `15`, `16`, `17` || +|| postgresqlConfig_9_6 | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** + +Configuration for a PostgreSQL 9.6 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_10_1c | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** + +Configuration for a PostgreSQL 10 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_10 | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** + +Configuration for a PostgreSQL 10 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_11 | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** + +Configuration for a PostgreSQL 11 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_11_1c | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** + +Configuration for a PostgreSQL 11 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_12 | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** + +Configuration for a PostgreSQL 12 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_12_1c | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** + +Configuration for a PostgreSQL 12 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_13 | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** + +Configuration for a PostgreSQL 13 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_13_1c | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** + +Configuration for a PostgreSQL 13 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_14 | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** + +Configuration for a PostgreSQL 14 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_14_1c | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** + +Configuration for a PostgreSQL 14 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_15 | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** + +Configuration for a PostgreSQL 15 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_15_1c | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** + +Configuration for a PostgreSQL 15 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_16 | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** + +Configuration for a PostgreSQL 16 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_16_1c | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** + +Configuration for a PostgreSQL 16 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** + +Configuration for a PostgreSQL 17 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** + +Configuration for a PostgreSQL 17 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** + +Configuration of the connection pooler. || +|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** + +Resources allocated to PostgreSQL hosts. || +|| autofailover | **boolean** + +Configuration setting which enables/disables autofailover in cluster. || +|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** + +Time to start the daily backup, in the UTC timezone. || +|| backupRetainPeriodDays | **string** (int64) + +Retention policy of automated backups. || +|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** + +Access policy to DB || +|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** + +Configuration of the performance diagnostics service. || +|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** + +Disk size autoscaling || +|# + +## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). + +#| +||Field | Description || +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Required field. ID of the folder to create the PostgreSQL cluster in. || -|| name | **string** +in bytes. || +|| tempBuffers | **string** (int64) -Required field. Name of the PostgreSQL cluster. The name must be unique within the folder. || -|| description | **string** +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Description of the PostgreSQL cluster. || -|| labels | **string** +in bytes. || +|| maintenanceWorkMem | **string** (int64) -Custom labels for the PostgreSQL cluster as `` key:value `` pairs. Maximum 64 per resource. -For example, "project": "mvp" or "source": "dictionary". || -|| environment | **enum** (Environment) +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -Required field. Deployment environment of the PostgreSQL cluster. +in bytes. || +|| tempFileLimit | **string** (int64) -- `ENVIRONMENT_UNSPECIFIED` -- `PRODUCTION`: Stable environment with a conservative update policy: -only hotfixes are applied during regular maintenance. -- `PRESTABLE`: Environment with more aggressive update policy: new versions -are rolled out irrespective of backward compatibility. || -|| configSpec | **[ConfigSpec](#yandex.cloud.mdb.postgresql.v1.ConfigSpec)** +in bytes. || +|| vacuumCostDelay | **string** (int64) -Required field. Configuration and resources for hosts that should be created for the PostgreSQL cluster. || -|| databaseSpecs[] | **[DatabaseSpec](#yandex.cloud.mdb.postgresql.v1.DatabaseSpec)** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Required field. Descriptions of databases to be created in the PostgreSQL cluster. || -|| userSpecs[] | **[UserSpec](#yandex.cloud.mdb.postgresql.v1.UserSpec)** +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Required field. Descriptions of database users to be created in the PostgreSQL cluster. || -|| hostSpecs[] | **[HostSpec](#yandex.cloud.mdb.postgresql.v1.HostSpec)** +in bytes || +|| backendFlushAfter | **string** (int64) -Required field. Individual configurations for hosts that should be created for the PostgreSQL cluster. || -|| networkId | **string** +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) + +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) + +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) + +Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) -Required field. ID of the network to create the cluster in. || -|| securityGroupIds[] | **string** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -User security groups || -|| deletionProtection | **boolean** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| sqlInheritance | **boolean** -Deletion Protection inhibits deletion of the cluster || -|| hostGroupIds[] | **string** +This option has been removed in PostgreSQL 10. || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Host groups hosting VMs of the cluster. || +in milliseconds. || +|| archiveTimeout | **string** (int64) + +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || |# -## ConfigSpec {#yandex.cloud.mdb.postgresql.v1.ConfigSpec} +## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || -|| version | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Version of PostgreSQL used in the cluster. -Possible values: `9.6`, `10`, `10_1c`, `11`, `12`, `13`, `14`, `15` || -|| postgresqlConfig_9_6 | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +in bytes. || +|| tempBuffers | **string** (int64) -Configuration for a PostgreSQL 9.6 cluster. +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_10_1c | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -Configuration for a PostgreSQL 10 1C cluster. +in bytes. || +|| tempFileLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| vacuumCostDelay | **string** (int64) -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_10 | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Configuration for a PostgreSQL 10 cluster. +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes || +|| backendFlushAfter | **string** (int64) -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_11 | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -Configuration for a PostgreSQL 11 cluster. +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_11_1c | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -Configuration for a PostgreSQL 11 1C cluster. +in bytes || +|| maxWalSize | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| minWalSize | **string** (int64) -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_12 | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) -Configuration for a PostgreSQL 12 cluster. +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_12_1c | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Configuration for a PostgreSQL 12 1C cluster. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_13 | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Configuration for a PostgreSQL 13 cluster. +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_13_1c | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Configuration for a PostgreSQL 13 1C cluster. +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| lockTimeout | **string** (int64) -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_14 | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Configuration for a PostgreSQL 14 cluster. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_14_1c | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -Configuration for a PostgreSQL 14 1C cluster. +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| deadlockTimeout | **string** (int64) -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_15 | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -Configuration for a PostgreSQL 15 cluster. +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| archiveTimeout | **string** (int64) -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_15_1c | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -Configuration for a PostgreSQL 15 1C cluster. +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_16 | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) -Configuration for a PostgreSQL 16 cluster. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| onlineAnalyzeEnable | **boolean** || +|| plantunerFixEmptyTable | **boolean** || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| geqo | **boolean** -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_16_1c | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -Configuration for a PostgreSQL 16 1C cluster. +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) -Configuration of a PostgreSQL cluster. || -|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) -Configuration of the connection pooler. || -|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) -Resources allocated to PostgreSQL hosts. || -|| autofailover | **boolean** +selective pressure within the population || +|| geqoSeed | **number** (double) -Configuration setting which enables/disables autofailover in cluster. || -|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) -Time to start the daily backup, in the UTC timezone. || -|| backupRetainPeriodDays | **string** (int64) +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) -Retention policy of automated backups. || -|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -Access policy to DB || -|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -Configuration of the performance diagnostics service. || -|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. -Disk size autoscaling || +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} +## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -3649,9 +4712,7 @@ in bytes || || checkpointTimeout | **string** (int64) in milliseconds. || -|| checkpointCompletionTarget | **number** (double) - -Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointCompletionTarget | **number** (double) || || checkpointFlushAfter | **string** (int64) in bytes || @@ -3748,84 +4809,189 @@ in milliseconds. || || rowSecurity | **boolean** || || defaultTransactionIsolation | **enum** (TransactionIsolation) -- `TRANSACTION_ISOLATION_UNSPECIFIED` -- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` -- `TRANSACTION_ISOLATION_READ_COMMITTED` -- `TRANSACTION_ISOLATION_REPEATABLE_READ` -- `TRANSACTION_ISOLATION_SERIALIZABLE` || -|| statementTimeout | **string** (int64) +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) + +in milliseconds. || +|| archiveTimeout | **string** (int64) + +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) -in milliseconds. || -|| lockTimeout | **string** (int64) +in bytes. || +|| geqo | **boolean** -in milliseconds. || -|| idleInTransactionSessionTimeout | **string** (int64) +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -in milliseconds. || -|| byteaOutput | **enum** (ByteaOutput) +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -- `BYTEA_OUTPUT_UNSPECIFIED` -- `BYTEA_OUTPUT_HEX` -- `BYTEA_OUTPUT_ESCAPED` || -|| xmlbinary | **enum** (XmlBinary) +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) -- `XML_BINARY_UNSPECIFIED` -- `XML_BINARY_BASE64` -- `XML_BINARY_HEX` || -|| xmloption | **enum** (XmlOption) +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) -- `XML_OPTION_UNSPECIFIED` -- `XML_OPTION_DOCUMENT` -- `XML_OPTION_CONTENT` || -|| ginPendingListLimit | **string** (int64) +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) -in bytes. || -|| deadlockTimeout | **string** (int64) +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) in milliseconds. || -|| maxLocksPerTransaction | **string** (int64) || -|| maxPredLocksPerTransaction | **string** (int64) || -|| arrayNulls | **boolean** || -|| backslashQuote | **enum** (BackslashQuote) +|| sessionDurationTimeout | **string** (int64) -- `BACKSLASH_QUOTE_UNSPECIFIED` -- `BACKSLASH_QUOTE` -- `BACKSLASH_QUOTE_ON` -- `BACKSLASH_QUOTE_OFF` -- `BACKSLASH_QUOTE_SAFE_ENCODING` || -|| defaultWithOids | **boolean** || -|| escapeStringWarning | **boolean** || -|| loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || -|| quoteAllIdentifiers | **boolean** || -|| standardConformingStrings | **boolean** || -|| synchronizeSeqscans | **boolean** || -|| transformNullEquals | **boolean** || -|| exitOnError | **boolean** || -|| seqPageCost | **number** (double) || -|| randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -This option has been removed in PostgreSQL 10. || -|| autovacuumMaxWorkers | **string** (int64) || -|| autovacuumVacuumCostDelay | **string** (int64) || -|| autovacuumVacuumCostLimit | **string** (int64) || -|| autovacuumNaptime | **string** (int64) +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -in milliseconds. || -|| archiveTimeout | **string** (int64) +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. -in milliseconds. || -|| trackActivityQuerySize | **string** (int64) || -|| effectiveIoConcurrency | **string** (int64) || -|| effectiveCacheSize | **string** (int64) || +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} +## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -3843,7 +5009,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -4066,6 +5231,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -4112,8 +5286,6 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || -|| onlineAnalyzeEnable | **boolean** || -|| plantunerFixEmptyTable | **boolean** || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -4143,6 +5315,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -4162,11 +5337,11 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} +## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -4184,7 +5359,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -4389,6 +5563,7 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || || enableBitmapscan | **boolean** || || enableHashagg | **boolean** || || enableHashjoin | **boolean** || @@ -4407,6 +5582,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -4458,6 +5642,7 @@ in milliseconds. || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || || maxStackDepth | **string** (int64) in bytes. || @@ -4482,6 +5667,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -4501,7 +5689,7 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} +## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -4754,6 +5942,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -4851,7 +6046,7 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} +## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -5105,6 +6300,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -5203,7 +6405,7 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} +## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -5509,6 +6711,30 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -5560,7 +6786,7 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} +## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -5867,15 +7093,36 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || -|| maxStackDepth | **string** (int64) - -in bytes. || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -5919,7 +7166,7 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} +## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -6127,7 +7374,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -6171,7 +7417,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -6249,6 +7494,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -6300,7 +7560,7 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} +## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -6508,7 +7768,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -6553,7 +7812,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -6631,6 +7889,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -6680,7 +7953,7 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} +## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -6950,7 +8223,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -7031,6 +8305,7 @@ in milliseconds. || || maxStackDepth | **string** (int64) in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -7074,7 +8349,7 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} +## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -7345,7 +8620,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -7424,6 +8700,10 @@ in milliseconds. || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -7467,7 +8747,7 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} +## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -7553,12 +8833,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -7567,6 +8847,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -7581,6 +8862,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -7595,6 +8877,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -7766,6 +9049,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -7863,7 +9147,7 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} +## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -7949,12 +9233,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -7963,6 +9247,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -7977,6 +9262,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -7991,6 +9277,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -8163,6 +9450,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -8261,11 +9549,11 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -8307,7 +9595,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -8659,13 +9946,26 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# -## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -8707,7 +10007,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -9061,6 +10360,19 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# ## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig} @@ -9423,151 +10735,526 @@ Defines which user queries will be written to the audit log. Corresponds to the The possible values are the following: -* PG_AUDIT_SETTINGS_LOG_READ: `SELECT` and `COPY` queries are logged if the data source is a relation or query. -* PG_AUDIT_SETTINGS_LOG_WRITE: `INSERT`, `UPDATE`, `DELETE`, `TRUNCATE`, and `COPY` queries are logged if the data target is a relation. -* PG_AUDIT_SETTINGS_LOG_FUNCTION: Function invocations and `DO` sections are logged. -* PG_AUDIT_SETTINGS_LOG_ROLE: Statements related to role and privilege management, such as `GRANT`, `REVOKE`, or `CREATE/ALTER/DROP ROLE`, are logged. -* PG_AUDIT_SETTINGS_LOG_DDL: Any `DDL` statements that do not belong to the `ROLE` class are logged. -* PG_AUDIT_SETTINGS_LOG_MISC: Miscellaneous commands, such as `DISCARD`, `FETCH`, `CHECKPOINT`, `VACUUM`, and `SET`, are logged. -* PG_AUDIT_SETTINGS_LOG_MISC_SET: Miscellaneous `SET` commands, e.g., `SET ROLE`, are logged. +* PG_AUDIT_SETTINGS_LOG_READ: `SELECT` and `COPY` queries are logged if the data source is a relation or query. +* PG_AUDIT_SETTINGS_LOG_WRITE: `INSERT`, `UPDATE`, `DELETE`, `TRUNCATE`, and `COPY` queries are logged if the data target is a relation. +* PG_AUDIT_SETTINGS_LOG_FUNCTION: Function invocations and `DO` sections are logged. +* PG_AUDIT_SETTINGS_LOG_ROLE: Statements related to role and privilege management, such as `GRANT`, `REVOKE`, or `CREATE/ALTER/DROP ROLE`, are logged. +* PG_AUDIT_SETTINGS_LOG_DDL: Any `DDL` statements that do not belong to the `ROLE` class are logged. +* PG_AUDIT_SETTINGS_LOG_MISC: Miscellaneous commands, such as `DISCARD`, `FETCH`, `CHECKPOINT`, `VACUUM`, and `SET`, are logged. +* PG_AUDIT_SETTINGS_LOG_MISC_SET: Miscellaneous `SET` commands, e.g., `SET ROLE`, are logged. + +The default value is PG_AUDIT_SETTINGS_LOG_UNSPECIFIED. In this case, the parameter is not configured. + +- `PG_AUDIT_SETTINGS_LOG_UNSPECIFIED` +- `PG_AUDIT_SETTINGS_LOG_READ` +- `PG_AUDIT_SETTINGS_LOG_WRITE` +- `PG_AUDIT_SETTINGS_LOG_FUNCTION` +- `PG_AUDIT_SETTINGS_LOG_ROLE` +- `PG_AUDIT_SETTINGS_LOG_DDL` +- `PG_AUDIT_SETTINGS_LOG_MISC` +- `PG_AUDIT_SETTINGS_LOG_MISC_SET` || +|# + +## HostSpec {#yandex.cloud.mdb.postgresql.v1.HostSpec} + +#| +||Field | Description || +|| zoneId | **string** + +ID of the availability zone where the host resides. +To get a list of available zones, use the [yandex.cloud.compute.v1.ZoneService.List](/docs/compute/api-ref/Zone/list#List) request. || +|| subnetId | **string** + +ID of the subnet that the host should belong to. This subnet should be a part +of the network that the cluster belongs to. +The ID of the network is set in the field [Cluster.networkId](#yandex.cloud.mdb.postgresql.v1.Cluster). || +|| assignPublicIp | **boolean** + +Whether the host should get a public IP address on creation. + +After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign +a public IP to a host without one, recreate the host with `assignPublicIp` set as needed. + +Possible values: +* false - don't assign a public IP to the host. +* true - the host should have a public IP address. || +|| replicationSource | **string** + +[Host.name](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) of the host to be used as the replication source (for cascading replication). || +|| priority | **string** (int64) + +Priority of the host as a replica. A higher value corresponds to higher priority. + +The host with the highest priority is the synchronous replica. All others are asynchronous. +The synchronous replica replaces the master when needed. + +When a replica becomes the master, its priority is ignored. || +|| configSpec | **[ConfigHostSpec](#yandex.cloud.mdb.postgresql.v1.ConfigHostSpec)** + +Configuration of a PostgreSQL server for the host. || +|# + +## ConfigHostSpec {#yandex.cloud.mdb.postgresql.v1.ConfigHostSpec} + +#| +||Field | Description || +|| postgresqlConfig_9_6 | **[PostgresqlHostConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6)** + +Configuration for a host with PostgreSQL 9.6 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_10_1c | **[PostgresqlHostConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C)** + +Configuration for a host with PostgreSQL 10 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_10 | **[PostgresqlHostConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10)** + +Configuration for a host with PostgreSQL 10 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_11 | **[PostgresqlHostConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11)** + +Configuration for a host with PostgreSQL 11 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_11_1c | **[PostgresqlHostConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C)** + +Configuration for a host with PostgreSQL 11 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_12 | **[PostgresqlHostConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12)** + +Configuration for a host with PostgreSQL 12 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_12_1c | **[PostgresqlHostConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C)** + +Configuration for a host with PostgreSQL 12 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_13 | **[PostgresqlHostConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13)** + +Configuration for a host with PostgreSQL 13 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_13_1c | **[PostgresqlHostConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C)** + +Configuration for a host with PostgreSQL 13 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_14 | **[PostgresqlHostConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14)** + +Configuration for a host with PostgreSQL 14 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_14_1c | **[PostgresqlHostConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C)** + +Configuration for a host with PostgreSQL 14 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_15 | **[PostgresqlHostConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15)** + +Configuration for a host with PostgreSQL 15 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_15_1c | **[PostgresqlHostConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C)** + +Configuration for a host with PostgreSQL 15 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_16 | **[PostgresqlHostConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16)** + +Configuration for a host with PostgreSQL 16 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_16_1c | **[PostgresqlHostConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C)** + +Configuration for a host with PostgreSQL 16 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17 | **[PostgresqlHostConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17_1c | **[PostgresqlHostConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|# + +## PostgresqlHostConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6} + +Options and structure of `PostgresqlHostConfig` reflects parameters of a PostgreSQL +configuration file. Detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/runtime-config.html). + +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| workMem | **string** (int64) + +in bytes. || +|| replacementSortTuples | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| oldSnapshotThreshold | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -The default value is PG_AUDIT_SETTINGS_LOG_UNSPECIFIED. In this case, the parameter is not configured. +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -- `PG_AUDIT_SETTINGS_LOG_UNSPECIFIED` -- `PG_AUDIT_SETTINGS_LOG_READ` -- `PG_AUDIT_SETTINGS_LOG_WRITE` -- `PG_AUDIT_SETTINGS_LOG_FUNCTION` -- `PG_AUDIT_SETTINGS_LOG_ROLE` -- `PG_AUDIT_SETTINGS_LOG_DDL` -- `PG_AUDIT_SETTINGS_LOG_MISC` -- `PG_AUDIT_SETTINGS_LOG_MISC_SET` || -|# +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -## HostSpec {#yandex.cloud.mdb.postgresql.v1.HostSpec} +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -#| -||Field | Description || -|| zoneId | **string** +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -ID of the availability zone where the host resides. -To get a list of available zones, use the [yandex.cloud.compute.v1.ZoneService.List](/docs/compute/api-ref/Zone/list#List) request. || -|| subnetId | **string** +in milliseconds. || +|| lockTimeout | **string** (int64) -ID of the subnet that the host should belong to. This subnet should be a part -of the network that the cluster belongs to. -The ID of the network is set in the field [Cluster.networkId](#yandex.cloud.mdb.postgresql.v1.Cluster). || -|| assignPublicIp | **boolean** +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Whether the host should get a public IP address on creation. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign -a public IP to a host without one, recreate the host with `assignPublicIp` set as needed. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Possible values: -* false - don't assign a public IP to the host. -* true - the host should have a public IP address. || -|| replicationSource | **string** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -[Host.name](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) of the host to be used as the replication source (for cascading replication). || -|| priority | **string** (int64) +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Priority of the host as a replica. A higher value corresponds to higher priority. +in bytes. || +|| deadlockTimeout | **string** (int64) -The host with the highest priority is the synchronous replica. All others are asynchronous. -The synchronous replica replaces the master when needed. +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -When a replica becomes the master, its priority is ignored. || -|| configSpec | **[ConfigHostSpec](#yandex.cloud.mdb.postgresql.v1.ConfigHostSpec)** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| sqlInheritance | **boolean** -Configuration of a PostgreSQL server for the host. || +This option has been removed in PostgreSQL 10. || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || |# -## ConfigHostSpec {#yandex.cloud.mdb.postgresql.v1.ConfigHostSpec} +## PostgresqlHostConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C} + +Options and structure of `PostgresqlHostConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || -|| postgresqlConfig_9_6 | **[PostgresqlHostConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6)** - -Configuration for a host with PostgreSQL 9.6 server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_10_1c | **[PostgresqlHostConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C)** - -Configuration for a host with PostgreSQL 10 1C server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_10 | **[PostgresqlHostConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10)** - -Configuration for a host with PostgreSQL 10 server deployed. +|| recoveryMinApplyDelay | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_11 | **[PostgresqlHostConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11)** +in milliseconds. || +|| sharedBuffers | **string** (int64) -Configuration for a host with PostgreSQL 11 server deployed. +in bytes. || +|| tempBuffers | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_11_1c | **[PostgresqlHostConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C)** +in bytes. || +|| workMem | **string** (int64) -Configuration for a host with PostgreSQL 11 1C server deployed. +in bytes. || +|| replacementSortTuples | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_12 | **[PostgresqlHostConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12)** +in bytes. || +|| tempFileLimit | **string** (int64) -Configuration for a host with PostgreSQL 12 server deployed. +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| oldSnapshotThreshold | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_12_1c | **[PostgresqlHostConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C)** +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) -Configuration for a host with PostgreSQL 12 1C server deployed. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_13 | **[PostgresqlHostConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13)** +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Configuration for a host with PostgreSQL 13 server deployed. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_13_1c | **[PostgresqlHostConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C)** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Configuration for a host with PostgreSQL 13 1C server deployed. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_14 | **[PostgresqlHostConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14)** +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Configuration for a host with PostgreSQL 14 server deployed. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_14_1c | **[PostgresqlHostConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Configuration for a host with PostgreSQL 14 1C server deployed. +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_15 | **[PostgresqlHostConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15)** +in milliseconds. || +|| lockTimeout | **string** (int64) -Configuration for a host with PostgreSQL 15 server deployed. +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_15_1c | **[PostgresqlHostConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C)** +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Configuration for a host with PostgreSQL 15 1C server deployed. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_16 | **[PostgresqlHostConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16)** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -Configuration for a host with PostgreSQL 16 server deployed. +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_16_1c | **[PostgresqlHostConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C)** +in bytes. || +|| deadlockTimeout | **string** (int64) -Configuration for a host with PostgreSQL 16 1C server deployed. +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6} +## PostgresqlHostConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10} -Options and structure of `PostgresqlHostConfig` reflects parameters of a PostgreSQL -configuration file. Detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/runtime-config.html). +Options and structure of `PostgresqlHostConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -9733,18 +11420,29 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** - -This option has been removed in PostgreSQL 10. || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C} +## PostgresqlHostConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11} -Options and structure of `PostgresqlHostConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -9759,9 +11457,6 @@ in bytes. || in bytes. || || workMem | **string** (int64) -in bytes. || -|| replacementSortTuples | **string** (int64) - in bytes. || || tempFileLimit | **string** (int64) @@ -9928,11 +11623,11 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10} +## PostgresqlHostConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C} -Options and structure of `PostgresqlHostConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -9947,9 +11642,6 @@ in bytes. || in bytes. || || workMem | **string** (int64) -in bytes. || -|| replacementSortTuples | **string** (int64) - in bytes. || || tempFileLimit | **string** (int64) @@ -10116,7 +11808,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11} +## PostgresqlHostConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10301,7 +11993,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C} +## PostgresqlHostConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10486,7 +12178,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12} +## PostgresqlHostConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10671,7 +12363,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C} +## PostgresqlHostConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10856,7 +12548,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13} +## PostgresqlHostConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11015,7 +12707,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -11041,7 +12732,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C} +## PostgresqlHostConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11200,7 +12891,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -11226,7 +12916,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14} +## PostgresqlHostConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11410,7 +13100,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C} +## PostgresqlHostConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11594,7 +13284,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15} +## PostgresqlHostConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11631,12 +13321,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11645,6 +13335,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11659,6 +13350,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11673,6 +13365,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11778,7 +13471,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C} +## PostgresqlHostConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11815,12 +13508,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11829,6 +13522,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11843,6 +13537,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11857,6 +13552,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11962,11 +13658,11 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16} +## PostgresqlHostConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -11986,7 +13682,6 @@ in bytes. || in bytes. || || backendFlushAfter | **string** (int64) || -|| oldSnapshotThreshold | **string** (int64) || || maxStandbyStreamingDelay | **string** (int64) in milliseconds. || @@ -12149,11 +13844,11 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C} +## PostgresqlHostConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12173,7 +13868,6 @@ in bytes. || in bytes. || || backendFlushAfter | **string** (int64) || -|| oldSnapshotThreshold | **string** (int64) || || maxStandbyStreamingDelay | **string** (int64) in milliseconds. || @@ -12376,7 +14070,7 @@ in milliseconds. || ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "effectiveConfig": { "maxConnections": "string", @@ -12451,15 +14145,723 @@ in milliseconds. || "exitOnError": "boolean", "seqPageCost": "number", "randomPageCost": "number", - "sqlInheritance": "boolean", + "sqlInheritance": "boolean", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "sqlInheritance": "boolean", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "sqlInheritance": "boolean", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + } + }, + "postgresqlConfig_10_1c": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "onlineAnalyzeEnable": "boolean", + "plantunerFixEmptyTable": "boolean", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "onlineAnalyzeEnable": "boolean", + "plantunerFixEmptyTable": "boolean", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "onlineAnalyzeEnable": "boolean", + "plantunerFixEmptyTable": "boolean", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" + } + }, + "postgresqlConfig_10": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", "autovacuumMaxWorkers": "string", "autovacuumVacuumCostDelay": "string", "autovacuumVacuumCostLimit": "string", "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", "effectiveIoConcurrency": "string", - "effectiveCacheSize": "string" + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" }, "userConfig": { "maxConnections": "string", @@ -12534,15 +14936,65 @@ in milliseconds. || "exitOnError": "boolean", "seqPageCost": "number", "randomPageCost": "number", - "sqlInheritance": "boolean", "autovacuumMaxWorkers": "string", "autovacuumVacuumCostDelay": "string", "autovacuumVacuumCostLimit": "string", "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", "effectiveIoConcurrency": "string", - "effectiveCacheSize": "string" + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" }, "defaultConfig": { "maxConnections": "string", @@ -12617,18 +15069,68 @@ in milliseconds. || "exitOnError": "boolean", "seqPageCost": "number", "randomPageCost": "number", - "sqlInheritance": "boolean", "autovacuumMaxWorkers": "string", "autovacuumVacuumCostDelay": "string", "autovacuumVacuumCostLimit": "string", "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", "effectiveIoConcurrency": "string", - "effectiveCacheSize": "string" + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" } }, - "postgresqlConfig_10_1c": { + "postgresqlConfig_11": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -12636,7 +15138,6 @@ in milliseconds. || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -12726,6 +15227,15 @@ in milliseconds. || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -12743,8 +15253,6 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", - "onlineAnalyzeEnable": "boolean", - "plantunerFixEmptyTable": "boolean", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -12758,6 +15266,9 @@ in milliseconds. || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -12771,7 +15282,6 @@ in milliseconds. || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -12861,6 +15371,15 @@ in milliseconds. || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -12878,8 +15397,6 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", - "onlineAnalyzeEnable": "boolean", - "plantunerFixEmptyTable": "boolean", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -12893,6 +15410,9 @@ in milliseconds. || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -12906,7 +15426,6 @@ in milliseconds. || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -12996,6 +15515,15 @@ in milliseconds. || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -13013,8 +15541,6 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", - "onlineAnalyzeEnable": "boolean", - "plantunerFixEmptyTable": "boolean", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -13028,6 +15554,9 @@ in milliseconds. || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -13035,7 +15564,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_10": { + "postgresqlConfig_11_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -13043,7 +15572,6 @@ in milliseconds. || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -13115,6 +15643,7 @@ in milliseconds. || "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", "enableBitmapscan": "boolean", "enableHashagg": "boolean", "enableHashjoin": "boolean", @@ -13133,6 +15662,15 @@ in milliseconds. || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -13155,6 +15693,7 @@ in milliseconds. || "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", @@ -13163,6 +15702,9 @@ in milliseconds. || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -13176,7 +15718,6 @@ in milliseconds. || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -13248,6 +15789,7 @@ in milliseconds. || "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", "enableBitmapscan": "boolean", "enableHashagg": "boolean", "enableHashjoin": "boolean", @@ -13266,6 +15808,15 @@ in milliseconds. || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -13288,6 +15839,7 @@ in milliseconds. || "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", @@ -13296,6 +15848,9 @@ in milliseconds. || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -13309,7 +15864,6 @@ in milliseconds. || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -13381,6 +15935,7 @@ in milliseconds. || "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", "enableBitmapscan": "boolean", "enableHashagg": "boolean", "enableHashjoin": "boolean", @@ -13399,6 +15954,15 @@ in milliseconds. || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -13421,6 +15985,7 @@ in milliseconds. || "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", @@ -13429,6 +15994,9 @@ in milliseconds. || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -13436,7 +16004,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_11": { + "postgresqlConfig_12": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -13542,6 +16110,8 @@ in milliseconds. || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -13686,6 +16256,8 @@ in milliseconds. || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -13830,6 +16402,8 @@ in milliseconds. || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -13870,7 +16444,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_11_1c": { + "postgresqlConfig_12_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -13977,6 +16551,8 @@ in milliseconds. || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -14123,6 +16699,8 @@ in milliseconds. || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -14269,6 +16847,8 @@ in milliseconds. || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -14310,7 +16890,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_12": { + "postgresqlConfig_13": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -14435,6 +17015,18 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -14581,6 +17173,18 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -14727,6 +17331,18 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -14750,7 +17366,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_12_1c": { + "postgresqlConfig_13_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -14876,13 +17492,24 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", - "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -15024,13 +17651,24 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", - "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -15172,13 +17810,24 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", - "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -15196,7 +17845,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_13": { + "postgresqlConfig_14": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -15261,7 +17910,6 @@ in milliseconds. || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -15301,7 +17949,6 @@ in milliseconds. || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -15333,6 +17980,13 @@ in milliseconds. || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -15419,7 +18073,6 @@ in milliseconds. || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -15459,7 +18112,6 @@ in milliseconds. || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -15491,6 +18143,13 @@ in milliseconds. || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -15577,7 +18236,6 @@ in milliseconds. || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -15617,7 +18275,6 @@ in milliseconds. || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -15649,6 +18306,13 @@ in milliseconds. || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -15672,7 +18336,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_13_1c": { + "postgresqlConfig_14_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -15737,7 +18401,6 @@ in milliseconds. || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -15778,7 +18441,6 @@ in milliseconds. || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -15810,6 +18472,13 @@ in milliseconds. || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -15896,7 +18565,6 @@ in milliseconds. || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -15937,7 +18605,6 @@ in milliseconds. || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -15969,6 +18636,13 @@ in milliseconds. || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -16055,7 +18729,6 @@ in milliseconds. || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -16096,7 +18769,6 @@ in milliseconds. || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -16128,6 +18800,13 @@ in milliseconds. || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -16151,7 +18830,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_14": { + "postgresqlConfig_15": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -16299,6 +18978,7 @@ in milliseconds. || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -16462,6 +19142,7 @@ in milliseconds. || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -16625,6 +19306,7 @@ in milliseconds. || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -16642,7 +19324,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_14_1c": { + "postgresqlConfig_15_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -16791,6 +19473,8 @@ in milliseconds. || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -16955,6 +19639,8 @@ in milliseconds. || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -17119,6 +19805,8 @@ in milliseconds. || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -17136,7 +19824,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_15": { + "postgresqlConfig_16": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -17170,7 +19858,7 @@ in milliseconds. || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -17334,7 +20022,7 @@ in milliseconds. || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -17498,7 +20186,7 @@ in milliseconds. || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -17630,7 +20318,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_15_1c": { + "postgresqlConfig_16_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -17664,7 +20352,7 @@ in milliseconds. || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -17830,7 +20518,7 @@ in milliseconds. || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -17996,7 +20684,7 @@ in milliseconds. || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -18130,7 +20818,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_16": { + "postgresqlConfig_17": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -18150,7 +20838,6 @@ in milliseconds. || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -18293,7 +20980,12 @@ in milliseconds. || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, "userConfig": { "maxConnections": "string", @@ -18314,7 +21006,6 @@ in milliseconds. || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -18457,7 +21148,12 @@ in milliseconds. || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, "defaultConfig": { "maxConnections": "string", @@ -18478,7 +21174,6 @@ in milliseconds. || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -18621,10 +21316,15 @@ in milliseconds. || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" } }, - "postgresqlConfig_16_1c": { + "postgresqlConfig_17_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -18644,7 +21344,6 @@ in milliseconds. || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -18789,7 +21488,12 @@ in milliseconds. || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, "userConfig": { "maxConnections": "string", @@ -18810,7 +21514,6 @@ in milliseconds. || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -18955,7 +21658,12 @@ in milliseconds. || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, "defaultConfig": { "maxConnections": "string", @@ -18976,7 +21684,6 @@ in milliseconds. || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -19121,7 +21828,12 @@ in milliseconds. || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" } }, // end of the list of possible fields @@ -19188,367 +21900,990 @@ in milliseconds. || } ``` -An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). +An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). + +#| +||Field | Description || +|| id | **string** + +ID of the operation. || +|| description | **string** + +Description of the operation. 0-256 characters long. || +|| createdAt | **string** (date-time) + +Creation timestamp. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| createdBy | **string** + +ID of the user or service account who initiated the operation. || +|| modifiedAt | **string** (date-time) + +The time when the Operation resource was last modified. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| done | **boolean** + +If the value is `false`, it means the operation is still in progress. +If `true`, the operation is completed, and either `error` or `response` is available. || +|| metadata | **[CreateClusterMetadata](#yandex.cloud.mdb.postgresql.v1.CreateClusterMetadata)** + +Service-specific metadata associated with the operation. +It typically contains the ID of the target resource that the operation is performed on. +Any method that returns a long-running operation should document the metadata type, if any. || +|| error | **[Status](#google.rpc.Status)** + +The error result of the operation in case of failure or cancellation. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** + +The normal response of the operation in case of success. +If the original method returns no data on success, such as Delete, +the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). +If the original method is the standard Create/Update, +the response should be the target resource of the operation. +Any method that returns a long-running operation should document the response type, if any. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|# + +## CreateClusterMetadata {#yandex.cloud.mdb.postgresql.v1.CreateClusterMetadata} + +#| +||Field | Description || +|| clusterId | **string** + +ID of the PostgreSQL cluster that is being created. || +|# + +## Status {#google.rpc.Status} + +The error result of the operation in case of failure or cancellation. + +#| +||Field | Description || +|| code | **integer** (int32) + +Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || +|| message | **string** + +An error message. || +|| details[] | **object** + +A list of messages that carry the error details. || +|# + +## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} + +A PostgreSQL Cluster resource. For more information, see +the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. + +#| +||Field | Description || +|| id | **string** + +ID of the PostgreSQL cluster. +This ID is assigned by MDB at creation time. || +|| folderId | **string** + +ID of the folder that the PostgreSQL cluster belongs to. || +|| createdAt | **string** (date-time) + +Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| name | **string** + +Name of the PostgreSQL cluster. +The name is unique within the folder. 1-63 characters long. || +|| description | **string** + +Description of the PostgreSQL cluster. 0-256 characters long. || +|| labels | **string** + +Custom labels for the PostgreSQL cluster as `` key:value `` pairs. +Maximum 64 per resource. || +|| environment | **enum** (Environment) + +Deployment environment of the PostgreSQL cluster. + +- `ENVIRONMENT_UNSPECIFIED` +- `PRODUCTION`: Stable environment with a conservative update policy: +only hotfixes are applied during regular maintenance. +- `PRESTABLE`: Environment with more aggressive update policy: new versions +are rolled out irrespective of backward compatibility. || +|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** + +Description of monitoring systems relevant to the PostgreSQL cluster. || +|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** + +Configuration of the PostgreSQL cluster. || +|| networkId | **string** + +ID of the network that the cluster belongs to. || +|| health | **enum** (Health) + +Aggregated cluster health. + +- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). +- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). +- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). +- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || +|| status | **enum** (Status) + +Current state of the cluster. + +- `STATUS_UNKNOWN`: Cluster state is unknown. +- `CREATING`: Cluster is being created. +- `RUNNING`: Cluster is running normally. +- `ERROR`: Cluster encountered a problem and cannot operate. +- `UPDATING`: Cluster is being updated. +- `STOPPING`: Cluster is stopping. +- `STOPPED`: Cluster stopped. +- `STARTING`: Cluster is starting. || +|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** + +Maintenance window for the cluster. || +|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** + +Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || +|| securityGroupIds[] | **string** + +User security groups || +|| deletionProtection | **boolean** + +Deletion Protection inhibits deletion of the cluster || +|| hostGroupIds[] | **string** + +Host groups hosting VMs of the cluster. || +|# + +## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} + +Monitoring system. + +#| +||Field | Description || +|| name | **string** + +Name of the monitoring system. || +|| description | **string** + +Description of the monitoring system. || +|| link | **string** + +Link to the monitoring system charts for the PostgreSQL cluster. || +|# + +## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} + +#| +||Field | Description || +|| version | **string** + +Version of PostgreSQL server software. || +|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** + +Configuration of a PostgreSQL 9.6 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** + +Configuration of a PostgreSQL 10 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** + +Configuration of a PostgreSQL 10 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** + +Configuration of a PostgreSQL 11 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** + +Configuration of a PostgreSQL 11 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** + +Configuration of a PostgreSQL 12 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** + +Configuration of a PostgreSQL 12 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** + +Configuration of a PostgreSQL 13 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** -#| -||Field | Description || -|| id | **string** +Configuration of a PostgreSQL 13 1C server. -ID of the operation. || -|| description | **string** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Description of the operation. 0-256 characters long. || -|| createdAt | **string** (date-time) +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** -Creation timestamp. +Configuration of a PostgreSQL 14 server. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| createdBy | **string** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** -ID of the user or service account who initiated the operation. || -|| modifiedAt | **string** (date-time) +Configuration of a PostgreSQL 14 1C server. -The time when the Operation resource was last modified. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| done | **boolean** +Configuration of a PostgreSQL 15 server. -If the value is `false`, it means the operation is still in progress. -If `true`, the operation is completed, and either `error` or `response` is available. || -|| metadata | **[CreateClusterMetadata](#yandex.cloud.mdb.postgresql.v1.CreateClusterMetadata)** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Service-specific metadata associated with the operation. -It typically contains the ID of the target resource that the operation is performed on. -Any method that returns a long-running operation should document the metadata type, if any. || -|| error | **[Status](#google.rpc.Status)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** -The error result of the operation in case of failure or cancellation. +Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `error`, `response`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || -|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** -The normal response of the operation in case of success. -If the original method returns no data on success, such as Delete, -the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). -If the original method is the standard Create/Update, -the response should be the target resource of the operation. -Any method that returns a long-running operation should document the response type, if any. +Configuration of a PostgreSQL 16 server. -Includes only one of the fields `error`, `response`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** + +Configuration of a PostgreSQL 16 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfigSet17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfigSet17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig2)** + +Configuration of the connection pooler. || +|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources2)** + +Resources allocated to PostgreSQL hosts. || +|| autofailover | **boolean** + +Configuration setting which enables/disables autofailover in cluster. || +|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay2)** + +Time to start the daily backup, in the UTC timezone. || +|| backupRetainPeriodDays | **string** (int64) + +Retention policy of automated backups. || +|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access2)** + +Access policy to DB || +|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics2)** + +Configuration of the performance diagnostics service. || +|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling2)** + +Disk size autoscaling || |# -## CreateClusterMetadata {#yandex.cloud.mdb.postgresql.v1.CreateClusterMetadata} +## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} #| ||Field | Description || -|| clusterId | **string** +|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** -ID of the PostgreSQL cluster that is being created. || +Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** + +User-defined settings for a PostgreSQL 9.6 cluster. || +|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** + +Default configuration for a PostgreSQL 9.6 cluster. || |# -## Status {#google.rpc.Status} +## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62} -The error result of the operation in case of failure or cancellation. +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). #| ||Field | Description || -|| code | **integer** (int32) +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || -|| message | **string** +in bytes. || +|| tempBuffers | **string** (int64) -An error message. || -|| details[] | **object** +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -A list of messages that carry the error details. || -|# +in bytes. || +|| maintenanceWorkMem | **string** (int64) -## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -A PostgreSQL Cluster resource. For more information, see -the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. +in bytes. || +|| tempFileLimit | **string** (int64) -#| -||Field | Description || -|| id | **string** +in bytes. || +|| vacuumCostDelay | **string** (int64) -ID of the PostgreSQL cluster. -This ID is assigned by MDB at creation time. || -|| folderId | **string** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -ID of the folder that the PostgreSQL cluster belongs to. || -|| createdAt | **string** (date-time) +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. +in bytes || +|| backendFlushAfter | **string** (int64) -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| name | **string** +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Name of the PostgreSQL cluster. -The name is unique within the folder. 1-63 characters long. || -|| description | **string** +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) + +Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Description of the PostgreSQL cluster. 0-256 characters long. || -|| labels | **string** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Custom labels for the PostgreSQL cluster as `` key:value `` pairs. -Maximum 64 per resource. || -|| environment | **enum** (Environment) +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Deployment environment of the PostgreSQL cluster. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -- `ENVIRONMENT_UNSPECIFIED` -- `PRODUCTION`: Stable environment with a conservative update policy: -only hotfixes are applied during regular maintenance. -- `PRESTABLE`: Environment with more aggressive update policy: new versions -are rolled out irrespective of backward compatibility. || -|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Description of monitoring systems relevant to the PostgreSQL cluster. || -|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Configuration of the PostgreSQL cluster. || -|| networkId | **string** +in milliseconds. || +|| lockTimeout | **string** (int64) -ID of the network that the cluster belongs to. || -|| health | **enum** (Health) +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Aggregated cluster health. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). -- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). -- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). -- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || -|| status | **enum** (Status) +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Current state of the cluster. +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -- `STATUS_UNKNOWN`: Cluster state is unknown. -- `CREATING`: Cluster is being created. -- `RUNNING`: Cluster is running normally. -- `ERROR`: Cluster encountered a problem and cannot operate. -- `UPDATING`: Cluster is being updated. -- `STOPPING`: Cluster is stopping. -- `STOPPED`: Cluster stopped. -- `STARTING`: Cluster is starting. || -|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Maintenance window for the cluster. || -|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** +in bytes. || +|| deadlockTimeout | **string** (int64) -Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || -|| securityGroupIds[] | **string** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -User security groups || -|| deletionProtection | **boolean** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| sqlInheritance | **boolean** -Deletion Protection inhibits deletion of the cluster || -|| hostGroupIds[] | **string** +This option has been removed in PostgreSQL 10. || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Host groups hosting VMs of the cluster. || -|# +in milliseconds. || +|| archiveTimeout | **string** (int64) -## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# -Monitoring system. +## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} #| ||Field | Description || -|| name | **string** +|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** -Name of the monitoring system. || -|| description | **string** +Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** -Description of the monitoring system. || -|| link | **string** +User-defined settings for a PostgreSQL 10 1C cluster. || +|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** -Link to the monitoring system charts for the PostgreSQL cluster. || +Default configuration for a PostgreSQL 10 1C cluster. || |# -## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} +## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || -|| version | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Version of PostgreSQL server software. || -|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** +in bytes. || +|| tempBuffers | **string** (int64) -Configuration of a PostgreSQL 9.6 server. +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -Configuration of a PostgreSQL 10 1C server. +in bytes. || +|| tempFileLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| vacuumCostDelay | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Configuration of a PostgreSQL 10 server. +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes || +|| backendFlushAfter | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -Configuration of a PostgreSQL 11 server. +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -Configuration of a PostgreSQL 11 1C server. +in bytes || +|| maxWalSize | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| minWalSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) -Configuration of a PostgreSQL 12 server. +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Configuration of a PostgreSQL 12 1C server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Configuration of a PostgreSQL 13 server. +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Configuration of a PostgreSQL 13 1C server. +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| lockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Configuration of a PostgreSQL 14 server. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -Configuration of a PostgreSQL 14 1C server. +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| deadlockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -Configuration of a PostgreSQL 15 server. +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| archiveTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -Configuration of a PostgreSQL 15 1C server. +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) -Configuration of a PostgreSQL 16 server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| onlineAnalyzeEnable | **boolean** || +|| plantunerFixEmptyTable | **boolean** || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| geqo | **boolean** -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -Configuration of a PostgreSQL 16 1C server. +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig2)** +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) -Configuration of the connection pooler. || -|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources2)** +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) -Resources allocated to PostgreSQL hosts. || -|| autofailover | **boolean** +selective pressure within the population || +|| geqoSeed | **number** (double) -Configuration setting which enables/disables autofailover in cluster. || -|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay2)** +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) -Time to start the daily backup, in the UTC timezone. || -|| backupRetainPeriodDays | **string** (int64) +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) -Retention policy of automated backups. || -|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access2)** +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -Access policy to DB || -|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics2)** +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -Configuration of the performance diagnostics service. || -|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling2)** +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. -Disk size autoscaling || +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} +## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** +|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** -Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** - -User-defined settings for a PostgreSQL 9.6 cluster. || -|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** +|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** -Default configuration for a PostgreSQL 9.6 cluster. || +User-defined settings for a PostgreSQL 10 cluster. || +|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** + +Default configuration for a PostgreSQL 10 cluster. || |# -## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62} +## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -19608,9 +22943,7 @@ in bytes || || checkpointTimeout | **string** (int64) in milliseconds. || -|| checkpointCompletionTarget | **number** (double) - -Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointCompletionTarget | **number** (double) || || checkpointFlushAfter | **string** (int64) in bytes || @@ -19763,9 +23096,6 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** - -This option has been removed in PostgreSQL 10. || || autovacuumMaxWorkers | **string** (int64) || || autovacuumVacuumCostDelay | **string** (int64) || || autovacuumVacuumCostLimit | **string** (int64) || @@ -19776,31 +23106,139 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) + +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} +## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** +|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** -Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** +|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** -User-defined settings for a PostgreSQL 10 1C cluster. || -|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** +User-defined settings for a PostgreSQL 11 cluster. || +|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** -Default configuration for a PostgreSQL 10 1C cluster. || +Default configuration for a PostgreSQL 11 cluster. || |# -## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2} +## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -19818,7 +23256,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -20041,6 +23478,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -20087,8 +23533,6 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || -|| onlineAnalyzeEnable | **boolean** || -|| plantunerFixEmptyTable | **boolean** || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -20118,6 +23562,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -20137,27 +23584,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} +## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** +|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** -Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** +|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** -User-defined settings for a PostgreSQL 10 cluster. || -|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** +User-defined settings for a PostgreSQL 11 1C cluster. || +|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** -Default configuration for a PostgreSQL 10 cluster. || +Default configuration for a PostgreSQL 11 1C cluster. || |# -## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102} +## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -20175,7 +23622,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -20380,6 +23826,7 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || || enableBitmapscan | **boolean** || || enableHashagg | **boolean** || || enableHashjoin | **boolean** || @@ -20398,6 +23845,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -20449,6 +23905,7 @@ in milliseconds. || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || || maxStackDepth | **string** (int64) in bytes. || @@ -20473,6 +23930,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -20492,23 +23952,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} +## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** +|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** -Effective settings for a PostgreSQL 11 cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** +|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** -User-defined settings for a PostgreSQL 11 cluster. || -|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** +User-defined settings for a PostgreSQL 12 cluster. || +|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** -Default configuration for a PostgreSQL 11 cluster. || +Default configuration for a PostgreSQL 12 cluster. || |# -## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112} +## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -20761,6 +24221,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -20858,23 +24325,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} +## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** +|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** -Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** +|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** -User-defined settings for a PostgreSQL 11 1C cluster. || -|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** +User-defined settings for a PostgreSQL 12 1C cluster. || +|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** -Default configuration for a PostgreSQL 11 1C cluster. || +Default configuration for a PostgreSQL 12 1C cluster. || |# -## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2} +## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -21128,6 +24595,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -21226,23 +24700,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} +## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** +|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** -Effective settings for a PostgreSQL 12 cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** +|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** -User-defined settings for a PostgreSQL 12 cluster. || -|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** +User-defined settings for a PostgreSQL 13 cluster. || +|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** -Default configuration for a PostgreSQL 12 cluster. || +Default configuration for a PostgreSQL 13 cluster. || |# -## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122} +## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -21548,6 +25022,30 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -21599,23 +25097,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} +## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** +|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** -Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** +|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** -User-defined settings for a PostgreSQL 12 1C cluster. || -|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** +User-defined settings for a PostgreSQL 13 1C cluster. || +|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** -Default configuration for a PostgreSQL 12 1C cluster. || +Default configuration for a PostgreSQL 13 1C cluster. || |# -## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2} +## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -21922,15 +25420,36 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || -|| maxStackDepth | **string** (int64) - -in bytes. || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -21974,23 +25493,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} +## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** +|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** -Effective settings for a PostgreSQL 13 cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** +|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** -User-defined settings for a PostgreSQL 13 cluster. || -|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** +User-defined settings for a PostgreSQL 14 cluster. || +|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** -Default configuration for a PostgreSQL 13 cluster. || +Default configuration for a PostgreSQL 14 cluster. || |# -## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132} +## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -22198,7 +25717,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -22242,7 +25760,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -22320,6 +25837,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -22371,23 +25903,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} +## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** +|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** -Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** +|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** -User-defined settings for a PostgreSQL 13 1C cluster. || -|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** +User-defined settings for a PostgreSQL 14 1C cluster. || +|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** -Default configuration for a PostgreSQL 13 1C cluster. || +Default configuration for a PostgreSQL 14 1C cluster. || |# -## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2} +## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -22595,7 +26127,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -22640,7 +26171,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -22718,6 +26248,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -22767,23 +26312,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} +## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** +|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** -Effective settings for a PostgreSQL 14 cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** +|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** -User-defined settings for a PostgreSQL 14 cluster. || -|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** +User-defined settings for a PostgreSQL 15 cluster. || +|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** -Default configuration for a PostgreSQL 14 cluster. || +Default configuration for a PostgreSQL 15 cluster. || |# -## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142} +## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -23053,7 +26598,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -23134,6 +26680,7 @@ in milliseconds. || || maxStackDepth | **string** (int64) in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -23177,23 +26724,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} +## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** +|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** -Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** +|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** -User-defined settings for a PostgreSQL 14 1C cluster. || -|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** +User-defined settings for a PostgreSQL 15 1C cluster. || +|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** -Default configuration for a PostgreSQL 14 1C cluster. || +Default configuration for a PostgreSQL 15 1C cluster. || |# -## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2} +## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -23464,7 +27011,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -23543,6 +27091,10 @@ in milliseconds. || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -23586,23 +27138,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} +## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** +|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** -Effective settings for a PostgreSQL 15 cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** +|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** -User-defined settings for a PostgreSQL 15 cluster. || -|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** +User-defined settings for a PostgreSQL 16 cluster. || +|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** -Default configuration for a PostgreSQL 15 cluster. || +Default configuration for a PostgreSQL 16 cluster. || |# -## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152} +## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -23688,12 +27240,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -23702,6 +27254,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -23716,6 +27269,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -23730,6 +27284,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -23901,6 +27456,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -23998,23 +27554,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} +## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** +|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** -Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** +|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** -User-defined settings for a PostgreSQL 15 1C cluster. || -|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** +User-defined settings for a PostgreSQL 16 1C cluster. || +|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** -Default configuration for a PostgreSQL 15 1C cluster. || +Default configuration for a PostgreSQL 16 1C cluster. || |# -## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2} +## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -24100,12 +27656,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -24114,6 +27670,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -24128,6 +27685,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -24142,6 +27700,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -24314,6 +27873,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -24412,27 +27972,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} +## PostgresqlConfigSet17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** +|| effectiveConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig172)** -Effective settings for a PostgreSQL 16 cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** +|| userConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig172)** -User-defined settings for a PostgreSQL 16 cluster. || -|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig172)** -Default configuration for a PostgreSQL 16 cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig172} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -24474,7 +28034,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -24826,29 +28385,42 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# -## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} +## PostgresqlConfigSet17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** +|| effectiveConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C2)** -Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** +|| userConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C2)** -User-defined settings for a PostgreSQL 16 1C cluster. || -|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C2)** -Default configuration for a PostgreSQL 16 1C cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2} +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -24890,7 +28462,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -25244,6 +28815,19 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# ## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig2} diff --git a/en/managed-postgresql/api-ref/Cluster/get.md b/en/managed-postgresql/api-ref/Cluster/get.md index 02743d241f8..957cbff30b9 100644 --- a/en/managed-postgresql/api-ref/Cluster/get.md +++ b/en/managed-postgresql/api-ref/Cluster/get.md @@ -47,7 +47,7 @@ To get the cluster ID use a [ClusterService.List](/docs/managed-postgresql/api-r ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "effectiveConfig": { "maxConnections": "string", @@ -6795,6 +6795,1024 @@ To get the cluster ID use a [ClusterService.List](/docs/managed-postgresql/api-r "passwordEncryption": "string" } }, + "postgresqlConfig_17": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, + "postgresqlConfig_17_1c": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, // end of the list of possible fields "poolerConfig": { "poolingMode": "string", @@ -6857,270 +7875,893 @@ To get the cluster ID use a [ClusterService.List](/docs/managed-postgresql/api-r } ``` -A PostgreSQL Cluster resource. For more information, see -the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. +A PostgreSQL Cluster resource. For more information, see +the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. + +#| +||Field | Description || +|| id | **string** + +ID of the PostgreSQL cluster. +This ID is assigned by MDB at creation time. || +|| folderId | **string** + +ID of the folder that the PostgreSQL cluster belongs to. || +|| createdAt | **string** (date-time) + +Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| name | **string** + +Name of the PostgreSQL cluster. +The name is unique within the folder. 1-63 characters long. || +|| description | **string** + +Description of the PostgreSQL cluster. 0-256 characters long. || +|| labels | **string** + +Custom labels for the PostgreSQL cluster as `` key:value `` pairs. +Maximum 64 per resource. || +|| environment | **enum** (Environment) + +Deployment environment of the PostgreSQL cluster. + +- `ENVIRONMENT_UNSPECIFIED` +- `PRODUCTION`: Stable environment with a conservative update policy: +only hotfixes are applied during regular maintenance. +- `PRESTABLE`: Environment with more aggressive update policy: new versions +are rolled out irrespective of backward compatibility. || +|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** + +Description of monitoring systems relevant to the PostgreSQL cluster. || +|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** + +Configuration of the PostgreSQL cluster. || +|| networkId | **string** + +ID of the network that the cluster belongs to. || +|| health | **enum** (Health) + +Aggregated cluster health. + +- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). +- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). +- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). +- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || +|| status | **enum** (Status) + +Current state of the cluster. + +- `STATUS_UNKNOWN`: Cluster state is unknown. +- `CREATING`: Cluster is being created. +- `RUNNING`: Cluster is running normally. +- `ERROR`: Cluster encountered a problem and cannot operate. +- `UPDATING`: Cluster is being updated. +- `STOPPING`: Cluster is stopping. +- `STOPPED`: Cluster stopped. +- `STARTING`: Cluster is starting. || +|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** + +Maintenance window for the cluster. || +|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** + +Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || +|| securityGroupIds[] | **string** + +User security groups || +|| deletionProtection | **boolean** + +Deletion Protection inhibits deletion of the cluster || +|| hostGroupIds[] | **string** + +Host groups hosting VMs of the cluster. || +|# + +## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} + +Monitoring system. + +#| +||Field | Description || +|| name | **string** + +Name of the monitoring system. || +|| description | **string** + +Description of the monitoring system. || +|| link | **string** + +Link to the monitoring system charts for the PostgreSQL cluster. || +|# + +## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} + +#| +||Field | Description || +|| version | **string** + +Version of PostgreSQL server software. || +|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** + +Configuration of a PostgreSQL 9.6 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** + +Configuration of a PostgreSQL 10 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** + +Configuration of a PostgreSQL 10 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** + +Configuration of a PostgreSQL 11 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** + +Configuration of a PostgreSQL 11 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** + +Configuration of a PostgreSQL 12 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** + +Configuration of a PostgreSQL 12 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** + +Configuration of a PostgreSQL 13 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** + +Configuration of a PostgreSQL 13 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** + +Configuration of a PostgreSQL 14 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** + +Configuration of a PostgreSQL 14 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** + +Configuration of a PostgreSQL 15 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** + +Configuration of a PostgreSQL 15 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** + +Configuration of a PostgreSQL 16 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** + +Configuration of a PostgreSQL 16 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfigSet17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfigSet17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** + +Configuration of the connection pooler. || +|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** + +Resources allocated to PostgreSQL hosts. || +|| autofailover | **boolean** + +Configuration setting which enables/disables autofailover in cluster. || +|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** + +Time to start the daily backup, in the UTC timezone. || +|| backupRetainPeriodDays | **string** (int64) + +Retention policy of automated backups. || +|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** + +Access policy to DB || +|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** + +Configuration of the performance diagnostics service. || +|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** + +Disk size autoscaling || +|# + +## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} #| ||Field | Description || -|| id | **string** +|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -ID of the PostgreSQL cluster. -This ID is assigned by MDB at creation time. || -|| folderId | **string** +Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -ID of the folder that the PostgreSQL cluster belongs to. || -|| createdAt | **string** (date-time) +User-defined settings for a PostgreSQL 9.6 cluster. || +|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. +Default configuration for a PostgreSQL 9.6 cluster. || +|# -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| name | **string** +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). -Name of the PostgreSQL cluster. -The name is unique within the folder. 1-63 characters long. || -|| description | **string** +#| +||Field | Description || +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) + +in bytes. || +|| maintenanceWorkMem | **string** (int64) + +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| vacuumCostDelay | **string** (int64) + +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) + +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) + +in bytes || +|| backendFlushAfter | **string** (int64) + +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) + +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) + +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) + +Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Description of the PostgreSQL cluster. 0-256 characters long. || -|| labels | **string** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Custom labels for the PostgreSQL cluster as `` key:value `` pairs. -Maximum 64 per resource. || -|| environment | **enum** (Environment) +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Deployment environment of the PostgreSQL cluster. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -- `ENVIRONMENT_UNSPECIFIED` -- `PRODUCTION`: Stable environment with a conservative update policy: -only hotfixes are applied during regular maintenance. -- `PRESTABLE`: Environment with more aggressive update policy: new versions -are rolled out irrespective of backward compatibility. || -|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Description of monitoring systems relevant to the PostgreSQL cluster. || -|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Configuration of the PostgreSQL cluster. || -|| networkId | **string** +in milliseconds. || +|| lockTimeout | **string** (int64) -ID of the network that the cluster belongs to. || -|| health | **enum** (Health) +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Aggregated cluster health. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). -- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). -- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). -- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || -|| status | **enum** (Status) +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Current state of the cluster. +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -- `STATUS_UNKNOWN`: Cluster state is unknown. -- `CREATING`: Cluster is being created. -- `RUNNING`: Cluster is running normally. -- `ERROR`: Cluster encountered a problem and cannot operate. -- `UPDATING`: Cluster is being updated. -- `STOPPING`: Cluster is stopping. -- `STOPPED`: Cluster stopped. -- `STARTING`: Cluster is starting. || -|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Maintenance window for the cluster. || -|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** +in bytes. || +|| deadlockTimeout | **string** (int64) -Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || -|| securityGroupIds[] | **string** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -User security groups || -|| deletionProtection | **boolean** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| sqlInheritance | **boolean** -Deletion Protection inhibits deletion of the cluster || -|| hostGroupIds[] | **string** +This option has been removed in PostgreSQL 10. || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Host groups hosting VMs of the cluster. || -|# +in milliseconds. || +|| archiveTimeout | **string** (int64) -## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# -Monitoring system. +## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} #| ||Field | Description || -|| name | **string** +|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Name of the monitoring system. || -|| description | **string** +Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Description of the monitoring system. || -|| link | **string** +User-defined settings for a PostgreSQL 10 1C cluster. || +|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Link to the monitoring system charts for the PostgreSQL cluster. || +Default configuration for a PostgreSQL 10 1C cluster. || |# -## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} +## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || -|| version | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Version of PostgreSQL server software. || -|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** +in bytes. || +|| tempBuffers | **string** (int64) -Configuration of a PostgreSQL 9.6 server. +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -Configuration of a PostgreSQL 10 1C server. +in bytes. || +|| tempFileLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| vacuumCostDelay | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Configuration of a PostgreSQL 10 server. +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes || +|| backendFlushAfter | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -Configuration of a PostgreSQL 11 server. +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -Configuration of a PostgreSQL 11 1C server. +in bytes || +|| maxWalSize | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| minWalSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) -Configuration of a PostgreSQL 12 server. +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Configuration of a PostgreSQL 12 1C server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Configuration of a PostgreSQL 13 server. +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Configuration of a PostgreSQL 13 1C server. +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| lockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Configuration of a PostgreSQL 14 server. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -Configuration of a PostgreSQL 14 1C server. +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| deadlockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -Configuration of a PostgreSQL 15 server. +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| archiveTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -Configuration of a PostgreSQL 15 1C server. +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) -Configuration of a PostgreSQL 16 server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| onlineAnalyzeEnable | **boolean** || +|| plantunerFixEmptyTable | **boolean** || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| geqo | **boolean** -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -Configuration of a PostgreSQL 16 1C server. +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) -Configuration of the connection pooler. || -|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) -Resources allocated to PostgreSQL hosts. || -|| autofailover | **boolean** +selective pressure within the population || +|| geqoSeed | **number** (double) -Configuration setting which enables/disables autofailover in cluster. || -|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) -Time to start the daily backup, in the UTC timezone. || -|| backupRetainPeriodDays | **string** (int64) +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) -Retention policy of automated backups. || -|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -Access policy to DB || -|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -Configuration of the performance diagnostics service. || -|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. -Disk size autoscaling || +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} +## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** - -User-defined settings for a PostgreSQL 9.6 cluster. || -|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Default configuration for a PostgreSQL 9.6 cluster. || +User-defined settings for a PostgreSQL 10 cluster. || +|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** + +Default configuration for a PostgreSQL 10 cluster. || |# -## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} +## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -7180,9 +8821,7 @@ in bytes || || checkpointTimeout | **string** (int64) in milliseconds. || -|| checkpointCompletionTarget | **number** (double) - -Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointCompletionTarget | **number** (double) || || checkpointFlushAfter | **string** (int64) in bytes || @@ -7335,9 +8974,6 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** - -This option has been removed in PostgreSQL 10. || || autovacuumMaxWorkers | **string** (int64) || || autovacuumVacuumCostDelay | **string** (int64) || || autovacuumVacuumCostLimit | **string** (int64) || @@ -7348,31 +8984,139 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) + +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} +## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -User-defined settings for a PostgreSQL 10 1C cluster. || -|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +User-defined settings for a PostgreSQL 11 cluster. || +|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Default configuration for a PostgreSQL 10 1C cluster. || +Default configuration for a PostgreSQL 11 cluster. || |# -## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} +## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7390,7 +9134,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -7613,6 +9356,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -7659,8 +9411,6 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || -|| onlineAnalyzeEnable | **boolean** || -|| plantunerFixEmptyTable | **boolean** || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -7690,6 +9440,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -7709,27 +9462,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} +## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -User-defined settings for a PostgreSQL 10 cluster. || -|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +User-defined settings for a PostgreSQL 11 1C cluster. || +|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Default configuration for a PostgreSQL 10 cluster. || +Default configuration for a PostgreSQL 11 1C cluster. || |# -## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} +## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7747,7 +9500,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -7952,6 +9704,7 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || || enableBitmapscan | **boolean** || || enableHashagg | **boolean** || || enableHashjoin | **boolean** || @@ -7970,6 +9723,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8021,6 +9783,7 @@ in milliseconds. || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || || maxStackDepth | **string** (int64) in bytes. || @@ -8045,6 +9808,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -8064,23 +9830,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} +## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Effective settings for a PostgreSQL 11 cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -User-defined settings for a PostgreSQL 11 cluster. || -|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +User-defined settings for a PostgreSQL 12 cluster. || +|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Default configuration for a PostgreSQL 11 cluster. || +Default configuration for a PostgreSQL 12 cluster. || |# -## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} +## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8333,6 +10099,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8430,23 +10203,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} +## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -User-defined settings for a PostgreSQL 11 1C cluster. || -|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +User-defined settings for a PostgreSQL 12 1C cluster. || +|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Default configuration for a PostgreSQL 11 1C cluster. || +Default configuration for a PostgreSQL 12 1C cluster. || |# -## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} +## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8700,6 +10473,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8798,23 +10578,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} +## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Effective settings for a PostgreSQL 12 cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -User-defined settings for a PostgreSQL 12 cluster. || -|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +User-defined settings for a PostgreSQL 13 cluster. || +|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Default configuration for a PostgreSQL 12 cluster. || +Default configuration for a PostgreSQL 13 cluster. || |# -## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} +## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9120,6 +10900,30 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -9171,23 +10975,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} +## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -User-defined settings for a PostgreSQL 12 1C cluster. || -|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +User-defined settings for a PostgreSQL 13 1C cluster. || +|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Default configuration for a PostgreSQL 12 1C cluster. || +Default configuration for a PostgreSQL 13 1C cluster. || |# -## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} +## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9494,15 +11298,36 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || -|| maxStackDepth | **string** (int64) - -in bytes. || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -9546,23 +11371,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} +## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Effective settings for a PostgreSQL 13 cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -User-defined settings for a PostgreSQL 13 cluster. || -|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +User-defined settings for a PostgreSQL 14 cluster. || +|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Default configuration for a PostgreSQL 13 cluster. || +Default configuration for a PostgreSQL 14 cluster. || |# -## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} +## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9770,7 +11595,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -9814,7 +11638,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -9892,6 +11715,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -9943,23 +11781,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} +## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -User-defined settings for a PostgreSQL 13 1C cluster. || -|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +User-defined settings for a PostgreSQL 14 1C cluster. || +|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Default configuration for a PostgreSQL 13 1C cluster. || +Default configuration for a PostgreSQL 14 1C cluster. || |# -## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} +## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10167,7 +12005,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -10212,7 +12049,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10290,6 +12126,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10339,23 +12190,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} +## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Effective settings for a PostgreSQL 14 cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -User-defined settings for a PostgreSQL 14 cluster. || -|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +User-defined settings for a PostgreSQL 15 cluster. || +|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Default configuration for a PostgreSQL 14 cluster. || +Default configuration for a PostgreSQL 15 cluster. || |# -## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} +## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10625,7 +12476,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -10706,6 +12558,7 @@ in milliseconds. || || maxStackDepth | **string** (int64) in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -10749,23 +12602,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} +## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -User-defined settings for a PostgreSQL 14 1C cluster. || -|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +User-defined settings for a PostgreSQL 15 1C cluster. || +|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Default configuration for a PostgreSQL 14 1C cluster. || +Default configuration for a PostgreSQL 15 1C cluster. || |# -## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} +## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11036,7 +12889,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -11115,6 +12969,10 @@ in milliseconds. || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -11158,23 +13016,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} +## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Effective settings for a PostgreSQL 15 cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -User-defined settings for a PostgreSQL 15 cluster. || -|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +User-defined settings for a PostgreSQL 16 cluster. || +|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Default configuration for a PostgreSQL 15 cluster. || +Default configuration for a PostgreSQL 16 cluster. || |# -## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} +## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11260,12 +13118,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11274,6 +13132,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11288,6 +13147,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11302,6 +13162,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11473,6 +13334,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11570,23 +13432,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} +## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -User-defined settings for a PostgreSQL 15 1C cluster. || -|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +User-defined settings for a PostgreSQL 16 1C cluster. || +|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Default configuration for a PostgreSQL 15 1C cluster. || +Default configuration for a PostgreSQL 16 1C cluster. || |# -## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} +## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11672,12 +13534,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11686,6 +13548,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11700,6 +13563,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11714,6 +13578,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11886,6 +13751,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11984,27 +13850,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} +## PostgresqlConfigSet17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| effectiveConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Effective settings for a PostgreSQL 16 cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| userConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -User-defined settings for a PostgreSQL 16 cluster. || -|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Default configuration for a PostgreSQL 16 cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12046,7 +13912,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12398,29 +14263,42 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# -## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} +## PostgresqlConfigSet17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| effectiveConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| userConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -User-defined settings for a PostgreSQL 16 1C cluster. || -|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Default configuration for a PostgreSQL 16 1C cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12462,7 +14340,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12816,6 +14693,19 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# ## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig} diff --git a/en/managed-postgresql/api-ref/Cluster/list.md b/en/managed-postgresql/api-ref/Cluster/list.md index 1b5af2cc4a9..f156d5a9ab2 100644 --- a/en/managed-postgresql/api-ref/Cluster/list.md +++ b/en/managed-postgresql/api-ref/Cluster/list.md @@ -64,7 +64,7 @@ The expression must specify: ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "effectiveConfig": { "maxConnections": "string", @@ -6812,6 +6812,1024 @@ The expression must specify: "passwordEncryption": "string" } }, + "postgresqlConfig_17": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, + "postgresqlConfig_17_1c": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, // end of the list of possible fields "poolerConfig": { "poolingMode": "string", @@ -6879,283 +7897,906 @@ The expression must specify: #| ||Field | Description || -|| clusters[] | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** +|| clusters[] | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** + +List of PostgreSQL Cluster resources. || +|| nextPageToken | **string** + +This token allows you to get the next page of results for list requests. If the number of results +is larger than [ListClustersRequest.pageSize](#yandex.cloud.mdb.postgresql.v1.ListClustersRequest), use the `nextPageToken` as the value +for the [ListClustersRequest.pageToken](#yandex.cloud.mdb.postgresql.v1.ListClustersRequest) parameter in the next list request. Each subsequent +list request will have its own `nextPageToken` to continue paging through the results. || +|# + +## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} + +A PostgreSQL Cluster resource. For more information, see +the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. + +#| +||Field | Description || +|| id | **string** + +ID of the PostgreSQL cluster. +This ID is assigned by MDB at creation time. || +|| folderId | **string** + +ID of the folder that the PostgreSQL cluster belongs to. || +|| createdAt | **string** (date-time) + +Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| name | **string** + +Name of the PostgreSQL cluster. +The name is unique within the folder. 1-63 characters long. || +|| description | **string** + +Description of the PostgreSQL cluster. 0-256 characters long. || +|| labels | **string** + +Custom labels for the PostgreSQL cluster as `` key:value `` pairs. +Maximum 64 per resource. || +|| environment | **enum** (Environment) + +Deployment environment of the PostgreSQL cluster. + +- `ENVIRONMENT_UNSPECIFIED` +- `PRODUCTION`: Stable environment with a conservative update policy: +only hotfixes are applied during regular maintenance. +- `PRESTABLE`: Environment with more aggressive update policy: new versions +are rolled out irrespective of backward compatibility. || +|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** + +Description of monitoring systems relevant to the PostgreSQL cluster. || +|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** + +Configuration of the PostgreSQL cluster. || +|| networkId | **string** + +ID of the network that the cluster belongs to. || +|| health | **enum** (Health) + +Aggregated cluster health. + +- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). +- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). +- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). +- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || +|| status | **enum** (Status) + +Current state of the cluster. + +- `STATUS_UNKNOWN`: Cluster state is unknown. +- `CREATING`: Cluster is being created. +- `RUNNING`: Cluster is running normally. +- `ERROR`: Cluster encountered a problem and cannot operate. +- `UPDATING`: Cluster is being updated. +- `STOPPING`: Cluster is stopping. +- `STOPPED`: Cluster stopped. +- `STARTING`: Cluster is starting. || +|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** + +Maintenance window for the cluster. || +|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** + +Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || +|| securityGroupIds[] | **string** + +User security groups || +|| deletionProtection | **boolean** + +Deletion Protection inhibits deletion of the cluster || +|| hostGroupIds[] | **string** + +Host groups hosting VMs of the cluster. || +|# + +## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} + +Monitoring system. + +#| +||Field | Description || +|| name | **string** + +Name of the monitoring system. || +|| description | **string** + +Description of the monitoring system. || +|| link | **string** + +Link to the monitoring system charts for the PostgreSQL cluster. || +|# + +## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} + +#| +||Field | Description || +|| version | **string** + +Version of PostgreSQL server software. || +|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** + +Configuration of a PostgreSQL 9.6 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** + +Configuration of a PostgreSQL 10 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** + +Configuration of a PostgreSQL 10 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** + +Configuration of a PostgreSQL 11 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** + +Configuration of a PostgreSQL 11 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** + +Configuration of a PostgreSQL 12 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** + +Configuration of a PostgreSQL 12 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** + +Configuration of a PostgreSQL 13 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** + +Configuration of a PostgreSQL 13 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** + +Configuration of a PostgreSQL 14 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** + +Configuration of a PostgreSQL 14 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** + +Configuration of a PostgreSQL 15 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** + +Configuration of a PostgreSQL 15 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** + +Configuration of a PostgreSQL 16 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** + +Configuration of a PostgreSQL 16 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfigSet17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfigSet17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** + +Configuration of the connection pooler. || +|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** + +Resources allocated to PostgreSQL hosts. || +|| autofailover | **boolean** + +Configuration setting which enables/disables autofailover in cluster. || +|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** + +Time to start the daily backup, in the UTC timezone. || +|| backupRetainPeriodDays | **string** (int64) + +Retention policy of automated backups. || +|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** + +Access policy to DB || +|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** + +Configuration of the performance diagnostics service. || +|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** + +Disk size autoscaling || +|# + +## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} + +#| +||Field | Description || +|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -List of PostgreSQL Cluster resources. || -|| nextPageToken | **string** +Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -This token allows you to get the next page of results for list requests. If the number of results -is larger than [ListClustersRequest.pageSize](#yandex.cloud.mdb.postgresql.v1.ListClustersRequest), use the `nextPageToken` as the value -for the [ListClustersRequest.pageToken](#yandex.cloud.mdb.postgresql.v1.ListClustersRequest) parameter in the next list request. Each subsequent -list request will have its own `nextPageToken` to continue paging through the results. || +User-defined settings for a PostgreSQL 9.6 cluster. || +|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** + +Default configuration for a PostgreSQL 9.6 cluster. || |# -## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} +## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} -A PostgreSQL Cluster resource. For more information, see -the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). #| ||Field | Description || -|| id | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -ID of the PostgreSQL cluster. -This ID is assigned by MDB at creation time. || -|| folderId | **string** +in bytes. || +|| tempBuffers | **string** (int64) -ID of the folder that the PostgreSQL cluster belongs to. || -|| createdAt | **string** (date-time) +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| name | **string** +in bytes. || +|| tempFileLimit | **string** (int64) -Name of the PostgreSQL cluster. -The name is unique within the folder. 1-63 characters long. || -|| description | **string** +in bytes. || +|| vacuumCostDelay | **string** (int64) + +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) + +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) + +in bytes || +|| backendFlushAfter | **string** (int64) + +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) + +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) + +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) + +Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Description of the PostgreSQL cluster. 0-256 characters long. || -|| labels | **string** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Custom labels for the PostgreSQL cluster as `` key:value `` pairs. -Maximum 64 per resource. || -|| environment | **enum** (Environment) +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Deployment environment of the PostgreSQL cluster. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -- `ENVIRONMENT_UNSPECIFIED` -- `PRODUCTION`: Stable environment with a conservative update policy: -only hotfixes are applied during regular maintenance. -- `PRESTABLE`: Environment with more aggressive update policy: new versions -are rolled out irrespective of backward compatibility. || -|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Description of monitoring systems relevant to the PostgreSQL cluster. || -|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Configuration of the PostgreSQL cluster. || -|| networkId | **string** +in milliseconds. || +|| lockTimeout | **string** (int64) -ID of the network that the cluster belongs to. || -|| health | **enum** (Health) +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Aggregated cluster health. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). -- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). -- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). -- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || -|| status | **enum** (Status) +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Current state of the cluster. +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -- `STATUS_UNKNOWN`: Cluster state is unknown. -- `CREATING`: Cluster is being created. -- `RUNNING`: Cluster is running normally. -- `ERROR`: Cluster encountered a problem and cannot operate. -- `UPDATING`: Cluster is being updated. -- `STOPPING`: Cluster is stopping. -- `STOPPED`: Cluster stopped. -- `STARTING`: Cluster is starting. || -|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Maintenance window for the cluster. || -|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** +in bytes. || +|| deadlockTimeout | **string** (int64) -Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || -|| securityGroupIds[] | **string** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -User security groups || -|| deletionProtection | **boolean** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| sqlInheritance | **boolean** -Deletion Protection inhibits deletion of the cluster || -|| hostGroupIds[] | **string** +This option has been removed in PostgreSQL 10. || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Host groups hosting VMs of the cluster. || -|# +in milliseconds. || +|| archiveTimeout | **string** (int64) -## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# -Monitoring system. +## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} #| ||Field | Description || -|| name | **string** +|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Name of the monitoring system. || -|| description | **string** +Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Description of the monitoring system. || -|| link | **string** +User-defined settings for a PostgreSQL 10 1C cluster. || +|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Link to the monitoring system charts for the PostgreSQL cluster. || +Default configuration for a PostgreSQL 10 1C cluster. || |# -## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} +## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || -|| version | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Version of PostgreSQL server software. || -|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** +in bytes. || +|| tempBuffers | **string** (int64) -Configuration of a PostgreSQL 9.6 server. +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -Configuration of a PostgreSQL 10 1C server. +in bytes. || +|| tempFileLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| vacuumCostDelay | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Configuration of a PostgreSQL 10 server. +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes || +|| backendFlushAfter | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -Configuration of a PostgreSQL 11 server. +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -Configuration of a PostgreSQL 11 1C server. +in bytes || +|| maxWalSize | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| minWalSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) -Configuration of a PostgreSQL 12 server. +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Configuration of a PostgreSQL 12 1C server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Configuration of a PostgreSQL 13 server. +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Configuration of a PostgreSQL 13 1C server. +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| lockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Configuration of a PostgreSQL 14 server. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -Configuration of a PostgreSQL 14 1C server. +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| deadlockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -Configuration of a PostgreSQL 15 server. +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| archiveTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -Configuration of a PostgreSQL 15 1C server. +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) -Configuration of a PostgreSQL 16 server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| onlineAnalyzeEnable | **boolean** || +|| plantunerFixEmptyTable | **boolean** || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| geqo | **boolean** -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -Configuration of a PostgreSQL 16 1C server. +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) -Configuration of the connection pooler. || -|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) -Resources allocated to PostgreSQL hosts. || -|| autofailover | **boolean** +selective pressure within the population || +|| geqoSeed | **number** (double) -Configuration setting which enables/disables autofailover in cluster. || -|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) -Time to start the daily backup, in the UTC timezone. || -|| backupRetainPeriodDays | **string** (int64) +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) -Retention policy of automated backups. || -|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -Access policy to DB || -|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -Configuration of the performance diagnostics service. || -|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. -Disk size autoscaling || +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} +## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** - -User-defined settings for a PostgreSQL 9.6 cluster. || -|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Default configuration for a PostgreSQL 9.6 cluster. || +User-defined settings for a PostgreSQL 10 cluster. || +|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** + +Default configuration for a PostgreSQL 10 cluster. || |# -## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} +## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -7215,9 +8856,7 @@ in bytes || || checkpointTimeout | **string** (int64) in milliseconds. || -|| checkpointCompletionTarget | **number** (double) - -Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointCompletionTarget | **number** (double) || || checkpointFlushAfter | **string** (int64) in bytes || @@ -7370,9 +9009,6 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** - -This option has been removed in PostgreSQL 10. || || autovacuumMaxWorkers | **string** (int64) || || autovacuumVacuumCostDelay | **string** (int64) || || autovacuumVacuumCostLimit | **string** (int64) || @@ -7383,31 +9019,139 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) + +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} +## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -User-defined settings for a PostgreSQL 10 1C cluster. || -|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +User-defined settings for a PostgreSQL 11 cluster. || +|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Default configuration for a PostgreSQL 10 1C cluster. || +Default configuration for a PostgreSQL 11 cluster. || |# -## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} +## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7425,7 +9169,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -7648,6 +9391,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -7694,8 +9446,6 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || -|| onlineAnalyzeEnable | **boolean** || -|| plantunerFixEmptyTable | **boolean** || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -7725,6 +9475,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -7744,27 +9497,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} +## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -User-defined settings for a PostgreSQL 10 cluster. || -|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +User-defined settings for a PostgreSQL 11 1C cluster. || +|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Default configuration for a PostgreSQL 10 cluster. || +Default configuration for a PostgreSQL 11 1C cluster. || |# -## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} +## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7782,7 +9535,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -7987,6 +9739,7 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || || enableBitmapscan | **boolean** || || enableHashagg | **boolean** || || enableHashjoin | **boolean** || @@ -8005,6 +9758,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8056,6 +9818,7 @@ in milliseconds. || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || || maxStackDepth | **string** (int64) in bytes. || @@ -8080,6 +9843,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -8099,23 +9865,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} +## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Effective settings for a PostgreSQL 11 cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -User-defined settings for a PostgreSQL 11 cluster. || -|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +User-defined settings for a PostgreSQL 12 cluster. || +|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Default configuration for a PostgreSQL 11 cluster. || +Default configuration for a PostgreSQL 12 cluster. || |# -## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} +## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8368,6 +10134,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8465,23 +10238,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} +## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -User-defined settings for a PostgreSQL 11 1C cluster. || -|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +User-defined settings for a PostgreSQL 12 1C cluster. || +|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Default configuration for a PostgreSQL 11 1C cluster. || +Default configuration for a PostgreSQL 12 1C cluster. || |# -## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} +## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8735,6 +10508,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8833,23 +10613,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} +## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Effective settings for a PostgreSQL 12 cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -User-defined settings for a PostgreSQL 12 cluster. || -|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +User-defined settings for a PostgreSQL 13 cluster. || +|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Default configuration for a PostgreSQL 12 cluster. || +Default configuration for a PostgreSQL 13 cluster. || |# -## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} +## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9155,6 +10935,30 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -9206,23 +11010,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} +## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -User-defined settings for a PostgreSQL 12 1C cluster. || -|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +User-defined settings for a PostgreSQL 13 1C cluster. || +|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Default configuration for a PostgreSQL 12 1C cluster. || +Default configuration for a PostgreSQL 13 1C cluster. || |# -## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} +## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9529,15 +11333,36 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || -|| maxStackDepth | **string** (int64) - -in bytes. || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -9581,23 +11406,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} +## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Effective settings for a PostgreSQL 13 cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -User-defined settings for a PostgreSQL 13 cluster. || -|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +User-defined settings for a PostgreSQL 14 cluster. || +|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Default configuration for a PostgreSQL 13 cluster. || +Default configuration for a PostgreSQL 14 cluster. || |# -## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} +## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9805,7 +11630,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -9849,7 +11673,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -9927,6 +11750,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -9978,23 +11816,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} +## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -User-defined settings for a PostgreSQL 13 1C cluster. || -|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +User-defined settings for a PostgreSQL 14 1C cluster. || +|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Default configuration for a PostgreSQL 13 1C cluster. || +Default configuration for a PostgreSQL 14 1C cluster. || |# -## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} +## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10202,7 +12040,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -10247,7 +12084,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10325,6 +12161,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10374,23 +12225,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} +## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Effective settings for a PostgreSQL 14 cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -User-defined settings for a PostgreSQL 14 cluster. || -|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +User-defined settings for a PostgreSQL 15 cluster. || +|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Default configuration for a PostgreSQL 14 cluster. || +Default configuration for a PostgreSQL 15 cluster. || |# -## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} +## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10660,7 +12511,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -10741,6 +12593,7 @@ in milliseconds. || || maxStackDepth | **string** (int64) in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -10784,23 +12637,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} +## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -User-defined settings for a PostgreSQL 14 1C cluster. || -|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +User-defined settings for a PostgreSQL 15 1C cluster. || +|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Default configuration for a PostgreSQL 14 1C cluster. || +Default configuration for a PostgreSQL 15 1C cluster. || |# -## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} +## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11071,7 +12924,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -11150,6 +13004,10 @@ in milliseconds. || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -11193,23 +13051,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} +## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Effective settings for a PostgreSQL 15 cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -User-defined settings for a PostgreSQL 15 cluster. || -|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +User-defined settings for a PostgreSQL 16 cluster. || +|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Default configuration for a PostgreSQL 15 cluster. || +Default configuration for a PostgreSQL 16 cluster. || |# -## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} +## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11295,12 +13153,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11309,6 +13167,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11323,6 +13182,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11337,6 +13197,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11508,6 +13369,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11605,23 +13467,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} +## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -User-defined settings for a PostgreSQL 15 1C cluster. || -|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +User-defined settings for a PostgreSQL 16 1C cluster. || +|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Default configuration for a PostgreSQL 15 1C cluster. || +Default configuration for a PostgreSQL 16 1C cluster. || |# -## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} +## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11707,12 +13569,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11721,6 +13583,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11735,6 +13598,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11749,6 +13613,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11921,6 +13786,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12019,27 +13885,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} +## PostgresqlConfigSet17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| effectiveConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Effective settings for a PostgreSQL 16 cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| userConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -User-defined settings for a PostgreSQL 16 cluster. || -|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Default configuration for a PostgreSQL 16 cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12081,7 +13947,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12433,29 +14298,42 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# -## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} +## PostgresqlConfigSet17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| effectiveConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| userConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -User-defined settings for a PostgreSQL 16 1C cluster. || -|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Default configuration for a PostgreSQL 16 1C cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12497,7 +14375,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12851,6 +14728,19 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# ## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig} diff --git a/en/managed-postgresql/api-ref/Cluster/listHosts.md b/en/managed-postgresql/api-ref/Cluster/listHosts.md index 651a0f906cf..7fca65f5ea6 100644 --- a/en/managed-postgresql/api-ref/Cluster/listHosts.md +++ b/en/managed-postgresql/api-ref/Cluster/listHosts.md @@ -66,7 +66,7 @@ returned by the previous list request. || "replicationSource": "string", "priority": "string", "config": { - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", @@ -1085,6 +1085,140 @@ returned by the previous list request. || "timezone": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" + }, + "postgresqlConfig_17": { + "recoveryMinApplyDelay": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "workMem": "string", + "tempFileLimit": "string", + "backendFlushAfter": "string", + "maxStandbyStreamingDelay": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + }, + "postgresqlConfig_17_1c": { + "recoveryMinApplyDelay": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "workMem": "string", + "tempFileLimit": "string", + "backendFlushAfter": "string", + "maxStandbyStreamingDelay": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" } // end of the list of possible fields }, @@ -1224,105 +1358,119 @@ Aggregated health of the service. If the field has default value, it is not retu Configuration for a host with PostgreSQL 9.6 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_10_1c | **[PostgresqlHostConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C)** Configuration for a host with PostgreSQL 10 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_10 | **[PostgresqlHostConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10)** Configuration for a host with PostgreSQL 10 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_11 | **[PostgresqlHostConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11)** Configuration for a host with PostgreSQL 11 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_11_1c | **[PostgresqlHostConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C)** Configuration for a host with PostgreSQL 11 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_12 | **[PostgresqlHostConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12)** Configuration for a host with PostgreSQL 12 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_12_1c | **[PostgresqlHostConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C)** Configuration for a host with PostgreSQL 12 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_13 | **[PostgresqlHostConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13)** Configuration for a host with PostgreSQL 13 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_13_1c | **[PostgresqlHostConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C)** Configuration for a host with PostgreSQL 13 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_14 | **[PostgresqlHostConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14)** Configuration for a host with PostgreSQL 14 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_14_1c | **[PostgresqlHostConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C)** Configuration for a host with PostgreSQL 14 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_15 | **[PostgresqlHostConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15)** Configuration for a host with PostgreSQL 15 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_15_1c | **[PostgresqlHostConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C)** Configuration for a host with PostgreSQL 15 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_16 | **[PostgresqlHostConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16)** Configuration for a host with PostgreSQL 16 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_16_1c | **[PostgresqlHostConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C)** Configuration for a host with PostgreSQL 16 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL server for the host. || +|| postgresqlConfig_17 | **[PostgresqlHostConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17)** + +Configuration for a host with PostgreSQL 17 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL server for the host. || +|| postgresqlConfig_17_1c | **[PostgresqlHostConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || |# @@ -4067,6 +4215,378 @@ in milliseconds. || || arrayNulls | **boolean** || || backslashQuote | **enum** (BackslashQuote) +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# + +## PostgresqlHostConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). + +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| workMem | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| debugParallelQuery | **enum** (DebugParallelQuery) + +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# + +## PostgresqlHostConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). + +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| workMem | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| debugParallelQuery | **enum** (DebugParallelQuery) + +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + - `BACKSLASH_QUOTE_UNSPECIFIED` - `BACKSLASH_QUOTE` - `BACKSLASH_QUOTE_ON` diff --git a/en/managed-postgresql/api-ref/Cluster/move.md b/en/managed-postgresql/api-ref/Cluster/move.md index e546afcc2f3..197c68ff3af 100644 --- a/en/managed-postgresql/api-ref/Cluster/move.md +++ b/en/managed-postgresql/api-ref/Cluster/move.md @@ -79,7 +79,7 @@ Required field. ID of the destination folder. || ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "effectiveConfig": { "maxConnections": "string", @@ -6827,6 +6827,1024 @@ Required field. ID of the destination folder. || "passwordEncryption": "string" } }, + "postgresqlConfig_17": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, + "postgresqlConfig_17_1c": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, // end of the list of possible fields "poolerConfig": { "poolingMode": "string", @@ -6891,373 +7909,996 @@ Required field. ID of the destination folder. || } ``` -An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). +An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). + +#| +||Field | Description || +|| id | **string** + +ID of the operation. || +|| description | **string** + +Description of the operation. 0-256 characters long. || +|| createdAt | **string** (date-time) + +Creation timestamp. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| createdBy | **string** + +ID of the user or service account who initiated the operation. || +|| modifiedAt | **string** (date-time) + +The time when the Operation resource was last modified. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| done | **boolean** + +If the value is `false`, it means the operation is still in progress. +If `true`, the operation is completed, and either `error` or `response` is available. || +|| metadata | **[MoveClusterMetadata](#yandex.cloud.mdb.postgresql.v1.MoveClusterMetadata)** + +Service-specific metadata associated with the operation. +It typically contains the ID of the target resource that the operation is performed on. +Any method that returns a long-running operation should document the metadata type, if any. || +|| error | **[Status](#google.rpc.Status)** + +The error result of the operation in case of failure or cancellation. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** + +The normal response of the operation in case of success. +If the original method returns no data on success, such as Delete, +the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). +If the original method is the standard Create/Update, +the response should be the target resource of the operation. +Any method that returns a long-running operation should document the response type, if any. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|# + +## MoveClusterMetadata {#yandex.cloud.mdb.postgresql.v1.MoveClusterMetadata} + +#| +||Field | Description || +|| clusterId | **string** + +ID of the PostgreSQL cluster being moved. || +|| sourceFolderId | **string** + +ID of the source folder. || +|| destinationFolderId | **string** + +ID of the destnation folder. || +|# + +## Status {#google.rpc.Status} + +The error result of the operation in case of failure or cancellation. + +#| +||Field | Description || +|| code | **integer** (int32) + +Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || +|| message | **string** + +An error message. || +|| details[] | **object** + +A list of messages that carry the error details. || +|# + +## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} + +A PostgreSQL Cluster resource. For more information, see +the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. + +#| +||Field | Description || +|| id | **string** + +ID of the PostgreSQL cluster. +This ID is assigned by MDB at creation time. || +|| folderId | **string** + +ID of the folder that the PostgreSQL cluster belongs to. || +|| createdAt | **string** (date-time) + +Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| name | **string** + +Name of the PostgreSQL cluster. +The name is unique within the folder. 1-63 characters long. || +|| description | **string** + +Description of the PostgreSQL cluster. 0-256 characters long. || +|| labels | **string** + +Custom labels for the PostgreSQL cluster as `` key:value `` pairs. +Maximum 64 per resource. || +|| environment | **enum** (Environment) + +Deployment environment of the PostgreSQL cluster. + +- `ENVIRONMENT_UNSPECIFIED` +- `PRODUCTION`: Stable environment with a conservative update policy: +only hotfixes are applied during regular maintenance. +- `PRESTABLE`: Environment with more aggressive update policy: new versions +are rolled out irrespective of backward compatibility. || +|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** + +Description of monitoring systems relevant to the PostgreSQL cluster. || +|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** + +Configuration of the PostgreSQL cluster. || +|| networkId | **string** + +ID of the network that the cluster belongs to. || +|| health | **enum** (Health) + +Aggregated cluster health. + +- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). +- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). +- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). +- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || +|| status | **enum** (Status) + +Current state of the cluster. + +- `STATUS_UNKNOWN`: Cluster state is unknown. +- `CREATING`: Cluster is being created. +- `RUNNING`: Cluster is running normally. +- `ERROR`: Cluster encountered a problem and cannot operate. +- `UPDATING`: Cluster is being updated. +- `STOPPING`: Cluster is stopping. +- `STOPPED`: Cluster stopped. +- `STARTING`: Cluster is starting. || +|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** + +Maintenance window for the cluster. || +|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** + +Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || +|| securityGroupIds[] | **string** + +User security groups || +|| deletionProtection | **boolean** + +Deletion Protection inhibits deletion of the cluster || +|| hostGroupIds[] | **string** + +Host groups hosting VMs of the cluster. || +|# + +## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} + +Monitoring system. + +#| +||Field | Description || +|| name | **string** + +Name of the monitoring system. || +|| description | **string** + +Description of the monitoring system. || +|| link | **string** + +Link to the monitoring system charts for the PostgreSQL cluster. || +|# + +## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} + +#| +||Field | Description || +|| version | **string** + +Version of PostgreSQL server software. || +|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** + +Configuration of a PostgreSQL 9.6 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** + +Configuration of a PostgreSQL 10 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** + +Configuration of a PostgreSQL 10 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** + +Configuration of a PostgreSQL 11 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** + +Configuration of a PostgreSQL 11 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** + +Configuration of a PostgreSQL 12 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** + +Configuration of a PostgreSQL 12 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** + +Configuration of a PostgreSQL 13 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** + +Configuration of a PostgreSQL 13 1C server. -#| -||Field | Description || -|| id | **string** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -ID of the operation. || -|| description | **string** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** -Description of the operation. 0-256 characters long. || -|| createdAt | **string** (date-time) +Configuration of a PostgreSQL 14 server. -Creation timestamp. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| createdBy | **string** +Configuration of a PostgreSQL 14 1C server. -ID of the user or service account who initiated the operation. || -|| modifiedAt | **string** (date-time) +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The time when the Operation resource was last modified. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Configuration of a PostgreSQL 15 server. -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| done | **boolean** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -If the value is `false`, it means the operation is still in progress. -If `true`, the operation is completed, and either `error` or `response` is available. || -|| metadata | **[MoveClusterMetadata](#yandex.cloud.mdb.postgresql.v1.MoveClusterMetadata)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** -Service-specific metadata associated with the operation. -It typically contains the ID of the target resource that the operation is performed on. -Any method that returns a long-running operation should document the metadata type, if any. || -|| error | **[Status](#google.rpc.Status)** +Configuration of a PostgreSQL 15 1C server. -The error result of the operation in case of failure or cancellation. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Includes only one of the fields `error`, `response`. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || -|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** +Configuration of a PostgreSQL 16 server. -The normal response of the operation in case of success. -If the original method returns no data on success, such as Delete, -the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). -If the original method is the standard Create/Update, -the response should be the target resource of the operation. -Any method that returns a long-running operation should document the response type, if any. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Includes only one of the fields `error`, `response`. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || +Configuration of a PostgreSQL 16 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfigSet17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfigSet17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** + +Configuration of the connection pooler. || +|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** + +Resources allocated to PostgreSQL hosts. || +|| autofailover | **boolean** + +Configuration setting which enables/disables autofailover in cluster. || +|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** + +Time to start the daily backup, in the UTC timezone. || +|| backupRetainPeriodDays | **string** (int64) + +Retention policy of automated backups. || +|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** + +Access policy to DB || +|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** + +Configuration of the performance diagnostics service. || +|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** + +Disk size autoscaling || |# -## MoveClusterMetadata {#yandex.cloud.mdb.postgresql.v1.MoveClusterMetadata} +## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} #| ||Field | Description || -|| clusterId | **string** +|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -ID of the PostgreSQL cluster being moved. || -|| sourceFolderId | **string** +Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -ID of the source folder. || -|| destinationFolderId | **string** +User-defined settings for a PostgreSQL 9.6 cluster. || +|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -ID of the destnation folder. || +Default configuration for a PostgreSQL 9.6 cluster. || |# -## Status {#google.rpc.Status} +## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} -The error result of the operation in case of failure or cancellation. +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). #| ||Field | Description || -|| code | **integer** (int32) +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || -|| message | **string** +in bytes. || +|| tempBuffers | **string** (int64) -An error message. || -|| details[] | **object** +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -A list of messages that carry the error details. || -|# +in bytes. || +|| maintenanceWorkMem | **string** (int64) -## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -A PostgreSQL Cluster resource. For more information, see -the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. +in bytes. || +|| tempFileLimit | **string** (int64) -#| -||Field | Description || -|| id | **string** +in bytes. || +|| vacuumCostDelay | **string** (int64) -ID of the PostgreSQL cluster. -This ID is assigned by MDB at creation time. || -|| folderId | **string** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -ID of the folder that the PostgreSQL cluster belongs to. || -|| createdAt | **string** (date-time) +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. +in bytes || +|| backendFlushAfter | **string** (int64) -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| name | **string** +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Name of the PostgreSQL cluster. -The name is unique within the folder. 1-63 characters long. || -|| description | **string** +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) + +Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Description of the PostgreSQL cluster. 0-256 characters long. || -|| labels | **string** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Custom labels for the PostgreSQL cluster as `` key:value `` pairs. -Maximum 64 per resource. || -|| environment | **enum** (Environment) +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Deployment environment of the PostgreSQL cluster. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -- `ENVIRONMENT_UNSPECIFIED` -- `PRODUCTION`: Stable environment with a conservative update policy: -only hotfixes are applied during regular maintenance. -- `PRESTABLE`: Environment with more aggressive update policy: new versions -are rolled out irrespective of backward compatibility. || -|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Description of monitoring systems relevant to the PostgreSQL cluster. || -|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Configuration of the PostgreSQL cluster. || -|| networkId | **string** +in milliseconds. || +|| lockTimeout | **string** (int64) -ID of the network that the cluster belongs to. || -|| health | **enum** (Health) +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Aggregated cluster health. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). -- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). -- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). -- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || -|| status | **enum** (Status) +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Current state of the cluster. +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -- `STATUS_UNKNOWN`: Cluster state is unknown. -- `CREATING`: Cluster is being created. -- `RUNNING`: Cluster is running normally. -- `ERROR`: Cluster encountered a problem and cannot operate. -- `UPDATING`: Cluster is being updated. -- `STOPPING`: Cluster is stopping. -- `STOPPED`: Cluster stopped. -- `STARTING`: Cluster is starting. || -|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Maintenance window for the cluster. || -|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** +in bytes. || +|| deadlockTimeout | **string** (int64) -Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || -|| securityGroupIds[] | **string** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -User security groups || -|| deletionProtection | **boolean** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| sqlInheritance | **boolean** -Deletion Protection inhibits deletion of the cluster || -|| hostGroupIds[] | **string** +This option has been removed in PostgreSQL 10. || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Host groups hosting VMs of the cluster. || -|# +in milliseconds. || +|| archiveTimeout | **string** (int64) -## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# -Monitoring system. +## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} #| ||Field | Description || -|| name | **string** +|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Name of the monitoring system. || -|| description | **string** +Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Description of the monitoring system. || -|| link | **string** +User-defined settings for a PostgreSQL 10 1C cluster. || +|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Link to the monitoring system charts for the PostgreSQL cluster. || +Default configuration for a PostgreSQL 10 1C cluster. || |# -## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} +## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || -|| version | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Version of PostgreSQL server software. || -|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** +in bytes. || +|| tempBuffers | **string** (int64) -Configuration of a PostgreSQL 9.6 server. +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -Configuration of a PostgreSQL 10 1C server. +in bytes. || +|| tempFileLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| vacuumCostDelay | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Configuration of a PostgreSQL 10 server. +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes || +|| backendFlushAfter | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -Configuration of a PostgreSQL 11 server. +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -Configuration of a PostgreSQL 11 1C server. +in bytes || +|| maxWalSize | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| minWalSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) -Configuration of a PostgreSQL 12 server. +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Configuration of a PostgreSQL 12 1C server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Configuration of a PostgreSQL 13 server. +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Configuration of a PostgreSQL 13 1C server. +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| lockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Configuration of a PostgreSQL 14 server. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -Configuration of a PostgreSQL 14 1C server. +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| deadlockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -Configuration of a PostgreSQL 15 server. +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| archiveTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -Configuration of a PostgreSQL 15 1C server. +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) -Configuration of a PostgreSQL 16 server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| onlineAnalyzeEnable | **boolean** || +|| plantunerFixEmptyTable | **boolean** || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| geqo | **boolean** -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -Configuration of a PostgreSQL 16 1C server. +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) -Configuration of the connection pooler. || -|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) -Resources allocated to PostgreSQL hosts. || -|| autofailover | **boolean** +selective pressure within the population || +|| geqoSeed | **number** (double) -Configuration setting which enables/disables autofailover in cluster. || -|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) -Time to start the daily backup, in the UTC timezone. || -|| backupRetainPeriodDays | **string** (int64) +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) -Retention policy of automated backups. || -|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -Access policy to DB || -|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -Configuration of the performance diagnostics service. || -|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. -Disk size autoscaling || +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} +## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** - -User-defined settings for a PostgreSQL 9.6 cluster. || -|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Default configuration for a PostgreSQL 9.6 cluster. || +User-defined settings for a PostgreSQL 10 cluster. || +|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** + +Default configuration for a PostgreSQL 10 cluster. || |# -## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} +## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -7317,9 +8958,7 @@ in bytes || || checkpointTimeout | **string** (int64) in milliseconds. || -|| checkpointCompletionTarget | **number** (double) - -Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointCompletionTarget | **number** (double) || || checkpointFlushAfter | **string** (int64) in bytes || @@ -7472,9 +9111,6 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** - -This option has been removed in PostgreSQL 10. || || autovacuumMaxWorkers | **string** (int64) || || autovacuumVacuumCostDelay | **string** (int64) || || autovacuumVacuumCostLimit | **string** (int64) || @@ -7485,31 +9121,139 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) + +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} +## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -User-defined settings for a PostgreSQL 10 1C cluster. || -|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +User-defined settings for a PostgreSQL 11 cluster. || +|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Default configuration for a PostgreSQL 10 1C cluster. || +Default configuration for a PostgreSQL 11 cluster. || |# -## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} +## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7527,7 +9271,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -7750,6 +9493,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -7796,8 +9548,6 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || -|| onlineAnalyzeEnable | **boolean** || -|| plantunerFixEmptyTable | **boolean** || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -7827,6 +9577,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -7846,27 +9599,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} +## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -User-defined settings for a PostgreSQL 10 cluster. || -|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +User-defined settings for a PostgreSQL 11 1C cluster. || +|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Default configuration for a PostgreSQL 10 cluster. || +Default configuration for a PostgreSQL 11 1C cluster. || |# -## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} +## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7884,7 +9637,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -8089,6 +9841,7 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || || enableBitmapscan | **boolean** || || enableHashagg | **boolean** || || enableHashjoin | **boolean** || @@ -8107,6 +9860,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8158,6 +9920,7 @@ in milliseconds. || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || || maxStackDepth | **string** (int64) in bytes. || @@ -8182,6 +9945,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -8201,23 +9967,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} +## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Effective settings for a PostgreSQL 11 cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -User-defined settings for a PostgreSQL 11 cluster. || -|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +User-defined settings for a PostgreSQL 12 cluster. || +|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Default configuration for a PostgreSQL 11 cluster. || +Default configuration for a PostgreSQL 12 cluster. || |# -## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} +## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8470,6 +10236,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8567,23 +10340,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} +## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -User-defined settings for a PostgreSQL 11 1C cluster. || -|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +User-defined settings for a PostgreSQL 12 1C cluster. || +|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Default configuration for a PostgreSQL 11 1C cluster. || +Default configuration for a PostgreSQL 12 1C cluster. || |# -## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} +## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8837,6 +10610,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8935,23 +10715,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} +## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Effective settings for a PostgreSQL 12 cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -User-defined settings for a PostgreSQL 12 cluster. || -|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +User-defined settings for a PostgreSQL 13 cluster. || +|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Default configuration for a PostgreSQL 12 cluster. || +Default configuration for a PostgreSQL 13 cluster. || |# -## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} +## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9257,6 +11037,30 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -9308,23 +11112,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} +## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -User-defined settings for a PostgreSQL 12 1C cluster. || -|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +User-defined settings for a PostgreSQL 13 1C cluster. || +|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Default configuration for a PostgreSQL 12 1C cluster. || +Default configuration for a PostgreSQL 13 1C cluster. || |# -## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} +## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9631,15 +11435,36 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || -|| maxStackDepth | **string** (int64) - -in bytes. || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -9683,23 +11508,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} +## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Effective settings for a PostgreSQL 13 cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -User-defined settings for a PostgreSQL 13 cluster. || -|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +User-defined settings for a PostgreSQL 14 cluster. || +|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Default configuration for a PostgreSQL 13 cluster. || +Default configuration for a PostgreSQL 14 cluster. || |# -## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} +## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9907,7 +11732,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -9951,7 +11775,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10029,6 +11852,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10080,23 +11918,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} +## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -User-defined settings for a PostgreSQL 13 1C cluster. || -|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +User-defined settings for a PostgreSQL 14 1C cluster. || +|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Default configuration for a PostgreSQL 13 1C cluster. || +Default configuration for a PostgreSQL 14 1C cluster. || |# -## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} +## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10304,7 +12142,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -10349,7 +12186,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10427,6 +12263,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10476,23 +12327,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} +## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Effective settings for a PostgreSQL 14 cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -User-defined settings for a PostgreSQL 14 cluster. || -|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +User-defined settings for a PostgreSQL 15 cluster. || +|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Default configuration for a PostgreSQL 14 cluster. || +Default configuration for a PostgreSQL 15 cluster. || |# -## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} +## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10762,7 +12613,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -10843,6 +12695,7 @@ in milliseconds. || || maxStackDepth | **string** (int64) in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -10886,23 +12739,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} +## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -User-defined settings for a PostgreSQL 14 1C cluster. || -|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +User-defined settings for a PostgreSQL 15 1C cluster. || +|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Default configuration for a PostgreSQL 14 1C cluster. || +Default configuration for a PostgreSQL 15 1C cluster. || |# -## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} +## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11173,7 +13026,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -11252,6 +13106,10 @@ in milliseconds. || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -11295,23 +13153,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} +## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Effective settings for a PostgreSQL 15 cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -User-defined settings for a PostgreSQL 15 cluster. || -|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +User-defined settings for a PostgreSQL 16 cluster. || +|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Default configuration for a PostgreSQL 15 cluster. || +Default configuration for a PostgreSQL 16 cluster. || |# -## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} +## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11397,12 +13255,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11411,6 +13269,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11425,6 +13284,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11439,6 +13299,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11610,6 +13471,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11707,23 +13569,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} +## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -User-defined settings for a PostgreSQL 15 1C cluster. || -|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +User-defined settings for a PostgreSQL 16 1C cluster. || +|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Default configuration for a PostgreSQL 15 1C cluster. || +Default configuration for a PostgreSQL 16 1C cluster. || |# -## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} +## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11809,12 +13671,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11823,6 +13685,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11837,6 +13700,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11851,6 +13715,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12023,6 +13888,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12121,27 +13987,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} +## PostgresqlConfigSet17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| effectiveConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Effective settings for a PostgreSQL 16 cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| userConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -User-defined settings for a PostgreSQL 16 cluster. || -|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Default configuration for a PostgreSQL 16 cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12183,7 +14049,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12535,29 +14400,42 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# -## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} +## PostgresqlConfigSet17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| effectiveConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| userConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -User-defined settings for a PostgreSQL 16 1C cluster. || -|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Default configuration for a PostgreSQL 16 1C cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12599,7 +14477,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12953,6 +14830,19 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# ## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig} diff --git a/en/managed-postgresql/api-ref/Cluster/rescheduleMaintenance.md b/en/managed-postgresql/api-ref/Cluster/rescheduleMaintenance.md index 5ad54f040a4..ec356370321 100644 --- a/en/managed-postgresql/api-ref/Cluster/rescheduleMaintenance.md +++ b/en/managed-postgresql/api-ref/Cluster/rescheduleMaintenance.md @@ -94,7 +94,7 @@ In some languages, built-in datetime utilities do not support nanosecond precisi ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "effectiveConfig": { "maxConnections": "string", @@ -6842,6 +6842,1024 @@ In some languages, built-in datetime utilities do not support nanosecond precisi "passwordEncryption": "string" } }, + "postgresqlConfig_17": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, + "postgresqlConfig_17_1c": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, // end of the list of possible fields "poolerConfig": { "poolingMode": "string", @@ -6906,379 +7924,1002 @@ In some languages, built-in datetime utilities do not support nanosecond precisi } ``` -An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). +An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). + +#| +||Field | Description || +|| id | **string** + +ID of the operation. || +|| description | **string** + +Description of the operation. 0-256 characters long. || +|| createdAt | **string** (date-time) + +Creation timestamp. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| createdBy | **string** + +ID of the user or service account who initiated the operation. || +|| modifiedAt | **string** (date-time) + +The time when the Operation resource was last modified. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| done | **boolean** + +If the value is `false`, it means the operation is still in progress. +If `true`, the operation is completed, and either `error` or `response` is available. || +|| metadata | **[RescheduleMaintenanceMetadata](#yandex.cloud.mdb.postgresql.v1.RescheduleMaintenanceMetadata)** + +Service-specific metadata associated with the operation. +It typically contains the ID of the target resource that the operation is performed on. +Any method that returns a long-running operation should document the metadata type, if any. || +|| error | **[Status](#google.rpc.Status)** + +The error result of the operation in case of failure or cancellation. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** + +The normal response of the operation in case of success. +If the original method returns no data on success, such as Delete, +the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). +If the original method is the standard Create/Update, +the response should be the target resource of the operation. +Any method that returns a long-running operation should document the response type, if any. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|# + +## RescheduleMaintenanceMetadata {#yandex.cloud.mdb.postgresql.v1.RescheduleMaintenanceMetadata} + +Rescheduled maintenance operation metadata. + +#| +||Field | Description || +|| clusterId | **string** + +Required. ID of the PostgreSQL cluster. || +|| delayedUntil | **string** (date-time) + +Required. The time until which this maintenance operation is to be delayed. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|# + +## Status {#google.rpc.Status} + +The error result of the operation in case of failure or cancellation. + +#| +||Field | Description || +|| code | **integer** (int32) + +Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || +|| message | **string** + +An error message. || +|| details[] | **object** + +A list of messages that carry the error details. || +|# + +## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} + +A PostgreSQL Cluster resource. For more information, see +the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. + +#| +||Field | Description || +|| id | **string** + +ID of the PostgreSQL cluster. +This ID is assigned by MDB at creation time. || +|| folderId | **string** + +ID of the folder that the PostgreSQL cluster belongs to. || +|| createdAt | **string** (date-time) + +Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| name | **string** + +Name of the PostgreSQL cluster. +The name is unique within the folder. 1-63 characters long. || +|| description | **string** + +Description of the PostgreSQL cluster. 0-256 characters long. || +|| labels | **string** + +Custom labels for the PostgreSQL cluster as `` key:value `` pairs. +Maximum 64 per resource. || +|| environment | **enum** (Environment) + +Deployment environment of the PostgreSQL cluster. + +- `ENVIRONMENT_UNSPECIFIED` +- `PRODUCTION`: Stable environment with a conservative update policy: +only hotfixes are applied during regular maintenance. +- `PRESTABLE`: Environment with more aggressive update policy: new versions +are rolled out irrespective of backward compatibility. || +|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** + +Description of monitoring systems relevant to the PostgreSQL cluster. || +|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** + +Configuration of the PostgreSQL cluster. || +|| networkId | **string** + +ID of the network that the cluster belongs to. || +|| health | **enum** (Health) + +Aggregated cluster health. + +- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). +- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). +- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). +- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || +|| status | **enum** (Status) + +Current state of the cluster. + +- `STATUS_UNKNOWN`: Cluster state is unknown. +- `CREATING`: Cluster is being created. +- `RUNNING`: Cluster is running normally. +- `ERROR`: Cluster encountered a problem and cannot operate. +- `UPDATING`: Cluster is being updated. +- `STOPPING`: Cluster is stopping. +- `STOPPED`: Cluster stopped. +- `STARTING`: Cluster is starting. || +|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** + +Maintenance window for the cluster. || +|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** + +Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || +|| securityGroupIds[] | **string** + +User security groups || +|| deletionProtection | **boolean** + +Deletion Protection inhibits deletion of the cluster || +|| hostGroupIds[] | **string** + +Host groups hosting VMs of the cluster. || +|# + +## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} + +Monitoring system. + +#| +||Field | Description || +|| name | **string** + +Name of the monitoring system. || +|| description | **string** + +Description of the monitoring system. || +|| link | **string** + +Link to the monitoring system charts for the PostgreSQL cluster. || +|# + +## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} + +#| +||Field | Description || +|| version | **string** + +Version of PostgreSQL server software. || +|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** + +Configuration of a PostgreSQL 9.6 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** + +Configuration of a PostgreSQL 10 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** + +Configuration of a PostgreSQL 10 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** + +Configuration of a PostgreSQL 11 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** + +Configuration of a PostgreSQL 11 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** + +Configuration of a PostgreSQL 12 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** + +Configuration of a PostgreSQL 12 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** + +Configuration of a PostgreSQL 13 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** + +Configuration of a PostgreSQL 13 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** -#| -||Field | Description || -|| id | **string** +Configuration of a PostgreSQL 14 server. -ID of the operation. || -|| description | **string** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Description of the operation. 0-256 characters long. || -|| createdAt | **string** (date-time) +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** -Creation timestamp. +Configuration of a PostgreSQL 14 1C server. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| createdBy | **string** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** -ID of the user or service account who initiated the operation. || -|| modifiedAt | **string** (date-time) +Configuration of a PostgreSQL 15 server. -The time when the Operation resource was last modified. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| done | **boolean** +Configuration of a PostgreSQL 15 1C server. -If the value is `false`, it means the operation is still in progress. -If `true`, the operation is completed, and either `error` or `response` is available. || -|| metadata | **[RescheduleMaintenanceMetadata](#yandex.cloud.mdb.postgresql.v1.RescheduleMaintenanceMetadata)** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Service-specific metadata associated with the operation. -It typically contains the ID of the target resource that the operation is performed on. -Any method that returns a long-running operation should document the metadata type, if any. || -|| error | **[Status](#google.rpc.Status)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** -The error result of the operation in case of failure or cancellation. +Configuration of a PostgreSQL 16 server. -Includes only one of the fields `error`, `response`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || -|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** -The normal response of the operation in case of success. -If the original method returns no data on success, such as Delete, -the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). -If the original method is the standard Create/Update, -the response should be the target resource of the operation. -Any method that returns a long-running operation should document the response type, if any. +Configuration of a PostgreSQL 16 1C server. -Includes only one of the fields `error`, `response`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || -|# +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfigSet17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17)** -## RescheduleMaintenanceMetadata {#yandex.cloud.mdb.postgresql.v1.RescheduleMaintenanceMetadata} +Configuration of a PostgreSQL 17 server. -Rescheduled maintenance operation metadata. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -#| -||Field | Description || -|| clusterId | **string** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfigSet17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C)** -Required. ID of the PostgreSQL cluster. || -|| delayedUntil | **string** (date-time) +Configuration of a PostgreSQL 17 1C server. -Required. The time until which this maintenance operation is to be delayed. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Configuration for PostgreSQL servers in the cluster. || +|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|# +Configuration of the connection pooler. || +|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** -## Status {#google.rpc.Status} +Resources allocated to PostgreSQL hosts. || +|| autofailover | **boolean** -The error result of the operation in case of failure or cancellation. +Configuration setting which enables/disables autofailover in cluster. || +|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** + +Time to start the daily backup, in the UTC timezone. || +|| backupRetainPeriodDays | **string** (int64) + +Retention policy of automated backups. || +|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** + +Access policy to DB || +|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** + +Configuration of the performance diagnostics service. || +|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** + +Disk size autoscaling || +|# + +## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} #| ||Field | Description || -|| code | **integer** (int32) +|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || -|| message | **string** +Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -An error message. || -|| details[] | **object** +User-defined settings for a PostgreSQL 9.6 cluster. || +|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -A list of messages that carry the error details. || +Default configuration for a PostgreSQL 9.6 cluster. || |# -## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} +## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} -A PostgreSQL Cluster resource. For more information, see -the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). #| ||Field | Description || -|| id | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -ID of the PostgreSQL cluster. -This ID is assigned by MDB at creation time. || -|| folderId | **string** +in bytes. || +|| tempBuffers | **string** (int64) -ID of the folder that the PostgreSQL cluster belongs to. || -|| createdAt | **string** (date-time) +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| name | **string** +in bytes. || +|| tempFileLimit | **string** (int64) -Name of the PostgreSQL cluster. -The name is unique within the folder. 1-63 characters long. || -|| description | **string** +in bytes. || +|| vacuumCostDelay | **string** (int64) + +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) + +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) + +in bytes || +|| backendFlushAfter | **string** (int64) + +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) + +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) + +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) + +Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Description of the PostgreSQL cluster. 0-256 characters long. || -|| labels | **string** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Custom labels for the PostgreSQL cluster as `` key:value `` pairs. -Maximum 64 per resource. || -|| environment | **enum** (Environment) +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Deployment environment of the PostgreSQL cluster. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -- `ENVIRONMENT_UNSPECIFIED` -- `PRODUCTION`: Stable environment with a conservative update policy: -only hotfixes are applied during regular maintenance. -- `PRESTABLE`: Environment with more aggressive update policy: new versions -are rolled out irrespective of backward compatibility. || -|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Description of monitoring systems relevant to the PostgreSQL cluster. || -|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Configuration of the PostgreSQL cluster. || -|| networkId | **string** +in milliseconds. || +|| lockTimeout | **string** (int64) -ID of the network that the cluster belongs to. || -|| health | **enum** (Health) +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Aggregated cluster health. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). -- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). -- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). -- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || -|| status | **enum** (Status) +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Current state of the cluster. +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -- `STATUS_UNKNOWN`: Cluster state is unknown. -- `CREATING`: Cluster is being created. -- `RUNNING`: Cluster is running normally. -- `ERROR`: Cluster encountered a problem and cannot operate. -- `UPDATING`: Cluster is being updated. -- `STOPPING`: Cluster is stopping. -- `STOPPED`: Cluster stopped. -- `STARTING`: Cluster is starting. || -|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Maintenance window for the cluster. || -|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** +in bytes. || +|| deadlockTimeout | **string** (int64) -Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || -|| securityGroupIds[] | **string** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -User security groups || -|| deletionProtection | **boolean** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| sqlInheritance | **boolean** -Deletion Protection inhibits deletion of the cluster || -|| hostGroupIds[] | **string** +This option has been removed in PostgreSQL 10. || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Host groups hosting VMs of the cluster. || -|# +in milliseconds. || +|| archiveTimeout | **string** (int64) -## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# -Monitoring system. +## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} #| ||Field | Description || -|| name | **string** +|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Name of the monitoring system. || -|| description | **string** +Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Description of the monitoring system. || -|| link | **string** +User-defined settings for a PostgreSQL 10 1C cluster. || +|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Link to the monitoring system charts for the PostgreSQL cluster. || +Default configuration for a PostgreSQL 10 1C cluster. || |# -## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} +## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || -|| version | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Version of PostgreSQL server software. || -|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** +in bytes. || +|| tempBuffers | **string** (int64) -Configuration of a PostgreSQL 9.6 server. +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -Configuration of a PostgreSQL 10 1C server. +in bytes. || +|| tempFileLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| vacuumCostDelay | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Configuration of a PostgreSQL 10 server. +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes || +|| backendFlushAfter | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -Configuration of a PostgreSQL 11 server. +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -Configuration of a PostgreSQL 11 1C server. +in bytes || +|| maxWalSize | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| minWalSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) -Configuration of a PostgreSQL 12 server. +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Configuration of a PostgreSQL 12 1C server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Configuration of a PostgreSQL 13 server. +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Configuration of a PostgreSQL 13 1C server. +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| lockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Configuration of a PostgreSQL 14 server. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -Configuration of a PostgreSQL 14 1C server. +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| deadlockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -Configuration of a PostgreSQL 15 server. +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| archiveTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -Configuration of a PostgreSQL 15 1C server. +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) -Configuration of a PostgreSQL 16 server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| onlineAnalyzeEnable | **boolean** || +|| plantunerFixEmptyTable | **boolean** || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| geqo | **boolean** -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -Configuration of a PostgreSQL 16 1C server. +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) -Configuration of the connection pooler. || -|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) -Resources allocated to PostgreSQL hosts. || -|| autofailover | **boolean** +selective pressure within the population || +|| geqoSeed | **number** (double) -Configuration setting which enables/disables autofailover in cluster. || -|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) -Time to start the daily backup, in the UTC timezone. || -|| backupRetainPeriodDays | **string** (int64) +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) -Retention policy of automated backups. || -|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -Access policy to DB || -|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -Configuration of the performance diagnostics service. || -|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. -Disk size autoscaling || +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} +## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** - -User-defined settings for a PostgreSQL 9.6 cluster. || -|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Default configuration for a PostgreSQL 9.6 cluster. || +User-defined settings for a PostgreSQL 10 cluster. || +|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** + +Default configuration for a PostgreSQL 10 cluster. || |# -## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} +## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -7338,9 +8979,7 @@ in bytes || || checkpointTimeout | **string** (int64) in milliseconds. || -|| checkpointCompletionTarget | **number** (double) - -Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointCompletionTarget | **number** (double) || || checkpointFlushAfter | **string** (int64) in bytes || @@ -7493,9 +9132,6 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** - -This option has been removed in PostgreSQL 10. || || autovacuumMaxWorkers | **string** (int64) || || autovacuumVacuumCostDelay | **string** (int64) || || autovacuumVacuumCostLimit | **string** (int64) || @@ -7506,31 +9142,139 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) + +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} +## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -User-defined settings for a PostgreSQL 10 1C cluster. || -|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +User-defined settings for a PostgreSQL 11 cluster. || +|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Default configuration for a PostgreSQL 10 1C cluster. || +Default configuration for a PostgreSQL 11 cluster. || |# -## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} +## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7548,7 +9292,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -7771,6 +9514,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -7817,8 +9569,6 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || -|| onlineAnalyzeEnable | **boolean** || -|| plantunerFixEmptyTable | **boolean** || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -7848,6 +9598,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -7867,27 +9620,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} +## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -User-defined settings for a PostgreSQL 10 cluster. || -|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +User-defined settings for a PostgreSQL 11 1C cluster. || +|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Default configuration for a PostgreSQL 10 cluster. || +Default configuration for a PostgreSQL 11 1C cluster. || |# -## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} +## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7905,7 +9658,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -8110,6 +9862,7 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || || enableBitmapscan | **boolean** || || enableHashagg | **boolean** || || enableHashjoin | **boolean** || @@ -8128,6 +9881,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8179,6 +9941,7 @@ in milliseconds. || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || || maxStackDepth | **string** (int64) in bytes. || @@ -8203,6 +9966,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -8222,23 +9988,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} +## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Effective settings for a PostgreSQL 11 cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -User-defined settings for a PostgreSQL 11 cluster. || -|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +User-defined settings for a PostgreSQL 12 cluster. || +|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Default configuration for a PostgreSQL 11 cluster. || +Default configuration for a PostgreSQL 12 cluster. || |# -## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} +## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8491,6 +10257,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8588,23 +10361,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} +## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -User-defined settings for a PostgreSQL 11 1C cluster. || -|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +User-defined settings for a PostgreSQL 12 1C cluster. || +|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Default configuration for a PostgreSQL 11 1C cluster. || +Default configuration for a PostgreSQL 12 1C cluster. || |# -## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} +## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8858,6 +10631,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8956,23 +10736,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} +## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Effective settings for a PostgreSQL 12 cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -User-defined settings for a PostgreSQL 12 cluster. || -|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +User-defined settings for a PostgreSQL 13 cluster. || +|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Default configuration for a PostgreSQL 12 cluster. || +Default configuration for a PostgreSQL 13 cluster. || |# -## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} +## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9278,6 +11058,30 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -9329,23 +11133,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} +## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -User-defined settings for a PostgreSQL 12 1C cluster. || -|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +User-defined settings for a PostgreSQL 13 1C cluster. || +|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Default configuration for a PostgreSQL 12 1C cluster. || +Default configuration for a PostgreSQL 13 1C cluster. || |# -## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} +## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9652,15 +11456,36 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || -|| maxStackDepth | **string** (int64) - -in bytes. || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -9704,23 +11529,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} +## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Effective settings for a PostgreSQL 13 cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -User-defined settings for a PostgreSQL 13 cluster. || -|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +User-defined settings for a PostgreSQL 14 cluster. || +|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Default configuration for a PostgreSQL 13 cluster. || +Default configuration for a PostgreSQL 14 cluster. || |# -## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} +## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9928,7 +11753,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -9972,7 +11796,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10050,6 +11873,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10101,23 +11939,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} +## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -User-defined settings for a PostgreSQL 13 1C cluster. || -|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +User-defined settings for a PostgreSQL 14 1C cluster. || +|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Default configuration for a PostgreSQL 13 1C cluster. || +Default configuration for a PostgreSQL 14 1C cluster. || |# -## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} +## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10325,7 +12163,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -10370,7 +12207,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10448,6 +12284,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10497,23 +12348,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} +## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Effective settings for a PostgreSQL 14 cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -User-defined settings for a PostgreSQL 14 cluster. || -|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +User-defined settings for a PostgreSQL 15 cluster. || +|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Default configuration for a PostgreSQL 14 cluster. || +Default configuration for a PostgreSQL 15 cluster. || |# -## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} +## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10783,7 +12634,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -10864,6 +12716,7 @@ in milliseconds. || || maxStackDepth | **string** (int64) in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -10907,23 +12760,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} +## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -User-defined settings for a PostgreSQL 14 1C cluster. || -|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +User-defined settings for a PostgreSQL 15 1C cluster. || +|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Default configuration for a PostgreSQL 14 1C cluster. || +Default configuration for a PostgreSQL 15 1C cluster. || |# -## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} +## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11194,7 +13047,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -11273,6 +13127,10 @@ in milliseconds. || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -11316,23 +13174,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} +## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Effective settings for a PostgreSQL 15 cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -User-defined settings for a PostgreSQL 15 cluster. || -|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +User-defined settings for a PostgreSQL 16 cluster. || +|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Default configuration for a PostgreSQL 15 cluster. || +Default configuration for a PostgreSQL 16 cluster. || |# -## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} +## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11418,12 +13276,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11432,6 +13290,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11446,6 +13305,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11460,6 +13320,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11631,6 +13492,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11728,23 +13590,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} +## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -User-defined settings for a PostgreSQL 15 1C cluster. || -|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +User-defined settings for a PostgreSQL 16 1C cluster. || +|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Default configuration for a PostgreSQL 15 1C cluster. || +Default configuration for a PostgreSQL 16 1C cluster. || |# -## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} +## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11830,12 +13692,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11844,6 +13706,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11858,6 +13721,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11872,6 +13736,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12044,6 +13909,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12142,27 +14008,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} +## PostgresqlConfigSet17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| effectiveConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Effective settings for a PostgreSQL 16 cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| userConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -User-defined settings for a PostgreSQL 16 cluster. || -|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Default configuration for a PostgreSQL 16 cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12204,7 +14070,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12556,29 +14421,42 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# -## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} +## PostgresqlConfigSet17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| effectiveConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| userConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -User-defined settings for a PostgreSQL 16 1C cluster. || -|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Default configuration for a PostgreSQL 16 1C cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12620,7 +14498,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12974,6 +14851,19 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# ## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig} diff --git a/en/managed-postgresql/api-ref/Cluster/restore.md b/en/managed-postgresql/api-ref/Cluster/restore.md index 664fdfc5cfe..bd219c381e6 100644 --- a/en/managed-postgresql/api-ref/Cluster/restore.md +++ b/en/managed-postgresql/api-ref/Cluster/restore.md @@ -26,7 +26,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "environment": "string", "configSpec": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "maxConnections": "string", "sharedBuffers": "string", @@ -2266,109 +2266,390 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "logAutovacuumMinDuration": "string", "passwordEncryption": "string" }, - // end of the list of possible fields - "poolerConfig": { - "poolingMode": "string", - "poolDiscard": "boolean" - }, - "resources": { - "resourcePresetId": "string", - "diskSize": "string", - "diskTypeId": "string" - }, - "autofailover": "boolean", - "backupWindowStart": { - "hours": "integer", - "minutes": "integer", - "seconds": "integer", - "nanos": "integer" - }, - "backupRetainPeriodDays": "string", - "access": { - "dataLens": "boolean", - "webSql": "boolean", - "serverless": "boolean", - "dataTransfer": "boolean", - "yandexQuery": "boolean" - }, - "performanceDiagnostics": { - "enabled": "boolean", - "sessionsSamplingInterval": "string", - "statementsSamplingInterval": "string" + "postgresqlConfig_17": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, - "diskSizeAutoscaling": { - "plannedUsageThreshold": "string", - "emergencyUsageThreshold": "string", - "diskSizeLimit": "string" - } - }, - "hostSpecs": [ - { - "zoneId": "string", - "subnetId": "string", - "assignPublicIp": "boolean", - "replicationSource": "string", - "priority": "string", - "configSpec": { - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` - "postgresqlConfig_9_6": { - "recoveryMinApplyDelay": "string", - "sharedBuffers": "string", - "tempBuffers": "string", - "workMem": "string", - "replacementSortTuples": "string", - "tempFileLimit": "string", - "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", - "maxStandbyStreamingDelay": "string", - "constraintExclusion": "string", - "cursorTupleFraction": "number", - "fromCollapseLimit": "string", - "joinCollapseLimit": "string", - "forceParallelMode": "string", - "clientMinMessages": "string", - "logMinMessages": "string", - "logMinErrorStatement": "string", - "logMinDurationStatement": "string", - "logCheckpoints": "boolean", - "logConnections": "boolean", - "logDisconnections": "boolean", - "logDuration": "boolean", - "logErrorVerbosity": "string", - "logLockWaits": "boolean", - "logStatement": "string", - "logTempFiles": "string", - "searchPath": "string", - "rowSecurity": "boolean", - "defaultTransactionIsolation": "string", - "statementTimeout": "string", - "lockTimeout": "string", - "idleInTransactionSessionTimeout": "string", - "byteaOutput": "string", - "xmlbinary": "string", - "xmloption": "string", - "ginPendingListLimit": "string", - "deadlockTimeout": "string", - "maxLocksPerTransaction": "string", - "maxPredLocksPerTransaction": "string", - "arrayNulls": "boolean", - "backslashQuote": "string", - "defaultWithOids": "boolean", - "escapeStringWarning": "boolean", - "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", - "quoteAllIdentifiers": "boolean", - "standardConformingStrings": "boolean", - "synchronizeSeqscans": "boolean", - "transformNullEquals": "boolean", - "exitOnError": "boolean", - "seqPageCost": "number", - "randomPageCost": "number", - "sqlInheritance": "boolean", - "effectiveIoConcurrency": "string", - "effectiveCacheSize": "string" - }, - "postgresqlConfig_10_1c": { + "postgresqlConfig_17_1c": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + // end of the list of possible fields + "poolerConfig": { + "poolingMode": "string", + "poolDiscard": "boolean" + }, + "resources": { + "resourcePresetId": "string", + "diskSize": "string", + "diskTypeId": "string" + }, + "autofailover": "boolean", + "backupWindowStart": { + "hours": "integer", + "minutes": "integer", + "seconds": "integer", + "nanos": "integer" + }, + "backupRetainPeriodDays": "string", + "access": { + "dataLens": "boolean", + "webSql": "boolean", + "serverless": "boolean", + "dataTransfer": "boolean", + "yandexQuery": "boolean" + }, + "performanceDiagnostics": { + "enabled": "boolean", + "sessionsSamplingInterval": "string", + "statementsSamplingInterval": "string" + }, + "diskSizeAutoscaling": { + "plannedUsageThreshold": "string", + "emergencyUsageThreshold": "string", + "diskSizeLimit": "string" + } + }, + "hostSpecs": [ + { + "zoneId": "string", + "subnetId": "string", + "assignPublicIp": "boolean", + "replicationSource": "string", + "priority": "string", + "configSpec": { + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` + "postgresqlConfig_9_6": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2421,24 +2702,11 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "exitOnError": "boolean", "seqPageCost": "number", "randomPageCost": "number", - "enableBitmapscan": "boolean", - "enableHashagg": "boolean", - "enableHashjoin": "boolean", - "enableIndexscan": "boolean", - "enableIndexonlyscan": "boolean", - "enableMaterial": "boolean", - "enableMergejoin": "boolean", - "enableNestloop": "boolean", - "enableSeqscan": "boolean", - "enableSort": "boolean", - "enableTidscan": "boolean", - "maxParallelWorkers": "string", - "maxParallelWorkersPerGather": "string", - "timezone": "string", + "sqlInheritance": "boolean", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_10": { + "postgresqlConfig_10_1c": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2508,11 +2776,12 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_11": { + "postgresqlConfig_10": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", "workMem": "string", + "replacementSortTuples": "string", "tempFileLimit": "string", "backendFlushAfter": "string", "oldSnapshotThreshold": "string", @@ -2577,7 +2846,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_11_1c": { + "postgresqlConfig_11": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2646,7 +2915,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_12": { + "postgresqlConfig_11_1c": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2715,7 +2984,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_12_1c": { + "postgresqlConfig_12": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2784,7 +3053,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_13": { + "postgresqlConfig_12_1c": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2853,7 +3122,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_13_1c": { + "postgresqlConfig_13": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2922,7 +3191,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_14": { + "postgresqlConfig_13_1c": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2966,6 +3235,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -2990,7 +3260,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_14_1c": { + "postgresqlConfig_14": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -3058,7 +3328,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_15": { + "postgresqlConfig_14_1c": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -3126,7 +3396,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_15_1c": { + "postgresqlConfig_15": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -3194,7 +3464,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_16": { + "postgresqlConfig_15_1c": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -3207,7 +3477,75 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "debugParallelQuery": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + }, + "postgresqlConfig_16": { + "recoveryMinApplyDelay": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "workMem": "string", + "tempFileLimit": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "maxStandbyStreamingDelay": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -3329,6 +3667,140 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "timezone": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" + }, + "postgresqlConfig_17": { + "recoveryMinApplyDelay": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "workMem": "string", + "tempFileLimit": "string", + "backendFlushAfter": "string", + "maxStandbyStreamingDelay": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + }, + "postgresqlConfig_17_1c": { + "recoveryMinApplyDelay": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "workMem": "string", + "tempFileLimit": "string", + "backendFlushAfter": "string", + "maxStandbyStreamingDelay": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" } // end of the list of possible fields } @@ -3420,110 +3892,124 @@ Host groups hosting VMs of the cluster. || || version | **string** Version of PostgreSQL used in the cluster. -Possible values: `9.6`, `10`, `10_1c`, `11`, `12`, `13`, `14`, `15` || +Possible values: `9.6`, `10`, `10_1c`, `11`, `12`, `13`, `14`, `15`, `16`, `17` || || postgresqlConfig_9_6 | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** Configuration for a PostgreSQL 9.6 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_10_1c | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** Configuration for a PostgreSQL 10 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_10 | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** Configuration for a PostgreSQL 10 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_11 | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** Configuration for a PostgreSQL 11 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_11_1c | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** Configuration for a PostgreSQL 11 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_12 | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** Configuration for a PostgreSQL 12 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_12_1c | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** Configuration for a PostgreSQL 12 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_13 | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** Configuration for a PostgreSQL 13 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_13_1c | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** Configuration for a PostgreSQL 13 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_14 | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** Configuration for a PostgreSQL 14 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_14_1c | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** Configuration for a PostgreSQL 14 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_15 | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** Configuration for a PostgreSQL 15 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_15_1c | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** Configuration for a PostgreSQL 15 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_16 | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** Configuration for a PostgreSQL 16 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_16_1c | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** Configuration for a PostgreSQL 16 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** + +Configuration for a PostgreSQL 17 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** + +Configuration for a PostgreSQL 17 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** @@ -9030,272 +9516,82 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || -|| poolingMode | **enum** (PoolingMode) +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Mode that the connection pooler is working in. -See descriptions of all modes in the [documentation for PgBouncer](https://pgbouncer.github.io/usage). +in bytes. || +|| tempBuffers | **string** (int64) -- `POOLING_MODE_UNSPECIFIED` -- `SESSION`: Session pooling mode. -- `TRANSACTION`: Transaction pooling mode. -- `STATEMENT`: Statement pooling mode. || -|| poolDiscard | **boolean** +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Setting `server_reset_query_always` parameter in PgBouncer. || -|# +in bytes. || +|| maintenanceWorkMem | **string** (int64) -## Resources {#yandex.cloud.mdb.postgresql.v1.Resources} +in bytes. || +|| autovacuumWorkMem | **string** (int64) -#| -||Field | Description || -|| resourcePresetId | **string** +in bytes. || +|| tempFileLimit | **string** (int64) -ID of the preset for computational resources available to a host (CPU, memory etc.). -All available presets are listed in the [documentation](/docs/managed-postgresql/concepts/instance-types). || -|| diskSize | **string** (int64) +in bytes. || +|| vacuumCostDelay | **string** (int64) -Volume of the storage available to a host, in bytes. || -|| diskTypeId | **string** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Type of the storage environment for the host. -Possible values: -* network-hdd - network HDD drive, -* network-ssd - network SSD drive, -* local-ssd - local SSD storage. || -|# - -## TimeOfDay {#google.type.TimeOfDay} - -Represents a time of day. The date and time zone are either not significant -or are specified elsewhere. An API may choose to allow leap seconds. Related -types are [google.type.Date](https://github.com/googleapis/googleapis/blob/master/google/type/date.proto) and [google.protobuf.Timestamp](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/timestamp.proto). - -#| -||Field | Description || -|| hours | **integer** (int32) - -Hours of day in 24 hour format. Should be from 0 to 23. An API may choose -to allow the value "24:00:00" for scenarios like business closing time. || -|| minutes | **integer** (int32) - -Minutes of hour of day. Must be from 0 to 59. || -|| seconds | **integer** (int32) - -Seconds of minutes of the time. Must normally be from 0 to 59. An API may -allow the value 60 if it allows leap-seconds. || -|| nanos | **integer** (int32) - -Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. || -|# - -## Access {#yandex.cloud.mdb.postgresql.v1.Access} - -#| -||Field | Description || -|| dataLens | **boolean** - -Allow access for DataLens || -|| webSql | **boolean** - -Allow SQL queries to the cluster databases from the management console. - -See [SQL queries in the management console](/docs/managed-postgresql/operations/web-sql-query) for more details. || -|| serverless | **boolean** - -Allow access for Serverless || -|| dataTransfer | **boolean** - -Allow access for DataTransfer. || -|| yandexQuery | **boolean** - -Allow access for YandexQuery. || -|# - -## PerformanceDiagnostics {#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics} - -#| -||Field | Description || -|| enabled | **boolean** - -Configuration setting which enables/disables performance diagnostics service in cluster. || -|| sessionsSamplingInterval | **string** (int64) - -Interval (in seconds) for pg_stat_activity sampling || -|| statementsSamplingInterval | **string** (int64) - -Interval (in seconds) for pg_stat_statements sampling || -|# - -## DiskSizeAutoscaling {#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling} - -#| -||Field | Description || -|| plannedUsageThreshold | **string** (int64) - -Threshold of storage usage (in percent) that triggers automatic scaling of the storage during the maintenance window. Zero value means disabled threshold. || -|| emergencyUsageThreshold | **string** (int64) - -Threshold of storage usage (in percent) that triggers immediate automatic scaling of the storage. Zero value means disabled threshold. || -|| diskSizeLimit | **string** (int64) - -New storage size (in bytes) that is set when one of the thresholds is achieved. || -|# - -## HostSpec {#yandex.cloud.mdb.postgresql.v1.HostSpec} - -#| -||Field | Description || -|| zoneId | **string** - -ID of the availability zone where the host resides. -To get a list of available zones, use the [yandex.cloud.compute.v1.ZoneService.List](/docs/compute/api-ref/Zone/list#List) request. || -|| subnetId | **string** - -ID of the subnet that the host should belong to. This subnet should be a part -of the network that the cluster belongs to. -The ID of the network is set in the field [Cluster.networkId](#yandex.cloud.mdb.postgresql.v1.Cluster). || -|| assignPublicIp | **boolean** - -Whether the host should get a public IP address on creation. - -After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign -a public IP to a host without one, recreate the host with `assignPublicIp` set as needed. - -Possible values: -* false - don't assign a public IP to the host. -* true - the host should have a public IP address. || -|| replicationSource | **string** - -[Host.name](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) of the host to be used as the replication source (for cascading replication). || -|| priority | **string** (int64) - -Priority of the host as a replica. A higher value corresponds to higher priority. - -The host with the highest priority is the synchronous replica. All others are asynchronous. -The synchronous replica replaces the master when needed. - -When a replica becomes the master, its priority is ignored. || -|| configSpec | **[ConfigHostSpec](#yandex.cloud.mdb.postgresql.v1.ConfigHostSpec)** - -Configuration of a PostgreSQL server for the host. || -|# - -## ConfigHostSpec {#yandex.cloud.mdb.postgresql.v1.ConfigHostSpec} - -#| -||Field | Description || -|| postgresqlConfig_9_6 | **[PostgresqlHostConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6)** - -Configuration for a host with PostgreSQL 9.6 server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_10_1c | **[PostgresqlHostConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C)** - -Configuration for a host with PostgreSQL 10 1C server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_10 | **[PostgresqlHostConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10)** - -Configuration for a host with PostgreSQL 10 server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_11 | **[PostgresqlHostConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11)** - -Configuration for a host with PostgreSQL 11 server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_11_1c | **[PostgresqlHostConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C)** - -Configuration for a host with PostgreSQL 11 1C server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_12 | **[PostgresqlHostConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12)** - -Configuration for a host with PostgreSQL 12 server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_12_1c | **[PostgresqlHostConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C)** - -Configuration for a host with PostgreSQL 12 1C server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_13 | **[PostgresqlHostConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13)** - -Configuration for a host with PostgreSQL 13 server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_13_1c | **[PostgresqlHostConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C)** - -Configuration for a host with PostgreSQL 13 1C server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_14 | **[PostgresqlHostConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14)** - -Configuration for a host with PostgreSQL 14 server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_14_1c | **[PostgresqlHostConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C)** - -Configuration for a host with PostgreSQL 14 1C server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_15 | **[PostgresqlHostConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15)** - -Configuration for a host with PostgreSQL 15 server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_15_1c | **[PostgresqlHostConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C)** - -Configuration for a host with PostgreSQL 15 1C server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_16 | **[PostgresqlHostConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16)** - -Configuration for a host with PostgreSQL 16 server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_16_1c | **[PostgresqlHostConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C)** - -Configuration for a host with PostgreSQL 16 1C server deployed. +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|# +in bytes || +|| backendFlushAfter | **string** (int64) -## PostgresqlHostConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6} +in bytes || +|| walLevel | **enum** (WalLevel) -Options and structure of `PostgresqlHostConfig` reflects parameters of a PostgreSQL -configuration file. Detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/runtime-config.html). +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -#| -||Field | Description || -|| recoveryMinApplyDelay | **string** (int64) +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) in milliseconds. || -|| sharedBuffers | **string** (int64) - -in bytes. || -|| tempBuffers | **string** (int64) - -in bytes. || -|| workMem | **string** (int64) +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -in bytes. || -|| replacementSortTuples | **string** (int64) +in bytes || +|| maxWalSize | **string** (int64) in bytes. || -|| tempFileLimit | **string** (int64) +|| minWalSize | **string** (int64) in bytes. || -|| backendFlushAfter | **string** (int64) || -|| oldSnapshotThreshold | **string** (int64) || || maxStandbyStreamingDelay | **string** (int64) in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || || constraintExclusion | **enum** (ConstraintExclusion) - `CONSTRAINT_EXCLUSION_UNSPECIFIED` @@ -9305,12 +9601,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -9319,6 +9615,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -9333,6 +9630,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -9347,6 +9645,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -9427,7 +9726,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -9435,44 +9733,277 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** - -This option has been removed in PostgreSQL 10. || -|| effectiveIoConcurrency | **string** (int64) || -|| effectiveCacheSize | **string** (int64) || -|# +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -## PostgresqlHostConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C} +in milliseconds. || +|| archiveTimeout | **string** (int64) -Options and structure of `PostgresqlHostConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) -#| -||Field | Description || -|| recoveryMinApplyDelay | **string** (int64) +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || +|| maxStandbyArchiveDelay | **string** (int64) in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || +|# + +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). + +#| +||Field | Description || +|| maxConnections | **string** (int64) || || sharedBuffers | **string** (int64) in bytes. || || tempBuffers | **string** (int64) in bytes. || +|| maxPreparedTransactions | **string** (int64) || || workMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) +|| maintenanceWorkMem | **string** (int64) + +in bytes. || +|| autovacuumWorkMem | **string** (int64) in bytes. || || tempFileLimit | **string** (int64) in bytes. || -|| backendFlushAfter | **string** (int64) || -|| oldSnapshotThreshold | **string** (int64) || +|| vacuumCostDelay | **string** (int64) + +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) + +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) + +in bytes || +|| backendFlushAfter | **string** (int64) + +in bytes || +|| walLevel | **enum** (WalLevel) + +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) + +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || || maxStandbyStreamingDelay | **string** (int64) in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || || constraintExclusion | **enum** (ConstraintExclusion) - `CONSTRAINT_EXCLUSION_UNSPECIFIED` @@ -9482,12 +10013,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -9496,6 +10027,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -9510,6 +10042,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -9524,6 +10057,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -9604,7 +10138,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -9612,71 +10145,84 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| enableBitmapscan | **boolean** || -|| enableHashagg | **boolean** || -|| enableHashjoin | **boolean** || -|| enableIndexscan | **boolean** || -|| enableIndexonlyscan | **boolean** || -|| enableMaterial | **boolean** || -|| enableMergejoin | **boolean** || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) + +in milliseconds. || +|| archiveTimeout | **string** (int64) + +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || || enableNestloop | **boolean** || || enableSeqscan | **boolean** || || enableSort | **boolean** || || enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || || maxParallelWorkers | **string** (int64) || || maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || -|# - -## PostgresqlHostConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10} - -Options and structure of `PostgresqlHostConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). - -#| -||Field | Description || -|| recoveryMinApplyDelay | **string** (int64) - -in milliseconds. || -|| sharedBuffers | **string** (int64) - -in bytes. || -|| tempBuffers | **string** (int64) - -in bytes. || -|| workMem | **string** (int64) - -in bytes. || -|| replacementSortTuples | **string** (int64) - -in bytes. || -|| tempFileLimit | **string** (int64) +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -in bytes. || -|| backendFlushAfter | **string** (int64) || -|| oldSnapshotThreshold | **string** (int64) || -|| maxStandbyStreamingDelay | **string** (int64) +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || +|| autoExplainLogMinDuration | **string** (int64) in milliseconds. || -|| constraintExclusion | **enum** (ConstraintExclusion) - -- `CONSTRAINT_EXCLUSION_UNSPECIFIED` -- `CONSTRAINT_EXCLUSION_ON` -- `CONSTRAINT_EXCLUSION_OFF` -- `CONSTRAINT_EXCLUSION_PARTITION` || -|| cursorTupleFraction | **number** (double) || -|| fromCollapseLimit | **string** (int64) || -|| joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || -|| clientMinMessages | **enum** (LogLevel) +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` - `LOG_LEVEL_DEBUG5` @@ -9684,337 +10230,375 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || -|| logMinMessages | **enum** (LogLevel) +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) -- `LOG_LEVEL_UNSPECIFIED` -- `LOG_LEVEL_DEBUG5` -- `LOG_LEVEL_DEBUG4` -- `LOG_LEVEL_DEBUG3` -- `LOG_LEVEL_DEBUG2` -- `LOG_LEVEL_DEBUG1` -- `LOG_LEVEL_LOG` -- `LOG_LEVEL_NOTICE` -- `LOG_LEVEL_WARNING` -- `LOG_LEVEL_ERROR` -- `LOG_LEVEL_FATAL` -- `LOG_LEVEL_PANIC` || -|| logMinErrorStatement | **enum** (LogLevel) +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) -- `LOG_LEVEL_UNSPECIFIED` -- `LOG_LEVEL_DEBUG5` -- `LOG_LEVEL_DEBUG4` -- `LOG_LEVEL_DEBUG3` -- `LOG_LEVEL_DEBUG2` -- `LOG_LEVEL_DEBUG1` -- `LOG_LEVEL_LOG` -- `LOG_LEVEL_NOTICE` -- `LOG_LEVEL_WARNING` -- `LOG_LEVEL_ERROR` -- `LOG_LEVEL_FATAL` -- `LOG_LEVEL_PANIC` || -|| logMinDurationStatement | **string** (int64) +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) in milliseconds. || -|| logCheckpoints | **boolean** || -|| logConnections | **boolean** || -|| logDisconnections | **boolean** || -|| logDuration | **boolean** || -|| logErrorVerbosity | **enum** (LogErrorVerbosity) +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) -- `LOG_ERROR_VERBOSITY_UNSPECIFIED` -- `LOG_ERROR_VERBOSITY_TERSE` -- `LOG_ERROR_VERBOSITY_DEFAULT` -- `LOG_ERROR_VERBOSITY_VERBOSE` || -|| logLockWaits | **boolean** || -|| logStatement | **enum** (LogStatement) +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) -- `LOG_STATEMENT_UNSPECIFIED` -- `LOG_STATEMENT_NONE` -- `LOG_STATEMENT_DDL` -- `LOG_STATEMENT_MOD` -- `LOG_STATEMENT_ALL` || -|| logTempFiles | **string** (int64) || -|| searchPath | **string** || -|| rowSecurity | **boolean** || -|| defaultTransactionIsolation | **enum** (TransactionIsolation) +in bytes. || +|| clientConnectionCheckInterval | **string** (int64) -- `TRANSACTION_ISOLATION_UNSPECIFIED` -- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` -- `TRANSACTION_ISOLATION_READ_COMMITTED` -- `TRANSACTION_ISOLATION_REPEATABLE_READ` -- `TRANSACTION_ISOLATION_SERIALIZABLE` || -|| statementTimeout | **string** (int64) +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** in milliseconds. || -|| lockTimeout | **string** (int64) +|| vacuumFailsafeAge | **string** (int64) in milliseconds. || -|| idleInTransactionSessionTimeout | **string** (int64) +|| vacuumMultixactFailsafeAge | **string** (int64) in milliseconds. || -|| byteaOutput | **enum** (ByteaOutput) +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) -- `BYTEA_OUTPUT_UNSPECIFIED` -- `BYTEA_OUTPUT_HEX` -- `BYTEA_OUTPUT_ESCAPED` || -|| xmlbinary | **enum** (XmlBinary) +in bytes. || +|| enableGroupByReordering | **boolean** || +|| geqo | **boolean** -- `XML_BINARY_UNSPECIFIED` -- `XML_BINARY_BASE64` -- `XML_BINARY_HEX` || -|| xmloption | **enum** (XmlOption) +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -- `XML_OPTION_UNSPECIFIED` -- `XML_OPTION_DOCUMENT` -- `XML_OPTION_CONTENT` || -|| ginPendingListLimit | **string** (int64) +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -in bytes. || -|| deadlockTimeout | **string** (int64) +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || +|| maxStandbyArchiveDelay | **string** (int64) in milliseconds. || -|| maxLocksPerTransaction | **string** (int64) || -|| maxPredLocksPerTransaction | **string** (int64) || -|| arrayNulls | **boolean** || -|| backslashQuote | **enum** (BackslashQuote) +|| sessionDurationTimeout | **string** (int64) -- `BACKSLASH_QUOTE_UNSPECIFIED` -- `BACKSLASH_QUOTE` -- `BACKSLASH_QUOTE_ON` -- `BACKSLASH_QUOTE_OFF` -- `BACKSLASH_QUOTE_SAFE_ENCODING` || -|| defaultWithOids | **boolean** || -|| escapeStringWarning | **boolean** || -|| loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || -|| quoteAllIdentifiers | **boolean** || -|| standardConformingStrings | **boolean** || -|| synchronizeSeqscans | **boolean** || -|| transformNullEquals | **boolean** || -|| exitOnError | **boolean** || -|| seqPageCost | **number** (double) || -|| randomPageCost | **number** (double) || -|| enableBitmapscan | **boolean** || -|| enableHashagg | **boolean** || -|| enableHashjoin | **boolean** || -|| enableIndexscan | **boolean** || -|| enableIndexonlyscan | **boolean** || -|| enableMaterial | **boolean** || -|| enableMergejoin | **boolean** || -|| enableNestloop | **boolean** || -|| enableSeqscan | **boolean** || -|| enableSort | **boolean** || -|| enableTidscan | **boolean** || -|| maxParallelWorkers | **string** (int64) || -|| maxParallelWorkersPerGather | **string** (int64) || -|| timezone | **string** || -|| effectiveIoConcurrency | **string** (int64) || -|| effectiveCacheSize | **string** (int64) || -|# +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -## PostgresqlHostConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11} +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || +|# + +## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig} #| ||Field | Description || -|| recoveryMinApplyDelay | **string** (int64) - -in milliseconds. || -|| sharedBuffers | **string** (int64) +|| poolingMode | **enum** (PoolingMode) -in bytes. || -|| tempBuffers | **string** (int64) +Mode that the connection pooler is working in. +See descriptions of all modes in the [documentation for PgBouncer](https://pgbouncer.github.io/usage). -in bytes. || -|| workMem | **string** (int64) +- `POOLING_MODE_UNSPECIFIED` +- `SESSION`: Session pooling mode. +- `TRANSACTION`: Transaction pooling mode. +- `STATEMENT`: Statement pooling mode. || +|| poolDiscard | **boolean** -in bytes. || -|| tempFileLimit | **string** (int64) +Setting `server_reset_query_always` parameter in PgBouncer. || +|# -in bytes. || -|| backendFlushAfter | **string** (int64) || -|| oldSnapshotThreshold | **string** (int64) || -|| maxStandbyStreamingDelay | **string** (int64) +## Resources {#yandex.cloud.mdb.postgresql.v1.Resources} -in milliseconds. || -|| constraintExclusion | **enum** (ConstraintExclusion) +#| +||Field | Description || +|| resourcePresetId | **string** -- `CONSTRAINT_EXCLUSION_UNSPECIFIED` -- `CONSTRAINT_EXCLUSION_ON` -- `CONSTRAINT_EXCLUSION_OFF` -- `CONSTRAINT_EXCLUSION_PARTITION` || -|| cursorTupleFraction | **number** (double) || -|| fromCollapseLimit | **string** (int64) || -|| joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +ID of the preset for computational resources available to a host (CPU, memory etc.). +All available presets are listed in the [documentation](/docs/managed-postgresql/concepts/instance-types). || +|| diskSize | **string** (int64) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || -|| clientMinMessages | **enum** (LogLevel) +Volume of the storage available to a host, in bytes. || +|| diskTypeId | **string** -- `LOG_LEVEL_UNSPECIFIED` -- `LOG_LEVEL_DEBUG5` -- `LOG_LEVEL_DEBUG4` -- `LOG_LEVEL_DEBUG3` -- `LOG_LEVEL_DEBUG2` -- `LOG_LEVEL_DEBUG1` -- `LOG_LEVEL_LOG` -- `LOG_LEVEL_NOTICE` -- `LOG_LEVEL_WARNING` -- `LOG_LEVEL_ERROR` -- `LOG_LEVEL_FATAL` -- `LOG_LEVEL_PANIC` || -|| logMinMessages | **enum** (LogLevel) +Type of the storage environment for the host. +Possible values: +* network-hdd - network HDD drive, +* network-ssd - network SSD drive, +* local-ssd - local SSD storage. || +|# -- `LOG_LEVEL_UNSPECIFIED` -- `LOG_LEVEL_DEBUG5` -- `LOG_LEVEL_DEBUG4` -- `LOG_LEVEL_DEBUG3` -- `LOG_LEVEL_DEBUG2` -- `LOG_LEVEL_DEBUG1` -- `LOG_LEVEL_LOG` -- `LOG_LEVEL_NOTICE` -- `LOG_LEVEL_WARNING` -- `LOG_LEVEL_ERROR` -- `LOG_LEVEL_FATAL` -- `LOG_LEVEL_PANIC` || -|| logMinErrorStatement | **enum** (LogLevel) +## TimeOfDay {#google.type.TimeOfDay} -- `LOG_LEVEL_UNSPECIFIED` -- `LOG_LEVEL_DEBUG5` -- `LOG_LEVEL_DEBUG4` -- `LOG_LEVEL_DEBUG3` -- `LOG_LEVEL_DEBUG2` -- `LOG_LEVEL_DEBUG1` -- `LOG_LEVEL_LOG` -- `LOG_LEVEL_NOTICE` -- `LOG_LEVEL_WARNING` -- `LOG_LEVEL_ERROR` -- `LOG_LEVEL_FATAL` -- `LOG_LEVEL_PANIC` || -|| logMinDurationStatement | **string** (int64) +Represents a time of day. The date and time zone are either not significant +or are specified elsewhere. An API may choose to allow leap seconds. Related +types are [google.type.Date](https://github.com/googleapis/googleapis/blob/master/google/type/date.proto) and [google.protobuf.Timestamp](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/timestamp.proto). -in milliseconds. || -|| logCheckpoints | **boolean** || -|| logConnections | **boolean** || -|| logDisconnections | **boolean** || -|| logDuration | **boolean** || -|| logErrorVerbosity | **enum** (LogErrorVerbosity) +#| +||Field | Description || +|| hours | **integer** (int32) -- `LOG_ERROR_VERBOSITY_UNSPECIFIED` -- `LOG_ERROR_VERBOSITY_TERSE` -- `LOG_ERROR_VERBOSITY_DEFAULT` -- `LOG_ERROR_VERBOSITY_VERBOSE` || -|| logLockWaits | **boolean** || -|| logStatement | **enum** (LogStatement) +Hours of day in 24 hour format. Should be from 0 to 23. An API may choose +to allow the value "24:00:00" for scenarios like business closing time. || +|| minutes | **integer** (int32) -- `LOG_STATEMENT_UNSPECIFIED` -- `LOG_STATEMENT_NONE` -- `LOG_STATEMENT_DDL` -- `LOG_STATEMENT_MOD` -- `LOG_STATEMENT_ALL` || -|| logTempFiles | **string** (int64) || -|| searchPath | **string** || -|| rowSecurity | **boolean** || -|| defaultTransactionIsolation | **enum** (TransactionIsolation) +Minutes of hour of day. Must be from 0 to 59. || +|| seconds | **integer** (int32) -- `TRANSACTION_ISOLATION_UNSPECIFIED` -- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` -- `TRANSACTION_ISOLATION_READ_COMMITTED` -- `TRANSACTION_ISOLATION_REPEATABLE_READ` -- `TRANSACTION_ISOLATION_SERIALIZABLE` || -|| statementTimeout | **string** (int64) +Seconds of minutes of the time. Must normally be from 0 to 59. An API may +allow the value 60 if it allows leap-seconds. || +|| nanos | **integer** (int32) -in milliseconds. || -|| lockTimeout | **string** (int64) +Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. || +|# -in milliseconds. || -|| idleInTransactionSessionTimeout | **string** (int64) +## Access {#yandex.cloud.mdb.postgresql.v1.Access} -in milliseconds. || -|| byteaOutput | **enum** (ByteaOutput) +#| +||Field | Description || +|| dataLens | **boolean** -- `BYTEA_OUTPUT_UNSPECIFIED` -- `BYTEA_OUTPUT_HEX` -- `BYTEA_OUTPUT_ESCAPED` || -|| xmlbinary | **enum** (XmlBinary) +Allow access for DataLens || +|| webSql | **boolean** -- `XML_BINARY_UNSPECIFIED` -- `XML_BINARY_BASE64` -- `XML_BINARY_HEX` || -|| xmloption | **enum** (XmlOption) +Allow SQL queries to the cluster databases from the management console. -- `XML_OPTION_UNSPECIFIED` -- `XML_OPTION_DOCUMENT` -- `XML_OPTION_CONTENT` || -|| ginPendingListLimit | **string** (int64) +See [SQL queries in the management console](/docs/managed-postgresql/operations/web-sql-query) for more details. || +|| serverless | **boolean** -in bytes. || -|| deadlockTimeout | **string** (int64) +Allow access for Serverless || +|| dataTransfer | **boolean** -in milliseconds. || -|| maxLocksPerTransaction | **string** (int64) || -|| maxPredLocksPerTransaction | **string** (int64) || -|| arrayNulls | **boolean** || -|| backslashQuote | **enum** (BackslashQuote) +Allow access for DataTransfer. || +|| yandexQuery | **boolean** -- `BACKSLASH_QUOTE_UNSPECIFIED` -- `BACKSLASH_QUOTE` -- `BACKSLASH_QUOTE_ON` -- `BACKSLASH_QUOTE_OFF` -- `BACKSLASH_QUOTE_SAFE_ENCODING` || -|| defaultWithOids | **boolean** || -|| escapeStringWarning | **boolean** || -|| loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || -|| quoteAllIdentifiers | **boolean** || -|| standardConformingStrings | **boolean** || -|| synchronizeSeqscans | **boolean** || -|| transformNullEquals | **boolean** || -|| exitOnError | **boolean** || -|| seqPageCost | **number** (double) || -|| randomPageCost | **number** (double) || -|| enableBitmapscan | **boolean** || -|| enableHashagg | **boolean** || -|| enableHashjoin | **boolean** || -|| enableIndexscan | **boolean** || -|| enableIndexonlyscan | **boolean** || -|| enableMaterial | **boolean** || -|| enableMergejoin | **boolean** || -|| enableNestloop | **boolean** || -|| enableSeqscan | **boolean** || -|| enableSort | **boolean** || -|| enableTidscan | **boolean** || -|| maxParallelWorkers | **string** (int64) || -|| maxParallelWorkersPerGather | **string** (int64) || -|| timezone | **string** || -|| effectiveIoConcurrency | **string** (int64) || -|| effectiveCacheSize | **string** (int64) || +Allow access for YandexQuery. || |# -## PostgresqlHostConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C} - -Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +## PerformanceDiagnostics {#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics} #| ||Field | Description || -|| recoveryMinApplyDelay | **string** (int64) - -in milliseconds. || -|| sharedBuffers | **string** (int64) +|| enabled | **boolean** + +Configuration setting which enables/disables performance diagnostics service in cluster. || +|| sessionsSamplingInterval | **string** (int64) + +Interval (in seconds) for pg_stat_activity sampling || +|| statementsSamplingInterval | **string** (int64) + +Interval (in seconds) for pg_stat_statements sampling || +|# + +## DiskSizeAutoscaling {#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling} + +#| +||Field | Description || +|| plannedUsageThreshold | **string** (int64) + +Threshold of storage usage (in percent) that triggers automatic scaling of the storage during the maintenance window. Zero value means disabled threshold. || +|| emergencyUsageThreshold | **string** (int64) + +Threshold of storage usage (in percent) that triggers immediate automatic scaling of the storage. Zero value means disabled threshold. || +|| diskSizeLimit | **string** (int64) + +New storage size (in bytes) that is set when one of the thresholds is achieved. || +|# + +## HostSpec {#yandex.cloud.mdb.postgresql.v1.HostSpec} + +#| +||Field | Description || +|| zoneId | **string** + +ID of the availability zone where the host resides. +To get a list of available zones, use the [yandex.cloud.compute.v1.ZoneService.List](/docs/compute/api-ref/Zone/list#List) request. || +|| subnetId | **string** + +ID of the subnet that the host should belong to. This subnet should be a part +of the network that the cluster belongs to. +The ID of the network is set in the field [Cluster.networkId](#yandex.cloud.mdb.postgresql.v1.Cluster). || +|| assignPublicIp | **boolean** + +Whether the host should get a public IP address on creation. + +After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign +a public IP to a host without one, recreate the host with `assignPublicIp` set as needed. + +Possible values: +* false - don't assign a public IP to the host. +* true - the host should have a public IP address. || +|| replicationSource | **string** + +[Host.name](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) of the host to be used as the replication source (for cascading replication). || +|| priority | **string** (int64) + +Priority of the host as a replica. A higher value corresponds to higher priority. + +The host with the highest priority is the synchronous replica. All others are asynchronous. +The synchronous replica replaces the master when needed. + +When a replica becomes the master, its priority is ignored. || +|| configSpec | **[ConfigHostSpec](#yandex.cloud.mdb.postgresql.v1.ConfigHostSpec)** + +Configuration of a PostgreSQL server for the host. || +|# + +## ConfigHostSpec {#yandex.cloud.mdb.postgresql.v1.ConfigHostSpec} + +#| +||Field | Description || +|| postgresqlConfig_9_6 | **[PostgresqlHostConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6)** + +Configuration for a host with PostgreSQL 9.6 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_10_1c | **[PostgresqlHostConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C)** + +Configuration for a host with PostgreSQL 10 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_10 | **[PostgresqlHostConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10)** + +Configuration for a host with PostgreSQL 10 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_11 | **[PostgresqlHostConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11)** + +Configuration for a host with PostgreSQL 11 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_11_1c | **[PostgresqlHostConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C)** + +Configuration for a host with PostgreSQL 11 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_12 | **[PostgresqlHostConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12)** + +Configuration for a host with PostgreSQL 12 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_12_1c | **[PostgresqlHostConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C)** + +Configuration for a host with PostgreSQL 12 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_13 | **[PostgresqlHostConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13)** + +Configuration for a host with PostgreSQL 13 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_13_1c | **[PostgresqlHostConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C)** + +Configuration for a host with PostgreSQL 13 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_14 | **[PostgresqlHostConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14)** + +Configuration for a host with PostgreSQL 14 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_14_1c | **[PostgresqlHostConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C)** + +Configuration for a host with PostgreSQL 14 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_15 | **[PostgresqlHostConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15)** + +Configuration for a host with PostgreSQL 15 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_15_1c | **[PostgresqlHostConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C)** + +Configuration for a host with PostgreSQL 15 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_16 | **[PostgresqlHostConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16)** + +Configuration for a host with PostgreSQL 16 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_16_1c | **[PostgresqlHostConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C)** + +Configuration for a host with PostgreSQL 16 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17 | **[PostgresqlHostConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17_1c | **[PostgresqlHostConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|# + +## PostgresqlHostConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6} + +Options and structure of `PostgresqlHostConfig` reflects parameters of a PostgreSQL +configuration file. Detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/runtime-config.html). + +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) in bytes. || || tempBuffers | **string** (int64) @@ -10022,6 +10606,9 @@ in bytes. || in bytes. || || workMem | **string** (int64) +in bytes. || +|| replacementSortTuples | **string** (int64) + in bytes. || || tempFileLimit | **string** (int64) @@ -10170,29 +10757,18 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| enableBitmapscan | **boolean** || -|| enableHashagg | **boolean** || -|| enableHashjoin | **boolean** || -|| enableIndexscan | **boolean** || -|| enableIndexonlyscan | **boolean** || -|| enableMaterial | **boolean** || -|| enableMergejoin | **boolean** || -|| enableNestloop | **boolean** || -|| enableSeqscan | **boolean** || -|| enableSort | **boolean** || -|| enableTidscan | **boolean** || -|| maxParallelWorkers | **string** (int64) || -|| maxParallelWorkersPerGather | **string** (int64) || -|| timezone | **string** || +|| sqlInheritance | **boolean** + +This option has been removed in PostgreSQL 10. || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12} +## PostgresqlHostConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C} -Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +Options and structure of `PostgresqlHostConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -10207,6 +10783,9 @@ in bytes. || in bytes. || || workMem | **string** (int64) +in bytes. || +|| replacementSortTuples | **string** (int64) + in bytes. || || tempFileLimit | **string** (int64) @@ -10373,11 +10952,11 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C} +## PostgresqlHostConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10} -Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +Options and structure of `PostgresqlHostConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -10392,6 +10971,9 @@ in bytes. || in bytes. || || workMem | **string** (int64) +in bytes. || +|| replacementSortTuples | **string** (int64) + in bytes. || || tempFileLimit | **string** (int64) @@ -10558,7 +11140,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13} +## PostgresqlHostConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10743,7 +11325,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C} +## PostgresqlHostConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10928,7 +11510,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14} +## PostgresqlHostConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11087,6 +11669,7 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -11112,7 +11695,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C} +## PostgresqlHostConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11271,6 +11854,7 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -11296,7 +11880,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15} +## PostgresqlHostConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11455,6 +12039,7 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -11480,7 +12065,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C} +## PostgresqlHostConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11639,6 +12224,7 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -11664,7 +12250,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16} +## PostgresqlHostConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11701,12 +12287,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| debugParallelQuery | **enum** (DebugParallelQuery) +|| forceParallelMode | **enum** (ForceParallelMode) -- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` -- `DEBUG_PARALLEL_QUERY_ON` -- `DEBUG_PARALLEL_QUERY_OFF` -- `DEBUG_PARALLEL_QUERY_REGRESS` || +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11715,7 +12301,6 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` -- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11730,7 +12315,6 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` -- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11745,7 +12329,6 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` -- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11851,7 +12434,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C} +## PostgresqlHostConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11888,12 +12471,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| debugParallelQuery | **enum** (DebugParallelQuery) +|| forceParallelMode | **enum** (ForceParallelMode) -- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` -- `DEBUG_PARALLEL_QUERY_ON` -- `DEBUG_PARALLEL_QUERY_OFF` -- `DEBUG_PARALLEL_QUERY_REGRESS` || +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11902,7 +12485,6 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` -- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11917,7 +12499,6 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` -- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11932,7 +12513,6 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` -- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12038,26 +12618,1140 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## Response {#yandex.cloud.operation.Operation} +## PostgresqlHostConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15} -**HTTP Code: 200 - OK** +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). -```json -{ - "id": "string", - "description": "string", - "createdAt": "string", - "createdBy": "string", - "modifiedAt": "string", - "done": "boolean", - "metadata": { - "clusterId": "string", - "backupId": "string" - }, - // Includes only one of the fields `error`, `response` - "error": { - "code": "integer", - "message": "string", +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| workMem | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| oldSnapshotThreshold | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# + +## PostgresqlHostConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). + +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| workMem | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| oldSnapshotThreshold | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# + +## PostgresqlHostConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). + +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| workMem | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| oldSnapshotThreshold | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| debugParallelQuery | **enum** (DebugParallelQuery) + +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# + +## PostgresqlHostConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). + +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| workMem | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| oldSnapshotThreshold | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| debugParallelQuery | **enum** (DebugParallelQuery) + +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# + +## PostgresqlHostConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). + +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| workMem | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| debugParallelQuery | **enum** (DebugParallelQuery) + +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# + +## PostgresqlHostConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). + +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| workMem | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| debugParallelQuery | **enum** (DebugParallelQuery) + +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# + +## Response {#yandex.cloud.operation.Operation} + +**HTTP Code: 200 - OK** + +```json +{ + "id": "string", + "description": "string", + "createdAt": "string", + "createdBy": "string", + "modifiedAt": "string", + "done": "boolean", + "metadata": { + "clusterId": "string", + "backupId": "string" + }, + // Includes only one of the fields `error`, `response` + "error": { + "code": "integer", + "message": "string", "details": [ "object" ] @@ -12079,7 +13773,7 @@ in milliseconds. || ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "effectiveConfig": { "maxConnections": "string", @@ -12154,15 +13848,723 @@ in milliseconds. || "exitOnError": "boolean", "seqPageCost": "number", "randomPageCost": "number", - "sqlInheritance": "boolean", + "sqlInheritance": "boolean", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "sqlInheritance": "boolean", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "sqlInheritance": "boolean", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + } + }, + "postgresqlConfig_10_1c": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "onlineAnalyzeEnable": "boolean", + "plantunerFixEmptyTable": "boolean", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "onlineAnalyzeEnable": "boolean", + "plantunerFixEmptyTable": "boolean", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "onlineAnalyzeEnable": "boolean", + "plantunerFixEmptyTable": "boolean", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" + } + }, + "postgresqlConfig_10": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", "autovacuumMaxWorkers": "string", "autovacuumVacuumCostDelay": "string", "autovacuumVacuumCostLimit": "string", "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", "effectiveIoConcurrency": "string", - "effectiveCacheSize": "string" + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" }, "userConfig": { "maxConnections": "string", @@ -12237,15 +14639,65 @@ in milliseconds. || "exitOnError": "boolean", "seqPageCost": "number", "randomPageCost": "number", - "sqlInheritance": "boolean", "autovacuumMaxWorkers": "string", "autovacuumVacuumCostDelay": "string", "autovacuumVacuumCostLimit": "string", "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", "effectiveIoConcurrency": "string", - "effectiveCacheSize": "string" + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" }, "defaultConfig": { "maxConnections": "string", @@ -12320,18 +14772,68 @@ in milliseconds. || "exitOnError": "boolean", "seqPageCost": "number", "randomPageCost": "number", - "sqlInheritance": "boolean", "autovacuumMaxWorkers": "string", "autovacuumVacuumCostDelay": "string", "autovacuumVacuumCostLimit": "string", "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", "effectiveIoConcurrency": "string", - "effectiveCacheSize": "string" + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" } }, - "postgresqlConfig_10_1c": { + "postgresqlConfig_11": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -12339,7 +14841,6 @@ in milliseconds. || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -12429,6 +14930,15 @@ in milliseconds. || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -12446,8 +14956,6 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", - "onlineAnalyzeEnable": "boolean", - "plantunerFixEmptyTable": "boolean", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -12461,6 +14969,9 @@ in milliseconds. || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -12474,7 +14985,6 @@ in milliseconds. || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -12564,6 +15074,15 @@ in milliseconds. || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -12581,8 +15100,6 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", - "onlineAnalyzeEnable": "boolean", - "plantunerFixEmptyTable": "boolean", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -12596,6 +15113,9 @@ in milliseconds. || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -12609,7 +15129,6 @@ in milliseconds. || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -12699,6 +15218,15 @@ in milliseconds. || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -12716,8 +15244,6 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", - "onlineAnalyzeEnable": "boolean", - "plantunerFixEmptyTable": "boolean", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -12731,6 +15257,9 @@ in milliseconds. || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -12738,7 +15267,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_10": { + "postgresqlConfig_11_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -12746,7 +15275,6 @@ in milliseconds. || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -12818,6 +15346,7 @@ in milliseconds. || "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", "enableBitmapscan": "boolean", "enableHashagg": "boolean", "enableHashjoin": "boolean", @@ -12836,6 +15365,15 @@ in milliseconds. || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -12858,6 +15396,7 @@ in milliseconds. || "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", @@ -12866,6 +15405,9 @@ in milliseconds. || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -12879,7 +15421,6 @@ in milliseconds. || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -12951,6 +15492,7 @@ in milliseconds. || "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", "enableBitmapscan": "boolean", "enableHashagg": "boolean", "enableHashjoin": "boolean", @@ -12969,6 +15511,15 @@ in milliseconds. || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -12991,6 +15542,7 @@ in milliseconds. || "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", @@ -12999,6 +15551,9 @@ in milliseconds. || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -13012,7 +15567,6 @@ in milliseconds. || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -13084,6 +15638,7 @@ in milliseconds. || "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", "enableBitmapscan": "boolean", "enableHashagg": "boolean", "enableHashjoin": "boolean", @@ -13102,6 +15657,15 @@ in milliseconds. || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -13124,6 +15688,7 @@ in milliseconds. || "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", @@ -13132,6 +15697,9 @@ in milliseconds. || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -13139,7 +15707,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_11": { + "postgresqlConfig_12": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -13245,6 +15813,8 @@ in milliseconds. || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -13389,6 +15959,8 @@ in milliseconds. || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -13533,6 +16105,8 @@ in milliseconds. || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -13573,7 +16147,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_11_1c": { + "postgresqlConfig_12_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -13680,6 +16254,8 @@ in milliseconds. || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -13826,6 +16402,8 @@ in milliseconds. || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -13972,6 +16550,8 @@ in milliseconds. || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -14013,7 +16593,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_12": { + "postgresqlConfig_13": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -14138,6 +16718,18 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -14284,6 +16876,18 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -14430,6 +17034,18 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -14453,7 +17069,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_12_1c": { + "postgresqlConfig_13_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -14579,13 +17195,24 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", - "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -14727,13 +17354,24 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", - "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -14875,13 +17513,24 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", - "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -14899,7 +17548,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_13": { + "postgresqlConfig_14": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -14964,7 +17613,6 @@ in milliseconds. || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -15004,7 +17652,6 @@ in milliseconds. || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -15036,6 +17683,13 @@ in milliseconds. || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -15122,7 +17776,6 @@ in milliseconds. || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -15162,7 +17815,6 @@ in milliseconds. || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -15194,6 +17846,13 @@ in milliseconds. || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -15280,7 +17939,6 @@ in milliseconds. || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -15320,7 +17978,6 @@ in milliseconds. || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -15352,6 +18009,13 @@ in milliseconds. || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -15375,7 +18039,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_13_1c": { + "postgresqlConfig_14_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -15440,7 +18104,6 @@ in milliseconds. || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -15481,7 +18144,6 @@ in milliseconds. || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -15513,6 +18175,13 @@ in milliseconds. || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -15599,7 +18268,6 @@ in milliseconds. || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -15640,7 +18308,6 @@ in milliseconds. || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -15672,6 +18339,13 @@ in milliseconds. || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -15758,7 +18432,6 @@ in milliseconds. || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -15799,7 +18472,6 @@ in milliseconds. || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -15831,6 +18503,13 @@ in milliseconds. || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -15854,7 +18533,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_14": { + "postgresqlConfig_15": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -16002,6 +18681,7 @@ in milliseconds. || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -16165,6 +18845,7 @@ in milliseconds. || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -16328,6 +19009,7 @@ in milliseconds. || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -16345,7 +19027,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_14_1c": { + "postgresqlConfig_15_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -16494,6 +19176,8 @@ in milliseconds. || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -16658,6 +19342,8 @@ in milliseconds. || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -16822,6 +19508,8 @@ in milliseconds. || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -16839,7 +19527,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_15": { + "postgresqlConfig_16": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -16873,7 +19561,7 @@ in milliseconds. || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -17037,7 +19725,7 @@ in milliseconds. || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -17201,7 +19889,7 @@ in milliseconds. || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -17333,7 +20021,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_15_1c": { + "postgresqlConfig_16_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -17367,7 +20055,7 @@ in milliseconds. || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -17533,7 +20221,7 @@ in milliseconds. || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -17699,7 +20387,7 @@ in milliseconds. || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -17833,7 +20521,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_16": { + "postgresqlConfig_17": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -17853,7 +20541,6 @@ in milliseconds. || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -17996,7 +20683,12 @@ in milliseconds. || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, "userConfig": { "maxConnections": "string", @@ -18017,7 +20709,6 @@ in milliseconds. || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -18160,7 +20851,12 @@ in milliseconds. || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, "defaultConfig": { "maxConnections": "string", @@ -18181,7 +20877,6 @@ in milliseconds. || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -18324,10 +21019,15 @@ in milliseconds. || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" } }, - "postgresqlConfig_16_1c": { + "postgresqlConfig_17_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -18347,7 +21047,6 @@ in milliseconds. || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -18492,7 +21191,12 @@ in milliseconds. || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, "userConfig": { "maxConnections": "string", @@ -18513,7 +21217,6 @@ in milliseconds. || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -18658,7 +21361,12 @@ in milliseconds. || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, "defaultConfig": { "maxConnections": "string", @@ -18679,7 +21387,6 @@ in milliseconds. || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -18824,7 +21531,12 @@ in milliseconds. || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" } }, // end of the list of possible fields @@ -18891,370 +21603,993 @@ in milliseconds. || } ``` -An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). +An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). + +#| +||Field | Description || +|| id | **string** + +ID of the operation. || +|| description | **string** + +Description of the operation. 0-256 characters long. || +|| createdAt | **string** (date-time) + +Creation timestamp. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| createdBy | **string** + +ID of the user or service account who initiated the operation. || +|| modifiedAt | **string** (date-time) + +The time when the Operation resource was last modified. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| done | **boolean** + +If the value is `false`, it means the operation is still in progress. +If `true`, the operation is completed, and either `error` or `response` is available. || +|| metadata | **[RestoreClusterMetadata](#yandex.cloud.mdb.postgresql.v1.RestoreClusterMetadata)** + +Service-specific metadata associated with the operation. +It typically contains the ID of the target resource that the operation is performed on. +Any method that returns a long-running operation should document the metadata type, if any. || +|| error | **[Status](#google.rpc.Status)** + +The error result of the operation in case of failure or cancellation. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** + +The normal response of the operation in case of success. +If the original method returns no data on success, such as Delete, +the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). +If the original method is the standard Create/Update, +the response should be the target resource of the operation. +Any method that returns a long-running operation should document the response type, if any. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|# + +## RestoreClusterMetadata {#yandex.cloud.mdb.postgresql.v1.RestoreClusterMetadata} + +#| +||Field | Description || +|| clusterId | **string** + +ID of the new PostgreSQL cluster that is being created from a backup. || +|| backupId | **string** + +ID of the backup that is being used for creating a cluster. || +|# + +## Status {#google.rpc.Status} + +The error result of the operation in case of failure or cancellation. + +#| +||Field | Description || +|| code | **integer** (int32) + +Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || +|| message | **string** + +An error message. || +|| details[] | **object** + +A list of messages that carry the error details. || +|# + +## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} + +A PostgreSQL Cluster resource. For more information, see +the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. + +#| +||Field | Description || +|| id | **string** + +ID of the PostgreSQL cluster. +This ID is assigned by MDB at creation time. || +|| folderId | **string** + +ID of the folder that the PostgreSQL cluster belongs to. || +|| createdAt | **string** (date-time) + +Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| name | **string** + +Name of the PostgreSQL cluster. +The name is unique within the folder. 1-63 characters long. || +|| description | **string** + +Description of the PostgreSQL cluster. 0-256 characters long. || +|| labels | **string** + +Custom labels for the PostgreSQL cluster as `` key:value `` pairs. +Maximum 64 per resource. || +|| environment | **enum** (Environment) + +Deployment environment of the PostgreSQL cluster. + +- `ENVIRONMENT_UNSPECIFIED` +- `PRODUCTION`: Stable environment with a conservative update policy: +only hotfixes are applied during regular maintenance. +- `PRESTABLE`: Environment with more aggressive update policy: new versions +are rolled out irrespective of backward compatibility. || +|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** + +Description of monitoring systems relevant to the PostgreSQL cluster. || +|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** + +Configuration of the PostgreSQL cluster. || +|| networkId | **string** + +ID of the network that the cluster belongs to. || +|| health | **enum** (Health) + +Aggregated cluster health. + +- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). +- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). +- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). +- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || +|| status | **enum** (Status) + +Current state of the cluster. + +- `STATUS_UNKNOWN`: Cluster state is unknown. +- `CREATING`: Cluster is being created. +- `RUNNING`: Cluster is running normally. +- `ERROR`: Cluster encountered a problem and cannot operate. +- `UPDATING`: Cluster is being updated. +- `STOPPING`: Cluster is stopping. +- `STOPPED`: Cluster stopped. +- `STARTING`: Cluster is starting. || +|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** + +Maintenance window for the cluster. || +|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** + +Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || +|| securityGroupIds[] | **string** + +User security groups || +|| deletionProtection | **boolean** + +Deletion Protection inhibits deletion of the cluster || +|| hostGroupIds[] | **string** + +Host groups hosting VMs of the cluster. || +|# + +## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} + +Monitoring system. + +#| +||Field | Description || +|| name | **string** + +Name of the monitoring system. || +|| description | **string** + +Description of the monitoring system. || +|| link | **string** + +Link to the monitoring system charts for the PostgreSQL cluster. || +|# + +## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} + +#| +||Field | Description || +|| version | **string** + +Version of PostgreSQL server software. || +|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** + +Configuration of a PostgreSQL 9.6 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** + +Configuration of a PostgreSQL 10 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** + +Configuration of a PostgreSQL 10 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** + +Configuration of a PostgreSQL 11 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** + +Configuration of a PostgreSQL 11 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** + +Configuration of a PostgreSQL 12 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** + +Configuration of a PostgreSQL 12 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** + +Configuration of a PostgreSQL 13 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** + +Configuration of a PostgreSQL 13 1C server. -#| -||Field | Description || -|| id | **string** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -ID of the operation. || -|| description | **string** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** -Description of the operation. 0-256 characters long. || -|| createdAt | **string** (date-time) +Configuration of a PostgreSQL 14 server. -Creation timestamp. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| createdBy | **string** +Configuration of a PostgreSQL 14 1C server. -ID of the user or service account who initiated the operation. || -|| modifiedAt | **string** (date-time) +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The time when the Operation resource was last modified. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Configuration of a PostgreSQL 15 server. -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| done | **boolean** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -If the value is `false`, it means the operation is still in progress. -If `true`, the operation is completed, and either `error` or `response` is available. || -|| metadata | **[RestoreClusterMetadata](#yandex.cloud.mdb.postgresql.v1.RestoreClusterMetadata)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** -Service-specific metadata associated with the operation. -It typically contains the ID of the target resource that the operation is performed on. -Any method that returns a long-running operation should document the metadata type, if any. || -|| error | **[Status](#google.rpc.Status)** +Configuration of a PostgreSQL 15 1C server. -The error result of the operation in case of failure or cancellation. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Includes only one of the fields `error`, `response`. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || -|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** +Configuration of a PostgreSQL 16 server. -The normal response of the operation in case of success. -If the original method returns no data on success, such as Delete, -the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). -If the original method is the standard Create/Update, -the response should be the target resource of the operation. -Any method that returns a long-running operation should document the response type, if any. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Includes only one of the fields `error`, `response`. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || +Configuration of a PostgreSQL 16 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfigSet17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfigSet17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig2)** + +Configuration of the connection pooler. || +|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources2)** + +Resources allocated to PostgreSQL hosts. || +|| autofailover | **boolean** + +Configuration setting which enables/disables autofailover in cluster. || +|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay2)** + +Time to start the daily backup, in the UTC timezone. || +|| backupRetainPeriodDays | **string** (int64) + +Retention policy of automated backups. || +|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access2)** + +Access policy to DB || +|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics2)** + +Configuration of the performance diagnostics service. || +|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling2)** + +Disk size autoscaling || |# -## RestoreClusterMetadata {#yandex.cloud.mdb.postgresql.v1.RestoreClusterMetadata} +## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} #| ||Field | Description || -|| clusterId | **string** +|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** -ID of the new PostgreSQL cluster that is being created from a backup. || -|| backupId | **string** +Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** -ID of the backup that is being used for creating a cluster. || +User-defined settings for a PostgreSQL 9.6 cluster. || +|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** + +Default configuration for a PostgreSQL 9.6 cluster. || |# -## Status {#google.rpc.Status} +## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62} -The error result of the operation in case of failure or cancellation. +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). #| ||Field | Description || -|| code | **integer** (int32) +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || -|| message | **string** +in bytes. || +|| tempBuffers | **string** (int64) -An error message. || -|| details[] | **object** +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -A list of messages that carry the error details. || -|# +in bytes. || +|| maintenanceWorkMem | **string** (int64) -## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -A PostgreSQL Cluster resource. For more information, see -the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. +in bytes. || +|| tempFileLimit | **string** (int64) -#| -||Field | Description || -|| id | **string** +in bytes. || +|| vacuumCostDelay | **string** (int64) -ID of the PostgreSQL cluster. -This ID is assigned by MDB at creation time. || -|| folderId | **string** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -ID of the folder that the PostgreSQL cluster belongs to. || -|| createdAt | **string** (date-time) +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. +in bytes || +|| backendFlushAfter | **string** (int64) -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| name | **string** +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Name of the PostgreSQL cluster. -The name is unique within the folder. 1-63 characters long. || -|| description | **string** +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) + +Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Description of the PostgreSQL cluster. 0-256 characters long. || -|| labels | **string** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Custom labels for the PostgreSQL cluster as `` key:value `` pairs. -Maximum 64 per resource. || -|| environment | **enum** (Environment) +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Deployment environment of the PostgreSQL cluster. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -- `ENVIRONMENT_UNSPECIFIED` -- `PRODUCTION`: Stable environment with a conservative update policy: -only hotfixes are applied during regular maintenance. -- `PRESTABLE`: Environment with more aggressive update policy: new versions -are rolled out irrespective of backward compatibility. || -|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Description of monitoring systems relevant to the PostgreSQL cluster. || -|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Configuration of the PostgreSQL cluster. || -|| networkId | **string** +in milliseconds. || +|| lockTimeout | **string** (int64) -ID of the network that the cluster belongs to. || -|| health | **enum** (Health) +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Aggregated cluster health. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). -- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). -- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). -- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || -|| status | **enum** (Status) +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Current state of the cluster. +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -- `STATUS_UNKNOWN`: Cluster state is unknown. -- `CREATING`: Cluster is being created. -- `RUNNING`: Cluster is running normally. -- `ERROR`: Cluster encountered a problem and cannot operate. -- `UPDATING`: Cluster is being updated. -- `STOPPING`: Cluster is stopping. -- `STOPPED`: Cluster stopped. -- `STARTING`: Cluster is starting. || -|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Maintenance window for the cluster. || -|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** +in bytes. || +|| deadlockTimeout | **string** (int64) -Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || -|| securityGroupIds[] | **string** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -User security groups || -|| deletionProtection | **boolean** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| sqlInheritance | **boolean** -Deletion Protection inhibits deletion of the cluster || -|| hostGroupIds[] | **string** +This option has been removed in PostgreSQL 10. || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Host groups hosting VMs of the cluster. || -|# +in milliseconds. || +|| archiveTimeout | **string** (int64) -## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# -Monitoring system. +## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} #| ||Field | Description || -|| name | **string** +|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** -Name of the monitoring system. || -|| description | **string** +Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** -Description of the monitoring system. || -|| link | **string** +User-defined settings for a PostgreSQL 10 1C cluster. || +|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** -Link to the monitoring system charts for the PostgreSQL cluster. || +Default configuration for a PostgreSQL 10 1C cluster. || |# -## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} +## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || -|| version | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Version of PostgreSQL server software. || -|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** +in bytes. || +|| tempBuffers | **string** (int64) -Configuration of a PostgreSQL 9.6 server. +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -Configuration of a PostgreSQL 10 1C server. +in bytes. || +|| tempFileLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| vacuumCostDelay | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Configuration of a PostgreSQL 10 server. +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes || +|| backendFlushAfter | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -Configuration of a PostgreSQL 11 server. +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -Configuration of a PostgreSQL 11 1C server. +in bytes || +|| maxWalSize | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| minWalSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) -Configuration of a PostgreSQL 12 server. +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Configuration of a PostgreSQL 12 1C server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Configuration of a PostgreSQL 13 server. +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Configuration of a PostgreSQL 13 1C server. +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| lockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Configuration of a PostgreSQL 14 server. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -Configuration of a PostgreSQL 14 1C server. +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| deadlockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -Configuration of a PostgreSQL 15 server. +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| archiveTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -Configuration of a PostgreSQL 15 1C server. +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) -Configuration of a PostgreSQL 16 server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| onlineAnalyzeEnable | **boolean** || +|| plantunerFixEmptyTable | **boolean** || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| geqo | **boolean** -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -Configuration of a PostgreSQL 16 1C server. +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig2)** +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) -Configuration of the connection pooler. || -|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources2)** +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) -Resources allocated to PostgreSQL hosts. || -|| autofailover | **boolean** +selective pressure within the population || +|| geqoSeed | **number** (double) -Configuration setting which enables/disables autofailover in cluster. || -|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay2)** +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) -Time to start the daily backup, in the UTC timezone. || -|| backupRetainPeriodDays | **string** (int64) +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) -Retention policy of automated backups. || -|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access2)** +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -Access policy to DB || -|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics2)** +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -Configuration of the performance diagnostics service. || -|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling2)** +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. -Disk size autoscaling || +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} +## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** +|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** -Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** - -User-defined settings for a PostgreSQL 9.6 cluster. || -|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** +|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** -Default configuration for a PostgreSQL 9.6 cluster. || +User-defined settings for a PostgreSQL 10 cluster. || +|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** + +Default configuration for a PostgreSQL 10 cluster. || |# -## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62} +## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -19314,9 +22649,7 @@ in bytes || || checkpointTimeout | **string** (int64) in milliseconds. || -|| checkpointCompletionTarget | **number** (double) - -Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointCompletionTarget | **number** (double) || || checkpointFlushAfter | **string** (int64) in bytes || @@ -19469,9 +22802,6 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** - -This option has been removed in PostgreSQL 10. || || autovacuumMaxWorkers | **string** (int64) || || autovacuumVacuumCostDelay | **string** (int64) || || autovacuumVacuumCostLimit | **string** (int64) || @@ -19482,31 +22812,139 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) + +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} +## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** +|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** -Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** +|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** -User-defined settings for a PostgreSQL 10 1C cluster. || -|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** +User-defined settings for a PostgreSQL 11 cluster. || +|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** -Default configuration for a PostgreSQL 10 1C cluster. || +Default configuration for a PostgreSQL 11 cluster. || |# -## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2} +## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -19524,7 +22962,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -19747,6 +23184,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -19793,8 +23239,6 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || -|| onlineAnalyzeEnable | **boolean** || -|| plantunerFixEmptyTable | **boolean** || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -19824,6 +23268,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -19843,27 +23290,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} +## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** +|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** -Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** +|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** -User-defined settings for a PostgreSQL 10 cluster. || -|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** +User-defined settings for a PostgreSQL 11 1C cluster. || +|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** -Default configuration for a PostgreSQL 10 cluster. || +Default configuration for a PostgreSQL 11 1C cluster. || |# -## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102} +## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -19881,7 +23328,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -20086,6 +23532,7 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || || enableBitmapscan | **boolean** || || enableHashagg | **boolean** || || enableHashjoin | **boolean** || @@ -20104,6 +23551,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -20155,6 +23611,7 @@ in milliseconds. || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || || maxStackDepth | **string** (int64) in bytes. || @@ -20179,6 +23636,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -20198,23 +23658,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} +## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** +|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** -Effective settings for a PostgreSQL 11 cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** +|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** -User-defined settings for a PostgreSQL 11 cluster. || -|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** +User-defined settings for a PostgreSQL 12 cluster. || +|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** -Default configuration for a PostgreSQL 11 cluster. || +Default configuration for a PostgreSQL 12 cluster. || |# -## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112} +## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -20467,6 +23927,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -20564,23 +24031,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} +## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** +|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** -Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** +|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** -User-defined settings for a PostgreSQL 11 1C cluster. || -|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** +User-defined settings for a PostgreSQL 12 1C cluster. || +|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** -Default configuration for a PostgreSQL 11 1C cluster. || +Default configuration for a PostgreSQL 12 1C cluster. || |# -## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2} +## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -20834,6 +24301,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -20932,23 +24406,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} +## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** +|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** -Effective settings for a PostgreSQL 12 cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** +|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** -User-defined settings for a PostgreSQL 12 cluster. || -|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** +User-defined settings for a PostgreSQL 13 cluster. || +|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** -Default configuration for a PostgreSQL 12 cluster. || +Default configuration for a PostgreSQL 13 cluster. || |# -## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122} +## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -21254,6 +24728,30 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -21305,23 +24803,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} +## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** +|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** -Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** +|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** -User-defined settings for a PostgreSQL 12 1C cluster. || -|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** +User-defined settings for a PostgreSQL 13 1C cluster. || +|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** -Default configuration for a PostgreSQL 12 1C cluster. || +Default configuration for a PostgreSQL 13 1C cluster. || |# -## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2} +## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -21628,15 +25126,36 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || -|| maxStackDepth | **string** (int64) - -in bytes. || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -21680,23 +25199,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} +## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** +|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** -Effective settings for a PostgreSQL 13 cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** +|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** -User-defined settings for a PostgreSQL 13 cluster. || -|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** +User-defined settings for a PostgreSQL 14 cluster. || +|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** -Default configuration for a PostgreSQL 13 cluster. || +Default configuration for a PostgreSQL 14 cluster. || |# -## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132} +## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -21904,7 +25423,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -21948,7 +25466,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -22026,6 +25543,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -22077,23 +25609,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} +## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** +|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** -Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** +|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** -User-defined settings for a PostgreSQL 13 1C cluster. || -|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** +User-defined settings for a PostgreSQL 14 1C cluster. || +|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** -Default configuration for a PostgreSQL 13 1C cluster. || +Default configuration for a PostgreSQL 14 1C cluster. || |# -## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2} +## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -22301,7 +25833,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -22346,7 +25877,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -22424,6 +25954,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -22473,23 +26018,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} +## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** +|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** -Effective settings for a PostgreSQL 14 cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** +|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** -User-defined settings for a PostgreSQL 14 cluster. || -|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** +User-defined settings for a PostgreSQL 15 cluster. || +|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** -Default configuration for a PostgreSQL 14 cluster. || +Default configuration for a PostgreSQL 15 cluster. || |# -## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142} +## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -22759,7 +26304,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -22840,6 +26386,7 @@ in milliseconds. || || maxStackDepth | **string** (int64) in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -22883,23 +26430,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} +## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** +|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** -Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** +|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** -User-defined settings for a PostgreSQL 14 1C cluster. || -|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** +User-defined settings for a PostgreSQL 15 1C cluster. || +|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** -Default configuration for a PostgreSQL 14 1C cluster. || +Default configuration for a PostgreSQL 15 1C cluster. || |# -## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2} +## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -23170,7 +26717,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -23249,6 +26797,10 @@ in milliseconds. || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -23292,23 +26844,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} +## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** +|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** -Effective settings for a PostgreSQL 15 cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** +|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** -User-defined settings for a PostgreSQL 15 cluster. || -|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** +User-defined settings for a PostgreSQL 16 cluster. || +|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** -Default configuration for a PostgreSQL 15 cluster. || +Default configuration for a PostgreSQL 16 cluster. || |# -## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152} +## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -23394,12 +26946,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -23408,6 +26960,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -23422,6 +26975,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -23436,6 +26990,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -23607,6 +27162,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -23704,23 +27260,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} +## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** +|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** -Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** +|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** -User-defined settings for a PostgreSQL 15 1C cluster. || -|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** +User-defined settings for a PostgreSQL 16 1C cluster. || +|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** -Default configuration for a PostgreSQL 15 1C cluster. || +Default configuration for a PostgreSQL 16 1C cluster. || |# -## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2} +## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -23806,12 +27362,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -23820,6 +27376,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -23834,6 +27391,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -23848,6 +27406,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -24020,6 +27579,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -24118,27 +27678,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} +## PostgresqlConfigSet17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** +|| effectiveConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig172)** -Effective settings for a PostgreSQL 16 cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** +|| userConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig172)** -User-defined settings for a PostgreSQL 16 cluster. || -|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig172)** -Default configuration for a PostgreSQL 16 cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig172} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -24180,7 +27740,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -24532,29 +28091,42 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# -## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} +## PostgresqlConfigSet17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** +|| effectiveConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C2)** -Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** +|| userConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C2)** -User-defined settings for a PostgreSQL 16 1C cluster. || -|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C2)** -Default configuration for a PostgreSQL 16 1C cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2} +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -24596,7 +28168,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -24950,6 +28521,19 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# ## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig2} diff --git a/en/managed-postgresql/api-ref/Cluster/start.md b/en/managed-postgresql/api-ref/Cluster/start.md index 549474ba612..98587e71aa3 100644 --- a/en/managed-postgresql/api-ref/Cluster/start.md +++ b/en/managed-postgresql/api-ref/Cluster/start.md @@ -62,7 +62,7 @@ Required field. ID of the PostgreSQL cluster to start. || ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "effectiveConfig": { "maxConnections": "string", @@ -6810,6 +6810,1024 @@ Required field. ID of the PostgreSQL cluster to start. || "passwordEncryption": "string" } }, + "postgresqlConfig_17": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, + "postgresqlConfig_17_1c": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, // end of the list of possible fields "poolerConfig": { "poolingMode": "string", @@ -6874,367 +7892,990 @@ Required field. ID of the PostgreSQL cluster to start. || } ``` -An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). +An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). + +#| +||Field | Description || +|| id | **string** + +ID of the operation. || +|| description | **string** + +Description of the operation. 0-256 characters long. || +|| createdAt | **string** (date-time) + +Creation timestamp. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| createdBy | **string** + +ID of the user or service account who initiated the operation. || +|| modifiedAt | **string** (date-time) + +The time when the Operation resource was last modified. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| done | **boolean** + +If the value is `false`, it means the operation is still in progress. +If `true`, the operation is completed, and either `error` or `response` is available. || +|| metadata | **[StartClusterMetadata](#yandex.cloud.mdb.postgresql.v1.StartClusterMetadata)** + +Service-specific metadata associated with the operation. +It typically contains the ID of the target resource that the operation is performed on. +Any method that returns a long-running operation should document the metadata type, if any. || +|| error | **[Status](#google.rpc.Status)** + +The error result of the operation in case of failure or cancellation. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** + +The normal response of the operation in case of success. +If the original method returns no data on success, such as Delete, +the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). +If the original method is the standard Create/Update, +the response should be the target resource of the operation. +Any method that returns a long-running operation should document the response type, if any. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|# + +## StartClusterMetadata {#yandex.cloud.mdb.postgresql.v1.StartClusterMetadata} + +#| +||Field | Description || +|| clusterId | **string** + +ID of the PostgreSQL cluster. || +|# + +## Status {#google.rpc.Status} + +The error result of the operation in case of failure or cancellation. + +#| +||Field | Description || +|| code | **integer** (int32) + +Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || +|| message | **string** + +An error message. || +|| details[] | **object** + +A list of messages that carry the error details. || +|# + +## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} + +A PostgreSQL Cluster resource. For more information, see +the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. + +#| +||Field | Description || +|| id | **string** + +ID of the PostgreSQL cluster. +This ID is assigned by MDB at creation time. || +|| folderId | **string** + +ID of the folder that the PostgreSQL cluster belongs to. || +|| createdAt | **string** (date-time) + +Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| name | **string** + +Name of the PostgreSQL cluster. +The name is unique within the folder. 1-63 characters long. || +|| description | **string** + +Description of the PostgreSQL cluster. 0-256 characters long. || +|| labels | **string** + +Custom labels for the PostgreSQL cluster as `` key:value `` pairs. +Maximum 64 per resource. || +|| environment | **enum** (Environment) + +Deployment environment of the PostgreSQL cluster. + +- `ENVIRONMENT_UNSPECIFIED` +- `PRODUCTION`: Stable environment with a conservative update policy: +only hotfixes are applied during regular maintenance. +- `PRESTABLE`: Environment with more aggressive update policy: new versions +are rolled out irrespective of backward compatibility. || +|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** + +Description of monitoring systems relevant to the PostgreSQL cluster. || +|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** + +Configuration of the PostgreSQL cluster. || +|| networkId | **string** + +ID of the network that the cluster belongs to. || +|| health | **enum** (Health) + +Aggregated cluster health. + +- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). +- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). +- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). +- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || +|| status | **enum** (Status) + +Current state of the cluster. + +- `STATUS_UNKNOWN`: Cluster state is unknown. +- `CREATING`: Cluster is being created. +- `RUNNING`: Cluster is running normally. +- `ERROR`: Cluster encountered a problem and cannot operate. +- `UPDATING`: Cluster is being updated. +- `STOPPING`: Cluster is stopping. +- `STOPPED`: Cluster stopped. +- `STARTING`: Cluster is starting. || +|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** + +Maintenance window for the cluster. || +|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** + +Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || +|| securityGroupIds[] | **string** + +User security groups || +|| deletionProtection | **boolean** + +Deletion Protection inhibits deletion of the cluster || +|| hostGroupIds[] | **string** + +Host groups hosting VMs of the cluster. || +|# + +## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} + +Monitoring system. + +#| +||Field | Description || +|| name | **string** + +Name of the monitoring system. || +|| description | **string** + +Description of the monitoring system. || +|| link | **string** + +Link to the monitoring system charts for the PostgreSQL cluster. || +|# + +## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} + +#| +||Field | Description || +|| version | **string** + +Version of PostgreSQL server software. || +|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** + +Configuration of a PostgreSQL 9.6 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** + +Configuration of a PostgreSQL 10 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** + +Configuration of a PostgreSQL 10 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** + +Configuration of a PostgreSQL 11 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** + +Configuration of a PostgreSQL 11 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** + +Configuration of a PostgreSQL 12 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** + +Configuration of a PostgreSQL 12 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** + +Configuration of a PostgreSQL 13 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** -#| -||Field | Description || -|| id | **string** +Configuration of a PostgreSQL 13 1C server. -ID of the operation. || -|| description | **string** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Description of the operation. 0-256 characters long. || -|| createdAt | **string** (date-time) +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** -Creation timestamp. +Configuration of a PostgreSQL 14 server. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| createdBy | **string** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** -ID of the user or service account who initiated the operation. || -|| modifiedAt | **string** (date-time) +Configuration of a PostgreSQL 14 1C server. -The time when the Operation resource was last modified. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| done | **boolean** +Configuration of a PostgreSQL 15 server. -If the value is `false`, it means the operation is still in progress. -If `true`, the operation is completed, and either `error` or `response` is available. || -|| metadata | **[StartClusterMetadata](#yandex.cloud.mdb.postgresql.v1.StartClusterMetadata)** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Service-specific metadata associated with the operation. -It typically contains the ID of the target resource that the operation is performed on. -Any method that returns a long-running operation should document the metadata type, if any. || -|| error | **[Status](#google.rpc.Status)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** -The error result of the operation in case of failure or cancellation. +Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `error`, `response`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || -|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** -The normal response of the operation in case of success. -If the original method returns no data on success, such as Delete, -the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). -If the original method is the standard Create/Update, -the response should be the target resource of the operation. -Any method that returns a long-running operation should document the response type, if any. +Configuration of a PostgreSQL 16 server. -Includes only one of the fields `error`, `response`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** + +Configuration of a PostgreSQL 16 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfigSet17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfigSet17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** + +Configuration of the connection pooler. || +|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** + +Resources allocated to PostgreSQL hosts. || +|| autofailover | **boolean** + +Configuration setting which enables/disables autofailover in cluster. || +|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** + +Time to start the daily backup, in the UTC timezone. || +|| backupRetainPeriodDays | **string** (int64) + +Retention policy of automated backups. || +|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** + +Access policy to DB || +|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** + +Configuration of the performance diagnostics service. || +|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** + +Disk size autoscaling || |# -## StartClusterMetadata {#yandex.cloud.mdb.postgresql.v1.StartClusterMetadata} +## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} #| ||Field | Description || -|| clusterId | **string** +|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -ID of the PostgreSQL cluster. || +Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** + +User-defined settings for a PostgreSQL 9.6 cluster. || +|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** + +Default configuration for a PostgreSQL 9.6 cluster. || |# -## Status {#google.rpc.Status} +## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} -The error result of the operation in case of failure or cancellation. +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). #| ||Field | Description || -|| code | **integer** (int32) +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || -|| message | **string** +in bytes. || +|| tempBuffers | **string** (int64) -An error message. || -|| details[] | **object** +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -A list of messages that carry the error details. || -|# +in bytes. || +|| maintenanceWorkMem | **string** (int64) -## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -A PostgreSQL Cluster resource. For more information, see -the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. +in bytes. || +|| tempFileLimit | **string** (int64) -#| -||Field | Description || -|| id | **string** +in bytes. || +|| vacuumCostDelay | **string** (int64) -ID of the PostgreSQL cluster. -This ID is assigned by MDB at creation time. || -|| folderId | **string** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -ID of the folder that the PostgreSQL cluster belongs to. || -|| createdAt | **string** (date-time) +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. +in bytes || +|| backendFlushAfter | **string** (int64) -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| name | **string** +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Name of the PostgreSQL cluster. -The name is unique within the folder. 1-63 characters long. || -|| description | **string** +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) + +Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Description of the PostgreSQL cluster. 0-256 characters long. || -|| labels | **string** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Custom labels for the PostgreSQL cluster as `` key:value `` pairs. -Maximum 64 per resource. || -|| environment | **enum** (Environment) +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Deployment environment of the PostgreSQL cluster. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -- `ENVIRONMENT_UNSPECIFIED` -- `PRODUCTION`: Stable environment with a conservative update policy: -only hotfixes are applied during regular maintenance. -- `PRESTABLE`: Environment with more aggressive update policy: new versions -are rolled out irrespective of backward compatibility. || -|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Description of monitoring systems relevant to the PostgreSQL cluster. || -|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Configuration of the PostgreSQL cluster. || -|| networkId | **string** +in milliseconds. || +|| lockTimeout | **string** (int64) -ID of the network that the cluster belongs to. || -|| health | **enum** (Health) +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Aggregated cluster health. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). -- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). -- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). -- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || -|| status | **enum** (Status) +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Current state of the cluster. +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -- `STATUS_UNKNOWN`: Cluster state is unknown. -- `CREATING`: Cluster is being created. -- `RUNNING`: Cluster is running normally. -- `ERROR`: Cluster encountered a problem and cannot operate. -- `UPDATING`: Cluster is being updated. -- `STOPPING`: Cluster is stopping. -- `STOPPED`: Cluster stopped. -- `STARTING`: Cluster is starting. || -|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Maintenance window for the cluster. || -|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** +in bytes. || +|| deadlockTimeout | **string** (int64) -Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || -|| securityGroupIds[] | **string** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -User security groups || -|| deletionProtection | **boolean** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| sqlInheritance | **boolean** -Deletion Protection inhibits deletion of the cluster || -|| hostGroupIds[] | **string** +This option has been removed in PostgreSQL 10. || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Host groups hosting VMs of the cluster. || -|# +in milliseconds. || +|| archiveTimeout | **string** (int64) -## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# -Monitoring system. +## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} #| ||Field | Description || -|| name | **string** +|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Name of the monitoring system. || -|| description | **string** +Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Description of the monitoring system. || -|| link | **string** +User-defined settings for a PostgreSQL 10 1C cluster. || +|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Link to the monitoring system charts for the PostgreSQL cluster. || +Default configuration for a PostgreSQL 10 1C cluster. || |# -## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} +## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || -|| version | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Version of PostgreSQL server software. || -|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** +in bytes. || +|| tempBuffers | **string** (int64) -Configuration of a PostgreSQL 9.6 server. +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -Configuration of a PostgreSQL 10 1C server. +in bytes. || +|| tempFileLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| vacuumCostDelay | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Configuration of a PostgreSQL 10 server. +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes || +|| backendFlushAfter | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -Configuration of a PostgreSQL 11 server. +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -Configuration of a PostgreSQL 11 1C server. +in bytes || +|| maxWalSize | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| minWalSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) -Configuration of a PostgreSQL 12 server. +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Configuration of a PostgreSQL 12 1C server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Configuration of a PostgreSQL 13 server. +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Configuration of a PostgreSQL 13 1C server. +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| lockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Configuration of a PostgreSQL 14 server. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -Configuration of a PostgreSQL 14 1C server. +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| deadlockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -Configuration of a PostgreSQL 15 server. +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| archiveTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -Configuration of a PostgreSQL 15 1C server. +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) -Configuration of a PostgreSQL 16 server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| onlineAnalyzeEnable | **boolean** || +|| plantunerFixEmptyTable | **boolean** || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| geqo | **boolean** -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -Configuration of a PostgreSQL 16 1C server. +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) -Configuration of the connection pooler. || -|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) -Resources allocated to PostgreSQL hosts. || -|| autofailover | **boolean** +selective pressure within the population || +|| geqoSeed | **number** (double) -Configuration setting which enables/disables autofailover in cluster. || -|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) -Time to start the daily backup, in the UTC timezone. || -|| backupRetainPeriodDays | **string** (int64) +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) -Retention policy of automated backups. || -|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -Access policy to DB || -|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -Configuration of the performance diagnostics service. || -|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. -Disk size autoscaling || +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} +## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** - -User-defined settings for a PostgreSQL 9.6 cluster. || -|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Default configuration for a PostgreSQL 9.6 cluster. || +User-defined settings for a PostgreSQL 10 cluster. || +|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** + +Default configuration for a PostgreSQL 10 cluster. || |# -## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} +## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -7294,9 +8935,7 @@ in bytes || || checkpointTimeout | **string** (int64) in milliseconds. || -|| checkpointCompletionTarget | **number** (double) - -Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointCompletionTarget | **number** (double) || || checkpointFlushAfter | **string** (int64) in bytes || @@ -7449,9 +9088,6 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** - -This option has been removed in PostgreSQL 10. || || autovacuumMaxWorkers | **string** (int64) || || autovacuumVacuumCostDelay | **string** (int64) || || autovacuumVacuumCostLimit | **string** (int64) || @@ -7462,31 +9098,139 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) + +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} +## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -User-defined settings for a PostgreSQL 10 1C cluster. || -|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +User-defined settings for a PostgreSQL 11 cluster. || +|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Default configuration for a PostgreSQL 10 1C cluster. || +Default configuration for a PostgreSQL 11 cluster. || |# -## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} +## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7504,7 +9248,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -7727,6 +9470,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -7773,8 +9525,6 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || -|| onlineAnalyzeEnable | **boolean** || -|| plantunerFixEmptyTable | **boolean** || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -7804,6 +9554,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -7823,27 +9576,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} +## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -User-defined settings for a PostgreSQL 10 cluster. || -|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +User-defined settings for a PostgreSQL 11 1C cluster. || +|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Default configuration for a PostgreSQL 10 cluster. || +Default configuration for a PostgreSQL 11 1C cluster. || |# -## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} +## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7861,7 +9614,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -8066,6 +9818,7 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || || enableBitmapscan | **boolean** || || enableHashagg | **boolean** || || enableHashjoin | **boolean** || @@ -8084,6 +9837,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8135,6 +9897,7 @@ in milliseconds. || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || || maxStackDepth | **string** (int64) in bytes. || @@ -8159,6 +9922,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -8178,23 +9944,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} +## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Effective settings for a PostgreSQL 11 cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -User-defined settings for a PostgreSQL 11 cluster. || -|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +User-defined settings for a PostgreSQL 12 cluster. || +|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Default configuration for a PostgreSQL 11 cluster. || +Default configuration for a PostgreSQL 12 cluster. || |# -## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} +## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8447,6 +10213,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8544,23 +10317,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} +## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -User-defined settings for a PostgreSQL 11 1C cluster. || -|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +User-defined settings for a PostgreSQL 12 1C cluster. || +|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Default configuration for a PostgreSQL 11 1C cluster. || +Default configuration for a PostgreSQL 12 1C cluster. || |# -## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} +## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8814,6 +10587,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8912,23 +10692,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} +## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Effective settings for a PostgreSQL 12 cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -User-defined settings for a PostgreSQL 12 cluster. || -|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +User-defined settings for a PostgreSQL 13 cluster. || +|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Default configuration for a PostgreSQL 12 cluster. || +Default configuration for a PostgreSQL 13 cluster. || |# -## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} +## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9234,6 +11014,30 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -9285,23 +11089,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} +## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -User-defined settings for a PostgreSQL 12 1C cluster. || -|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +User-defined settings for a PostgreSQL 13 1C cluster. || +|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Default configuration for a PostgreSQL 12 1C cluster. || +Default configuration for a PostgreSQL 13 1C cluster. || |# -## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} +## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9608,15 +11412,36 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || -|| maxStackDepth | **string** (int64) - -in bytes. || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -9660,23 +11485,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} +## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Effective settings for a PostgreSQL 13 cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -User-defined settings for a PostgreSQL 13 cluster. || -|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +User-defined settings for a PostgreSQL 14 cluster. || +|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Default configuration for a PostgreSQL 13 cluster. || +Default configuration for a PostgreSQL 14 cluster. || |# -## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} +## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9884,7 +11709,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -9928,7 +11752,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10006,6 +11829,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10057,23 +11895,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} +## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -User-defined settings for a PostgreSQL 13 1C cluster. || -|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +User-defined settings for a PostgreSQL 14 1C cluster. || +|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Default configuration for a PostgreSQL 13 1C cluster. || +Default configuration for a PostgreSQL 14 1C cluster. || |# -## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} +## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10281,7 +12119,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -10326,7 +12163,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10404,6 +12240,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10453,23 +12304,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} +## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Effective settings for a PostgreSQL 14 cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -User-defined settings for a PostgreSQL 14 cluster. || -|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +User-defined settings for a PostgreSQL 15 cluster. || +|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Default configuration for a PostgreSQL 14 cluster. || +Default configuration for a PostgreSQL 15 cluster. || |# -## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} +## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10739,7 +12590,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -10820,6 +12672,7 @@ in milliseconds. || || maxStackDepth | **string** (int64) in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -10863,23 +12716,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} +## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -User-defined settings for a PostgreSQL 14 1C cluster. || -|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +User-defined settings for a PostgreSQL 15 1C cluster. || +|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Default configuration for a PostgreSQL 14 1C cluster. || +Default configuration for a PostgreSQL 15 1C cluster. || |# -## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} +## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11150,7 +13003,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -11229,6 +13083,10 @@ in milliseconds. || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -11272,23 +13130,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} +## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Effective settings for a PostgreSQL 15 cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -User-defined settings for a PostgreSQL 15 cluster. || -|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +User-defined settings for a PostgreSQL 16 cluster. || +|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Default configuration for a PostgreSQL 15 cluster. || +Default configuration for a PostgreSQL 16 cluster. || |# -## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} +## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11374,12 +13232,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11388,6 +13246,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11402,6 +13261,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11416,6 +13276,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11587,6 +13448,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11684,23 +13546,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} +## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -User-defined settings for a PostgreSQL 15 1C cluster. || -|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +User-defined settings for a PostgreSQL 16 1C cluster. || +|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Default configuration for a PostgreSQL 15 1C cluster. || +Default configuration for a PostgreSQL 16 1C cluster. || |# -## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} +## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11786,12 +13648,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11800,6 +13662,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11814,6 +13677,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11828,6 +13692,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12000,6 +13865,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12098,27 +13964,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} +## PostgresqlConfigSet17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| effectiveConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Effective settings for a PostgreSQL 16 cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| userConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -User-defined settings for a PostgreSQL 16 cluster. || -|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Default configuration for a PostgreSQL 16 cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12160,7 +14026,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12512,29 +14377,42 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# -## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} +## PostgresqlConfigSet17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| effectiveConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| userConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -User-defined settings for a PostgreSQL 16 1C cluster. || -|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Default configuration for a PostgreSQL 16 1C cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12576,7 +14454,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12930,6 +14807,19 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# ## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig} diff --git a/en/managed-postgresql/api-ref/Cluster/startFailover.md b/en/managed-postgresql/api-ref/Cluster/startFailover.md index 097aae5f991..8a4adf90155 100644 --- a/en/managed-postgresql/api-ref/Cluster/startFailover.md +++ b/en/managed-postgresql/api-ref/Cluster/startFailover.md @@ -77,7 +77,7 @@ New master host. Switch to the most up-to-date replica if not provided. || ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "effectiveConfig": { "maxConnections": "string", @@ -6825,6 +6825,1024 @@ New master host. Switch to the most up-to-date replica if not provided. || "passwordEncryption": "string" } }, + "postgresqlConfig_17": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, + "postgresqlConfig_17_1c": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, // end of the list of possible fields "poolerConfig": { "poolingMode": "string", @@ -6889,367 +7907,990 @@ New master host. Switch to the most up-to-date replica if not provided. || } ``` -An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). +An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). + +#| +||Field | Description || +|| id | **string** + +ID of the operation. || +|| description | **string** + +Description of the operation. 0-256 characters long. || +|| createdAt | **string** (date-time) + +Creation timestamp. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| createdBy | **string** + +ID of the user or service account who initiated the operation. || +|| modifiedAt | **string** (date-time) + +The time when the Operation resource was last modified. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| done | **boolean** + +If the value is `false`, it means the operation is still in progress. +If `true`, the operation is completed, and either `error` or `response` is available. || +|| metadata | **[StartClusterFailoverMetadata](#yandex.cloud.mdb.postgresql.v1.StartClusterFailoverMetadata)** + +Service-specific metadata associated with the operation. +It typically contains the ID of the target resource that the operation is performed on. +Any method that returns a long-running operation should document the metadata type, if any. || +|| error | **[Status](#google.rpc.Status)** + +The error result of the operation in case of failure or cancellation. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** + +The normal response of the operation in case of success. +If the original method returns no data on success, such as Delete, +the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). +If the original method is the standard Create/Update, +the response should be the target resource of the operation. +Any method that returns a long-running operation should document the response type, if any. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|# + +## StartClusterFailoverMetadata {#yandex.cloud.mdb.postgresql.v1.StartClusterFailoverMetadata} + +#| +||Field | Description || +|| clusterId | **string** + +ID of the PostgreSQL cluster being failovered. || +|# + +## Status {#google.rpc.Status} + +The error result of the operation in case of failure or cancellation. + +#| +||Field | Description || +|| code | **integer** (int32) + +Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || +|| message | **string** + +An error message. || +|| details[] | **object** + +A list of messages that carry the error details. || +|# + +## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} + +A PostgreSQL Cluster resource. For more information, see +the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. + +#| +||Field | Description || +|| id | **string** + +ID of the PostgreSQL cluster. +This ID is assigned by MDB at creation time. || +|| folderId | **string** + +ID of the folder that the PostgreSQL cluster belongs to. || +|| createdAt | **string** (date-time) + +Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| name | **string** + +Name of the PostgreSQL cluster. +The name is unique within the folder. 1-63 characters long. || +|| description | **string** + +Description of the PostgreSQL cluster. 0-256 characters long. || +|| labels | **string** + +Custom labels for the PostgreSQL cluster as `` key:value `` pairs. +Maximum 64 per resource. || +|| environment | **enum** (Environment) + +Deployment environment of the PostgreSQL cluster. + +- `ENVIRONMENT_UNSPECIFIED` +- `PRODUCTION`: Stable environment with a conservative update policy: +only hotfixes are applied during regular maintenance. +- `PRESTABLE`: Environment with more aggressive update policy: new versions +are rolled out irrespective of backward compatibility. || +|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** + +Description of monitoring systems relevant to the PostgreSQL cluster. || +|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** + +Configuration of the PostgreSQL cluster. || +|| networkId | **string** + +ID of the network that the cluster belongs to. || +|| health | **enum** (Health) + +Aggregated cluster health. + +- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). +- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). +- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). +- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || +|| status | **enum** (Status) + +Current state of the cluster. + +- `STATUS_UNKNOWN`: Cluster state is unknown. +- `CREATING`: Cluster is being created. +- `RUNNING`: Cluster is running normally. +- `ERROR`: Cluster encountered a problem and cannot operate. +- `UPDATING`: Cluster is being updated. +- `STOPPING`: Cluster is stopping. +- `STOPPED`: Cluster stopped. +- `STARTING`: Cluster is starting. || +|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** + +Maintenance window for the cluster. || +|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** + +Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || +|| securityGroupIds[] | **string** + +User security groups || +|| deletionProtection | **boolean** + +Deletion Protection inhibits deletion of the cluster || +|| hostGroupIds[] | **string** + +Host groups hosting VMs of the cluster. || +|# + +## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} + +Monitoring system. + +#| +||Field | Description || +|| name | **string** + +Name of the monitoring system. || +|| description | **string** + +Description of the monitoring system. || +|| link | **string** + +Link to the monitoring system charts for the PostgreSQL cluster. || +|# + +## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} + +#| +||Field | Description || +|| version | **string** + +Version of PostgreSQL server software. || +|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** + +Configuration of a PostgreSQL 9.6 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** + +Configuration of a PostgreSQL 10 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** + +Configuration of a PostgreSQL 10 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** + +Configuration of a PostgreSQL 11 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** + +Configuration of a PostgreSQL 11 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** + +Configuration of a PostgreSQL 12 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** + +Configuration of a PostgreSQL 12 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** + +Configuration of a PostgreSQL 13 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** -#| -||Field | Description || -|| id | **string** +Configuration of a PostgreSQL 13 1C server. -ID of the operation. || -|| description | **string** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Description of the operation. 0-256 characters long. || -|| createdAt | **string** (date-time) +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** -Creation timestamp. +Configuration of a PostgreSQL 14 server. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| createdBy | **string** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** -ID of the user or service account who initiated the operation. || -|| modifiedAt | **string** (date-time) +Configuration of a PostgreSQL 14 1C server. -The time when the Operation resource was last modified. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| done | **boolean** +Configuration of a PostgreSQL 15 server. -If the value is `false`, it means the operation is still in progress. -If `true`, the operation is completed, and either `error` or `response` is available. || -|| metadata | **[StartClusterFailoverMetadata](#yandex.cloud.mdb.postgresql.v1.StartClusterFailoverMetadata)** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Service-specific metadata associated with the operation. -It typically contains the ID of the target resource that the operation is performed on. -Any method that returns a long-running operation should document the metadata type, if any. || -|| error | **[Status](#google.rpc.Status)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** -The error result of the operation in case of failure or cancellation. +Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `error`, `response`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || -|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** -The normal response of the operation in case of success. -If the original method returns no data on success, such as Delete, -the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). -If the original method is the standard Create/Update, -the response should be the target resource of the operation. -Any method that returns a long-running operation should document the response type, if any. +Configuration of a PostgreSQL 16 server. -Includes only one of the fields `error`, `response`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** + +Configuration of a PostgreSQL 16 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfigSet17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfigSet17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** + +Configuration of the connection pooler. || +|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** + +Resources allocated to PostgreSQL hosts. || +|| autofailover | **boolean** + +Configuration setting which enables/disables autofailover in cluster. || +|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** + +Time to start the daily backup, in the UTC timezone. || +|| backupRetainPeriodDays | **string** (int64) + +Retention policy of automated backups. || +|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** + +Access policy to DB || +|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** + +Configuration of the performance diagnostics service. || +|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** + +Disk size autoscaling || |# -## StartClusterFailoverMetadata {#yandex.cloud.mdb.postgresql.v1.StartClusterFailoverMetadata} +## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} #| ||Field | Description || -|| clusterId | **string** +|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -ID of the PostgreSQL cluster being failovered. || +Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** + +User-defined settings for a PostgreSQL 9.6 cluster. || +|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** + +Default configuration for a PostgreSQL 9.6 cluster. || |# -## Status {#google.rpc.Status} +## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} -The error result of the operation in case of failure or cancellation. +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). #| ||Field | Description || -|| code | **integer** (int32) +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || -|| message | **string** +in bytes. || +|| tempBuffers | **string** (int64) -An error message. || -|| details[] | **object** +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -A list of messages that carry the error details. || -|# +in bytes. || +|| maintenanceWorkMem | **string** (int64) -## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -A PostgreSQL Cluster resource. For more information, see -the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. +in bytes. || +|| tempFileLimit | **string** (int64) -#| -||Field | Description || -|| id | **string** +in bytes. || +|| vacuumCostDelay | **string** (int64) -ID of the PostgreSQL cluster. -This ID is assigned by MDB at creation time. || -|| folderId | **string** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -ID of the folder that the PostgreSQL cluster belongs to. || -|| createdAt | **string** (date-time) +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. +in bytes || +|| backendFlushAfter | **string** (int64) -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| name | **string** +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Name of the PostgreSQL cluster. -The name is unique within the folder. 1-63 characters long. || -|| description | **string** +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) + +Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Description of the PostgreSQL cluster. 0-256 characters long. || -|| labels | **string** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Custom labels for the PostgreSQL cluster as `` key:value `` pairs. -Maximum 64 per resource. || -|| environment | **enum** (Environment) +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Deployment environment of the PostgreSQL cluster. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -- `ENVIRONMENT_UNSPECIFIED` -- `PRODUCTION`: Stable environment with a conservative update policy: -only hotfixes are applied during regular maintenance. -- `PRESTABLE`: Environment with more aggressive update policy: new versions -are rolled out irrespective of backward compatibility. || -|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Description of monitoring systems relevant to the PostgreSQL cluster. || -|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Configuration of the PostgreSQL cluster. || -|| networkId | **string** +in milliseconds. || +|| lockTimeout | **string** (int64) -ID of the network that the cluster belongs to. || -|| health | **enum** (Health) +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Aggregated cluster health. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). -- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). -- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). -- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || -|| status | **enum** (Status) +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Current state of the cluster. +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -- `STATUS_UNKNOWN`: Cluster state is unknown. -- `CREATING`: Cluster is being created. -- `RUNNING`: Cluster is running normally. -- `ERROR`: Cluster encountered a problem and cannot operate. -- `UPDATING`: Cluster is being updated. -- `STOPPING`: Cluster is stopping. -- `STOPPED`: Cluster stopped. -- `STARTING`: Cluster is starting. || -|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Maintenance window for the cluster. || -|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** +in bytes. || +|| deadlockTimeout | **string** (int64) -Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || -|| securityGroupIds[] | **string** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -User security groups || -|| deletionProtection | **boolean** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| sqlInheritance | **boolean** -Deletion Protection inhibits deletion of the cluster || -|| hostGroupIds[] | **string** +This option has been removed in PostgreSQL 10. || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Host groups hosting VMs of the cluster. || -|# +in milliseconds. || +|| archiveTimeout | **string** (int64) -## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# -Monitoring system. +## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} #| ||Field | Description || -|| name | **string** +|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Name of the monitoring system. || -|| description | **string** +Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Description of the monitoring system. || -|| link | **string** +User-defined settings for a PostgreSQL 10 1C cluster. || +|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Link to the monitoring system charts for the PostgreSQL cluster. || +Default configuration for a PostgreSQL 10 1C cluster. || |# -## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} +## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || -|| version | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Version of PostgreSQL server software. || -|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** +in bytes. || +|| tempBuffers | **string** (int64) -Configuration of a PostgreSQL 9.6 server. +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -Configuration of a PostgreSQL 10 1C server. +in bytes. || +|| tempFileLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| vacuumCostDelay | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Configuration of a PostgreSQL 10 server. +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes || +|| backendFlushAfter | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -Configuration of a PostgreSQL 11 server. +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -Configuration of a PostgreSQL 11 1C server. +in bytes || +|| maxWalSize | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| minWalSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) -Configuration of a PostgreSQL 12 server. +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Configuration of a PostgreSQL 12 1C server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Configuration of a PostgreSQL 13 server. +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Configuration of a PostgreSQL 13 1C server. +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| lockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Configuration of a PostgreSQL 14 server. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -Configuration of a PostgreSQL 14 1C server. +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| deadlockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -Configuration of a PostgreSQL 15 server. +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| archiveTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -Configuration of a PostgreSQL 15 1C server. +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) -Configuration of a PostgreSQL 16 server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| onlineAnalyzeEnable | **boolean** || +|| plantunerFixEmptyTable | **boolean** || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| geqo | **boolean** -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -Configuration of a PostgreSQL 16 1C server. +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) -Configuration of the connection pooler. || -|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) -Resources allocated to PostgreSQL hosts. || -|| autofailover | **boolean** +selective pressure within the population || +|| geqoSeed | **number** (double) -Configuration setting which enables/disables autofailover in cluster. || -|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) -Time to start the daily backup, in the UTC timezone. || -|| backupRetainPeriodDays | **string** (int64) +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) -Retention policy of automated backups. || -|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -Access policy to DB || -|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -Configuration of the performance diagnostics service. || -|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. -Disk size autoscaling || +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} +## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** - -User-defined settings for a PostgreSQL 9.6 cluster. || -|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Default configuration for a PostgreSQL 9.6 cluster. || +User-defined settings for a PostgreSQL 10 cluster. || +|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** + +Default configuration for a PostgreSQL 10 cluster. || |# -## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} +## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -7309,9 +8950,7 @@ in bytes || || checkpointTimeout | **string** (int64) in milliseconds. || -|| checkpointCompletionTarget | **number** (double) - -Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointCompletionTarget | **number** (double) || || checkpointFlushAfter | **string** (int64) in bytes || @@ -7464,9 +9103,6 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** - -This option has been removed in PostgreSQL 10. || || autovacuumMaxWorkers | **string** (int64) || || autovacuumVacuumCostDelay | **string** (int64) || || autovacuumVacuumCostLimit | **string** (int64) || @@ -7477,31 +9113,139 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) + +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} +## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -User-defined settings for a PostgreSQL 10 1C cluster. || -|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +User-defined settings for a PostgreSQL 11 cluster. || +|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Default configuration for a PostgreSQL 10 1C cluster. || +Default configuration for a PostgreSQL 11 cluster. || |# -## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} +## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7519,7 +9263,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -7742,6 +9485,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -7788,8 +9540,6 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || -|| onlineAnalyzeEnable | **boolean** || -|| plantunerFixEmptyTable | **boolean** || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -7819,6 +9569,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -7838,27 +9591,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} +## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -User-defined settings for a PostgreSQL 10 cluster. || -|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +User-defined settings for a PostgreSQL 11 1C cluster. || +|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Default configuration for a PostgreSQL 10 cluster. || +Default configuration for a PostgreSQL 11 1C cluster. || |# -## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} +## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7876,7 +9629,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -8081,6 +9833,7 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || || enableBitmapscan | **boolean** || || enableHashagg | **boolean** || || enableHashjoin | **boolean** || @@ -8099,6 +9852,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8150,6 +9912,7 @@ in milliseconds. || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || || maxStackDepth | **string** (int64) in bytes. || @@ -8174,6 +9937,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -8193,23 +9959,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} +## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Effective settings for a PostgreSQL 11 cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -User-defined settings for a PostgreSQL 11 cluster. || -|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +User-defined settings for a PostgreSQL 12 cluster. || +|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Default configuration for a PostgreSQL 11 cluster. || +Default configuration for a PostgreSQL 12 cluster. || |# -## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} +## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8462,6 +10228,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8559,23 +10332,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} +## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -User-defined settings for a PostgreSQL 11 1C cluster. || -|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +User-defined settings for a PostgreSQL 12 1C cluster. || +|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Default configuration for a PostgreSQL 11 1C cluster. || +Default configuration for a PostgreSQL 12 1C cluster. || |# -## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} +## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8829,6 +10602,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8927,23 +10707,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} +## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Effective settings for a PostgreSQL 12 cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -User-defined settings for a PostgreSQL 12 cluster. || -|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +User-defined settings for a PostgreSQL 13 cluster. || +|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Default configuration for a PostgreSQL 12 cluster. || +Default configuration for a PostgreSQL 13 cluster. || |# -## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} +## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9249,6 +11029,30 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -9300,23 +11104,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} +## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -User-defined settings for a PostgreSQL 12 1C cluster. || -|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +User-defined settings for a PostgreSQL 13 1C cluster. || +|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Default configuration for a PostgreSQL 12 1C cluster. || +Default configuration for a PostgreSQL 13 1C cluster. || |# -## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} +## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9623,15 +11427,36 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || -|| maxStackDepth | **string** (int64) - -in bytes. || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -9675,23 +11500,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} +## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Effective settings for a PostgreSQL 13 cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -User-defined settings for a PostgreSQL 13 cluster. || -|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +User-defined settings for a PostgreSQL 14 cluster. || +|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Default configuration for a PostgreSQL 13 cluster. || +Default configuration for a PostgreSQL 14 cluster. || |# -## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} +## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9899,7 +11724,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -9943,7 +11767,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10021,6 +11844,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10072,23 +11910,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} +## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -User-defined settings for a PostgreSQL 13 1C cluster. || -|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +User-defined settings for a PostgreSQL 14 1C cluster. || +|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Default configuration for a PostgreSQL 13 1C cluster. || +Default configuration for a PostgreSQL 14 1C cluster. || |# -## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} +## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10296,7 +12134,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -10341,7 +12178,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10419,6 +12255,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10468,23 +12319,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} +## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Effective settings for a PostgreSQL 14 cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -User-defined settings for a PostgreSQL 14 cluster. || -|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +User-defined settings for a PostgreSQL 15 cluster. || +|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Default configuration for a PostgreSQL 14 cluster. || +Default configuration for a PostgreSQL 15 cluster. || |# -## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} +## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10754,7 +12605,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -10835,6 +12687,7 @@ in milliseconds. || || maxStackDepth | **string** (int64) in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -10878,23 +12731,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} +## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -User-defined settings for a PostgreSQL 14 1C cluster. || -|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +User-defined settings for a PostgreSQL 15 1C cluster. || +|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Default configuration for a PostgreSQL 14 1C cluster. || +Default configuration for a PostgreSQL 15 1C cluster. || |# -## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} +## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11165,7 +13018,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -11244,6 +13098,10 @@ in milliseconds. || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -11287,23 +13145,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} +## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Effective settings for a PostgreSQL 15 cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -User-defined settings for a PostgreSQL 15 cluster. || -|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +User-defined settings for a PostgreSQL 16 cluster. || +|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Default configuration for a PostgreSQL 15 cluster. || +Default configuration for a PostgreSQL 16 cluster. || |# -## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} +## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11389,12 +13247,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11403,6 +13261,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11417,6 +13276,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11431,6 +13291,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11602,6 +13463,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11699,23 +13561,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} +## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -User-defined settings for a PostgreSQL 15 1C cluster. || -|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +User-defined settings for a PostgreSQL 16 1C cluster. || +|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Default configuration for a PostgreSQL 15 1C cluster. || +Default configuration for a PostgreSQL 16 1C cluster. || |# -## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} +## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11801,12 +13663,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11815,6 +13677,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11829,6 +13692,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11843,6 +13707,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12015,6 +13880,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12113,27 +13979,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} +## PostgresqlConfigSet17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| effectiveConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Effective settings for a PostgreSQL 16 cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| userConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -User-defined settings for a PostgreSQL 16 cluster. || -|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Default configuration for a PostgreSQL 16 cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12175,7 +14041,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12527,29 +14392,42 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# -## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} +## PostgresqlConfigSet17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| effectiveConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| userConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -User-defined settings for a PostgreSQL 16 1C cluster. || -|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Default configuration for a PostgreSQL 16 1C cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12591,7 +14469,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12945,6 +14822,19 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# ## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig} diff --git a/en/managed-postgresql/api-ref/Cluster/stop.md b/en/managed-postgresql/api-ref/Cluster/stop.md index 6c1ca7243ef..025ae7e0174 100644 --- a/en/managed-postgresql/api-ref/Cluster/stop.md +++ b/en/managed-postgresql/api-ref/Cluster/stop.md @@ -62,7 +62,7 @@ Required field. ID of the PostgreSQL cluster to stop. || ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "effectiveConfig": { "maxConnections": "string", @@ -6810,6 +6810,1024 @@ Required field. ID of the PostgreSQL cluster to stop. || "passwordEncryption": "string" } }, + "postgresqlConfig_17": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, + "postgresqlConfig_17_1c": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, // end of the list of possible fields "poolerConfig": { "poolingMode": "string", @@ -6874,367 +7892,990 @@ Required field. ID of the PostgreSQL cluster to stop. || } ``` -An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). +An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). + +#| +||Field | Description || +|| id | **string** + +ID of the operation. || +|| description | **string** + +Description of the operation. 0-256 characters long. || +|| createdAt | **string** (date-time) + +Creation timestamp. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| createdBy | **string** + +ID of the user or service account who initiated the operation. || +|| modifiedAt | **string** (date-time) + +The time when the Operation resource was last modified. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| done | **boolean** + +If the value is `false`, it means the operation is still in progress. +If `true`, the operation is completed, and either `error` or `response` is available. || +|| metadata | **[StopClusterMetadata](#yandex.cloud.mdb.postgresql.v1.StopClusterMetadata)** + +Service-specific metadata associated with the operation. +It typically contains the ID of the target resource that the operation is performed on. +Any method that returns a long-running operation should document the metadata type, if any. || +|| error | **[Status](#google.rpc.Status)** + +The error result of the operation in case of failure or cancellation. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** + +The normal response of the operation in case of success. +If the original method returns no data on success, such as Delete, +the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). +If the original method is the standard Create/Update, +the response should be the target resource of the operation. +Any method that returns a long-running operation should document the response type, if any. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|# + +## StopClusterMetadata {#yandex.cloud.mdb.postgresql.v1.StopClusterMetadata} + +#| +||Field | Description || +|| clusterId | **string** + +ID of the PostgreSQL cluster. || +|# + +## Status {#google.rpc.Status} + +The error result of the operation in case of failure or cancellation. + +#| +||Field | Description || +|| code | **integer** (int32) + +Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || +|| message | **string** + +An error message. || +|| details[] | **object** + +A list of messages that carry the error details. || +|# + +## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} + +A PostgreSQL Cluster resource. For more information, see +the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. + +#| +||Field | Description || +|| id | **string** + +ID of the PostgreSQL cluster. +This ID is assigned by MDB at creation time. || +|| folderId | **string** + +ID of the folder that the PostgreSQL cluster belongs to. || +|| createdAt | **string** (date-time) + +Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| name | **string** + +Name of the PostgreSQL cluster. +The name is unique within the folder. 1-63 characters long. || +|| description | **string** + +Description of the PostgreSQL cluster. 0-256 characters long. || +|| labels | **string** + +Custom labels for the PostgreSQL cluster as `` key:value `` pairs. +Maximum 64 per resource. || +|| environment | **enum** (Environment) + +Deployment environment of the PostgreSQL cluster. + +- `ENVIRONMENT_UNSPECIFIED` +- `PRODUCTION`: Stable environment with a conservative update policy: +only hotfixes are applied during regular maintenance. +- `PRESTABLE`: Environment with more aggressive update policy: new versions +are rolled out irrespective of backward compatibility. || +|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** + +Description of monitoring systems relevant to the PostgreSQL cluster. || +|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** + +Configuration of the PostgreSQL cluster. || +|| networkId | **string** + +ID of the network that the cluster belongs to. || +|| health | **enum** (Health) + +Aggregated cluster health. + +- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). +- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). +- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). +- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || +|| status | **enum** (Status) + +Current state of the cluster. + +- `STATUS_UNKNOWN`: Cluster state is unknown. +- `CREATING`: Cluster is being created. +- `RUNNING`: Cluster is running normally. +- `ERROR`: Cluster encountered a problem and cannot operate. +- `UPDATING`: Cluster is being updated. +- `STOPPING`: Cluster is stopping. +- `STOPPED`: Cluster stopped. +- `STARTING`: Cluster is starting. || +|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** + +Maintenance window for the cluster. || +|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** + +Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || +|| securityGroupIds[] | **string** + +User security groups || +|| deletionProtection | **boolean** + +Deletion Protection inhibits deletion of the cluster || +|| hostGroupIds[] | **string** + +Host groups hosting VMs of the cluster. || +|# + +## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} + +Monitoring system. + +#| +||Field | Description || +|| name | **string** + +Name of the monitoring system. || +|| description | **string** + +Description of the monitoring system. || +|| link | **string** + +Link to the monitoring system charts for the PostgreSQL cluster. || +|# + +## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} + +#| +||Field | Description || +|| version | **string** + +Version of PostgreSQL server software. || +|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** + +Configuration of a PostgreSQL 9.6 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** + +Configuration of a PostgreSQL 10 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** + +Configuration of a PostgreSQL 10 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** + +Configuration of a PostgreSQL 11 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** + +Configuration of a PostgreSQL 11 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** + +Configuration of a PostgreSQL 12 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** + +Configuration of a PostgreSQL 12 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** + +Configuration of a PostgreSQL 13 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** -#| -||Field | Description || -|| id | **string** +Configuration of a PostgreSQL 13 1C server. -ID of the operation. || -|| description | **string** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Description of the operation. 0-256 characters long. || -|| createdAt | **string** (date-time) +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** -Creation timestamp. +Configuration of a PostgreSQL 14 server. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| createdBy | **string** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** -ID of the user or service account who initiated the operation. || -|| modifiedAt | **string** (date-time) +Configuration of a PostgreSQL 14 1C server. -The time when the Operation resource was last modified. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| done | **boolean** +Configuration of a PostgreSQL 15 server. -If the value is `false`, it means the operation is still in progress. -If `true`, the operation is completed, and either `error` or `response` is available. || -|| metadata | **[StopClusterMetadata](#yandex.cloud.mdb.postgresql.v1.StopClusterMetadata)** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Service-specific metadata associated with the operation. -It typically contains the ID of the target resource that the operation is performed on. -Any method that returns a long-running operation should document the metadata type, if any. || -|| error | **[Status](#google.rpc.Status)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** -The error result of the operation in case of failure or cancellation. +Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `error`, `response`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || -|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** -The normal response of the operation in case of success. -If the original method returns no data on success, such as Delete, -the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). -If the original method is the standard Create/Update, -the response should be the target resource of the operation. -Any method that returns a long-running operation should document the response type, if any. +Configuration of a PostgreSQL 16 server. -Includes only one of the fields `error`, `response`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** + +Configuration of a PostgreSQL 16 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfigSet17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfigSet17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** + +Configuration of the connection pooler. || +|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** + +Resources allocated to PostgreSQL hosts. || +|| autofailover | **boolean** + +Configuration setting which enables/disables autofailover in cluster. || +|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** + +Time to start the daily backup, in the UTC timezone. || +|| backupRetainPeriodDays | **string** (int64) + +Retention policy of automated backups. || +|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** + +Access policy to DB || +|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** + +Configuration of the performance diagnostics service. || +|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** + +Disk size autoscaling || |# -## StopClusterMetadata {#yandex.cloud.mdb.postgresql.v1.StopClusterMetadata} +## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} #| ||Field | Description || -|| clusterId | **string** +|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -ID of the PostgreSQL cluster. || +Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** + +User-defined settings for a PostgreSQL 9.6 cluster. || +|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** + +Default configuration for a PostgreSQL 9.6 cluster. || |# -## Status {#google.rpc.Status} +## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} -The error result of the operation in case of failure or cancellation. +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). #| ||Field | Description || -|| code | **integer** (int32) +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || -|| message | **string** +in bytes. || +|| tempBuffers | **string** (int64) -An error message. || -|| details[] | **object** +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -A list of messages that carry the error details. || -|# +in bytes. || +|| maintenanceWorkMem | **string** (int64) -## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -A PostgreSQL Cluster resource. For more information, see -the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. +in bytes. || +|| tempFileLimit | **string** (int64) -#| -||Field | Description || -|| id | **string** +in bytes. || +|| vacuumCostDelay | **string** (int64) -ID of the PostgreSQL cluster. -This ID is assigned by MDB at creation time. || -|| folderId | **string** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -ID of the folder that the PostgreSQL cluster belongs to. || -|| createdAt | **string** (date-time) +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. +in bytes || +|| backendFlushAfter | **string** (int64) -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| name | **string** +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Name of the PostgreSQL cluster. -The name is unique within the folder. 1-63 characters long. || -|| description | **string** +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) + +Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Description of the PostgreSQL cluster. 0-256 characters long. || -|| labels | **string** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Custom labels for the PostgreSQL cluster as `` key:value `` pairs. -Maximum 64 per resource. || -|| environment | **enum** (Environment) +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Deployment environment of the PostgreSQL cluster. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -- `ENVIRONMENT_UNSPECIFIED` -- `PRODUCTION`: Stable environment with a conservative update policy: -only hotfixes are applied during regular maintenance. -- `PRESTABLE`: Environment with more aggressive update policy: new versions -are rolled out irrespective of backward compatibility. || -|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Description of monitoring systems relevant to the PostgreSQL cluster. || -|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Configuration of the PostgreSQL cluster. || -|| networkId | **string** +in milliseconds. || +|| lockTimeout | **string** (int64) -ID of the network that the cluster belongs to. || -|| health | **enum** (Health) +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Aggregated cluster health. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). -- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). -- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). -- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || -|| status | **enum** (Status) +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Current state of the cluster. +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -- `STATUS_UNKNOWN`: Cluster state is unknown. -- `CREATING`: Cluster is being created. -- `RUNNING`: Cluster is running normally. -- `ERROR`: Cluster encountered a problem and cannot operate. -- `UPDATING`: Cluster is being updated. -- `STOPPING`: Cluster is stopping. -- `STOPPED`: Cluster stopped. -- `STARTING`: Cluster is starting. || -|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Maintenance window for the cluster. || -|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** +in bytes. || +|| deadlockTimeout | **string** (int64) -Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || -|| securityGroupIds[] | **string** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -User security groups || -|| deletionProtection | **boolean** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| sqlInheritance | **boolean** -Deletion Protection inhibits deletion of the cluster || -|| hostGroupIds[] | **string** +This option has been removed in PostgreSQL 10. || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Host groups hosting VMs of the cluster. || -|# +in milliseconds. || +|| archiveTimeout | **string** (int64) -## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# -Monitoring system. +## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} #| ||Field | Description || -|| name | **string** +|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Name of the monitoring system. || -|| description | **string** +Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Description of the monitoring system. || -|| link | **string** +User-defined settings for a PostgreSQL 10 1C cluster. || +|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Link to the monitoring system charts for the PostgreSQL cluster. || +Default configuration for a PostgreSQL 10 1C cluster. || |# -## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} +## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || -|| version | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Version of PostgreSQL server software. || -|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** +in bytes. || +|| tempBuffers | **string** (int64) -Configuration of a PostgreSQL 9.6 server. +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -Configuration of a PostgreSQL 10 1C server. +in bytes. || +|| tempFileLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| vacuumCostDelay | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Configuration of a PostgreSQL 10 server. +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes || +|| backendFlushAfter | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -Configuration of a PostgreSQL 11 server. +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -Configuration of a PostgreSQL 11 1C server. +in bytes || +|| maxWalSize | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| minWalSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) -Configuration of a PostgreSQL 12 server. +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Configuration of a PostgreSQL 12 1C server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Configuration of a PostgreSQL 13 server. +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Configuration of a PostgreSQL 13 1C server. +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| lockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Configuration of a PostgreSQL 14 server. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -Configuration of a PostgreSQL 14 1C server. +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| deadlockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -Configuration of a PostgreSQL 15 server. +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| archiveTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -Configuration of a PostgreSQL 15 1C server. +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) -Configuration of a PostgreSQL 16 server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| onlineAnalyzeEnable | **boolean** || +|| plantunerFixEmptyTable | **boolean** || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| geqo | **boolean** -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -Configuration of a PostgreSQL 16 1C server. +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) -Configuration of the connection pooler. || -|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) -Resources allocated to PostgreSQL hosts. || -|| autofailover | **boolean** +selective pressure within the population || +|| geqoSeed | **number** (double) -Configuration setting which enables/disables autofailover in cluster. || -|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) -Time to start the daily backup, in the UTC timezone. || -|| backupRetainPeriodDays | **string** (int64) +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) -Retention policy of automated backups. || -|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -Access policy to DB || -|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -Configuration of the performance diagnostics service. || -|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. -Disk size autoscaling || +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} +## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** - -User-defined settings for a PostgreSQL 9.6 cluster. || -|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Default configuration for a PostgreSQL 9.6 cluster. || +User-defined settings for a PostgreSQL 10 cluster. || +|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** + +Default configuration for a PostgreSQL 10 cluster. || |# -## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} +## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -7294,9 +8935,7 @@ in bytes || || checkpointTimeout | **string** (int64) in milliseconds. || -|| checkpointCompletionTarget | **number** (double) - -Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointCompletionTarget | **number** (double) || || checkpointFlushAfter | **string** (int64) in bytes || @@ -7449,9 +9088,6 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** - -This option has been removed in PostgreSQL 10. || || autovacuumMaxWorkers | **string** (int64) || || autovacuumVacuumCostDelay | **string** (int64) || || autovacuumVacuumCostLimit | **string** (int64) || @@ -7462,31 +9098,139 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) + +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} +## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -User-defined settings for a PostgreSQL 10 1C cluster. || -|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +User-defined settings for a PostgreSQL 11 cluster. || +|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Default configuration for a PostgreSQL 10 1C cluster. || +Default configuration for a PostgreSQL 11 cluster. || |# -## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} +## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7504,7 +9248,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -7727,6 +9470,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -7773,8 +9525,6 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || -|| onlineAnalyzeEnable | **boolean** || -|| plantunerFixEmptyTable | **boolean** || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -7804,6 +9554,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -7823,27 +9576,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} +## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -User-defined settings for a PostgreSQL 10 cluster. || -|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +User-defined settings for a PostgreSQL 11 1C cluster. || +|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Default configuration for a PostgreSQL 10 cluster. || +Default configuration for a PostgreSQL 11 1C cluster. || |# -## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} +## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7861,7 +9614,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -8066,6 +9818,7 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || || enableBitmapscan | **boolean** || || enableHashagg | **boolean** || || enableHashjoin | **boolean** || @@ -8084,6 +9837,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8135,6 +9897,7 @@ in milliseconds. || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || || maxStackDepth | **string** (int64) in bytes. || @@ -8159,6 +9922,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -8178,23 +9944,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} +## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Effective settings for a PostgreSQL 11 cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -User-defined settings for a PostgreSQL 11 cluster. || -|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +User-defined settings for a PostgreSQL 12 cluster. || +|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Default configuration for a PostgreSQL 11 cluster. || +Default configuration for a PostgreSQL 12 cluster. || |# -## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} +## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8447,6 +10213,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8544,23 +10317,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} +## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -User-defined settings for a PostgreSQL 11 1C cluster. || -|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +User-defined settings for a PostgreSQL 12 1C cluster. || +|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Default configuration for a PostgreSQL 11 1C cluster. || +Default configuration for a PostgreSQL 12 1C cluster. || |# -## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} +## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8814,6 +10587,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8912,23 +10692,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} +## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Effective settings for a PostgreSQL 12 cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -User-defined settings for a PostgreSQL 12 cluster. || -|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +User-defined settings for a PostgreSQL 13 cluster. || +|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Default configuration for a PostgreSQL 12 cluster. || +Default configuration for a PostgreSQL 13 cluster. || |# -## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} +## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9234,6 +11014,30 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -9285,23 +11089,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} +## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -User-defined settings for a PostgreSQL 12 1C cluster. || -|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +User-defined settings for a PostgreSQL 13 1C cluster. || +|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Default configuration for a PostgreSQL 12 1C cluster. || +Default configuration for a PostgreSQL 13 1C cluster. || |# -## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} +## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9608,15 +11412,36 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || -|| maxStackDepth | **string** (int64) - -in bytes. || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -9660,23 +11485,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} +## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Effective settings for a PostgreSQL 13 cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -User-defined settings for a PostgreSQL 13 cluster. || -|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +User-defined settings for a PostgreSQL 14 cluster. || +|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Default configuration for a PostgreSQL 13 cluster. || +Default configuration for a PostgreSQL 14 cluster. || |# -## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} +## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9884,7 +11709,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -9928,7 +11752,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10006,6 +11829,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10057,23 +11895,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} +## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -User-defined settings for a PostgreSQL 13 1C cluster. || -|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +User-defined settings for a PostgreSQL 14 1C cluster. || +|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Default configuration for a PostgreSQL 13 1C cluster. || +Default configuration for a PostgreSQL 14 1C cluster. || |# -## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} +## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10281,7 +12119,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -10326,7 +12163,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10404,6 +12240,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10453,23 +12304,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} +## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Effective settings for a PostgreSQL 14 cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -User-defined settings for a PostgreSQL 14 cluster. || -|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +User-defined settings for a PostgreSQL 15 cluster. || +|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Default configuration for a PostgreSQL 14 cluster. || +Default configuration for a PostgreSQL 15 cluster. || |# -## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} +## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10739,7 +12590,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -10820,6 +12672,7 @@ in milliseconds. || || maxStackDepth | **string** (int64) in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -10863,23 +12716,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} +## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -User-defined settings for a PostgreSQL 14 1C cluster. || -|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +User-defined settings for a PostgreSQL 15 1C cluster. || +|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Default configuration for a PostgreSQL 14 1C cluster. || +Default configuration for a PostgreSQL 15 1C cluster. || |# -## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} +## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11150,7 +13003,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -11229,6 +13083,10 @@ in milliseconds. || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -11272,23 +13130,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} +## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Effective settings for a PostgreSQL 15 cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -User-defined settings for a PostgreSQL 15 cluster. || -|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +User-defined settings for a PostgreSQL 16 cluster. || +|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Default configuration for a PostgreSQL 15 cluster. || +Default configuration for a PostgreSQL 16 cluster. || |# -## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} +## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11374,12 +13232,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11388,6 +13246,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11402,6 +13261,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11416,6 +13276,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11587,6 +13448,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11684,23 +13546,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} +## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -User-defined settings for a PostgreSQL 15 1C cluster. || -|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +User-defined settings for a PostgreSQL 16 1C cluster. || +|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Default configuration for a PostgreSQL 15 1C cluster. || +Default configuration for a PostgreSQL 16 1C cluster. || |# -## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} +## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11786,12 +13648,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11800,6 +13662,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11814,6 +13677,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11828,6 +13692,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12000,6 +13865,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12098,27 +13964,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} +## PostgresqlConfigSet17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| effectiveConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Effective settings for a PostgreSQL 16 cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| userConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -User-defined settings for a PostgreSQL 16 cluster. || -|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Default configuration for a PostgreSQL 16 cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12160,7 +14026,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12512,29 +14377,42 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# -## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} +## PostgresqlConfigSet17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| effectiveConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| userConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -User-defined settings for a PostgreSQL 16 1C cluster. || -|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Default configuration for a PostgreSQL 16 1C cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12576,7 +14454,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12930,6 +14807,19 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# ## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig} diff --git a/en/managed-postgresql/api-ref/Cluster/update.md b/en/managed-postgresql/api-ref/Cluster/update.md index 29b16227889..3e562334730 100644 --- a/en/managed-postgresql/api-ref/Cluster/update.md +++ b/en/managed-postgresql/api-ref/Cluster/update.md @@ -32,7 +32,7 @@ To get the PostgreSQL cluster ID, use a [ClusterService.List](/docs/managed-post "labels": "string", "configSpec": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "maxConnections": "string", "sharedBuffers": "string", @@ -2272,213 +2272,565 @@ To get the PostgreSQL cluster ID, use a [ClusterService.List](/docs/managed-post "logAutovacuumMinDuration": "string", "passwordEncryption": "string" }, - // end of the list of possible fields - "poolerConfig": { - "poolingMode": "string", - "poolDiscard": "boolean" - }, - "resources": { - "resourcePresetId": "string", - "diskSize": "string", - "diskTypeId": "string" - }, - "autofailover": "boolean", - "backupWindowStart": { - "hours": "integer", - "minutes": "integer", - "seconds": "integer", - "nanos": "integer" - }, - "backupRetainPeriodDays": "string", - "access": { - "dataLens": "boolean", - "webSql": "boolean", - "serverless": "boolean", - "dataTransfer": "boolean", - "yandexQuery": "boolean" - }, - "performanceDiagnostics": { - "enabled": "boolean", - "sessionsSamplingInterval": "string", - "statementsSamplingInterval": "string" + "postgresqlConfig_17": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, - "diskSizeAutoscaling": { - "plannedUsageThreshold": "string", - "emergencyUsageThreshold": "string", - "diskSizeLimit": "string" - } - }, - "name": "string", - "maintenanceWindow": { - // Includes only one of the fields `anytime`, `weeklyMaintenanceWindow` - "anytime": "object", - "weeklyMaintenanceWindow": { - "day": "string", - "hour": "string" - } - // end of the list of possible fields - }, - "securityGroupIds": [ - "string" - ], - "deletionProtection": "boolean", - "networkId": "string" -} -``` - -#| -||Field | Description || -|| updateMask | **string** (field-mask) - -A comma-separated names off ALL fields to be updated. -Only the specified fields will be changed. The others will be left untouched. -If the field is specified in `` updateMask `` and no value for that field was sent in the request, -the field's value will be reset to the default. The default value for most fields is null or 0. - -If `` updateMask `` is not sent in the request, all fields' values will be updated. -Fields specified in the request will be updated to provided values. -The rest of the fields will be reset to the default. || -|| description | **string** - -New description of the PostgreSQL cluster. || -|| labels | **string** - -Custom labels for the PostgreSQL cluster as `` key:value `` pairs. Maximum 64 per resource. -For example, "project": "mvp" or "source": "dictionary". - -The new set of labels will completely replace the old ones. To add a label, request the current -set with the [ClusterService.Get](/docs/managed-postgresql/api-ref/Cluster/get#Get) method, then send an [ClusterService.Update](#Update) request with the new label added to the set. || -|| configSpec | **[ConfigSpec](#yandex.cloud.mdb.postgresql.v1.ConfigSpec)** - -New configuration and resources for hosts in the cluster. || -|| name | **string** - -New name for the cluster. || -|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** - -New maintenance window settings for the cluster. || -|| securityGroupIds[] | **string** - -User security groups || -|| deletionProtection | **boolean** - -Deletion Protection inhibits deletion of the cluster || -|| networkId | **string** - -ID of the network to move the cluster to. || -|# - -## ConfigSpec {#yandex.cloud.mdb.postgresql.v1.ConfigSpec} + "postgresqlConfig_17_1c": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + // end of the list of possible fields + "poolerConfig": { + "poolingMode": "string", + "poolDiscard": "boolean" + }, + "resources": { + "resourcePresetId": "string", + "diskSize": "string", + "diskTypeId": "string" + }, + "autofailover": "boolean", + "backupWindowStart": { + "hours": "integer", + "minutes": "integer", + "seconds": "integer", + "nanos": "integer" + }, + "backupRetainPeriodDays": "string", + "access": { + "dataLens": "boolean", + "webSql": "boolean", + "serverless": "boolean", + "dataTransfer": "boolean", + "yandexQuery": "boolean" + }, + "performanceDiagnostics": { + "enabled": "boolean", + "sessionsSamplingInterval": "string", + "statementsSamplingInterval": "string" + }, + "diskSizeAutoscaling": { + "plannedUsageThreshold": "string", + "emergencyUsageThreshold": "string", + "diskSizeLimit": "string" + } + }, + "name": "string", + "maintenanceWindow": { + // Includes only one of the fields `anytime`, `weeklyMaintenanceWindow` + "anytime": "object", + "weeklyMaintenanceWindow": { + "day": "string", + "hour": "string" + } + // end of the list of possible fields + }, + "securityGroupIds": [ + "string" + ], + "deletionProtection": "boolean", + "networkId": "string" +} +``` #| ||Field | Description || -|| version | **string** - -Version of PostgreSQL used in the cluster. -Possible values: `9.6`, `10`, `10_1c`, `11`, `12`, `13`, `14`, `15` || -|| postgresqlConfig_9_6 | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| updateMask | **string** (field-mask) -Configuration for a PostgreSQL 9.6 cluster. +A comma-separated names off ALL fields to be updated. +Only the specified fields will be changed. The others will be left untouched. +If the field is specified in `` updateMask `` and no value for that field was sent in the request, +the field's value will be reset to the default. The default value for most fields is null or 0. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +If `` updateMask `` is not sent in the request, all fields' values will be updated. +Fields specified in the request will be updated to provided values. +The rest of the fields will be reset to the default. || +|| description | **string** -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_10_1c | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +New description of the PostgreSQL cluster. || +|| labels | **string** -Configuration for a PostgreSQL 10 1C cluster. +Custom labels for the PostgreSQL cluster as `` key:value `` pairs. Maximum 64 per resource. +For example, "project": "mvp" or "source": "dictionary". -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +The new set of labels will completely replace the old ones. To add a label, request the current +set with the [ClusterService.Get](/docs/managed-postgresql/api-ref/Cluster/get#Get) method, then send an [ClusterService.Update](#Update) request with the new label added to the set. || +|| configSpec | **[ConfigSpec](#yandex.cloud.mdb.postgresql.v1.ConfigSpec)** -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_10 | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +New configuration and resources for hosts in the cluster. || +|| name | **string** -Configuration for a PostgreSQL 10 cluster. +New name for the cluster. || +|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +New maintenance window settings for the cluster. || +|| securityGroupIds[] | **string** -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_11 | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +User security groups || +|| deletionProtection | **boolean** -Configuration for a PostgreSQL 11 cluster. +Deletion Protection inhibits deletion of the cluster || +|| networkId | **string** -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +ID of the network to move the cluster to. || +|# + +## ConfigSpec {#yandex.cloud.mdb.postgresql.v1.ConfigSpec} + +#| +||Field | Description || +|| version | **string** + +Version of PostgreSQL used in the cluster. +Possible values: `9.6`, `10`, `10_1c`, `11`, `12`, `13`, `14`, `15`, `16`, `17` || +|| postgresqlConfig_9_6 | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** + +Configuration for a PostgreSQL 9.6 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_10_1c | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** + +Configuration for a PostgreSQL 10 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_10 | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** + +Configuration for a PostgreSQL 10 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_11 | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** + +Configuration for a PostgreSQL 11 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_11_1c | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** Configuration for a PostgreSQL 11 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_12 | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** Configuration for a PostgreSQL 12 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_12_1c | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** Configuration for a PostgreSQL 12 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_13 | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** Configuration for a PostgreSQL 13 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_13_1c | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** Configuration for a PostgreSQL 13 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_14 | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** Configuration for a PostgreSQL 14 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_14_1c | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** Configuration for a PostgreSQL 14 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_15 | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** Configuration for a PostgreSQL 15 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_15_1c | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** Configuration for a PostgreSQL 15 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_16 | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** Configuration for a PostgreSQL 16 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_16_1c | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** Configuration for a PostgreSQL 16 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** + +Configuration for a PostgreSQL 17 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** + +Configuration for a PostgreSQL 17 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** @@ -7985,208 +8337,1692 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || -|| poolingMode | **enum** (PoolingMode) - -Mode that the connection pooler is working in. -See descriptions of all modes in the [documentation for PgBouncer](https://pgbouncer.github.io/usage). +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -- `POOLING_MODE_UNSPECIFIED` -- `SESSION`: Session pooling mode. -- `TRANSACTION`: Transaction pooling mode. -- `STATEMENT`: Statement pooling mode. || -|| poolDiscard | **boolean** +in bytes. || +|| tempBuffers | **string** (int64) -Setting `server_reset_query_always` parameter in PgBouncer. || -|# +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -## Resources {#yandex.cloud.mdb.postgresql.v1.Resources} +in bytes. || +|| maintenanceWorkMem | **string** (int64) -#| -||Field | Description || -|| resourcePresetId | **string** +in bytes. || +|| autovacuumWorkMem | **string** (int64) -ID of the preset for computational resources available to a host (CPU, memory etc.). -All available presets are listed in the [documentation](/docs/managed-postgresql/concepts/instance-types). || -|| diskSize | **string** (int64) +in bytes. || +|| tempFileLimit | **string** (int64) -Volume of the storage available to a host, in bytes. || -|| diskTypeId | **string** +in bytes. || +|| vacuumCostDelay | **string** (int64) -Type of the storage environment for the host. -Possible values: -* network-hdd - network HDD drive, -* network-ssd - network SSD drive, -* local-ssd - local SSD storage. || -|# +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -## TimeOfDay {#google.type.TimeOfDay} +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Represents a time of day. The date and time zone are either not significant -or are specified elsewhere. An API may choose to allow leap seconds. Related -types are [google.type.Date](https://github.com/googleapis/googleapis/blob/master/google/type/date.proto) and [google.protobuf.Timestamp](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/timestamp.proto). +in bytes || +|| backendFlushAfter | **string** (int64) -#| -||Field | Description || -|| hours | **integer** (int32) +in bytes || +|| walLevel | **enum** (WalLevel) -Hours of day in 24 hour format. Should be from 0 to 23. An API may choose -to allow the value "24:00:00" for scenarios like business closing time. || -|| minutes | **integer** (int32) +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Minutes of hour of day. Must be from 0 to 59. || -|| seconds | **integer** (int32) +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) -Seconds of minutes of the time. Must normally be from 0 to 59. An API may -allow the value 60 if it allows leap-seconds. || -|| nanos | **integer** (int32) +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. || -|# +in bytes || +|| maxWalSize | **string** (int64) -## Access {#yandex.cloud.mdb.postgresql.v1.Access} +in bytes. || +|| minWalSize | **string** (int64) -#| -||Field | Description || -|| dataLens | **boolean** +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) -Allow access for DataLens || -|| webSql | **boolean** +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) -Allow SQL queries to the cluster databases from the management console. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| debugParallelQuery | **enum** (DebugParallelQuery) -See [SQL queries in the management console](/docs/managed-postgresql/operations/web-sql-query) for more details. || -|| serverless | **boolean** +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Allow access for Serverless || -|| dataTransfer | **boolean** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Allow access for DataTransfer. || -|| yandexQuery | **boolean** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Allow access for YandexQuery. || -|# +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -## PerformanceDiagnostics {#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics} +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -#| -||Field | Description || -|| enabled | **boolean** +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Configuration setting which enables/disables performance diagnostics service in cluster. || -|| sessionsSamplingInterval | **string** (int64) +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Interval (in seconds) for pg_stat_activity sampling || -|| statementsSamplingInterval | **string** (int64) +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Interval (in seconds) for pg_stat_statements sampling || -|# +in milliseconds. || +|| lockTimeout | **string** (int64) -## DiskSizeAutoscaling {#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling} +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -#| -||Field | Description || -|| plannedUsageThreshold | **string** (int64) +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Threshold of storage usage (in percent) that triggers automatic scaling of the storage during the maintenance window. Zero value means disabled threshold. || -|| emergencyUsageThreshold | **string** (int64) +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Threshold of storage usage (in percent) that triggers immediate automatic scaling of the storage. Zero value means disabled threshold. || -|| diskSizeLimit | **string** (int64) +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -New storage size (in bytes) that is set when one of the thresholds is achieved. || -|# +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -## MaintenanceWindow {#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow} +in bytes. || +|| deadlockTimeout | **string** (int64) -A maintenance window settings. +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -#| -||Field | Description || -|| anytime | **object** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Maintenance operation can be scheduled anytime. +in milliseconds. || +|| archiveTimeout | **string** (int64) -Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`. +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) -The maintenance policy in effect. || -|| weeklyMaintenanceWindow | **[WeeklyMaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.WeeklyMaintenanceWindow)** +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -Maintenance operation can be scheduled on a weekly basis. +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || +|| autoExplainLogMinDuration | **string** (int64) -Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`. +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -The maintenance policy in effect. || +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || +|| maxStandbyArchiveDelay | **string** (int64) + +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# -## WeeklyMaintenanceWindow {#yandex.cloud.mdb.postgresql.v1.WeeklyMaintenanceWindow} +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C} -Weelky maintenance window settings. +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || -|| day | **enum** (WeekDay) +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Day of the week (in `DDD` format). +in bytes. || +|| tempBuffers | **string** (int64) -- `WEEK_DAY_UNSPECIFIED` -- `MON` -- `TUE` -- `WED` -- `THU` -- `FRI` -- `SAT` -- `SUN` || -|| hour | **string** (int64) +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Hour of the day in UTC (in `HH` format). || -|# +in bytes. || +|| maintenanceWorkMem | **string** (int64) -## Response {#yandex.cloud.operation.Operation} +in bytes. || +|| autovacuumWorkMem | **string** (int64) -**HTTP Code: 200 - OK** +in bytes. || +|| tempFileLimit | **string** (int64) -```json -{ - "id": "string", - "description": "string", - "createdAt": "string", - "createdBy": "string", - "modifiedAt": "string", - "done": "boolean", - "metadata": { - "clusterId": "string" - }, - // Includes only one of the fields `error`, `response` - "error": { - "code": "integer", - "message": "string", - "details": [ - "object" - ] - }, - "response": { - "id": "string", - "folderId": "string", - "createdAt": "string", - "name": "string", - "description": "string", - "labels": "string", - "environment": "string", - "monitoring": [ - { - "name": "string", - "description": "string", - "link": "string" - } - ], - "config": { - "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` - "postgresqlConfig_9_6": { +in bytes. || +|| vacuumCostDelay | **string** (int64) + +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) + +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) + +in bytes || +|| backendFlushAfter | **string** (int64) + +in bytes || +|| walLevel | **enum** (WalLevel) + +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) + +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| debugParallelQuery | **enum** (DebugParallelQuery) + +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) + +in milliseconds. || +|| archiveTimeout | **string** (int64) + +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || +|| maxStandbyArchiveDelay | **string** (int64) + +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || +|# + +## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig} + +#| +||Field | Description || +|| poolingMode | **enum** (PoolingMode) + +Mode that the connection pooler is working in. +See descriptions of all modes in the [documentation for PgBouncer](https://pgbouncer.github.io/usage). + +- `POOLING_MODE_UNSPECIFIED` +- `SESSION`: Session pooling mode. +- `TRANSACTION`: Transaction pooling mode. +- `STATEMENT`: Statement pooling mode. || +|| poolDiscard | **boolean** + +Setting `server_reset_query_always` parameter in PgBouncer. || +|# + +## Resources {#yandex.cloud.mdb.postgresql.v1.Resources} + +#| +||Field | Description || +|| resourcePresetId | **string** + +ID of the preset for computational resources available to a host (CPU, memory etc.). +All available presets are listed in the [documentation](/docs/managed-postgresql/concepts/instance-types). || +|| diskSize | **string** (int64) + +Volume of the storage available to a host, in bytes. || +|| diskTypeId | **string** + +Type of the storage environment for the host. +Possible values: +* network-hdd - network HDD drive, +* network-ssd - network SSD drive, +* local-ssd - local SSD storage. || +|# + +## TimeOfDay {#google.type.TimeOfDay} + +Represents a time of day. The date and time zone are either not significant +or are specified elsewhere. An API may choose to allow leap seconds. Related +types are [google.type.Date](https://github.com/googleapis/googleapis/blob/master/google/type/date.proto) and [google.protobuf.Timestamp](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/timestamp.proto). + +#| +||Field | Description || +|| hours | **integer** (int32) + +Hours of day in 24 hour format. Should be from 0 to 23. An API may choose +to allow the value "24:00:00" for scenarios like business closing time. || +|| minutes | **integer** (int32) + +Minutes of hour of day. Must be from 0 to 59. || +|| seconds | **integer** (int32) + +Seconds of minutes of the time. Must normally be from 0 to 59. An API may +allow the value 60 if it allows leap-seconds. || +|| nanos | **integer** (int32) + +Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. || +|# + +## Access {#yandex.cloud.mdb.postgresql.v1.Access} + +#| +||Field | Description || +|| dataLens | **boolean** + +Allow access for DataLens || +|| webSql | **boolean** + +Allow SQL queries to the cluster databases from the management console. + +See [SQL queries in the management console](/docs/managed-postgresql/operations/web-sql-query) for more details. || +|| serverless | **boolean** + +Allow access for Serverless || +|| dataTransfer | **boolean** + +Allow access for DataTransfer. || +|| yandexQuery | **boolean** + +Allow access for YandexQuery. || +|# + +## PerformanceDiagnostics {#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics} + +#| +||Field | Description || +|| enabled | **boolean** + +Configuration setting which enables/disables performance diagnostics service in cluster. || +|| sessionsSamplingInterval | **string** (int64) + +Interval (in seconds) for pg_stat_activity sampling || +|| statementsSamplingInterval | **string** (int64) + +Interval (in seconds) for pg_stat_statements sampling || +|# + +## DiskSizeAutoscaling {#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling} + +#| +||Field | Description || +|| plannedUsageThreshold | **string** (int64) + +Threshold of storage usage (in percent) that triggers automatic scaling of the storage during the maintenance window. Zero value means disabled threshold. || +|| emergencyUsageThreshold | **string** (int64) + +Threshold of storage usage (in percent) that triggers immediate automatic scaling of the storage. Zero value means disabled threshold. || +|| diskSizeLimit | **string** (int64) + +New storage size (in bytes) that is set when one of the thresholds is achieved. || +|# + +## MaintenanceWindow {#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow} + +A maintenance window settings. + +#| +||Field | Description || +|| anytime | **object** + +Maintenance operation can be scheduled anytime. + +Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`. + +The maintenance policy in effect. || +|| weeklyMaintenanceWindow | **[WeeklyMaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.WeeklyMaintenanceWindow)** + +Maintenance operation can be scheduled on a weekly basis. + +Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`. + +The maintenance policy in effect. || +|# + +## WeeklyMaintenanceWindow {#yandex.cloud.mdb.postgresql.v1.WeeklyMaintenanceWindow} + +Weelky maintenance window settings. + +#| +||Field | Description || +|| day | **enum** (WeekDay) + +Day of the week (in `DDD` format). + +- `WEEK_DAY_UNSPECIFIED` +- `MON` +- `TUE` +- `WED` +- `THU` +- `FRI` +- `SAT` +- `SUN` || +|| hour | **string** (int64) + +Hour of the day in UTC (in `HH` format). || +|# + +## Response {#yandex.cloud.operation.Operation} + +**HTTP Code: 200 - OK** + +```json +{ + "id": "string", + "description": "string", + "createdAt": "string", + "createdBy": "string", + "modifiedAt": "string", + "done": "boolean", + "metadata": { + "clusterId": "string" + }, + // Includes only one of the fields `error`, `response` + "error": { + "code": "integer", + "message": "string", + "details": [ + "object" + ] + }, + "response": { + "id": "string", + "folderId": "string", + "createdAt": "string", + "name": "string", + "description": "string", + "labels": "string", + "environment": "string", + "monitoring": [ + { + "name": "string", + "description": "string", + "link": "string" + } + ], + "config": { + "version": "string", + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` + "postgresqlConfig_9_6": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "sqlInheritance": "boolean", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "sqlInheritance": "boolean", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "sqlInheritance": "boolean", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + } + }, + "postgresqlConfig_10_1c": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "onlineAnalyzeEnable": "boolean", + "plantunerFixEmptyTable": "boolean", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "onlineAnalyzeEnable": "boolean", + "plantunerFixEmptyTable": "boolean", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "onlineAnalyzeEnable": "boolean", + "plantunerFixEmptyTable": "boolean", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" + } + }, + "postgresqlConfig_10": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -8260,15 +10096,65 @@ Hour of the day in UTC (in `HH` format). || "exitOnError": "boolean", "seqPageCost": "number", "randomPageCost": "number", - "sqlInheritance": "boolean", "autovacuumMaxWorkers": "string", "autovacuumVacuumCostDelay": "string", "autovacuumVacuumCostLimit": "string", "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", "effectiveIoConcurrency": "string", - "effectiveCacheSize": "string" + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" }, "userConfig": { "maxConnections": "string", @@ -8343,15 +10229,65 @@ Hour of the day in UTC (in `HH` format). || "exitOnError": "boolean", "seqPageCost": "number", "randomPageCost": "number", - "sqlInheritance": "boolean", "autovacuumMaxWorkers": "string", "autovacuumVacuumCostDelay": "string", "autovacuumVacuumCostLimit": "string", "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", "effectiveIoConcurrency": "string", - "effectiveCacheSize": "string" + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" }, "defaultConfig": { "maxConnections": "string", @@ -8426,18 +10362,68 @@ Hour of the day in UTC (in `HH` format). || "exitOnError": "boolean", "seqPageCost": "number", "randomPageCost": "number", - "sqlInheritance": "boolean", "autovacuumMaxWorkers": "string", "autovacuumVacuumCostDelay": "string", "autovacuumVacuumCostLimit": "string", "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", "effectiveIoConcurrency": "string", - "effectiveCacheSize": "string" + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" } }, - "postgresqlConfig_10_1c": { + "postgresqlConfig_11": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -8445,7 +10431,6 @@ Hour of the day in UTC (in `HH` format). || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -8535,6 +10520,15 @@ Hour of the day in UTC (in `HH` format). || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -8552,8 +10546,6 @@ Hour of the day in UTC (in `HH` format). || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", - "onlineAnalyzeEnable": "boolean", - "plantunerFixEmptyTable": "boolean", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -8567,6 +10559,9 @@ Hour of the day in UTC (in `HH` format). || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -8580,7 +10575,6 @@ Hour of the day in UTC (in `HH` format). || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -8670,6 +10664,15 @@ Hour of the day in UTC (in `HH` format). || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -8687,8 +10690,6 @@ Hour of the day in UTC (in `HH` format). || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", - "onlineAnalyzeEnable": "boolean", - "plantunerFixEmptyTable": "boolean", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -8702,6 +10703,9 @@ Hour of the day in UTC (in `HH` format). || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -8715,7 +10719,6 @@ Hour of the day in UTC (in `HH` format). || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -8805,6 +10808,15 @@ Hour of the day in UTC (in `HH` format). || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -8822,8 +10834,6 @@ Hour of the day in UTC (in `HH` format). || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", - "onlineAnalyzeEnable": "boolean", - "plantunerFixEmptyTable": "boolean", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -8837,6 +10847,9 @@ Hour of the day in UTC (in `HH` format). || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -8844,7 +10857,7 @@ Hour of the day in UTC (in `HH` format). || "passwordEncryption": "string" } }, - "postgresqlConfig_10": { + "postgresqlConfig_11_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -8852,7 +10865,6 @@ Hour of the day in UTC (in `HH` format). || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -8924,6 +10936,7 @@ Hour of the day in UTC (in `HH` format). || "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", "enableBitmapscan": "boolean", "enableHashagg": "boolean", "enableHashjoin": "boolean", @@ -8942,6 +10955,15 @@ Hour of the day in UTC (in `HH` format). || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -8964,6 +10986,7 @@ Hour of the day in UTC (in `HH` format). || "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", @@ -8972,6 +10995,9 @@ Hour of the day in UTC (in `HH` format). || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -8985,7 +11011,6 @@ Hour of the day in UTC (in `HH` format). || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -9057,6 +11082,7 @@ Hour of the day in UTC (in `HH` format). || "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", "enableBitmapscan": "boolean", "enableHashagg": "boolean", "enableHashjoin": "boolean", @@ -9075,6 +11101,15 @@ Hour of the day in UTC (in `HH` format). || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -9097,6 +11132,7 @@ Hour of the day in UTC (in `HH` format). || "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", @@ -9105,6 +11141,9 @@ Hour of the day in UTC (in `HH` format). || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -9118,7 +11157,6 @@ Hour of the day in UTC (in `HH` format). || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -9190,6 +11228,7 @@ Hour of the day in UTC (in `HH` format). || "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", "enableBitmapscan": "boolean", "enableHashagg": "boolean", "enableHashjoin": "boolean", @@ -9208,6 +11247,15 @@ Hour of the day in UTC (in `HH` format). || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -9230,6 +11278,7 @@ Hour of the day in UTC (in `HH` format). || "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", @@ -9238,6 +11287,9 @@ Hour of the day in UTC (in `HH` format). || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -9245,7 +11297,7 @@ Hour of the day in UTC (in `HH` format). || "passwordEncryption": "string" } }, - "postgresqlConfig_11": { + "postgresqlConfig_12": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -9351,6 +11403,8 @@ Hour of the day in UTC (in `HH` format). || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -9495,6 +11549,8 @@ Hour of the day in UTC (in `HH` format). || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -9639,6 +11695,8 @@ Hour of the day in UTC (in `HH` format). || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -9679,7 +11737,7 @@ Hour of the day in UTC (in `HH` format). || "passwordEncryption": "string" } }, - "postgresqlConfig_11_1c": { + "postgresqlConfig_12_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -9786,6 +11844,8 @@ Hour of the day in UTC (in `HH` format). || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -9932,6 +11992,8 @@ Hour of the day in UTC (in `HH` format). || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -10078,6 +12140,8 @@ Hour of the day in UTC (in `HH` format). || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -10119,7 +12183,7 @@ Hour of the day in UTC (in `HH` format). || "passwordEncryption": "string" } }, - "postgresqlConfig_12": { + "postgresqlConfig_13": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -10244,6 +12308,18 @@ Hour of the day in UTC (in `HH` format). || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -10390,6 +12466,18 @@ Hour of the day in UTC (in `HH` format). || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -10536,6 +12624,18 @@ Hour of the day in UTC (in `HH` format). || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -10559,7 +12659,7 @@ Hour of the day in UTC (in `HH` format). || "passwordEncryption": "string" } }, - "postgresqlConfig_12_1c": { + "postgresqlConfig_13_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -10685,13 +12785,24 @@ Hour of the day in UTC (in `HH` format). || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", - "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -10833,13 +12944,24 @@ Hour of the day in UTC (in `HH` format). || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", - "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -10981,13 +13103,24 @@ Hour of the day in UTC (in `HH` format). || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", - "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -11005,7 +13138,7 @@ Hour of the day in UTC (in `HH` format). || "passwordEncryption": "string" } }, - "postgresqlConfig_13": { + "postgresqlConfig_14": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -11070,7 +13203,6 @@ Hour of the day in UTC (in `HH` format). || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -11110,7 +13242,6 @@ Hour of the day in UTC (in `HH` format). || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -11142,6 +13273,13 @@ Hour of the day in UTC (in `HH` format). || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -11228,7 +13366,6 @@ Hour of the day in UTC (in `HH` format). || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -11268,7 +13405,6 @@ Hour of the day in UTC (in `HH` format). || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -11300,6 +13436,13 @@ Hour of the day in UTC (in `HH` format). || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -11386,7 +13529,6 @@ Hour of the day in UTC (in `HH` format). || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -11426,7 +13568,6 @@ Hour of the day in UTC (in `HH` format). || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -11458,6 +13599,13 @@ Hour of the day in UTC (in `HH` format). || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -11481,7 +13629,7 @@ Hour of the day in UTC (in `HH` format). || "passwordEncryption": "string" } }, - "postgresqlConfig_13_1c": { + "postgresqlConfig_14_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -11546,7 +13694,6 @@ Hour of the day in UTC (in `HH` format). || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -11587,7 +13734,6 @@ Hour of the day in UTC (in `HH` format). || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -11619,6 +13765,13 @@ Hour of the day in UTC (in `HH` format). || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -11705,7 +13858,6 @@ Hour of the day in UTC (in `HH` format). || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -11746,7 +13898,6 @@ Hour of the day in UTC (in `HH` format). || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -11778,6 +13929,13 @@ Hour of the day in UTC (in `HH` format). || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -11864,7 +14022,6 @@ Hour of the day in UTC (in `HH` format). || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -11905,7 +14062,6 @@ Hour of the day in UTC (in `HH` format). || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -11937,6 +14093,13 @@ Hour of the day in UTC (in `HH` format). || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -11960,7 +14123,7 @@ Hour of the day in UTC (in `HH` format). || "passwordEncryption": "string" } }, - "postgresqlConfig_14": { + "postgresqlConfig_15": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -12108,6 +14271,7 @@ Hour of the day in UTC (in `HH` format). || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -12271,6 +14435,7 @@ Hour of the day in UTC (in `HH` format). || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -12434,6 +14599,7 @@ Hour of the day in UTC (in `HH` format). || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -12451,7 +14617,7 @@ Hour of the day in UTC (in `HH` format). || "passwordEncryption": "string" } }, - "postgresqlConfig_14_1c": { + "postgresqlConfig_15_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -12600,6 +14766,8 @@ Hour of the day in UTC (in `HH` format). || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -12764,6 +14932,8 @@ Hour of the day in UTC (in `HH` format). || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -12928,6 +15098,8 @@ Hour of the day in UTC (in `HH` format). || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -12945,7 +15117,7 @@ Hour of the day in UTC (in `HH` format). || "passwordEncryption": "string" } }, - "postgresqlConfig_15": { + "postgresqlConfig_16": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -12979,7 +15151,7 @@ Hour of the day in UTC (in `HH` format). || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -13143,7 +15315,7 @@ Hour of the day in UTC (in `HH` format). || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -13307,7 +15479,7 @@ Hour of the day in UTC (in `HH` format). || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -13439,7 +15611,7 @@ Hour of the day in UTC (in `HH` format). || "passwordEncryption": "string" } }, - "postgresqlConfig_15_1c": { + "postgresqlConfig_16_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -13473,7 +15645,7 @@ Hour of the day in UTC (in `HH` format). || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -13639,7 +15811,7 @@ Hour of the day in UTC (in `HH` format). || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -13805,7 +15977,7 @@ Hour of the day in UTC (in `HH` format). || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -13939,7 +16111,7 @@ Hour of the day in UTC (in `HH` format). || "passwordEncryption": "string" } }, - "postgresqlConfig_16": { + "postgresqlConfig_17": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -13959,7 +16131,6 @@ Hour of the day in UTC (in `HH` format). || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -14102,7 +16273,12 @@ Hour of the day in UTC (in `HH` format). || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, "userConfig": { "maxConnections": "string", @@ -14123,7 +16299,6 @@ Hour of the day in UTC (in `HH` format). || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -14266,7 +16441,12 @@ Hour of the day in UTC (in `HH` format). || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, "defaultConfig": { "maxConnections": "string", @@ -14287,7 +16467,6 @@ Hour of the day in UTC (in `HH` format). || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -14430,10 +16609,15 @@ Hour of the day in UTC (in `HH` format). || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" } }, - "postgresqlConfig_16_1c": { + "postgresqlConfig_17_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -14453,7 +16637,6 @@ Hour of the day in UTC (in `HH` format). || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -14598,7 +16781,12 @@ Hour of the day in UTC (in `HH` format). || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, "userConfig": { "maxConnections": "string", @@ -14619,7 +16807,6 @@ Hour of the day in UTC (in `HH` format). || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -14764,7 +16951,12 @@ Hour of the day in UTC (in `HH` format). || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, "defaultConfig": { "maxConnections": "string", @@ -14785,7 +16977,6 @@ Hour of the day in UTC (in `HH` format). || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -14930,7 +17121,12 @@ Hour of the day in UTC (in `HH` format). || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" } }, // end of the list of possible fields @@ -14997,367 +17193,990 @@ Hour of the day in UTC (in `HH` format). || } ``` -An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). +An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). + +#| +||Field | Description || +|| id | **string** + +ID of the operation. || +|| description | **string** + +Description of the operation. 0-256 characters long. || +|| createdAt | **string** (date-time) + +Creation timestamp. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| createdBy | **string** + +ID of the user or service account who initiated the operation. || +|| modifiedAt | **string** (date-time) + +The time when the Operation resource was last modified. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| done | **boolean** + +If the value is `false`, it means the operation is still in progress. +If `true`, the operation is completed, and either `error` or `response` is available. || +|| metadata | **[UpdateClusterMetadata](#yandex.cloud.mdb.postgresql.v1.UpdateClusterMetadata)** + +Service-specific metadata associated with the operation. +It typically contains the ID of the target resource that the operation is performed on. +Any method that returns a long-running operation should document the metadata type, if any. || +|| error | **[Status](#google.rpc.Status)** + +The error result of the operation in case of failure or cancellation. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** + +The normal response of the operation in case of success. +If the original method returns no data on success, such as Delete, +the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). +If the original method is the standard Create/Update, +the response should be the target resource of the operation. +Any method that returns a long-running operation should document the response type, if any. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|# + +## UpdateClusterMetadata {#yandex.cloud.mdb.postgresql.v1.UpdateClusterMetadata} + +#| +||Field | Description || +|| clusterId | **string** + +ID of the PostgreSQL Cluster resource that is being updated. || +|# + +## Status {#google.rpc.Status} + +The error result of the operation in case of failure or cancellation. + +#| +||Field | Description || +|| code | **integer** (int32) + +Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || +|| message | **string** + +An error message. || +|| details[] | **object** + +A list of messages that carry the error details. || +|# + +## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} + +A PostgreSQL Cluster resource. For more information, see +the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. + +#| +||Field | Description || +|| id | **string** + +ID of the PostgreSQL cluster. +This ID is assigned by MDB at creation time. || +|| folderId | **string** + +ID of the folder that the PostgreSQL cluster belongs to. || +|| createdAt | **string** (date-time) + +Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| name | **string** + +Name of the PostgreSQL cluster. +The name is unique within the folder. 1-63 characters long. || +|| description | **string** + +Description of the PostgreSQL cluster. 0-256 characters long. || +|| labels | **string** + +Custom labels for the PostgreSQL cluster as `` key:value `` pairs. +Maximum 64 per resource. || +|| environment | **enum** (Environment) + +Deployment environment of the PostgreSQL cluster. + +- `ENVIRONMENT_UNSPECIFIED` +- `PRODUCTION`: Stable environment with a conservative update policy: +only hotfixes are applied during regular maintenance. +- `PRESTABLE`: Environment with more aggressive update policy: new versions +are rolled out irrespective of backward compatibility. || +|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** + +Description of monitoring systems relevant to the PostgreSQL cluster. || +|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** + +Configuration of the PostgreSQL cluster. || +|| networkId | **string** + +ID of the network that the cluster belongs to. || +|| health | **enum** (Health) + +Aggregated cluster health. + +- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). +- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). +- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). +- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || +|| status | **enum** (Status) + +Current state of the cluster. + +- `STATUS_UNKNOWN`: Cluster state is unknown. +- `CREATING`: Cluster is being created. +- `RUNNING`: Cluster is running normally. +- `ERROR`: Cluster encountered a problem and cannot operate. +- `UPDATING`: Cluster is being updated. +- `STOPPING`: Cluster is stopping. +- `STOPPED`: Cluster stopped. +- `STARTING`: Cluster is starting. || +|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow2)** + +Maintenance window for the cluster. || +|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** + +Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || +|| securityGroupIds[] | **string** + +User security groups || +|| deletionProtection | **boolean** + +Deletion Protection inhibits deletion of the cluster || +|| hostGroupIds[] | **string** + +Host groups hosting VMs of the cluster. || +|# + +## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} + +Monitoring system. + +#| +||Field | Description || +|| name | **string** + +Name of the monitoring system. || +|| description | **string** + +Description of the monitoring system. || +|| link | **string** + +Link to the monitoring system charts for the PostgreSQL cluster. || +|# + +## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} + +#| +||Field | Description || +|| version | **string** + +Version of PostgreSQL server software. || +|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** + +Configuration of a PostgreSQL 9.6 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** + +Configuration of a PostgreSQL 10 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** + +Configuration of a PostgreSQL 10 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** + +Configuration of a PostgreSQL 11 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** + +Configuration of a PostgreSQL 11 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** + +Configuration of a PostgreSQL 12 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** + +Configuration of a PostgreSQL 12 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** + +Configuration of a PostgreSQL 13 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** -#| -||Field | Description || -|| id | **string** +Configuration of a PostgreSQL 13 1C server. -ID of the operation. || -|| description | **string** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Description of the operation. 0-256 characters long. || -|| createdAt | **string** (date-time) +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** -Creation timestamp. +Configuration of a PostgreSQL 14 server. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| createdBy | **string** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** -ID of the user or service account who initiated the operation. || -|| modifiedAt | **string** (date-time) +Configuration of a PostgreSQL 14 1C server. -The time when the Operation resource was last modified. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| done | **boolean** +Configuration of a PostgreSQL 15 server. -If the value is `false`, it means the operation is still in progress. -If `true`, the operation is completed, and either `error` or `response` is available. || -|| metadata | **[UpdateClusterMetadata](#yandex.cloud.mdb.postgresql.v1.UpdateClusterMetadata)** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Service-specific metadata associated with the operation. -It typically contains the ID of the target resource that the operation is performed on. -Any method that returns a long-running operation should document the metadata type, if any. || -|| error | **[Status](#google.rpc.Status)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** -The error result of the operation in case of failure or cancellation. +Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `error`, `response`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || -|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** -The normal response of the operation in case of success. -If the original method returns no data on success, such as Delete, -the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). -If the original method is the standard Create/Update, -the response should be the target resource of the operation. -Any method that returns a long-running operation should document the response type, if any. +Configuration of a PostgreSQL 16 server. -Includes only one of the fields `error`, `response`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** + +Configuration of a PostgreSQL 16 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfigSet17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfigSet17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig2)** + +Configuration of the connection pooler. || +|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources2)** + +Resources allocated to PostgreSQL hosts. || +|| autofailover | **boolean** + +Configuration setting which enables/disables autofailover in cluster. || +|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay2)** + +Time to start the daily backup, in the UTC timezone. || +|| backupRetainPeriodDays | **string** (int64) + +Retention policy of automated backups. || +|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access2)** + +Access policy to DB || +|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics2)** + +Configuration of the performance diagnostics service. || +|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling2)** + +Disk size autoscaling || |# -## UpdateClusterMetadata {#yandex.cloud.mdb.postgresql.v1.UpdateClusterMetadata} +## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} #| ||Field | Description || -|| clusterId | **string** +|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** -ID of the PostgreSQL Cluster resource that is being updated. || +Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** + +User-defined settings for a PostgreSQL 9.6 cluster. || +|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** + +Default configuration for a PostgreSQL 9.6 cluster. || |# -## Status {#google.rpc.Status} +## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62} -The error result of the operation in case of failure or cancellation. +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). #| ||Field | Description || -|| code | **integer** (int32) +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || -|| message | **string** +in bytes. || +|| tempBuffers | **string** (int64) -An error message. || -|| details[] | **object** +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -A list of messages that carry the error details. || -|# +in bytes. || +|| maintenanceWorkMem | **string** (int64) -## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -A PostgreSQL Cluster resource. For more information, see -the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. +in bytes. || +|| tempFileLimit | **string** (int64) -#| -||Field | Description || -|| id | **string** +in bytes. || +|| vacuumCostDelay | **string** (int64) -ID of the PostgreSQL cluster. -This ID is assigned by MDB at creation time. || -|| folderId | **string** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -ID of the folder that the PostgreSQL cluster belongs to. || -|| createdAt | **string** (date-time) +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. +in bytes || +|| backendFlushAfter | **string** (int64) -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| name | **string** +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Name of the PostgreSQL cluster. -The name is unique within the folder. 1-63 characters long. || -|| description | **string** +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) + +Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Description of the PostgreSQL cluster. 0-256 characters long. || -|| labels | **string** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Custom labels for the PostgreSQL cluster as `` key:value `` pairs. -Maximum 64 per resource. || -|| environment | **enum** (Environment) +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Deployment environment of the PostgreSQL cluster. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -- `ENVIRONMENT_UNSPECIFIED` -- `PRODUCTION`: Stable environment with a conservative update policy: -only hotfixes are applied during regular maintenance. -- `PRESTABLE`: Environment with more aggressive update policy: new versions -are rolled out irrespective of backward compatibility. || -|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Description of monitoring systems relevant to the PostgreSQL cluster. || -|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Configuration of the PostgreSQL cluster. || -|| networkId | **string** +in milliseconds. || +|| lockTimeout | **string** (int64) -ID of the network that the cluster belongs to. || -|| health | **enum** (Health) +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Aggregated cluster health. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). -- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). -- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). -- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || -|| status | **enum** (Status) +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Current state of the cluster. +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -- `STATUS_UNKNOWN`: Cluster state is unknown. -- `CREATING`: Cluster is being created. -- `RUNNING`: Cluster is running normally. -- `ERROR`: Cluster encountered a problem and cannot operate. -- `UPDATING`: Cluster is being updated. -- `STOPPING`: Cluster is stopping. -- `STOPPED`: Cluster stopped. -- `STARTING`: Cluster is starting. || -|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow2)** +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Maintenance window for the cluster. || -|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** +in bytes. || +|| deadlockTimeout | **string** (int64) -Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || -|| securityGroupIds[] | **string** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -User security groups || -|| deletionProtection | **boolean** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| sqlInheritance | **boolean** -Deletion Protection inhibits deletion of the cluster || -|| hostGroupIds[] | **string** +This option has been removed in PostgreSQL 10. || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Host groups hosting VMs of the cluster. || -|# +in milliseconds. || +|| archiveTimeout | **string** (int64) -## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# -Monitoring system. +## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} #| ||Field | Description || -|| name | **string** +|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** -Name of the monitoring system. || -|| description | **string** +Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** -Description of the monitoring system. || -|| link | **string** +User-defined settings for a PostgreSQL 10 1C cluster. || +|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** -Link to the monitoring system charts for the PostgreSQL cluster. || +Default configuration for a PostgreSQL 10 1C cluster. || |# -## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} +## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || -|| version | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Version of PostgreSQL server software. || -|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** +in bytes. || +|| tempBuffers | **string** (int64) -Configuration of a PostgreSQL 9.6 server. +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -Configuration of a PostgreSQL 10 1C server. +in bytes. || +|| tempFileLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| vacuumCostDelay | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Configuration of a PostgreSQL 10 server. +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes || +|| backendFlushAfter | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -Configuration of a PostgreSQL 11 server. +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -Configuration of a PostgreSQL 11 1C server. +in bytes || +|| maxWalSize | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| minWalSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) -Configuration of a PostgreSQL 12 server. +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Configuration of a PostgreSQL 12 1C server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Configuration of a PostgreSQL 13 server. +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Configuration of a PostgreSQL 13 1C server. +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| lockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Configuration of a PostgreSQL 14 server. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -Configuration of a PostgreSQL 14 1C server. +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| deadlockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -Configuration of a PostgreSQL 15 server. +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| archiveTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -Configuration of a PostgreSQL 15 1C server. +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) -Configuration of a PostgreSQL 16 server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| onlineAnalyzeEnable | **boolean** || +|| plantunerFixEmptyTable | **boolean** || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| geqo | **boolean** -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -Configuration of a PostgreSQL 16 1C server. +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig2)** +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) -Configuration of the connection pooler. || -|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources2)** +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) -Resources allocated to PostgreSQL hosts. || -|| autofailover | **boolean** +selective pressure within the population || +|| geqoSeed | **number** (double) -Configuration setting which enables/disables autofailover in cluster. || -|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay2)** +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) -Time to start the daily backup, in the UTC timezone. || -|| backupRetainPeriodDays | **string** (int64) +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) -Retention policy of automated backups. || -|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access2)** +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -Access policy to DB || -|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics2)** +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -Configuration of the performance diagnostics service. || -|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling2)** +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. -Disk size autoscaling || +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} +## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** +|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** -Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** - -User-defined settings for a PostgreSQL 9.6 cluster. || -|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** +|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** -Default configuration for a PostgreSQL 9.6 cluster. || +User-defined settings for a PostgreSQL 10 cluster. || +|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** + +Default configuration for a PostgreSQL 10 cluster. || |# -## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62} +## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -15417,9 +18236,7 @@ in bytes || || checkpointTimeout | **string** (int64) in milliseconds. || -|| checkpointCompletionTarget | **number** (double) - -Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointCompletionTarget | **number** (double) || || checkpointFlushAfter | **string** (int64) in bytes || @@ -15572,9 +18389,6 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** - -This option has been removed in PostgreSQL 10. || || autovacuumMaxWorkers | **string** (int64) || || autovacuumVacuumCostDelay | **string** (int64) || || autovacuumVacuumCostLimit | **string** (int64) || @@ -15585,31 +18399,139 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) + +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} +## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** +|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** -Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** +|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** -User-defined settings for a PostgreSQL 10 1C cluster. || -|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** +User-defined settings for a PostgreSQL 11 cluster. || +|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** -Default configuration for a PostgreSQL 10 1C cluster. || +Default configuration for a PostgreSQL 11 cluster. || |# -## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2} +## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -15627,7 +18549,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -15850,6 +18771,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -15896,8 +18826,6 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || -|| onlineAnalyzeEnable | **boolean** || -|| plantunerFixEmptyTable | **boolean** || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -15927,6 +18855,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -15946,27 +18877,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} +## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** +|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** -Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** +|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** -User-defined settings for a PostgreSQL 10 cluster. || -|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** +User-defined settings for a PostgreSQL 11 1C cluster. || +|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** -Default configuration for a PostgreSQL 10 cluster. || +Default configuration for a PostgreSQL 11 1C cluster. || |# -## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102} +## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -15984,7 +18915,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -16189,6 +19119,7 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || || enableBitmapscan | **boolean** || || enableHashagg | **boolean** || || enableHashjoin | **boolean** || @@ -16207,6 +19138,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -16258,6 +19198,7 @@ in milliseconds. || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || || maxStackDepth | **string** (int64) in bytes. || @@ -16282,6 +19223,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -16301,23 +19245,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} +## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** +|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** -Effective settings for a PostgreSQL 11 cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** +|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** -User-defined settings for a PostgreSQL 11 cluster. || -|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** +User-defined settings for a PostgreSQL 12 cluster. || +|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** -Default configuration for a PostgreSQL 11 cluster. || +Default configuration for a PostgreSQL 12 cluster. || |# -## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112} +## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -16570,6 +19514,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -16667,23 +19618,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} +## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** +|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** -Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** +|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** -User-defined settings for a PostgreSQL 11 1C cluster. || -|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** +User-defined settings for a PostgreSQL 12 1C cluster. || +|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** -Default configuration for a PostgreSQL 11 1C cluster. || +Default configuration for a PostgreSQL 12 1C cluster. || |# -## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2} +## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -16937,6 +19888,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -17035,23 +19993,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} +## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** +|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** -Effective settings for a PostgreSQL 12 cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** +|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** -User-defined settings for a PostgreSQL 12 cluster. || -|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** +User-defined settings for a PostgreSQL 13 cluster. || +|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** -Default configuration for a PostgreSQL 12 cluster. || +Default configuration for a PostgreSQL 13 cluster. || |# -## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122} +## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -17357,6 +20315,30 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -17408,23 +20390,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} +## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** +|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** -Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** +|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** -User-defined settings for a PostgreSQL 12 1C cluster. || -|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** +User-defined settings for a PostgreSQL 13 1C cluster. || +|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** -Default configuration for a PostgreSQL 12 1C cluster. || +Default configuration for a PostgreSQL 13 1C cluster. || |# -## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2} +## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -17731,15 +20713,36 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || -|| maxStackDepth | **string** (int64) - -in bytes. || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -17783,23 +20786,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} +## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** +|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** -Effective settings for a PostgreSQL 13 cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** +|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** -User-defined settings for a PostgreSQL 13 cluster. || -|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** +User-defined settings for a PostgreSQL 14 cluster. || +|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** -Default configuration for a PostgreSQL 13 cluster. || +Default configuration for a PostgreSQL 14 cluster. || |# -## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132} +## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -18007,7 +21010,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -18051,7 +21053,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -18129,6 +21130,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -18180,23 +21196,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} +## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** +|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** -Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** +|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** -User-defined settings for a PostgreSQL 13 1C cluster. || -|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** +User-defined settings for a PostgreSQL 14 1C cluster. || +|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** -Default configuration for a PostgreSQL 13 1C cluster. || +Default configuration for a PostgreSQL 14 1C cluster. || |# -## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2} +## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -18404,7 +21420,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -18449,7 +21464,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -18527,6 +21541,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -18576,23 +21605,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} +## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** +|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** -Effective settings for a PostgreSQL 14 cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** +|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** -User-defined settings for a PostgreSQL 14 cluster. || -|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** +User-defined settings for a PostgreSQL 15 cluster. || +|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** -Default configuration for a PostgreSQL 14 cluster. || +Default configuration for a PostgreSQL 15 cluster. || |# -## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142} +## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -18862,7 +21891,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -18943,6 +21973,7 @@ in milliseconds. || || maxStackDepth | **string** (int64) in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -18986,23 +22017,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} +## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** +|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** -Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** +|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** -User-defined settings for a PostgreSQL 14 1C cluster. || -|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** +User-defined settings for a PostgreSQL 15 1C cluster. || +|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** -Default configuration for a PostgreSQL 14 1C cluster. || +Default configuration for a PostgreSQL 15 1C cluster. || |# -## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2} +## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -19273,7 +22304,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -19352,6 +22384,10 @@ in milliseconds. || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -19395,23 +22431,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} +## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** +|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** -Effective settings for a PostgreSQL 15 cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** +|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** -User-defined settings for a PostgreSQL 15 cluster. || -|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** +User-defined settings for a PostgreSQL 16 cluster. || +|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** -Default configuration for a PostgreSQL 15 cluster. || +Default configuration for a PostgreSQL 16 cluster. || |# -## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152} +## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -19497,12 +22533,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -19511,6 +22547,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -19525,6 +22562,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -19539,6 +22577,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -19710,6 +22749,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -19807,23 +22847,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} +## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** +|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** -Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** +|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** -User-defined settings for a PostgreSQL 15 1C cluster. || -|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** +User-defined settings for a PostgreSQL 16 1C cluster. || +|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** -Default configuration for a PostgreSQL 15 1C cluster. || +Default configuration for a PostgreSQL 16 1C cluster. || |# -## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2} +## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -19909,12 +22949,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -19923,6 +22963,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -19937,6 +22978,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -19951,6 +22993,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -20123,6 +23166,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -20221,27 +23265,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} +## PostgresqlConfigSet17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** +|| effectiveConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig172)** -Effective settings for a PostgreSQL 16 cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** +|| userConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig172)** -User-defined settings for a PostgreSQL 16 cluster. || -|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig172)** -Default configuration for a PostgreSQL 16 cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig172} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -20283,7 +23327,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -20635,29 +23678,42 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# -## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} +## PostgresqlConfigSet17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** +|| effectiveConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C2)** -Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** +|| userConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C2)** -User-defined settings for a PostgreSQL 16 1C cluster. || -|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C2)** -Default configuration for a PostgreSQL 16 1C cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2} +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -20699,7 +23755,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -21053,6 +24108,19 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# ## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig2} diff --git a/en/managed-postgresql/api-ref/Cluster/updateHosts.md b/en/managed-postgresql/api-ref/Cluster/updateHosts.md index b756930956e..b2fff548f23 100644 --- a/en/managed-postgresql/api-ref/Cluster/updateHosts.md +++ b/en/managed-postgresql/api-ref/Cluster/updateHosts.md @@ -33,7 +33,7 @@ To get the PostgreSQL cluster ID, use a [ClusterService.List](/docs/managed-post "replicationSource": "string", "priority": "string", "configSpec": { - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", @@ -1052,6 +1052,140 @@ To get the PostgreSQL cluster ID, use a [ClusterService.List](/docs/managed-post "timezone": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" + }, + "postgresqlConfig_17": { + "recoveryMinApplyDelay": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "workMem": "string", + "tempFileLimit": "string", + "backendFlushAfter": "string", + "maxStandbyStreamingDelay": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + }, + "postgresqlConfig_17_1c": { + "recoveryMinApplyDelay": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "workMem": "string", + "tempFileLimit": "string", + "backendFlushAfter": "string", + "maxStandbyStreamingDelay": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" } // end of the list of possible fields }, @@ -1113,77 +1247,87 @@ Whether the host should get a public IP address on creation. || Configuration for a host with PostgreSQL 9.6 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_10_1c | **[PostgresqlHostConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C)** Configuration for a host with PostgreSQL 10 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_10 | **[PostgresqlHostConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10)** Configuration for a host with PostgreSQL 10 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_11 | **[PostgresqlHostConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11)** Configuration for a host with PostgreSQL 11 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_11_1c | **[PostgresqlHostConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C)** Configuration for a host with PostgreSQL 11 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_12 | **[PostgresqlHostConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12)** Configuration for a host with PostgreSQL 12 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_12_1c | **[PostgresqlHostConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C)** Configuration for a host with PostgreSQL 12 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_13 | **[PostgresqlHostConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13)** Configuration for a host with PostgreSQL 13 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_13_1c | **[PostgresqlHostConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C)** Configuration for a host with PostgreSQL 13 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_14 | **[PostgresqlHostConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14)** Configuration for a host with PostgreSQL 14 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_14_1c | **[PostgresqlHostConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C)** Configuration for a host with PostgreSQL 14 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_15 | **[PostgresqlHostConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15)** Configuration for a host with PostgreSQL 15 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_15_1c | **[PostgresqlHostConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C)** Configuration for a host with PostgreSQL 15 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_16 | **[PostgresqlHostConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16)** Configuration for a host with PostgreSQL 16 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_16_1c | **[PostgresqlHostConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C)** Configuration for a host with PostgreSQL 16 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17 | **[PostgresqlHostConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17_1c | **[PostgresqlHostConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || |# ## PostgresqlHostConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6} @@ -3959,6 +4103,378 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# +## PostgresqlHostConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). + +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| workMem | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| debugParallelQuery | **enum** (DebugParallelQuery) + +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# + +## PostgresqlHostConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). + +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| workMem | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| debugParallelQuery | **enum** (DebugParallelQuery) + +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# + ## Response {#yandex.cloud.operation.Operation} **HTTP Code: 200 - OK** diff --git a/en/managed-postgresql/api-ref/User/update.md b/en/managed-postgresql/api-ref/User/update.md index 831f4405fb3..53d21f8ee3b 100644 --- a/en/managed-postgresql/api-ref/User/update.md +++ b/en/managed-postgresql/api-ref/User/update.md @@ -89,7 +89,7 @@ Set of permissions granted to the user to access specific databases. || Maximum number of database connections available to the user. -When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresqlConfig.maxConnections](/docs/managed-postgresql/api-ref/Cluster/get#yandex.cloud.mdb.postgresql.v1.ClusterConfig.postgresqlConfig) setting. +When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresql_config.max_connections] setting. When used in transaction pooling, this setting limits the number of user's active transactions; therefore, in this mode user can open thousands of connections, but only `N` concurrent connections will be opened, where `N` is the value of the setting. diff --git a/en/managed-postgresql/api-ref/grpc/Cluster/addHosts.md b/en/managed-postgresql/api-ref/grpc/Cluster/addHosts.md index ef97e10acb0..2b339bea82d 100644 --- a/en/managed-postgresql/api-ref/grpc/Cluster/addHosts.md +++ b/en/managed-postgresql/api-ref/grpc/Cluster/addHosts.md @@ -24,7 +24,7 @@ Creates new hosts for a cluster. "replicationSource": "string", "priority": "google.protobuf.Int64Value", "configSpec": { - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10", @@ -39,7 +39,9 @@ Creates new hosts for a cluster. "postgresqlConfig_15": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15", "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16", - "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C" + "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C" // end of the list of possible fields } } @@ -105,77 +107,87 @@ Configuration of a PostgreSQL server for the host. || Configuration for a host with PostgreSQL 9.6 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host10_1c.proto)** Configuration for a host with PostgreSQL 10 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host10.proto)** Configuration for a host with PostgreSQL 10 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host11.proto)** Configuration for a host with PostgreSQL 11 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host11_1c.proto)** Configuration for a host with PostgreSQL 11 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host12.proto)** Configuration for a host with PostgreSQL 12 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host12_1c.proto)** Configuration for a host with PostgreSQL 12 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host13.proto)** Configuration for a host with PostgreSQL 13 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host13_1c.proto)** Configuration for a host with PostgreSQL 13 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host14.proto)** Configuration for a host with PostgreSQL 14 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host14_1c.proto)** Configuration for a host with PostgreSQL 14 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host15.proto)** Configuration for a host with PostgreSQL 15 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host15_1c.proto)** Configuration for a host with PostgreSQL 15 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host16.proto)** Configuration for a host with PostgreSQL 16 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host16_1c.proto)** Configuration for a host with PostgreSQL 16 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host17.proto)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host17_1c.proto)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || |# ## operation.Operation {#yandex.cloud.operation.Operation} diff --git a/en/managed-postgresql/api-ref/grpc/Cluster/backup.md b/en/managed-postgresql/api-ref/grpc/Cluster/backup.md index 34a06762481..5bc8544fcd4 100644 --- a/en/managed-postgresql/api-ref/grpc/Cluster/backup.md +++ b/en/managed-postgresql/api-ref/grpc/Cluster/backup.md @@ -60,7 +60,7 @@ To get the PostgreSQL cluster ID, use a [ClusterService.List](/docs/managed-post ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10", @@ -76,6 +76,8 @@ To get the PostgreSQL cluster ID, use a [ClusterService.List](/docs/managed-post "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -313,105 +315,119 @@ Version of PostgreSQL server software. || Configuration of a PostgreSQL 9.6 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration of a PostgreSQL 10 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration of a PostgreSQL 10 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration of a PostgreSQL 11 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration of a PostgreSQL 11 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration of a PostgreSQL 12 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration of a PostgreSQL 12 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration of a PostgreSQL 13 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration of a PostgreSQL 13 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration of a PostgreSQL 14 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration of a PostgreSQL 14 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration of a PostgreSQL 15 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration of a PostgreSQL 16 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration of a PostgreSQL 16 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** diff --git a/en/managed-postgresql/api-ref/grpc/Cluster/create.md b/en/managed-postgresql/api-ref/grpc/Cluster/create.md index bfb21987540..5fa205fc30c 100644 --- a/en/managed-postgresql/api-ref/grpc/Cluster/create.md +++ b/en/managed-postgresql/api-ref/grpc/Cluster/create.md @@ -22,7 +22,7 @@ Creates a PostgreSQL cluster in the specified folder. "environment": "Environment", "configSpec": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10", @@ -38,6 +38,8 @@ Creates a PostgreSQL cluster in the specified folder. "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -130,7 +132,7 @@ Creates a PostgreSQL cluster in the specified folder. "replicationSource": "string", "priority": "google.protobuf.Int64Value", "configSpec": { - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10", @@ -145,7 +147,9 @@ Creates a PostgreSQL cluster in the specified folder. "postgresqlConfig_15": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15", "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16", - "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C" + "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C" // end of the list of possible fields } } @@ -218,110 +222,124 @@ Host groups hosting VMs of the cluster. || || version | **string** Version of PostgreSQL used in the cluster. -Possible values: `9.6`, `10`, `10_1c`, `11`, `12`, `13`, `14`, `15` || +Possible values: `9.6`, `10`, `10_1c`, `11`, `12`, `13`, `14`, `15`, `16`, `17` || || postgresqlConfig_9_6 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql9_6.proto)** Configuration for a PostgreSQL 9.6 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration for a PostgreSQL 10 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration for a PostgreSQL 10 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration for a PostgreSQL 11 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration for a PostgreSQL 11 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration for a PostgreSQL 12 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration for a PostgreSQL 12 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration for a PostgreSQL 13 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration for a PostgreSQL 13 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration for a PostgreSQL 14 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration for a PostgreSQL 14 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration for a PostgreSQL 15 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration for a PostgreSQL 15 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration for a PostgreSQL 16 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration for a PostgreSQL 16 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration for a PostgreSQL 17 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration for a PostgreSQL 17 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** @@ -503,7 +521,7 @@ Set of permissions to grant to the user to access specific databases. || Maximum number of database connections that should be available to the user. -When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresql_config_12.effective_config.max_connections] setting. +When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresqlConfig_12.effectiveConfig.maxConnections](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.maxconnections.proto) setting. When used in transaction pooling, this setting limits the number of user's active transactions; therefore, in this mode user can open thousands of connections, but only `N` concurrent connections will be opened, where `N` is the value of the setting. @@ -753,77 +771,87 @@ Configuration of a PostgreSQL server for the host. || Configuration for a host with PostgreSQL 9.6 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host10_1c.proto)** Configuration for a host with PostgreSQL 10 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host10.proto)** Configuration for a host with PostgreSQL 10 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host11.proto)** Configuration for a host with PostgreSQL 11 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host11_1c.proto)** Configuration for a host with PostgreSQL 11 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host12.proto)** Configuration for a host with PostgreSQL 12 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host12_1c.proto)** Configuration for a host with PostgreSQL 12 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host13.proto)** Configuration for a host with PostgreSQL 13 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host13_1c.proto)** Configuration for a host with PostgreSQL 13 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host14.proto)** Configuration for a host with PostgreSQL 14 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host14_1c.proto)** Configuration for a host with PostgreSQL 14 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host15.proto)** Configuration for a host with PostgreSQL 15 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host15_1c.proto)** Configuration for a host with PostgreSQL 15 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host16.proto)** Configuration for a host with PostgreSQL 16 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host16_1c.proto)** Configuration for a host with PostgreSQL 16 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host17.proto)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host17_1c.proto)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || |# ## operation.Operation {#yandex.cloud.operation.Operation} @@ -858,7 +886,7 @@ Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c` ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10", @@ -874,6 +902,8 @@ Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c` "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -1108,105 +1138,119 @@ Version of PostgreSQL server software. || Configuration of a PostgreSQL 9.6 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration of a PostgreSQL 10 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration of a PostgreSQL 10 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration of a PostgreSQL 11 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration of a PostgreSQL 11 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration of a PostgreSQL 12 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration of a PostgreSQL 12 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration of a PostgreSQL 13 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration of a PostgreSQL 13 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration of a PostgreSQL 14 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration of a PostgreSQL 14 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration of a PostgreSQL 15 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration of a PostgreSQL 16 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration of a PostgreSQL 16 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig2)** diff --git a/en/managed-postgresql/api-ref/grpc/Cluster/get.md b/en/managed-postgresql/api-ref/grpc/Cluster/get.md index ca5dd311b59..05f61417141 100644 --- a/en/managed-postgresql/api-ref/grpc/Cluster/get.md +++ b/en/managed-postgresql/api-ref/grpc/Cluster/get.md @@ -49,7 +49,7 @@ To get the cluster ID use a [ClusterService.List](/docs/managed-postgresql/api-r ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10", @@ -65,6 +65,8 @@ To get the cluster ID use a [ClusterService.List](/docs/managed-postgresql/api-r "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -231,105 +233,119 @@ Version of PostgreSQL server software. || Configuration of a PostgreSQL 9.6 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration of a PostgreSQL 10 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration of a PostgreSQL 10 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration of a PostgreSQL 11 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration of a PostgreSQL 11 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration of a PostgreSQL 12 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration of a PostgreSQL 12 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration of a PostgreSQL 13 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration of a PostgreSQL 13 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration of a PostgreSQL 14 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration of a PostgreSQL 14 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration of a PostgreSQL 15 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration of a PostgreSQL 16 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration of a PostgreSQL 16 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** diff --git a/en/managed-postgresql/api-ref/grpc/Cluster/list.md b/en/managed-postgresql/api-ref/grpc/Cluster/list.md index 8a0c746fdab..abb7a7fe1da 100644 --- a/en/managed-postgresql/api-ref/grpc/Cluster/list.md +++ b/en/managed-postgresql/api-ref/grpc/Cluster/list.md @@ -69,7 +69,7 @@ The expression must specify: ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10", @@ -85,6 +85,8 @@ The expression must specify: "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -269,105 +271,119 @@ Version of PostgreSQL server software. || Configuration of a PostgreSQL 9.6 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration of a PostgreSQL 10 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration of a PostgreSQL 10 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration of a PostgreSQL 11 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration of a PostgreSQL 11 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration of a PostgreSQL 12 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration of a PostgreSQL 12 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration of a PostgreSQL 13 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration of a PostgreSQL 13 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration of a PostgreSQL 14 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration of a PostgreSQL 14 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration of a PostgreSQL 15 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration of a PostgreSQL 16 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration of a PostgreSQL 16 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** diff --git a/en/managed-postgresql/api-ref/grpc/Cluster/listHosts.md b/en/managed-postgresql/api-ref/grpc/Cluster/listHosts.md index 7ab5ef2fdbe..98dc8020700 100644 --- a/en/managed-postgresql/api-ref/grpc/Cluster/listHosts.md +++ b/en/managed-postgresql/api-ref/grpc/Cluster/listHosts.md @@ -64,7 +64,7 @@ returned by the previous list request. || "replicationSource": "string", "priority": "google.protobuf.Int64Value", "config": { - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10", @@ -79,7 +79,9 @@ returned by the previous list request. || "postgresqlConfig_15": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15", "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16", - "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C" + "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C" // end of the list of possible fields }, "assignPublicIp": "bool", @@ -218,105 +220,119 @@ Aggregated health of the service. If the field has default value, it is not retu Configuration for a host with PostgreSQL 9.6 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host10_1c.proto)** Configuration for a host with PostgreSQL 10 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host10.proto)** Configuration for a host with PostgreSQL 10 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host11.proto)** Configuration for a host with PostgreSQL 11 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host11_1c.proto)** Configuration for a host with PostgreSQL 11 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host12.proto)** Configuration for a host with PostgreSQL 12 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host12_1c.proto)** Configuration for a host with PostgreSQL 12 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host13.proto)** Configuration for a host with PostgreSQL 13 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host13_1c.proto)** Configuration for a host with PostgreSQL 13 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host14.proto)** Configuration for a host with PostgreSQL 14 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host14_1c.proto)** Configuration for a host with PostgreSQL 14 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host15.proto)** Configuration for a host with PostgreSQL 15 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host15_1c.proto)** Configuration for a host with PostgreSQL 15 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host16.proto)** Configuration for a host with PostgreSQL 16 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host16_1c.proto)** Configuration for a host with PostgreSQL 16 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL server for the host. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host17.proto)** + +Configuration for a host with PostgreSQL 17 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL server for the host. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host17_1c.proto)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || |# \ No newline at end of file diff --git a/en/managed-postgresql/api-ref/grpc/Cluster/move.md b/en/managed-postgresql/api-ref/grpc/Cluster/move.md index 51ab012ec25..bf79d1c269a 100644 --- a/en/managed-postgresql/api-ref/grpc/Cluster/move.md +++ b/en/managed-postgresql/api-ref/grpc/Cluster/move.md @@ -64,7 +64,7 @@ Required field. ID of the destination folder. || ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10", @@ -80,6 +80,8 @@ Required field. ID of the destination folder. || "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -320,105 +322,119 @@ Version of PostgreSQL server software. || Configuration of a PostgreSQL 9.6 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration of a PostgreSQL 10 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration of a PostgreSQL 10 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration of a PostgreSQL 11 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration of a PostgreSQL 11 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration of a PostgreSQL 12 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration of a PostgreSQL 12 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration of a PostgreSQL 13 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration of a PostgreSQL 13 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration of a PostgreSQL 14 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration of a PostgreSQL 14 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration of a PostgreSQL 15 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration of a PostgreSQL 16 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration of a PostgreSQL 16 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** diff --git a/en/managed-postgresql/api-ref/grpc/Cluster/rescheduleMaintenance.md b/en/managed-postgresql/api-ref/grpc/Cluster/rescheduleMaintenance.md index 5909dc205e6..9b9665b555a 100644 --- a/en/managed-postgresql/api-ref/grpc/Cluster/rescheduleMaintenance.md +++ b/en/managed-postgresql/api-ref/grpc/Cluster/rescheduleMaintenance.md @@ -72,7 +72,7 @@ The time until which this maintenance operation should be delayed. The value sho ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10", @@ -88,6 +88,8 @@ The time until which this maintenance operation should be delayed. The value sho "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -327,105 +329,119 @@ Version of PostgreSQL server software. || Configuration of a PostgreSQL 9.6 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration of a PostgreSQL 10 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration of a PostgreSQL 10 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration of a PostgreSQL 11 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration of a PostgreSQL 11 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration of a PostgreSQL 12 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration of a PostgreSQL 12 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration of a PostgreSQL 13 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration of a PostgreSQL 13 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration of a PostgreSQL 14 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration of a PostgreSQL 14 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration of a PostgreSQL 15 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration of a PostgreSQL 16 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration of a PostgreSQL 16 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** diff --git a/en/managed-postgresql/api-ref/grpc/Cluster/restore.md b/en/managed-postgresql/api-ref/grpc/Cluster/restore.md index e83434031e7..0c4883a5bbb 100644 --- a/en/managed-postgresql/api-ref/grpc/Cluster/restore.md +++ b/en/managed-postgresql/api-ref/grpc/Cluster/restore.md @@ -24,7 +24,7 @@ Creates a new PostgreSQL cluster using the specified backup. "environment": "Environment", "configSpec": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10", @@ -40,6 +40,8 @@ Creates a new PostgreSQL cluster using the specified backup. "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -79,7 +81,7 @@ Creates a new PostgreSQL cluster using the specified backup. "replicationSource": "string", "priority": "google.protobuf.Int64Value", "configSpec": { - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10", @@ -94,7 +96,9 @@ Creates a new PostgreSQL cluster using the specified backup. "postgresqlConfig_15": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15", "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16", - "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C" + "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C" // end of the list of possible fields } } @@ -178,110 +182,124 @@ Host groups hosting VMs of the cluster. || || version | **string** Version of PostgreSQL used in the cluster. -Possible values: `9.6`, `10`, `10_1c`, `11`, `12`, `13`, `14`, `15` || +Possible values: `9.6`, `10`, `10_1c`, `11`, `12`, `13`, `14`, `15`, `16`, `17` || || postgresqlConfig_9_6 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql9_6.proto)** Configuration for a PostgreSQL 9.6 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration for a PostgreSQL 10 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration for a PostgreSQL 10 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration for a PostgreSQL 11 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration for a PostgreSQL 11 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration for a PostgreSQL 12 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration for a PostgreSQL 12 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration for a PostgreSQL 13 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration for a PostgreSQL 13 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration for a PostgreSQL 14 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration for a PostgreSQL 14 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration for a PostgreSQL 15 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration for a PostgreSQL 15 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration for a PostgreSQL 16 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration for a PostgreSQL 16 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration for a PostgreSQL 17 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration for a PostgreSQL 17 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** @@ -448,77 +466,87 @@ Configuration of a PostgreSQL server for the host. || Configuration for a host with PostgreSQL 9.6 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host10_1c.proto)** Configuration for a host with PostgreSQL 10 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host10.proto)** Configuration for a host with PostgreSQL 10 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host11.proto)** Configuration for a host with PostgreSQL 11 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host11_1c.proto)** Configuration for a host with PostgreSQL 11 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host12.proto)** Configuration for a host with PostgreSQL 12 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host12_1c.proto)** Configuration for a host with PostgreSQL 12 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host13.proto)** Configuration for a host with PostgreSQL 13 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host13_1c.proto)** Configuration for a host with PostgreSQL 13 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host14.proto)** Configuration for a host with PostgreSQL 14 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host14_1c.proto)** Configuration for a host with PostgreSQL 14 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host15.proto)** Configuration for a host with PostgreSQL 15 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host15_1c.proto)** Configuration for a host with PostgreSQL 15 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host16.proto)** Configuration for a host with PostgreSQL 16 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host16_1c.proto)** Configuration for a host with PostgreSQL 16 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host17.proto)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host17_1c.proto)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || |# ## operation.Operation {#yandex.cloud.operation.Operation} @@ -554,7 +582,7 @@ Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c` ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10", @@ -570,6 +598,8 @@ Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c` "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -807,105 +837,119 @@ Version of PostgreSQL server software. || Configuration of a PostgreSQL 9.6 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration of a PostgreSQL 10 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration of a PostgreSQL 10 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration of a PostgreSQL 11 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration of a PostgreSQL 11 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration of a PostgreSQL 12 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration of a PostgreSQL 12 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration of a PostgreSQL 13 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration of a PostgreSQL 13 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration of a PostgreSQL 14 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration of a PostgreSQL 14 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration of a PostgreSQL 15 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration of a PostgreSQL 16 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration of a PostgreSQL 16 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig2)** diff --git a/en/managed-postgresql/api-ref/grpc/Cluster/start.md b/en/managed-postgresql/api-ref/grpc/Cluster/start.md index 0eb45bcfeb3..710eaf5bbe8 100644 --- a/en/managed-postgresql/api-ref/grpc/Cluster/start.md +++ b/en/managed-postgresql/api-ref/grpc/Cluster/start.md @@ -58,7 +58,7 @@ Required field. ID of the PostgreSQL cluster to start. || ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10", @@ -74,6 +74,8 @@ Required field. ID of the PostgreSQL cluster to start. || "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -308,105 +310,119 @@ Version of PostgreSQL server software. || Configuration of a PostgreSQL 9.6 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration of a PostgreSQL 10 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration of a PostgreSQL 10 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration of a PostgreSQL 11 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration of a PostgreSQL 11 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration of a PostgreSQL 12 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration of a PostgreSQL 12 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration of a PostgreSQL 13 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration of a PostgreSQL 13 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration of a PostgreSQL 14 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration of a PostgreSQL 14 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration of a PostgreSQL 15 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration of a PostgreSQL 16 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration of a PostgreSQL 16 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** diff --git a/en/managed-postgresql/api-ref/grpc/Cluster/startFailover.md b/en/managed-postgresql/api-ref/grpc/Cluster/startFailover.md index 2f47012aa52..9d572d4a036 100644 --- a/en/managed-postgresql/api-ref/grpc/Cluster/startFailover.md +++ b/en/managed-postgresql/api-ref/grpc/Cluster/startFailover.md @@ -62,7 +62,7 @@ New master host. Switch to the most up-to-date replica if not provided. || ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10", @@ -78,6 +78,8 @@ New master host. Switch to the most up-to-date replica if not provided. || "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -312,105 +314,119 @@ Version of PostgreSQL server software. || Configuration of a PostgreSQL 9.6 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration of a PostgreSQL 10 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration of a PostgreSQL 10 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration of a PostgreSQL 11 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration of a PostgreSQL 11 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration of a PostgreSQL 12 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration of a PostgreSQL 12 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration of a PostgreSQL 13 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration of a PostgreSQL 13 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration of a PostgreSQL 14 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration of a PostgreSQL 14 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration of a PostgreSQL 15 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration of a PostgreSQL 16 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration of a PostgreSQL 16 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** diff --git a/en/managed-postgresql/api-ref/grpc/Cluster/stop.md b/en/managed-postgresql/api-ref/grpc/Cluster/stop.md index 17c62608d80..1a78a191720 100644 --- a/en/managed-postgresql/api-ref/grpc/Cluster/stop.md +++ b/en/managed-postgresql/api-ref/grpc/Cluster/stop.md @@ -58,7 +58,7 @@ Required field. ID of the PostgreSQL cluster to stop. || ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10", @@ -74,6 +74,8 @@ Required field. ID of the PostgreSQL cluster to stop. || "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -308,105 +310,119 @@ Version of PostgreSQL server software. || Configuration of a PostgreSQL 9.6 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration of a PostgreSQL 10 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration of a PostgreSQL 10 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration of a PostgreSQL 11 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration of a PostgreSQL 11 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration of a PostgreSQL 12 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration of a PostgreSQL 12 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration of a PostgreSQL 13 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration of a PostgreSQL 13 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration of a PostgreSQL 14 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration of a PostgreSQL 14 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration of a PostgreSQL 15 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration of a PostgreSQL 16 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration of a PostgreSQL 16 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** diff --git a/en/managed-postgresql/api-ref/grpc/Cluster/update.md b/en/managed-postgresql/api-ref/grpc/Cluster/update.md index d091a02a39d..49e460decc7 100644 --- a/en/managed-postgresql/api-ref/grpc/Cluster/update.md +++ b/en/managed-postgresql/api-ref/grpc/Cluster/update.md @@ -21,7 +21,7 @@ Updates the specified PostgreSQL cluster. "labels": "string", "configSpec": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10", @@ -37,6 +37,8 @@ Updates the specified PostgreSQL cluster. "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -132,110 +134,124 @@ ID of the network to move the cluster to. || || version | **string** Version of PostgreSQL used in the cluster. -Possible values: `9.6`, `10`, `10_1c`, `11`, `12`, `13`, `14`, `15` || +Possible values: `9.6`, `10`, `10_1c`, `11`, `12`, `13`, `14`, `15`, `16`, `17` || || postgresqlConfig_9_6 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql9_6.proto)** Configuration for a PostgreSQL 9.6 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration for a PostgreSQL 10 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration for a PostgreSQL 10 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration for a PostgreSQL 11 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration for a PostgreSQL 11 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration for a PostgreSQL 12 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration for a PostgreSQL 12 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration for a PostgreSQL 13 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration for a PostgreSQL 13 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration for a PostgreSQL 14 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration for a PostgreSQL 14 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration for a PostgreSQL 15 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration for a PostgreSQL 15 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration for a PostgreSQL 16 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration for a PostgreSQL 16 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration for a PostgreSQL 17 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration for a PostgreSQL 17 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** @@ -439,7 +455,7 @@ Hour of the day in UTC (in `HH` format). || ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10", @@ -455,6 +471,8 @@ Hour of the day in UTC (in `HH` format). || "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -689,105 +707,119 @@ Version of PostgreSQL server software. || Configuration of a PostgreSQL 9.6 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration of a PostgreSQL 10 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration of a PostgreSQL 10 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration of a PostgreSQL 11 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration of a PostgreSQL 11 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration of a PostgreSQL 12 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration of a PostgreSQL 12 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration of a PostgreSQL 13 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration of a PostgreSQL 13 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration of a PostgreSQL 14 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration of a PostgreSQL 14 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration of a PostgreSQL 15 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration of a PostgreSQL 16 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration of a PostgreSQL 16 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig2)** diff --git a/en/managed-postgresql/api-ref/grpc/Cluster/updateHosts.md b/en/managed-postgresql/api-ref/grpc/Cluster/updateHosts.md index 3dd20e9ec32..2657a333112 100644 --- a/en/managed-postgresql/api-ref/grpc/Cluster/updateHosts.md +++ b/en/managed-postgresql/api-ref/grpc/Cluster/updateHosts.md @@ -22,7 +22,7 @@ Updates the specified hosts. "replicationSource": "string", "priority": "google.protobuf.Int64Value", "configSpec": { - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10", @@ -37,7 +37,9 @@ Updates the specified hosts. "postgresqlConfig_15": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15", "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16", - "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C" + "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C" // end of the list of possible fields }, "updateMask": "google.protobuf.FieldMask", @@ -95,77 +97,87 @@ Whether the host should get a public IP address on creation. || Configuration for a host with PostgreSQL 9.6 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host10_1c.proto)** Configuration for a host with PostgreSQL 10 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host10.proto)** Configuration for a host with PostgreSQL 10 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host11.proto)** Configuration for a host with PostgreSQL 11 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host11_1c.proto)** Configuration for a host with PostgreSQL 11 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host12.proto)** Configuration for a host with PostgreSQL 12 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host12_1c.proto)** Configuration for a host with PostgreSQL 12 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host13.proto)** Configuration for a host with PostgreSQL 13 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host13_1c.proto)** Configuration for a host with PostgreSQL 13 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host14.proto)** Configuration for a host with PostgreSQL 14 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host14_1c.proto)** Configuration for a host with PostgreSQL 14 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host15.proto)** Configuration for a host with PostgreSQL 15 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host15_1c.proto)** Configuration for a host with PostgreSQL 15 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host16.proto)** Configuration for a host with PostgreSQL 16 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host16_1c.proto)** Configuration for a host with PostgreSQL 16 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host17.proto)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host17_1c.proto)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || |# ## operation.Operation {#yandex.cloud.operation.Operation} diff --git a/en/managed-postgresql/api-ref/grpc/User/create.md b/en/managed-postgresql/api-ref/grpc/User/create.md index aa6ca7aa288..6fe9295380b 100644 --- a/en/managed-postgresql/api-ref/grpc/User/create.md +++ b/en/managed-postgresql/api-ref/grpc/User/create.md @@ -82,7 +82,7 @@ Set of permissions to grant to the user to access specific databases. || Maximum number of database connections that should be available to the user. -When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresql_config_12.effective_config.max_connections] setting. +When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresqlConfig_12.effectiveConfig.maxConnections](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.maxconnections.proto) setting. When used in transaction pooling, this setting limits the number of user's active transactions; therefore, in this mode user can open thousands of connections, but only `N` concurrent connections will be opened, where `N` is the value of the setting. @@ -427,7 +427,7 @@ Set of permissions granted to the user to access specific databases. || Maximum number of database connections available to the user. -When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresql_config_12.effective_config.max_connections] setting. +When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresqlConfig_12.effectiveConfig.maxConnections](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.maxconnections.proto) setting. When used in transaction pooling, this setting limits the number of user's active transactions; therefore, in this mode user can open thousands of connections, but only `N` concurrent connections will be opened, where `N` is the value of the setting. diff --git a/en/managed-postgresql/api-ref/grpc/User/get.md b/en/managed-postgresql/api-ref/grpc/User/get.md index 220e5ae514d..dd4d74ef05b 100644 --- a/en/managed-postgresql/api-ref/grpc/User/get.md +++ b/en/managed-postgresql/api-ref/grpc/User/get.md @@ -92,7 +92,7 @@ Set of permissions granted to the user to access specific databases. || Maximum number of database connections available to the user. -When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresql_config_12.effective_config.max_connections] setting. +When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresqlConfig_12.effectiveConfig.maxConnections](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.maxconnections.proto) setting. When used in transaction pooling, this setting limits the number of user's active transactions; therefore, in this mode user can open thousands of connections, but only `N` concurrent connections will be opened, where `N` is the value of the setting. diff --git a/en/managed-postgresql/api-ref/grpc/User/grantPermission.md b/en/managed-postgresql/api-ref/grpc/User/grantPermission.md index c1d21a7dff5..6d57d370cbc 100644 --- a/en/managed-postgresql/api-ref/grpc/User/grantPermission.md +++ b/en/managed-postgresql/api-ref/grpc/User/grantPermission.md @@ -190,7 +190,7 @@ Set of permissions granted to the user to access specific databases. || Maximum number of database connections available to the user. -When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresql_config_12.effective_config.max_connections] setting. +When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresqlConfig_12.effectiveConfig.maxConnections](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.maxconnections.proto) setting. When used in transaction pooling, this setting limits the number of user's active transactions; therefore, in this mode user can open thousands of connections, but only `N` concurrent connections will be opened, where `N` is the value of the setting. diff --git a/en/managed-postgresql/api-ref/grpc/User/list.md b/en/managed-postgresql/api-ref/grpc/User/list.md index 39c6577314d..54670be8e8f 100644 --- a/en/managed-postgresql/api-ref/grpc/User/list.md +++ b/en/managed-postgresql/api-ref/grpc/User/list.md @@ -116,7 +116,7 @@ Set of permissions granted to the user to access specific databases. || Maximum number of database connections available to the user. -When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresql_config_12.effective_config.max_connections] setting. +When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresqlConfig_12.effectiveConfig.maxConnections](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.maxconnections.proto) setting. When used in transaction pooling, this setting limits the number of user's active transactions; therefore, in this mode user can open thousands of connections, but only `N` concurrent connections will be opened, where `N` is the value of the setting. diff --git a/en/managed-postgresql/api-ref/grpc/User/revokePermission.md b/en/managed-postgresql/api-ref/grpc/User/revokePermission.md index e22f309cfec..0fa1aa2d0da 100644 --- a/en/managed-postgresql/api-ref/grpc/User/revokePermission.md +++ b/en/managed-postgresql/api-ref/grpc/User/revokePermission.md @@ -178,7 +178,7 @@ Set of permissions granted to the user to access specific databases. || Maximum number of database connections available to the user. -When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresql_config_12.effective_config.max_connections] setting. +When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresqlConfig_12.effectiveConfig.maxConnections](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.maxconnections.proto) setting. When used in transaction pooling, this setting limits the number of user's active transactions; therefore, in this mode user can open thousands of connections, but only `N` concurrent connections will be opened, where `N` is the value of the setting. diff --git a/en/managed-postgresql/api-ref/grpc/User/update.md b/en/managed-postgresql/api-ref/grpc/User/update.md index 3af8b836098..6102125c235 100644 --- a/en/managed-postgresql/api-ref/grpc/User/update.md +++ b/en/managed-postgresql/api-ref/grpc/User/update.md @@ -76,7 +76,7 @@ Set of permissions granted to the user to access specific databases. || Maximum number of database connections available to the user. -When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresqlConfig.maxConnections](/docs/managed-postgresql/api-ref/grpc/Cluster/get#yandex.cloud.mdb.postgresql.v1.ClusterConfig.postgresqlConfig) setting. +When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresql_config.max_connections] setting. When used in transaction pooling, this setting limits the number of user's active transactions; therefore, in this mode user can open thousands of connections, but only `N` concurrent connections will be opened, where `N` is the value of the setting. @@ -418,7 +418,7 @@ Set of permissions granted to the user to access specific databases. || Maximum number of database connections available to the user. -When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresql_config_12.effective_config.max_connections] setting. +When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresqlConfig_12.effectiveConfig.maxConnections](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.maxconnections.proto) setting. When used in transaction pooling, this setting limits the number of user's active transactions; therefore, in this mode user can open thousands of connections, but only `N` concurrent connections will be opened, where `N` is the value of the setting. diff --git a/en/managed-postgresql/concepts/limits.md b/en/managed-postgresql/concepts/limits.md index 6a2f9ec1544..e11c674892b 100644 --- a/en/managed-postgresql/concepts/limits.md +++ b/en/managed-postgresql/concepts/limits.md @@ -1,6 +1,6 @@ --- title: Quotas and limits in {{ mpg-name }} -description: '{{ mpg-name }} has limits and quotas for the number of clusters, total number of processor cores for all database hosts, total amount of RAM for all database hosts, and total storage for all clusters per cloud. For more information about the service restrictions, read this article.' +description: '{{ mpg-name }} has limits and quotas for the number of clusters, total number of processor cores for all database hosts, total amount of virtual memory for all database hosts, and total storage for all clusters per cloud. For more information about the service restrictions, read this article.' editable: false --- diff --git a/en/managed-postgresql/operations/cluster-backups.md b/en/managed-postgresql/operations/cluster-backups.md index 05c45dfc3c7..93bfb9648e9 100644 --- a/en/managed-postgresql/operations/cluster-backups.md +++ b/en/managed-postgresql/operations/cluster-backups.md @@ -29,53 +29,53 @@ When restored to the current state, the new cluster will match the state of: - Management console {#console} - **To restore an existing cluster from a backup:** - - 1. Go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-postgresql }}**. - 1. Click the cluster name and open the **{{ ui-key.yacloud.postgresql.cluster.switch_backups }}** tab. - 1. Click ![image](../../_assets/console-icons/ellipsis.svg) for the backup you need and click **{{ ui-key.yacloud.mdb.cluster.backups.button_restore }}**. - 1. Set up the new cluster. You can select a folder for the new cluster from the **{{ ui-key.yacloud.mdb.forms.base_field_folder }}** list. - 1. To restore the cluster state to the required point in time after creating this backup, configure **{{ ui-key.yacloud.mdb.forms.field_date }}** as appropriate. You can enter the value manually or select it from the drop-down calendar. + **To restore an existing cluster from a backup**: - If you do not change the setting, the cluster will be restored to the state when the backup was completed. + 1. Go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-postgresql }}**. + 1. Click the cluster name and open the **{{ ui-key.yacloud.postgresql.cluster.switch_backups }}** tab. + 1. Click ![image](../../_assets/console-icons/ellipsis.svg) for the backup you need, then click **{{ ui-key.yacloud.mdb.cluster.backups.button_restore }}**. + 1. Set up the new cluster. You can select a folder for the new cluster from the **{{ ui-key.yacloud.mdb.forms.base_field_folder }}** list. + 1. To restore the cluster to a particular point in time after creating this backup, configure **{{ ui-key.yacloud.mdb.forms.field_date }}** accordingly. You can enter the date manually or select it from the drop-down calendar. - 1. Click **{{ ui-key.yacloud.mdb.cluster.backups.button_restore }}**. + If you do not change the setting, the cluster will be restored to the state when the backup was completed. - **To restore a previously deleted cluster from a backup:** + 1. Click **{{ ui-key.yacloud.mdb.cluster.backups.button_restore }}**. - 1. Go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-postgresql }}**. - 1. Select the **{{ ui-key.yacloud.postgresql.switch_backups }}** tab. - 1. Find the backup you need using the backup creation time and cluster ID. The **{{ ui-key.yacloud.common.id }}** column contains IDs in `:` format. - 1. Click ![image](../../_assets/console-icons/ellipsis.svg) for the backup you need and click **{{ ui-key.yacloud.mdb.cluster.backups.button_restore }}**. - 1. Set up the new cluster. You can select a folder for the new cluster from the **{{ ui-key.yacloud.mdb.forms.base_field_folder }}** list. - 1. To restore the cluster state to the required point in time after creating this backup, configure **{{ ui-key.yacloud.mdb.forms.field_date }}** as appropriate. You can enter the value manually or select it from the drop-down calendar. + **To restore a previously deleted cluster from a backup**: - If you do not change the setting, the cluster will be restored to the state when the backup was completed. + 1. Go to the folder page and select **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-postgresql }}**. + 1. Select the **{{ ui-key.yacloud.postgresql.switch_backups }}** tab. + 1. Find the backup you need using the backup creation time and cluster ID. The **{{ ui-key.yacloud.common.id }}** column contains IDs formatted as `:`. + 1. Click ![image](../../_assets/console-icons/ellipsis.svg) for the backup you need, then click **{{ ui-key.yacloud.mdb.cluster.backups.button_restore }}**. + 1. Set up the new cluster. You can select a folder for the new cluster from the **{{ ui-key.yacloud.mdb.forms.base_field_folder }}** list. + 1. To restore the cluster to a particular point in time after creating this backup, configure **{{ ui-key.yacloud.mdb.forms.field_date }}** accordingly. You can enter the date manually or select it from the drop-down calendar. - 1. Click **{{ ui-key.yacloud.mdb.cluster.backups.button_restore }}**. - - {{ mpg-name }} will launch the operation to create a cluster from the backup. + If you do not change the setting, the cluster will be restored to the state when the backup was completed. + 1. Click **{{ ui-key.yacloud.mdb.cluster.backups.button_restore }}**. + + {{ mpg-name }} will launch the operation to create a cluster from the backup. + - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - By default, the cluster is restored to the same folder where the backup is stored. To restore the cluster to a different folder, specify its ID in the `--folder-id` parameter. + By default, the cluster is restored to the same folder where the backup is stored. To restore the cluster to a different folder, specify its ID in the `--folder-id` parameter. - To restore a cluster from a backup: + To restore a cluster from a backup: - 1. View a description of the CLI restore {{ PG }} cluster command: + 1. View a description of the CLI restore {{ PG }} cluster command: ```bash {{ yc-mdb-pg }} cluster restore --help ``` - 1. Getting a list of available {{ PG }} cluster backups: + 1. Getting a list of available {{ PG }} cluster backups: ```bash {{ yc-mdb-pg }} backup list ``` - + ```text +--------------------------+---------------------+----------------------+---------------------+ | ID | CREATED AT | SOURCE CLUSTER ID | STARTED AT | @@ -85,9 +85,9 @@ When restored to the current state, the new cluster will match the state of: +--------------------------+---------------------+----------------------+---------------------+ ``` - The time when the backup was completed is shown in the `CREATED AT` column with a list of available backups, in `yyyy-mm-dd hh:mm:ss` format (`2020-08-10 12:00:00` in the example above). You can restore a cluster to any point in time starting with the point when the backup is created. + The backup completion time is shown in the `CREATED AT` column of the list of available backups, in `yyyy-mm-dd hh:mm:ss` format (`2020-08-10 12:00:00` in the example above). You can restore a cluster to any point in time starting with the point when the backup is created. - 1. Request the creation of a cluster from a backup: + 1. Request the creation of a cluster from a backup: ```bash @@ -109,21 +109,21 @@ When restored to the current state, the new cluster will match the state of: Where: * `--backup-id`: [Backup](../concepts/backup.md) ID. - * `--time`: Time point to restore the {{ PG }} cluster to, in `yyyy-mm-ddThh:mm:ssZ` format. + * `--time`: Time point to restore the {{ PG }} cluster to, in `yyyy-mm-ddThh:mm:ssZ` time format. * `--name`: Cluster name. * `--environment`: Environment: - * `PRESTABLE`: For testing purposes. The prestable environment is similar to the production environment and likewise covered by the SLA, but it is the first to get new functionalities, improvements, and bug fixes. In the prestable environment, you can test compatibility of new versions with your application. - * `PRODUCTION`: For stable versions of your apps. + * `PRESTABLE`: For testing purposes. The prestable environment is similar to the production environment and likewise covered by the SLA, but it is the first to get new functionalities, improvements, and bug fixes. In the prestable environment, you can test compatibility of new versions with your application. + * `PRODUCTION`: For stable versions of your apps. * `--network-name`: [Network name](../../vpc/concepts/network.md#network). * `--host`: Host parameters: - * `zone-id`: [Availability zone](../../overview/concepts/geo-scope.md). + * `zone-id`: [Availability zone](../../overview/concepts/geo-scope.md). - * `subnet-name`: [Subnet name](../../vpc/concepts/network.md#subnet). Specify if two or more subnets are created in the selected availability zone. - * `assign-public-ip`: Flag to be set if [public access to the host](../concepts/network.md#public-access-to-a-host) is required, `true` or `false`. + * `subnet-name`: [Subnet name](../../vpc/concepts/network.md#subnet). Specify if two or more subnets are created in the selected availability zone. + * `assign-public-ip`: Flag to add if [public access to the host](../concepts/network.md#public-access-to-a-host) is required (`true` or `false`). * `--resource-preset`: [Host class](../concepts/instance-types.md#available-flavors). @@ -131,22 +131,22 @@ When restored to the current state, the new cluster will match the state of: * `--disk-type`: [Disk type](../concepts/storage.md): - * `network-hdd` - * `network-ssd` - * `local-ssd` - * `network-ssd-nonreplicated` + * `network-hdd` + * `network-ssd` + * `local-ssd` + * `network-ssd-nonreplicated` - {{ TF }} {#tf} - Use {{ TF }} to restore: + Use {{ TF }} to restore: * Existing cluster from a backup. * Cluster created and deleted via the management console, CLI, or API. {% note info %} - The cluster is restored to the folder, the ID of which is specified in the `folder_id` parameter of [provider settings]({{ tf-provider-link }}). + The cluster will be restored to the folder whose ID is specified in the `folder_id` parameter of [provider settings]({{ tf-provider-link }}). {% endnote %} @@ -171,30 +171,30 @@ When restored to the current state, the new cluster will match the state of: 1. Create a [{{ TF }} configuration file](cluster-create.md#create-cluster) for the new cluster. - Do not use resources of the databases (`yandex_mdb_postgresql_database`) and users (`yandex_mdb_postgresql_user`). They will be restored from the backup. + Do not use the database (`yandex_mdb_postgresql_database`) and user (`yandex_mdb_postgresql_user`) resources: these will be restored from the backup. - 1. Add a block named `restore` to the configuration file: + 1. Add the `restore` section to the configuration file: - ```hcl - resource "yandex_mdb_postgresql_cluster" "" { - ... - restore { - backup_id = "" - time = "
` command. The results are sorted by the document editing time, from the newest to the oldest. The search type is `{{ ui-key.yacloud.search-api.test-query.label_search_type-russian }}` (yandex.ru). Search region: Novosibirsk Oblast. The **Family search** filter is applied to the search results. The results are grouped by domain. Each group contains three documents, and the number of groups returned per page is 10. The maximum number of passages per document is 2. {{ search-api-full-name }} returns a UTF-8 encoded XML file. +The URL and request body presented below return the fifth page of search results for the `
` request. The results are sorted by the document editing time, from the newest to the oldest. The search type is `{{ ui-key.yacloud.search-api.test-query.label_search_type-russian }}` (yandex.ru). Search region: Novosibirsk Oblast. The **Family search** filter is applied to the search results. The results are grouped by domain. Each group contains three documents, and the number of groups returned per page is 10. The maximum number of passages per document is 2. {{ search-api-full-name }} returns a UTF-8 encoded XML file. Request URL: diff --git a/en/search-api/operations/mobile.md b/en/search-api/operations/mobile.md index e0112642b62..3e16b9fcce9 100644 --- a/en/search-api/operations/mobile.md +++ b/en/search-api/operations/mobile.md @@ -9,13 +9,16 @@ To get mobile search results, add the `user-agent` header with the device and br - cURL {#curl} ```bash - curl -H 'user-agent: Mozilla/5.0 (iPhone; CPU iPhone OS 13_2_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.0.3 Mobile/15E148 Safari/604.1' 'https://yandex.ru/search/xml?query=youtube&user={USER}&key={KEY}&lr=2&l10n=en&page=0&groupby=attr%3Dd.mode%3Ddeep.groups-on-page%3D100.docs-in-group%3D1&filter=moderate&noredirect=1&nocache=da' + curl \ + --header 'user-agent: Mozilla/5.0 (iPhone; CPU iPhone OS 13_2_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.0.3 Mobile/15E148 Safari/604.1' \ + 'https://yandex.ru/search/xml?query=youtube&user={USER}&key={KEY}&lr=2&l10n=en&page=0&groupby=attr%3Dd.mode%3Ddeep.groups-on-page%3D100.docs-in-group%3D1&filter=moderate&noredirect=1&nocache=da' ``` - Python {#python} ```python import subprocess + MOBILE_HEADER = 'user-agent: Mozilla/5.0 (iPhone; CPU iPhone OS 13_2_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.0.3 Mobile/15E148 Safari/604.1' URL = f'https://yandex.ru/search/xml?query=youtube&user={USER}&key={KEY}&lr=2&l10n=en&page=0&groupby=attr%3Dd.mode%3Ddeep.groups-on-page%3D100.docs-in-group%3D1&filter=moderate&noredirect=1&nocache=da' with open('mob.xml', 'w') as f: diff --git a/en/search-api/operations/searching.md b/en/search-api/operations/searching.md index fe35cd738fb..886e9337e17 100644 --- a/en/search-api/operations/searching.md +++ b/en/search-api/operations/searching.md @@ -61,13 +61,14 @@ Based on the search type selected when signing up for the service, specify the a https://yandex.ru/search/xml?folderid=b1gt6g8ht345********&apikey=your_service_account_API_key********&query=%3Ctable%3E&lr=11316&l10n=ru&sortby=rlv&filter=strict&groupby=attr%3Dd.mode%3Ddeep.groups-on-page%3D5.docs-in-group%3D3&maxpassages=3&page=4 ``` - This request returns the fifth page of search results for the `
` command. The search type is `{{ ui-key.yacloud.search-api.test-query.label_search_type-russian }}` (yandex.ru). Search region is Novosibirsk Oblast, and the notification language is Russian. The **Family search** filter will be applied to the search results. The number of passages is three. The results are grouped by domain and sorted by relevance. Each group contains three documents, and the number of groups returned per page is five. + This request returns the fifth page of search results for the `
` prompt. The search type is `{{ ui-key.yacloud.search-api.test-query.label_search_type-russian }}` (yandex.ru). Search region: Novosibirsk Oblast. Notification language: Russian. The **Family search** filter will be applied to the search results. The number of passages is three. The results are grouped by domain and sorted by relevance. Each group contains three documents, and the number of groups returned per page is five. 1. Send a query to the Yandex search database. To do this, use the [cURL](https://curl.haxx.se) utility: ```bash - curl -X GET \ - -o result.xml \ + curl \ + --request GET \ + --output result.xml \ 'https://yandex.ru/search/xml?folderid=b1gt6g8ht345********&apikey=your_service_account_API_key********&query=%3Ctable%3E&lr=11316&l10n=ru&sortby=rlv&filter=strict&groupby=attr%3Dd.mode%3Ddeep.groups-on-page%3D5.docs-in-group%3D3&maxpassages=3&page=4' ``` @@ -120,15 +121,16 @@ Based on the search type selected when signing up for the service, specify the a For detailed information about the parameters specified in the request body, see [Request body parameters](../concepts/post-request.md#post-body-parameters). - The following request example returns the fifth page of search results for the `
` command. The results are sorted by the document editing time, from the newest to the oldest. The search type is `{{ ui-key.yacloud.search-api.test-query.label_search_type-russian }}` (yandex.ru). Search region: Novosibirsk Oblast. The **Family search** filter is applied to the search results. The results are grouped by domain. Each group contains three documents, and the number of groups returned per page is 10. The maximum number of passages per document is 2. + The following request example returns the fifth page of search results for the `
` prompt. The results are sorted by the document editing time, from the newest to the oldest. The search type is `{{ ui-key.yacloud.search-api.test-query.label_search_type-russian }}` (yandex.ru). Search region: Novosibirsk Oblast. The **Family search** filter is applied to the search results. The results are grouped by domain. Each group contains three documents, and the number of groups returned per page is 10. The maximum number of passages per document is 2. 1. Send a query to the Yandex search database. To do this, use the [cURL](https://curl.haxx.se) utility: ```bash - curl -X POST \ - -H "Authorization: Api-Key " \ - -d "@body.xml" \ - -o result.xml \ + curl \ + --request POST \ + --header "Authorization: Api-Key " \ + --data "@body.xml" \ + --output result.xml \ 'https://yandex.ru/search/xml?folderid=b1gt6g8ht345********&filter=strict&lr=11316&l10n=ru' ``` @@ -174,8 +176,9 @@ Based on the search type selected when signing up for the service, specify the a 1. Send a query to the Yandex image search database. To do this, use the [cURL](https://curl.haxx.se) utility: ```bash - curl -X GET \ - -o result.xml \ + curl \ + --request GET \ + --output result.xml \ 'https://yandex.ru/images-xml?folderid=b1gt6g8ht345********&apikey=your_service_account_API_key********&text=funny+cats&groupby=attr=ii.groups-on-page=3&p=2&fyandex=1&site=somepics.ru&itype=jpg&iorient=horizontal&isize=medium&icolor=color' ``` diff --git a/en/security-deck/pricing.md b/en/security-deck/pricing.md index abd7dbb40ea..3fa9b4d72f1 100644 --- a/en/security-deck/pricing.md +++ b/en/security-deck/pricing.md @@ -5,3 +5,9 @@ editable: false # {{ sd-full-name }} pricing policy The {{ sd-name }} service and its modules can be used free of charge at the [Preview](../overview/concepts/launch-stages.md) stage. + +{% note info %} + +When [scanning data](operations/dspm/create-scan.md), {{ sd-name }} sends requests to files in {{ objstorage-full-name }} buckets. Such requests are charged based on the {{ objstorage-name }} [pricing policy](../storage/pricing.md). + +{% endnote %} \ No newline at end of file diff --git a/en/security/domains/iam-checklist.md b/en/security/domains/iam-checklist.md index 4ef0b886c04..43f9b592c1d 100644 --- a/en/security/domains/iam-checklist.md +++ b/en/security/domains/iam-checklist.md @@ -45,7 +45,7 @@ This section provides recommendations on how to make the best use of {{ yandex-c ✔ **Using a service account for operations from within a virtual machine**: [Link a service account to the VM](../../compute/operations/vm-connect/auth-inside-vm.md). Thus, you will no longer need to store your service account keys on the VM for authentication: your IAM token will be available via a [metadata service link](../../compute/operations/vm-connect/auth-inside-vm.md#auth-inside-vm). -✔ **Using an IAM token for authentication**: If you need to use static credentials, consider using an [IAM token](../../iam/concepts/authorization/iam-token.md). Keys have an unlimited lifetime, while IAM tokens are valid for {{ iam-token-lifetime }}. +✔ **Using an IAM token for authentication**: If you need to use static credentials, consider using an [IAM token](../../iam/concepts/authorization/iam-token.md). Keys have an unlimited lifetime, while IAM tokens are valid for {{ iam-token-lifetime }}. If the IAM token has been [compromised](../../iam/operations/compromised-credentials.md) or you no longer plan to use it, [revoke](../../iam/operations/iam-token/revoke-iam-token.md) it. ✔ **Using service accounts**: Use [service accounts](../../iam/concepts/users/service-accounts.md) to automate your work with {{ yandex-cloud }}. You can check the date and time of the last authentication on the service account information page in the management console: this information allows you to track cases of unauthorized use of service accounts. @@ -55,7 +55,7 @@ This section provides recommendations on how to make the best use of {{ yandex-c ✔ **Storing service account keys in secrets**: If using static keys, [store them in {{ lockbox-name }} secrets](../../lockbox/tutorials/static-key-in-lockbox.md). -✔ **Periodic rotation of service account keys**: Keys with no expiration date ([authorized keys](../../iam/concepts/authorization/key.md), and [static keys](../../iam/concepts/authorization/access-key.md)) require [manual rotation](../../iam/operations/compromised-credentials.md#key-reissue). You can check out the date when a key was created in its properties. Perform key rotation at least once in 90 days. +✔ **Periodic rotation of service account keys**: Keys with no expiration date ([authorized keys](../../iam/concepts/authorization/key.md) and [static keys](../../iam/concepts/authorization/access-key.md)) require [manual rotation](../../iam/operations/compromised-credentials.md#key-reissue). You can check out the date when a key was created in its properties. Perform key rotation at least once in 90 days. ## Secrets {#secrets} @@ -65,12 +65,5 @@ This section provides recommendations on how to make the best use of {{ yandex-c ✔ **Using {{ lockbox-name }} secrets for storing access keys and tokens**: Store keys and tokens in [{{ lockbox-name }} secrets](../../lockbox/tutorials/static-key-in-lockbox.md) and use their payload when you need to apply a key or token. -✔ **Using API keys with limited access**: Create [API keys with limited scope and validity period](../../iam/concepts/authorization/api-key.md#scoped-api-keys) for working with the list of relevant services to lower the risk of unauthorized use of the keys. +✔ **Using API keys with limited access**: Create [API keys with limited scope and validity period](../../iam/concepts/authorization/api-key.md#scoped-api-keys) to work with your list of required services to lower the risk of unauthorized use of the keys. -## Other recommendations {#other-recommendations} - -✔ **Relevance of contact information of the person in charge of the organization**: Specify relevant contact information using [this guide](../../billing/operations/change-data.md#change-address). - -✔ **Access management for contractors and third parties**: If you grant third-party contractors access to your clouds, make sure to follow these security measures: - * Assign permissions to contractor employees based on the principle of least privilege. - * Where possible, create a separate account for third-party employees in your corporate IdP and assign the relevant policies to this account. diff --git a/en/serverless-integrations/concepts/workflows/yawl.md b/en/serverless-integrations/concepts/workflows/yawl.md index 91cdaaba844..56d5861c348 100644 --- a/en/serverless-integrations/concepts/workflows/yawl.md +++ b/en/serverless-integrations/concepts/workflows/yawl.md @@ -8,8 +8,8 @@ Field name | Type | Required | Description --- | --- | --- | --- `yawl` | `string` | Yes | Specification language version. Possible values: `1.0`. `start` | `string` | Yes | ID of the [step](#step) to start off the workflow execution. -`defaultRetryPolicy` | [RetryPolicy](#RetryPolicy) | No | Retry policy applied by default to all steps if a steps throws an error during execution. -`steps` | `map` | Yes | Description of workflow steps. Object where key is the step ID selected by the user, and value is the object describing the step parameters. +`defaultRetryPolicy` | [RetryPolicy](#RetryPolicy) | No | Retry policy applied by default to any step throwing an error during execution. +`steps` | `map` | Yes | Description of workflow steps. Object where key is the step ID selected by user, and value is the object describing the step parameters. ## Step object {#Step} @@ -23,12 +23,12 @@ Field name | Type | Required | Description ### Common fields {#common} -The fields described herein are available for all integration steps. +The fields described herein are available for any of integration steps. Field name | Type | Required | Default value | Description --- | --- | --- | --- | --- `input` | `string` | No | [Overall state of the workflow](workflow.md#state) | A jq expression to filter the workflow state fed into the step. -`output` | `string` | No | Step outputs | A jq expression to filter the step outputs added into the workflow state. +`output` | `string` | No | Step outputs | A jq expression to filter the step outputs to inject into the workflow state. `next` | `string` | No | No | ID of the next step. `retryPolicy` | [RetryPolicy](#retry-policy) | No | `defaultRetryPolicy`, if set on the [workflow](#workflow) level | Retry policy applied if a step throws an error during execution. `timeout` | `Duration` | No | 15 minutes | Maximum step execution time. @@ -37,7 +37,7 @@ Field name | Type | Required | Default value | Description Field name | Type | Required | Default value | Description --- | --- | --- | --- | --- -`errorList` | `[]WorkflowError` | Yes | `[]` | List of errors for which the step will be retried. For more information, see [{#T}](execution.md#errors). +`errorList` | `WorkflowError[]` | Yes | `[]` | List of errors for which the step will be retried. For more information, see [{#T}](execution.md#errors). `errorListMode` | `INCLUDE/EXCLUDE` | No | `INCLUDE` | Error selection mode: `INCLUDE` to retry on errors listed in `error_list`; `EXCLUDE` to retry on any error other than those listed in `error_list`. `initialDelay` | `Duration` | No | `1s` | Initial value for a delay between retries. `backoffRate` | `double` | No | `1.0` | Multiplier for time between each next retry. @@ -62,9 +62,9 @@ Only for services with [gRPC reflection](https://grpc.io/docs/guides/reflection/ Field name | Type | Required | Default value | [Templating](templating.md) is supported | Description --- | --- | --- | --- | --- | --- -`endpoint` | `string` | Yes | No | Yes | Server address. +`endpoint` | `string` | Yes | No | Yes | Server address `method` | `string` | Yes | No | Yes | gRPC service and method. -`useServiceAccount` | `bool` | No | `false` | No | If `true`, the IAM token of the service account specified in the workflow settings will be added to request headers. +`useServiceAccount` | `bool` | No | `false` | No | Set `true` for your request headers to include the IAM token of the service account specified in the workflow settings. `body` | `string` | No | `""` | Yes | Request body. `headers` | `map` | No | `{}` | Yes: in header values | Request headers. @@ -155,7 +155,7 @@ Field name | Type | Required | Default value | [Templating](templating.md) is su ### FoundationModelsCall {#FoundationModelsCall} -Integration with [{{ foundation-models-full-name }}](../../../foundation-models/). Currently, the only supported integration is the one with [{{ yagpt-full-name }}](../../../foundation-models/concepts/yandexgpt/index.md) for text generation. +Integration with [{{ foundation-models-full-name }}](../../../foundation-models/). Currently, the only supported integration is that with [{{ yagpt-full-name }}](../../../foundation-models/concepts/yandexgpt/index.md) for text generation purposes. Field name | Type | Required | Default value | [Templating](templating.md) is supported | Description --- | --- | --- | --- | --- | --- @@ -164,25 +164,25 @@ Field name | Type | Required | Default value | [Templating](templating.md) is su #### FoundationModelsCallGenerate object {#FoundationModelsCallGenerate} -The `json` and `messages` are mutually exclusive: you can either specify a JSON string or explicitly list the messages. +The `json` and `messages` are mutually exclusive: you can either specify a JSON string or enlist the messages you need. Field name | Type | Required | Default value | [Templating](templating.md) is supported | Description --- | --- | --- | --- | --- | --- -`temperature` | `double` | No | `0` | No | With a higher temperature, you get a more creative and randomized response from the model. This parameter accepts values between 0 and 1, inclusive. -`maxTokens` | `int64` | Yes | No | No | Maximum number of tokens to generate. Allows limiting the model's response if needed. +`temperature` | `double` | No | `0` | No | With a higher temperature, you get more creative and randomized response from the model. This parameter accepts values between 0 and 1, inclusive. +`maxTokens` | `int64` | Yes | No | No | Maximum number of tokens to generate. With this, you can limit the model output size if you need. `json` | `string` | No | `""` | Yes | Context for the model, as a JSON string. For more information, see the `messages` field description in the [{{ foundation-models-name }} documentation](../../../foundation-models/operations/yandexgpt/create-prompt.md#request). -`messages` | [][FoundationModelsCallGenerateMessage](#FoundationModelsCallGenerateMessage) | No | `""` | No | Context for the model, as a list of input messages. +`messages` | [FoundationModelsCallGenerateMessage](#FoundationModelsCallGenerateMessage)[] | No | `""` | No | Context for the model, as a list of input messages. #### [FoundationModelsCallGenerateMessage](#FoundationModelsCallGenerateMessage) object Field name | Type | Required | Default value | [Templating](templating.md) is supported | Description --- | --- | --- | --- | --- | --- -`role` | `string` | Yes | No | Yes | Message sender ID. For more information, see [TextGeneration.completion](../../../foundation-models/text-generation/api-ref/TextGeneration/completion.md). +`role` | `string` | Yes | No | Yes | ID of the message sender. For more information, see [TextGeneration.completion](../../../foundation-models/text-generation/api-ref/TextGeneration/completion.md). `text` | `string` | Yes | No | Yes | Message text. For more information, see [TextGeneration.completion](../../../foundation-models/text-generation/api-ref/TextGeneration/completion.md). ### ObjectStorage {#ObjectStorage} -Interacting with the {{ objstorage-full-name }} objects. The `put` and `get` fields are mutually exclusive: you can perform only one action on an object. +Interacting with the {{ objstorage-full-name }} objects. The `put` and `get` fields are mutually exclusive: for any object, you can perform only one of these actions on an object. Field name | Type | Required | Default value | [Templating](templating.md) is supported | Description --- | --- | --- | --- | --- | --- @@ -201,19 +201,19 @@ Field name | Type | Required | Default value | [Templating](templating.md) is su ### Switch {#Switch} -Selecting the further execution path. Only one path can be selected: the one for which the condition first returns `true`. If all conditions evaluate to `false` and no value set for the `default` field, the run will be terminated with an error. +Selecting the further execution path. Only one path can be selected: the one for which the condition first returns `true`. If all conditions have returned `false`, and no value is set in the `default` field, the run will be terminated with an error. Field name | Type | Required | Default value | [Templating](templating.md) is supported | Description --- | --- | --- | --- | --- | --- `input` | `string` | No | [Overall state of the workflow](workflow.md#state) | Yes | A jq expression to filter the workflow state fed into the step. `choices` | [Choice](#Choice)[] | Yes | No | No | List of possible further execution paths. -`default` | `string` | No | No | No | ID of the step to execute if none of the conditions specified in `choices` return `true`. +`default` | `string` | No | No | No | ID of the step to execute if none of the conditions specified in `choices` evaluates to `true`. #### Choice object {#Choice} Field name | Type | Required | Description --- | --- | --- | --- -`condition` | `string` | Yes | Condition in the form of a jq expression that returns either `true` or `false` string. +`condition` | `string` | Yes | Condition in the form of jq expression that returns either `true` or `false` string. `next` | `string` | Yes | ID of the step to execute if the condition returns `true`. ### Foreach {#Foreach} @@ -231,12 +231,12 @@ Field name | Type | Required | Default value | [Templating](templating.md) is su Field name | Type | Required | Description --- | --- | --- | --- -`start` | `string` | Yes | ID of the step to start the execution from. +`start` | `string` | Yes | ID of the step to start from. `steps` | `map` | Yes | Description of the steps. Object where key is the step ID, and value is the object describing the step parameters. The structure is similar to the `steps` field in the [high-level specification](#workflow). ### Parallel {#Parallel} -Executes multiple branches (sequences of steps) concurrently. Execution result is an object where key is the execution branch name, and value is the execution branch outputs. Read more about the [workflow state during the Parallel step](workflow.md#state-for-Parallel). +Executes multiple branches (sequences of steps) concurrently. The execution returns an object where key is the execution branch name, and value is the execution branch outputs. Read more about the [workflow state during the Parallel step](workflow.md#state-for-Parallel). Field name | Type | Required | Default value | [Templating](templating.md) is supported | Description --- | --- | --- | --- | --- | --- @@ -249,16 +249,16 @@ Field name | Type | Required | Default value | [Templating](templating.md) is su Field name | Type | Required | Description --- | --- | --- | --- -`start` | `string` | Yes | ID of the step to start off the branch execution. +`start` | `string` | Yes | ID of the step where the branch execution will start. `steps` | `map` | Yes | Description of steps in the execution branch. Object where key is the step ID, and value is the object describing the step parameters. The structure is similar to the `steps` field in the [high-level specification](#workflow). ### Success {#Success} -Successfully completes the workflow run. If placed inside [Foreach](#Foreach) or [Parallel](#Parallel), terminates the whole run, not just its current branch. +Successfully completes the workflow. If placed inside [Foreach](#Foreach) or [Parallel](#Parallel), it will complete the whole workflow, not just its current branch. ### Fail {#Fail} -Terminates the workflow run with an error. If placed inside [Foreach](#Foreach) or [Parallel](#Parallel), terminates the whole run, not just its current branch. +Terminates the workflow with an error. If placed inside [Foreach](#Foreach) or [Parallel](#Parallel), it will terminate the whole workflow, not just its current branch. Field name | Type | Required | [Templating](templating.md) is supported | Description --- | --- | --- | --- | --- diff --git a/en/smartcaptcha/operations/create-captcha.md b/en/smartcaptcha/operations/create-captcha.md index 235ad5d4b11..a9a0ed813e3 100644 --- a/en/smartcaptcha/operations/create-captcha.md +++ b/en/smartcaptcha/operations/create-captcha.md @@ -48,9 +48,9 @@ When creating a CAPTCHA, you can: 1. Configure the **Challenge options**. You can only specify the default CAPTCHA or add other [options](../concepts/captcha-variants.md) if you want to show different CAPTCHAs for different requests. 1. For the **Default** option, specify: - * **{{ ui-key.yacloud.smartcaptcha.label_main-challenge }}**: Type of the [main challenge](../concepts/tasks.md#main-task) the user will get. - * **{{ ui-key.yacloud.smartcaptcha.label_additional-challenge }}**: Type of the [additional challenge](../concepts/tasks.md#additional-task) the user will get. - * **{{ ui-key.yacloud.smartcaptcha.label_complexity }}**: [Difficulty level](../concepts/tasks.md#task-difficulty) of the challenge the user will get. + * **{{ ui-key.yacloud.smartcaptcha.label_main-challenge }}**: Type of the [main challenge](../concepts/tasks.md#main-task) that will be presented to the user. + * **{{ ui-key.yacloud.smartcaptcha.label_additional-challenge }}**: Type of the [additional challenge](../concepts/tasks.md#additional-task) that will be presented to the user. + * **{{ ui-key.yacloud.smartcaptcha.label_complexity }}**: [Difficulty level](../concepts/tasks.md#task-difficulty) of the challenge that will be presented to the user: * `{{ ui-key.yacloud.smartcaptcha.value_complexity-easy }}`: Simple challenge. * `{{ ui-key.yacloud.smartcaptcha.value_complexity-medium }}`: Medium level challenge. * `{{ ui-key.yacloud.smartcaptcha.value_complexity-hard }}`: Difficult challenge. @@ -86,7 +86,7 @@ When creating a CAPTCHA, you can: 1. Add other CAPTCHA options and rules for incoming traffic in a similar way. 1. Click **{{ ui-key.yacloud.common.create }}**. - + ![screen03](../../_assets/smartcaptcha/create-captcha/screen03.png) The CAPTCHA will appear on the service page under **{{ ui-key.yacloud.smartcaptcha.label_captcha-settings-list }}**. diff --git a/en/smartcaptcha/quickstart.md b/en/smartcaptcha/quickstart.md index 6c0b3034e60..15b8e86624e 100644 --- a/en/smartcaptcha/quickstart.md +++ b/en/smartcaptcha/quickstart.md @@ -101,7 +101,7 @@ The **I’m not a robot** button will appear on the page. The service will check ## Check the user response {#check-answer} -After the check, the user is given a unique token. The token is loaded to the ` @@ -110,17 +110,10 @@ After the check, the user is given a unique token. The token is loaded to the `< ``` -To validate the token, send a POST request to `https://smartcaptcha.yandexcloud.net/validate`: +To validate the token, send a POST request to `https://smartcaptcha.yandexcloud.net/validate` specifying the parameters in `x-www-form-urlencoded` format: -```HTML -response = requests.post( -"https://smartcaptcha.yandexcloud.net/validate", - { - "secret": SMARTCAPTCHA_SERVER_KEY, - "token": token, - "ip": "" - } -) +``` +secret=&token=&ip= ``` Where: @@ -227,7 +220,7 @@ Example of the token validation function: $server_output = curl_exec($ch); $httpcode = curl_getinfo($ch, CURLINFO_HTTP_CODE); curl_close($ch); - + if ($httpcode !== 200) { echo "Allow access due to an error: code=$httpcode; message=$server_output\n"; return true; @@ -271,7 +264,7 @@ Example of the token validation function: return True return json.loads(server_output)["status"] == "ok" - token = "" # For example, it can be `request.form["smart-token"]` + token = "" # For example, request.form["smart-token"] if check_captcha(token): print("Passed") else: diff --git a/en/smartcaptcha/release-notes.md b/en/smartcaptcha/release-notes.md index b0e404343fa..86565a0f494 100644 --- a/en/smartcaptcha/release-notes.md +++ b/en/smartcaptcha/release-notes.md @@ -5,6 +5,15 @@ description: This section contains {{ captcha-name }} release notes. # {{ captcha-full-name }} release notes +## Q3 2024 {#q3-2024} + +* Added [various CAPTCHA options](./concepts/captcha-variants.md) you can show depending on the basic properties of incoming requests. To flexibly split requests, you can use different combinations of [traffic conditions](./concepts/captcha-variants.md#traffic-conditions). + +* Implemented CAPTCHA accessibility criteria in accordance with [GOST R 52 872-2019](https://protect.gost.ru/document1.aspx?control=31&id=233736). In particular, now: + * CAPTCHA is compatible with screen access programs. + * You can control it with a keyboard or on-screen buttons (relevant for SmartTV). + * It contains more explanatory elements. + ## Q2 2024 {#q2-2024} -For {{ captcha-name }}, the maximum [difficulty level](concepts/tasks.md#task-difficulty) was added. This level requires completing an additional high difficulty challenge. \ No newline at end of file +For {{ captcha-name }}, added the maximum [difficulty level](concepts/tasks.md#task-difficulty). This level requires completing an additional high difficulty challenge. \ No newline at end of file diff --git a/en/smartwebsecurity/concepts/arl.md b/en/smartwebsecurity/concepts/arl.md index e0cd61c68da..d29d0263d8b 100644 --- a/en/smartwebsecurity/concepts/arl.md +++ b/en/smartwebsecurity/concepts/arl.md @@ -28,7 +28,7 @@ An ARL rule may impose a limit on incoming HTTP requests for all traffic or traf [Conditions](conditions.md) are defined by the following parameters: * `IP`: IP address, address range, or address region of clients subject to the rule. -* `Request path`: Path or a portion of the path the request was sent to. +* `Request path`: Path or part of the path the request was sent to. * `Host`: Domain name the request was sent to. * `HTTP method`: Method or set of methods the request belongs to. * `HTTP header`: Request header parameters. @@ -40,16 +40,16 @@ You can count the requests for the limit purposes in one of the following ways: * Counting each request individually. * Grouping requests by a certain attribute and limiting the number of groups. - + You can group requests: -* Automatically based on the `Request path`, `HTTP method`, `IP address`, `Region`, and `Host` attributes. +* Automatically, by `Request path`, `HTTP method`, `IP address`, `Region`, and `Host` attributes. * Based on key match in the `Query params`, `HTTP header`, and `HTTP cookie` attributes. - - You can configure flexible match/no match conditions for the parameters you specify for traffic. You can look for case-sensitive or case-insensitive string matches. Parameters can be represented by single values, ranges, or regular expressions. + + You can configure flexible match/no match conditions for the parameters you specify for traffic. You can search for both case-sensitive or case-insensitive string matches. Parameters can be represented by single values, ranges, or regular expressions. You can also select a time interval from 1 second to 60 minutes. -All requests in excess of the limit received within the specified time interval will be blocked. In which case the client will get the `429` error. +All requests in excess of the limit received within the specified time interval will be blocked. In this case, the client will get the `429` error. You can use the **Logging only (Dry run)** mode to calculate limits and test ARL rules. Requests will not be blocked in this mode. This allows you to evaluate backend capabilities and find the optimum limit values. diff --git a/en/smartwebsecurity/concepts/conditions.md b/en/smartwebsecurity/concepts/conditions.md index 0e364bb203b..ca1dd0e68a9 100644 --- a/en/smartwebsecurity/concepts/conditions.md +++ b/en/smartwebsecurity/concepts/conditions.md @@ -8,7 +8,7 @@ description: You can set up conditions for your security rules. For more informa You can set the following rule [conditions](rules.md): #| -|| **Type** | **Match criteria** | **Values** | **Example** | **Logical Operator** || +|| **Type** | **Match options** | **Values** | **Example** | **Logical operator** || || `{{ ui-key.yacloud.component.condition-column.condition_name-ip-range }}` | * Matches or falls within the range * Mismatches or lies outside the range @@ -33,11 +33,12 @@ You can set the following rule [conditions](rules.md): * Starts with * Does not start with * Matches regular expression -* Mismatches regular expression +* Does not match regular expression | -Format `key: value`, where key is the HTTP header, +Format: `key: value`, where key is an HTTP header, value is a specific header value, value -prefix or [regular expression](https://en.wikipedia.org/wiki/Regular_expression) of the [PIRE](https://github.com/yandex/pire) library +prefix, or [regular expression](https://en.wikipedia.org/wiki/Regular_expression) of +[PIRE](https://github.com/yandex/pire) library | * `User-Agent: curl/7.55.1` | _and_ || @@ -47,25 +48,24 @@ prefix or [regular expression](https://en.wikipedia.org/wiki/Regular_expression) * Starts with * Does not start with * Matches regular expression -* Mismatches regular expression +* Does not match regular expression | -Request path, beginning of request path, or regular -expression of PIRE library +Request path, initial part of the request path, or PIRE library +regular expression | * `/` -| _Not used_ || +| _N/A_ || || `Query Match` | * Matches * Mismatches * Starts with * Does not start with * Matches regular expression -* Mismatches regular expression +* Does not match regular expression | -Format `key: value`, where key is the request -parameter, value is a specific parameter value, -value prefix, or regular expression of the -PIRE library +Format: `key: value`, where key is a request +parameter, value is a specific value for the parameter, +value prefix, or PIRE library regular expression | * `a: 1` * `A: 2` @@ -76,12 +76,12 @@ PIRE library * Starts with * Does not start with * Matches regular expression -* Mismatches regular expression +* Does not match regular expression | Values of the `Host` header for HTTP/1.1 or -the `authority` pseudoheader for HTTP/2 by which a virtual -host, value prefix, or PIRE library -regular expression is selected +the `authority` pseudoheader for HTTP/2 used to +select a virtual host, value prefix, or +PIRE library regular expression | * `example.com` | _or_ || @@ -91,40 +91,130 @@ regular expression is selected * Starts with * Does not start with * Matches regular expression -* Mismatches regular expression +* Does not match regular expression | -[HTTP request method](https://en.wikipedia.org/wiki/HTTP#Request_methods) in the upper case, -with an arbitrary value, value prefix, or PIRE library -regular expression allowed +[HTTP request method](https://en.wikipedia.org/wiki/HTTP#Request_methods) in the upper case; you can use +an arbitrary value, value prefix, +or PIRE library regular expression | * `GET` * `POST` * `DELETE` | _or_ || -|| `Cookie` | +|| `{{ ui-key.yacloud.component.condition-column.condition_name-cookie }}` | * Matches * Mismatches * Starts with * Does not start with * Matches regular expression -* Mismatches regular expression +* Does not match regular expression | -Format`key: value`, where key is the Cookie header, value is the specific Cookie value, value prefix, or regular expression of the PIRE library +Format: `key: value`, where key is a Cookie header, +value is a specific Cookie value, value +prefix, or PIRE library regular expression | * `csrftoken=u32t4o3tb` | _and_ || -|| `HTTP body` | +|| `{{ ui-key.yacloud.component.condition-column.condition_name-body }}` | * Matches * Mismatches * Starts with * Does not start with * Matches regular expression -* Mismatches regular expression +* Does not match regular expression | -String in the HTTP packet body or PIRE library regular expression +String in the HTTP packet body or +PIRE library regular expression | * `
` | _or_ || -|# \ No newline at end of file +|# + +## Regular expression format {#regular-expressions} + +You can use regular expressions in such conditions as `{{ ui-key.yacloud.component.condition-column.condition_name-header }}`, `{{ ui-key.yacloud.component.condition-column.condition_name-requestUri }}`, `Query Match`, `{{ ui-key.yacloud.component.condition-column.condition_name-authority }}`, `{{ ui-key.yacloud.component.condition-column.condition_name-httpMethod }}`, `{{ ui-key.yacloud.component.condition-column.condition_name-cookie }}`, or `{{ ui-key.yacloud.component.condition-column.condition_name-body }}`. These conditions support the match types _Matches regular expression_ and _Does not match regular expression_. + +### Regular expression operators {#regular-expressions-operators} + +* Quantifiers. These set the allowed number of element repetitions. + + * `*`: Zero or more occurrences of any characters. `a*`: Zero or more occurrences of the `a` character. `a*b`: Any occurrence of `a` before `b`. + + For example, `a*` means an empty string, `a`, `aa`, `aaa`, etc. + + * `a+`: One or more occurrences of `a`. + + For example, `a+`: `a`, `aa`, `aaa`, etc. + + * `a?`: Zero or one occurrence of `a`. + + For example, `https?://` means `http://` and `https://`. + + * `{n}`: n occurrences. For example, `a{3}`: `aaa`. + + * `{n,m}`: From n through m occurrences. For example, `a{3,5}`: `aaa`, `aaaa`, and `aaaaa`. + + * `{n,}`: At least n occurrences. For example, `a{3,}`: `aaa`, `aaaa`, `aaaaa`, etc. + +* Characters and operations. + + * `.`: Any single character, but for line break one. + + For example, `a.b` means `aab` and `acb`, but not `ab`. + + * `[abc]`: One of the characters between the square brackets. + + For example, `[abc]` means `a`, `b`, and `c`. + + * `[^abc]`: Any character, but for those between the square brackets. + + For example, `[^abc]` means any character other than `a`, `b`, or `c`. + + * `[a-z]`: Any character from `a` through `z`. + + For example, `[a-z]` means any lowercase letter from `a` through `z`. + + * `a|b`: Mutually exclusive options, either `a` or `b`. + + For example, `example|domain` means either `example` or `domain`. + + * `\\w`: Any letter. + * `\\W`: Non-letter (digit, underscore, punctuation marks, space, etc). + * `\\d`: Digit. `\\D`: Non-digit. + * `\\s`: Space. `\\S`: Non-space. + +{% note info %} + +To use a character not as a regular expression operator or special character, escape it with `\`. For example, you need to escape such characters as `. + * [ ] ( ) { } ^ $ ?`. + +{% endnote %} + +### Case in regular expressions {#regular-expressions-case} + +* Case sensitive. Enter a regular expression in required case. + + For example, `exaMple` will represent the `exaMple` string. + +* Case insensitive. Add `(?i)` to the beginning of the expression. + + For example, `(?i)example` will represent strings like `example`, `EXaMple`, `EXAMPLE`, etc. + +### Examples of regular expressions + +* `^User-Agent:\s*$`: Block requests with empty or space-only `User-Agent` header value. + + In this expression, `^` is the beginning of the string, `\s*` is zero or more spaces, and `$` is the end of the string. + +* `\\[\'\"\.\;]`: Block requests containing `\` before a suspicious character (backslash injections). + + In this expression, `\\` is backslash, and `[\'\"\.\;]` is any character from between the square brackets. + +* `a{100,}`: Block requests containing unusually long sequences of identical characters, as this may be a sign of a DDoS attack. + + In this expression, `a{100,}` stands for 100 or more `a` in a row. + +* `--.*`: Block requests containing comments in SQL queries, as this may be a sign of an SQL injection. + + In this expression, `--` is the beginning of an SQL comment, and `.*` is zero or more of any characters. diff --git a/en/smartwebsecurity/concepts/index.md b/en/smartwebsecurity/concepts/index.md index dc709b983c1..11c2f452d8b 100644 --- a/en/smartwebsecurity/concepts/index.md +++ b/en/smartwebsecurity/concepts/index.md @@ -20,14 +20,14 @@ In a nutshell, the service checks the HTTP requests sent to the protected resour ## {{ alb-name }} coniguration recommendations {#alb-settings-recommendation} -To enhance DDoS protection of your applications, consider these additional tips: +To enhance DDoS protection of your applications, follow these additional recommendations: * Configure [autoscaling](../../application-load-balancer/concepts/application-load-balancer.md#lcu-scaling). This will allow you to dynamically adapt to the increased load and optimize traffic redistribution. * Place resource units in multiple [availability zones](../../overview/concepts/geo-scope.md). -* Use the secure HTTPS protocol: [configure a listener](../../application-load-balancer/concepts/application-load-balancer.md#listener) to automatically redirect requests from HTTP to HTTPS. +* Use the secure HTTPS protocol: [set up a listener](../../application-load-balancer/concepts/application-load-balancer.md#listener) to automatically redirect requests from HTTP to HTTPS. -* Ensure protection at the lower OSI model level: [enable](../tutorials/alb-with-ddos-protection/console.md) basic DDOS protection at L3 and L4 to prevent some attacks at an earlier stage. +* Establish protection at the lower OSI model level: [enable](../tutorials/alb-with-ddos-protection/console.md) basic DDOS protection at levels L3 and L4 to prevent part of attacks at an earlier stage. -These measures, in addition to setting up {{ sws-name }}, will increase the resilience of your services to potential threats and ensure security of your applications. +These measures in addition to setting up {{ sws-name }} will increase the resilience of your services to potential threats and ensure secure operation of applications. diff --git a/en/smartwebsecurity/concepts/rules.md b/en/smartwebsecurity/concepts/rules.md index a8eb52d9c65..43852a44c2e 100644 --- a/en/smartwebsecurity/concepts/rules.md +++ b/en/smartwebsecurity/concepts/rules.md @@ -52,6 +52,6 @@ Actions for Smart Protection and Web Application Firewall rules: * _Full Protection_: Traffic is checked by ML models and behavioral analysis algorithms. Suspicious requests are sent to {{ captcha-name }}. * _API Protection_: Traffic is checked by ML models and behavioral analysis algorithms. Suspicious requests are denied. -Advanced Rate Limiter rule action: _Block requests when exceeding the limit_. Requests above the specified limit over a period of time will be blocked. The requesting client will get error `429`. +Action for Advanced Rate Limiter rules: _Block requests when exceeding the limit_. Requests above the specified limit over a period of time will be blocked. The requesting client will get error `429`. -Requests that have been allowed by all rules and passed to the protected resource are called _legitimate_. +The requests that were allowed by all rules and passed on to the protected resource are called _legitimate_. \ No newline at end of file diff --git a/en/smartwebsecurity/concepts/waf.md b/en/smartwebsecurity/concepts/waf.md index b08f89684ee..d0aff8d5af3 100644 --- a/en/smartwebsecurity/concepts/waf.md +++ b/en/smartwebsecurity/concepts/waf.md @@ -11,26 +11,25 @@ For more information about connecting to a security profile, see [{#T}](../quick The following settings are available in the WAF profile: * [Basic rule set](#rules-set) * [Exclusion rules](#exclusion-rules) - -_Configuring request body analysis parameters will become available at a later time._ +* [Request analysis parameters](#request-analysis-parameters) ## Basic rule set {#rules-set} -The WAF profile offers a basic rule set called [OWASP Core Rule Set](https://coreruleset.org/). The set was developed by the Open Worldwide Application Security Project (OWASP) to ensure protection against vulnerabilities listed in the [OWASP TOP‑10](https://owasp.org/www-project-top-ten/). The OWASP Core Rule Set consists of rules made to detect malicious actions, including malicious file uploads, potential SQL injection attacks, DoS attempts, code injection attempts, and so on. For more information, see the [OWASP Core Rule Set repository on GitHub](https://github.com/coreruleset/coreruleset). +The WAF profile offers a basic rule set called [OWASP Core Rule Set](https://coreruleset.org/). The set was developed by the Open Worldwide Application Security Project (OWASP) to ensure protection against vulnerabilities listed in the [OWASP TOP‑10](https://owasp.org/www-project-top-ten/). The OWASP Core Rule Set consists of rules aimed to detect malicious actions, including malicious file uploads, potential SQL injection attacks, DoS attempts, code injection attempts, and many more. For more information, see the [OWASP Core Rule Set repository on GitHub](https://github.com/coreruleset/coreruleset). _Other basic rule sets will become available soon._ -In the basic rule set settings, you can select specific request checking rules. Each rule has an [anomaly](#anomaly) value and a [paranoia](#paranoia) level assigned. +In the basic rule set settings, you can select specific request analysis rules. Each rule has an [anomaly](#anomaly) value and a [paranoia](#paranoia) level assigned. ### Anomaly {#anomaly} -Each rule from the set is assigned a numeric _anomaly_ value, i.e., a potential attack indicator. The higher this value, the more likely it is that the request that satisfies the rule is an attack. +Each rule from the set is assigned a numeric _anomaly_ value, i.e., a potential attack indicator. The higher this value, the more likely it is that the request that satisfies this rule is in fact an attack. You can set an _anomaly threshold_ for the whole set of rules, i.e., the sum of anomaly values of the triggered rules that will block the request. The possible threshold values are from `2` to `10,000`. -We recommend that you start with the anomaly threshold of `25` and gradually bring it down to `5`. To reduce the anomaly threshold, work on the WAF false positives triggered by legitimate requests. To do so, select rules from the basic set and configure [exclusion rules](#exclusion-rules). You can use the **Only logging (dry-run)** mode in the security profile to test various anomaly thresholds. +We recommend to start with the anomaly threshold of `25` and gradually reduce it to `5`. To reduce the anomaly threshold, address WAF false positives triggered by legitimate requests. To do so, select rules from the basic set and configure [exclusion rules](#exclusion-rules). You can use the **Only logging (dry-run)** mode in the security profile to test various anomaly thresholds. -You can turn any rule from your set into a _blocking_ rule. A request that satisfies such a rule will be blocked regardless of the anomaly threshold you use. If the **Only logging (dry-run)** mode is enabled in the security profile, requests will not be blocked even when if they satisfy the blocking rules. +You can turn any rule from the set into a _blocking_ one. A request that satisfies such a rule will be blocked regardless of the anomaly threshold you specified. If the **Only logging (dry-run)** mode is enabled in the security profile, requests will not be blocked even when if they satisfy the blocking rules. ### Paranoia level {#paranoia} @@ -46,6 +45,18 @@ You can configure skipping specific rules or all rules in a given set. You can configure [trigger conditions](conditions.md) for each exclusion rule. If you use several conditions of different types, they all must be satisfied for the exclusion rule to trigger. If no conditions are specified, the exclusion rule will apply to the whole traffic. +## Request analysis parameters {#request-analysis-parameters} + +When you configure a WAF profile, you can enable request body inspection and specify the following parameters: + +* The maximum size of the request body starts from 8 KB (_you can customize the size later_). + + Defining a maximum request body size affects the performance and security of your web application. Limiting the size helps prevent excessive resource consumption and also mitigate the effects of DoS/DDoS attacks, where attackers send large requests in order to exhaust the server's resources. + +* Actions you need to take when the maximum request body size is exceeded: + * Do not analyze (skip). You can use it when a legitimate application frequently sends large requests. + * Block. This is a more universal and secure approach. Any requests exceeding the specified limit will be blocked, thus reducing the risk of attacks. + ## See also {#see-also} * [{#T}](../quickstart/quickstart-waf.md) \ No newline at end of file diff --git a/en/smartwebsecurity/pricing.md b/en/smartwebsecurity/pricing.md index 21f457fc71a..2a7bddfae74 100644 --- a/en/smartwebsecurity/pricing.md +++ b/en/smartwebsecurity/pricing.md @@ -12,7 +12,7 @@ editable: false ## What goes into the cost of using {{ sws-name }} {#rules} -The {{ sws-name }} cost depends on the number of [legitimate](concepts/rules.md#rule-action) requests. +In {{ sws-name }}, you pay for the actual number of [legitimate](concepts/rules.md#rule-action) requests. ## Prices for the Russia region {#prices} @@ -37,7 +37,7 @@ The {{ sws-name }} cost depends on the number of [legitimate](concepts/rules.md# {% note warning %} -The following price will be effective as of October 1, 2024. +The pricing below will apply starting October 1, 2024. {% endnote %} @@ -45,10 +45,14 @@ The following price will be effective as of October 1, 2024. {% include [usd-requests](../_pricing/smartwebsecurity/usd-requests-waf.md) %} +{% cut "Example of cost calculation for requests processed by WAF rules" %} -### Ready-made cost calculations for requests +{% include [usd-smartwebsecurity](../_pricing_examples/smartwebsecurity/usd-smartwebsecurity-waf.md) %} + +{% endcut %} -To estimate the approximate cost of requests, the table below shows the price calculations for a certain number of requests per month. This number does not include the free limit of 10,000 requests. The cost provided is for reference. The actual usage of {{ sws-name }} by your services will be calculated based on the actual number of requests. + +#### Pre-calculated request costs @@ -56,3 +60,4 @@ To estimate the approximate cost of requests, the table below shows the price ca To use DDoS protection at levels 3 and 4 of the OSI model, enable [{{ ddos-protection-full-name }}](../vpc/ddos-protection/index.md). The service is charged for the [public IP address](../vpc/pricing.md#prices-public-ip) and [{{ ddos-protection-full-name }}](../vpc/pricing.md#prices-ddos-protection). + diff --git a/en/smartwebsecurity/quickstart/quickstart-arl.md b/en/smartwebsecurity/quickstart/quickstart-arl.md index 4f24574cdc1..f111eb6987e 100644 --- a/en/smartwebsecurity/quickstart/quickstart-arl.md +++ b/en/smartwebsecurity/quickstart/quickstart-arl.md @@ -21,15 +21,15 @@ To get started with ARL: - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the folder where you want to create your ARL profile. - 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_smartwebsecurity }}**. - 1. Go to the ![image](../../_assets/smartwebsecurity/arl.svg) **ARL profiles** tab and click **Create ARL profile**. - 1. Describe a scenario of using ARL features in your projects and click **Submit request**. + 1. In the [management console]({{ link-console-main }}), select the folder where you want to create your ARL profile. + 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_smartwebsecurity }}**. + 1. Go to the ![image](../../_assets/smartwebsecurity/arl.svg) **ARL profiles** tab and click **Create ARL profile**. + 1. Describe a scenario of using ARL features in your projects and click **Submit request**. Once your request is approved, you can proceed to create an ARL profile. - 1. Enter a name for the profile, e.g. `test-arl-profile-1`. - 1. Add profile description and labels if needed. - 1. Click **Create**. + 1. Enter a name for the profile, e.g., `test-arl-profile-1`. + 1. Add profile description and labels if needed. + 1. Click **Create**. {% endlist %} @@ -39,37 +39,37 @@ To get started with ARL: - Management console {#console} - 1. Click **Add a rule** on the ARL profile's review page that opens. - 1. Enter a name for the rule, e.g., `arl-rule-1`. - 1. In the **Priority** field, set the rule's priority within the ARL profile, e.g., `1000`. - 1. (Optional) To test the ARL rule, enable the **Logging only (Dry run)** mode. Requests will not be blocked in this mode. - 1. Under **Traffic conditions**, select **All traffic** or **With a condition**. - 1. To set [traffic conditions](../concepts/conditions.md), select one or more items from the **Conditions** list: - * `IP`: IP address, IP address range, or IP address region. - * `HTTP header`: String in the HTTP header. - * `HTTP body`: String in the HTTP package body. - * `Request path`: Request path. - * `Host`: Domain receiving the request. - * `HTTP method`: Request method. - * `Cookie`: String in the cookie header. - - 1. Under **Request counting**, select how to count requests for limit application purposes: - * **No grouping**: Counting each request individually. - * **Grouping by property**: Counting the number of request groups sharing one or multiple common properties. - 1. Select a grouping property: - * `Request path`: Request path. - * `HTTP method`: Request method. - * `IP address`: IP address the request came from. - * `Region`: IP address region of the requests. - * `Host`: Domain receiving the request. - * `HTTP cookie`: String in the cookie header. - * `HTTP header`: String in the HTTP header. - * `Query params`: String in the request parameters. - 1. (Optional) Enable **Case-sensitive** to put properties with the same values in different cases into different groups. - - 1. Specify the limit of requests and select the time interval, e.g., `1000` requests per `1` minute. - - 1. Click **Save rule**. + 1. Click **Add a rule** on the ARL profile's review page that opens. + 1. Enter a name for the rule, e.g., `arl-rule-1`. + 1. In the **Priority** field, set the rule's priority within the ARL profile, e.g., `1000`. + 1. (Optional) To test the ARL rule, enable the **Logging only (Dry run)** mode. Requests will not be blocked in this mode. + 1. Under **Traffic conditions**, select **All traffic** or **With a condition**. + 1. To set [traffic conditions](../concepts/conditions.md), select one or more items from the **Conditions** list: + * `IP`: IP address, IP address range, or IP address region. + * `HTTP header`: String in the HTTP header. + * `HTTP body`: String in the HTTP packet body. + * `Request path`: Request path. + * `Host`: Domain receiving the request. + * `HTTP method`: Request method. + * `Cookie`: String in the cookie header. + + 1. Under **Request counting**, select how to count requests for limit application purposes: + * **No grouping**: Counting each request individually. + * **Grouping by property**: Counting the number of request groups sharing one or multiple common properties. + 1. Select a grouping property: + * `Request path`: Request path. + * `HTTP method`: Request method. + * `IP address`: IP address the request came from. + * `Region`: IP address region of the requests. + * `Host`: Domain receiving the request. + * `HTTP cookie`: String in the cookie header. + * `HTTP header`: String in the HTTP header. + * `Query params`: String in query parameters. + 1. (Optional) Enable **Case-sensitive** to put properties with the same values in different cases into different groups. + + 1. Specify the request limit and select the time interval, e.g., `1000` requests per `1` minute. + + 1. Click **Save rule**. {% endlist %} @@ -79,11 +79,11 @@ To get started with ARL: - Management console {#console} - 1. Go to ![image](../../_assets/console-icons/shield-check.svg) **{{ ui-key.yacloud.smart-web-security.title_profiles }}**. - 1. From the list, select the security profile you want to connect your ARL profile to, e.g., `test-sp1`. - 1. Click **Edit**. - 1. From the **ARL profile** list, select the `test-arl-profile-1` profile you created earlier. - 1. Click **Save**. + 1. Go to the ![image](../../_assets/console-icons/shield-check.svg) **{{ ui-key.yacloud.smart-web-security.title_profiles }}** tab. + 1. From the list, select the security profile you want to connect your ARL profile to, e.g., `test-sp1`. + 1. Click **Edit**. + 1. From the **ARL profile** list, select `test-arl-profile-1` you created earlier. + 1. Click **Save**. {% endlist %} diff --git a/en/smartwebsecurity/quickstart/quickstart-waf.md b/en/smartwebsecurity/quickstart/quickstart-waf.md index 66724ab804c..4ad42717cae 100644 --- a/en/smartwebsecurity/quickstart/quickstart-waf.md +++ b/en/smartwebsecurity/quickstart/quickstart-waf.md @@ -22,15 +22,15 @@ To get started with WAF: - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select a folder you want to create your WAF profile in. - 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_smartwebsecurity }}**. - 1. Go to the ![image](../../_assets/smartwebsecurity/waf.svg) **WAF profiles** tab and click **Create WAF profile**. - 1. Describe a scenario of using WAF features in your projects and click **Submit request**. + 1. In the [management console]({{ link-console-main }}), select the folder where you want to create your WAF profile. + 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_smartwebsecurity }}**. + 1. Go to the ![image](../../_assets/smartwebsecurity/waf.svg) **WAF profiles** tab and click **Create WAF profile**. + 1. Describe a scenario of using WAF features in your projects and click **Submit request**. Once your request is approved, you can proceed to create a WAF profile. - 1. Enter a name for the profile, e.g., `test-waf-profile-1`. - 1. The WAF profile's default basic rule set is called [OWASP Core Rule Set](https://coreruleset.org/). To view the rules it includes, click the line with its description. - 1. Click **Create**. + 1. Enter a name for the profile, e.g., `test-waf-profile-1`. + 1. The WAF profile's default basic rule set is called [OWASP Core Rule Set](https://coreruleset.org/). To view the rules it includes, click the line with its description. + 1. Click **Create**. {% endlist %} @@ -40,17 +40,17 @@ To get started with WAF: - Management console {#console} - 1. On the WAF profile's review page that opens, click **Configure basic rule set**. - 1. Set the preferred **Anomaly threshold**, which is the sum of [anomaly values](../concepts/waf.md#anomaly) of the triggered rules that will block the request, e.g., `Moderate: 25 or higher`. + 1. On the WAF profile's review page that opens, click **Configure basic rule set**. + 1. Set the preferred **Anomaly threshold**, which is the sum of [anomaly values](../concepts/waf.md#anomaly) of the triggered rules that will block the request, e.g., `Moderate: 25 or higher`. - We recommend that you start with the anomaly threshold of `25` and gradually bring it down to `5`. To reduce the anomaly threshold, work on the WAF false positives triggered by legitimate requests. To do so, select rules from the basic set and configure [exclusion rules](#create-exclusion). You can use the **Only logging (dry-run)** mode in the security profile to test various anomaly thresholds. + We recommend to start with the anomaly threshold of `25` and gradually reduce it to `5`. To reduce the anomaly threshold, address WAF false positives triggered by legitimate requests. To do so, select rules from the basic set and configure [exclusion rules](#create-exclusion). You can use the **Only logging (dry-run)** mode in the security profile to test various anomaly thresholds. - 1. Set the preferred **Paranoia level**, e.g., `2 and lower`. + 1. Set the preferred **Paranoia level**, e.g., `2 and lower`. [Paranoia level](../concepts/waf.md#paranoia) classifies rules according to their aggression. The higher the paranoia level, the better your protection, but also the higher the probability of WAF false positives. - 1. Check the rules you included in the set. Add or delete them as needed. When using rules, pay attention to their anomaly values and paranoia levels. + 1. Check the rules you included in the set. Add or delete them as needed. When using rules, pay attention to their anomaly values and paranoia levels. - You can turn any rule from the set into a blocking rule. A request that satisfies such a rule will be blocked regardless of the anomaly threshold you use. To turn a rule into a blocking rule, click ![image](../../_assets/console-icons/ban.svg) to the right of it. If the **Only logging (dry-run)** mode is enabled in the security profile, requests will not be blocked even when if they satisfy the blocking rules. + You can turn any rule from the set into a blocking rule. A request that satisfies such a rule will be blocked regardless of the anomaly threshold you specified. To turn a rule into a blocking rule, click ![image](../../_assets/console-icons/ban.svg) to the right of it. If the **Only logging (dry-run)** mode is enabled in the security profile, requests will not be blocked even when if they satisfy the blocking rules. {% endlist %} @@ -60,13 +60,13 @@ To get started with WAF: - Management console {#console} - 1. Go to the ![image](../../_assets/console-icons/file-xmark.svg) **Exclusion rules** tab and click **Create exclusion rule**. - 1. Enter a name for the [exclusion rule](../concepts/waf.md#exclusion-rules), e.g., `exclusion-rule-1`. - 1. Under **Scope of use**, specify rules from the basic set for which the exclusion will be valid. You can select **All rules** or specific ones. - 1. Under **Traffic conditions**, select the [conditions](../concepts/conditions.md) for the exclusion rule to trigger. + 1. Go to the ![image](../../_assets/console-icons/file-xmark.svg) **Exclusion rules** tab and click **Create exclusion rule**. + 1. Enter a name for the [exclusion rule](../concepts/waf.md#exclusion-rules), e.g., `exception-rule-1`. + 1. Under **Scope of use**, specify rules from the basic set for which the exclusion will be valid. You can select **All rules** or specific ones. + 1. Under **Traffic conditions**, select the [conditions](../concepts/conditions.md) for the exclusion rule to trigger. If you leave the **Conditions** field empty, the exclusion rule will apply to the whole traffic. - 1. Click **Create**. + 1. Click **Create**. {% endlist %} @@ -76,17 +76,17 @@ To get started with WAF: - Management console {#console} - 1. Go to the ![image](../../_assets/console-icons/shield-check.svg) **Security profiles** tab. - 1. From the list, select the security profile you want to connect your WAF profile to, e.g., `test-sp1`. - 1. Click ![plus-sign](../../_assets/console-icons/plus.svg) **{{ ui-key.yacloud.smart-web-security.form.button_add-rule }}**. - 1. Enter a name for the rule, e.g., `waf-rule-1`. - 1. In the **Priority** field, set a value higher than that of the Smart Protection rules already existing in the security profile, e.g., `888800`. - 1. (Optional) To test your WAF profile and simulate false positives triggered by legitimate requests, use the **Only logging (dry-run)** mode in the security profile. - 1. In the **Rule type** field, select **Web Application Firewall**. - 1. In the **WAF profile** field, select the `test-waf-profile-1` profile you created earlier. - 1. In the **Action** field, select **Full protection**. - 1. If required, set the [conditions](../concepts/conditions.md) for traffic mapping. - 1. Click **Add**. + 1. Go to the ![image](../../_assets/console-icons/shield-check.svg) **Security profiles** tab. + 1. From the list, select the security profile you want to connect your WAF profile to, e.g., `test-sp1`. + 1. Click ![plus-sign](../../_assets/console-icons/plus.svg) **{{ ui-key.yacloud.smart-web-security.form.button_add-rule }}**. + 1. Enter a name for the rule, e.g., `waf-rule-1`. + 1. In the **Priority** field, set a value higher than that of the Smart Protection rules already existing in the security profile, e.g., `888800`. + 1. (Optional) To test your WAF profile and simulate false positives triggered by legitimate requests, use the **Only logging (dry-run)** mode in the security profile. + 1. In the **Rule type** field, select **Web Application Firewall**. + 1. In the **WAF profile** field, select the `test-waf-profile-1` profile you created earlier. + 1. In the **Action** field, select **Full protection**. + 1. If required, set the [conditions](../concepts/conditions.md) for traffic mapping. + 1. Click **Add**. {% endlist %} diff --git a/en/smartwebsecurity/release-notes.md b/en/smartwebsecurity/release-notes.md index 5032e23dc56..e9c85efd366 100644 --- a/en/smartwebsecurity/release-notes.md +++ b/en/smartwebsecurity/release-notes.md @@ -5,6 +5,10 @@ description: This section contains {{ sws-name }} release notes. # {{ sws-full-name }} release notes +## Q3 2024 {#q3-2024} + +For traffic conditions that use regular expressions, you can now toggle between case-sensitive an case-insensitive string search. For more information, see [Regular expression format](concepts/conditions.md#regular-expressions). + ## Q2 2024 {#q2-2024} * Implemented [Web Application Firewall (WAF)](./concepts/waf.md) to protect web applications against external threats, such as SQL injections, cross-site scripting, and other vulnerabilities. WAF analyzes and filters HTTP requests blocking potentially malicious data. diff --git a/en/speechkit/pricing.md b/en/speechkit/pricing.md index 129fe42657e..5ddfa93b927 100644 --- a/en/speechkit/pricing.md +++ b/en/speechkit/pricing.md @@ -1,6 +1,6 @@ --- title: '{{ speechkit-full-name }} pricing policy' -description: This article describes the {{ speechkit-full-name }} pricing policy. +description: This article provides the {{ speechkit-full-name }} pricing policy. editable: false --- @@ -59,7 +59,7 @@ The billing unit is a 15-second segment of a single-channel audio file. Shorter {% note warning %} -In [streaming mode](stt/streaming.md), billing begins when a [message with recognition settings](stt/streaming.md#specification-msg) is sent. Even if you do not send any audio after this message, it will be treated as one consumed billing unit. +In [streaming mode](stt/streaming.md), billing begins as soon as you send a [message with recognition settings](stt/streaming.md#specification-msg). If you do not send any audio after this message, it will be treated as one consumed billing unit. {% endnote %} @@ -73,7 +73,7 @@ In [streaming mode](stt/streaming.md), billing begins when a [message with recog > > **Explanation**: The length of each audio is rounded up to 15 seconds. Thus, we have two segments, 15 seconds each. -#### Asynchronous recognition {#rules-stt-long} +#### Asynchronous recognition with {#rules-stt-long} These rules apply when using [asynchronous recognition](stt/transcribation.md). @@ -143,8 +143,8 @@ The cost is calculated as follows: The cost of using {{ speechkit-short-name }} for speech synthesis using the API v3 with the following parameters: -* **Number of requests sent**: 3 -* **Number of characters in requests**: 150, 300, 600 +* **Number of requests sent**: 3. +* **Number of characters in requests**: 150, 300, 600. @@ -210,4 +210,3 @@ The cost is calculated as follows: {% include [usd-speechkit-stt-long-deferred](../_pricing_examples/speechkit/usd-speechkit-stt-long-deferred.md) %} - diff --git a/en/speechkit/quickstart/stt-quickstart-v1.md b/en/speechkit/quickstart/stt-quickstart-v1.md index 4e5d88c4659..7833f7dc1bc 100644 --- a/en/speechkit/quickstart/stt-quickstart-v1.md +++ b/en/speechkit/quickstart/stt-quickstart-v1.md @@ -1,6 +1,6 @@ # How to recognize short audio files in {{ speechkit-short-name }} -The service can recognize speech [in different ways](../stt/index.md#stt-ways). The example below demonstrates an audio file recognition using the [synchronous recognition](../stt/request.md) API. This API has the following limitations: +The service can recognize speech [in different ways](../stt/index.md#stt-ways). In the example below, the audio file is recognized using the [synchronous recognition](../stt/request.md) API. This API has the following limitations: * Maximum audio duration: {{ stt-short-audioLength }} * Maximum file size: {{ stt-short-fileSize }} @@ -10,18 +10,19 @@ Send a speech recognition [request](../stt/request.md): ```bash export FOLDER_ID= export IAM_TOKEN= -curl -X POST \ - -H "Authorization: Bearer ${IAM_TOKEN}" \ - --data-binary "@speech.ogg" \ - "https://stt.{{ api-host }}/speech/v1/stt:recognize?folderId=${FOLDER_ID}&lang=ru-RU" +curl \ + --request POST \ + --header "Authorization: Bearer ${IAM_TOKEN}" \ + --data-binary "@speech.ogg" \ + "https://stt.{{ api-host }}/speech/v1/stt:recognize?folderId=${FOLDER_ID}&lang=ru-RU" ``` Where: -* `FOLDER_ID`: Folder ID received [before starting](index.md#before-you-begin) -* `IAM_TOKEN`: IAM token received [before starting](index.md#before-you-begin) -* `lang`: Recognition [language](../stt/models.md#languages) -* `speech.ogg`: Audio file with speech +* `FOLDER_ID`: Folder ID you got [before you started](index.md#before-you-begin). +* `IAM_TOKEN`: IAM token you got [before you started](index.md#before-you-begin). +* `lang`: Recognition [language](../stt/models.md#languages). +* `speech.ogg`: Speech audio file. The service responds with the recognized text: @@ -31,7 +32,7 @@ The service responds with the recognized text: } ``` -#### Additional information {#tutorials} +#### More information {#tutorials} * [{#T}](../stt/api/request-api.md) * [{#T}](../stt/api/request-examples.md) diff --git a/en/speechkit/quickstart/tts-quickstart-v1.md b/en/speechkit/quickstart/tts-quickstart-v1.md index dd7f8c6ba15..a3ebbdbd141 100644 --- a/en/speechkit/quickstart/tts-quickstart-v1.md +++ b/en/speechkit/quickstart/tts-quickstart-v1.md @@ -12,11 +12,12 @@ Now y+ou can, too! EOM export FOLDER_ID= export IAM_TOKEN= -curl -X POST \ - -H "Authorization: Bearer ${IAM_TOKEN}" \ - --data-urlencode "text=${TEXT}" \ - -d "lang=ru-RU&voice=filipp&folderId=${FOLDER_ID}" \ - "https://tts.{{ api-host }}/speech/v1/tts:synthesize" > speech.ogg +curl + --request POST \ + --header "Authorization: Bearer ${IAM_TOKEN}" \ + --data-urlencode "text=${TEXT}" \ + --data "lang=ru-RU&voice=filipp&folderId=${FOLDER_ID}" \ + "https://tts.{{ api-host }}/speech/v1/tts:synthesize" > speech.ogg ``` Where: diff --git a/en/speechkit/release-notes-tts.md b/en/speechkit/release-notes-tts.md index 1ac956dd7be..b3915bba120 100644 --- a/en/speechkit/release-notes-tts.md +++ b/en/speechkit/release-notes-tts.md @@ -4,6 +4,11 @@ For more information about voice models, see [About technology](tts/index.md#voices). +### Release as of 20/09/24 {#200924} + +* A quality update for the `filipp`, `ermil`, and `zahar` [voices](tts/voices.md). +* Optimized the normalizer for the Kazakh and Uzbek languages. + ### Release as of 09/09/24 {#090924} Improved question intonation and overall synthesis quality for all publicly available Russian voices. @@ -106,7 +111,7 @@ The `general` branch now has these new voices: `amira` and `john`. 1. More pausing features were added: * The error when pauses shorter than 1200 milliseconds were not taken into account in SSML markup has been fixed. Note that pauses shorter than 700 milliseconds are considered a synthesis cue and do not allow accurate control of the duration of a pause between words. * SSML pauses with the `x-weak`, `weak`, and `medium` values have a greater impact on the synthesized text. - * You can now apply pauses when using TTS markup. Use the `<[small]>` tag to set the pause length in the synthesized text, e.g., `Hello, <[small]>`. The possible pause lengths are: `tiny`, `small`, `medium`, `large`, `huge`. + * You can now apply pauses when using TTS markup. Use the `<[small]>` tag to set the pause length in the synthesized text, e.g., `Hello, <[small]>`. The possible pause lengths are: `tiny`, `small`, `medium`, `large`, or `huge`. 1. Support for `filipp:deprecated` was discontinued. `filipp:deprecated` and `filipp` now sound the same. @@ -134,7 +139,7 @@ The `general` branch now has these new voices: `amira` and `john`. 1. Fixed the emphasis placement quality regression issue for the `alena` and `filipp` voices. Improved emphasis placement and subjective perception for all voices. -1. Started a major upgrade of standard voices: `oksana`, `ermil`, `jane`, `omazh`, and `zahar` will be replaced with `oksana:rc`, `ermil:rc`, `jane:rc`, `omazh:rc`, and `zahar:rc`, respectively. The update will not affect the cost of the regular voices. The existing `oksana`, `ermil`, `jane`, `omazh`, and `zahar` voices are available in the `:deprecated` branch. +1. Started a major update of standard voices: `oksana`, `ermil`, `jane`, `omazh`, and `zahar` will be replaced with `oksana:rc`, `ermil:rc`, `jane:rc`, `omazh:rc`, and `zahar:rc`, respectively. The update will not affect the cost of the regular voices. The existing `oksana`, `ermil`, `jane`, `omazh`, and `zahar` voices are available in the `:deprecated` branch. ### Release as of 24/01/22 {#240122} diff --git a/en/speechkit/stt/api/request-examples.md b/en/speechkit/stt/api/request-examples.md index 32e6cf28b55..14671dcad2c 100644 --- a/en/speechkit/stt/api/request-examples.md +++ b/en/speechkit/stt/api/request-examples.md @@ -5,7 +5,7 @@ The example shows how the [API v1](request-api.md) helps synchronously recognize The example uses the following parameters: * [Language](../index.md#langs): Russian. -* Other parameters left by default. +* Other parameters are left at their defaults. Use the [cURL](https://curl.haxx.se) utility to generate and send a request to the server for recognition. @@ -17,125 +17,126 @@ The Yandex account or federated account are authenticated using an [IAM token](. - POST request {#post} - Send a [request](../request.md) to convert speech to text: + Send a [request](../request.md) to convert speech to text: - ```httpget - POST /speech/v1/stt:recognize?topic=general&lang=ru-RU&folderId={} HTTP/1.1 - Host: stt.{{ api-host }} - Authorization: Bearer + ```httpget + POST /speech/v1/stt:recognize?topic=general&lang=ru-RU&folderId={} HTTP/1.1 + Host: stt.{{ api-host }} + Authorization: Bearer - ... (binary content of an audio file) - ``` + ... (binary content of an audio file) + ``` - Where: + Where: - * `topic`: [Language model](../models.md). - * `lang`: [Recognition language](../index.md#langs). - * `folderId`: [Folder ID](../../../resource-manager/operations/folder/get-id.md). - * ``: [IAM token](../../../iam/concepts/authorization/iam-token.md). + * `topic`: [Language model](../models.md). + * `lang`: [Recognition language](../index.md#langs). + * `folderId`: [Folder ID](../../../resource-manager/operations/folder/get-id.md). + * ``: [IAM token](../../../iam/concepts/authorization/iam-token.md). - cURL {#curl} - Send a [request](../request.md) to convert speech to text: + Send a [request](../request.md) to convert speech to text: - ```bash - export FOLDER_ID=< - export IAM_TOKEN= - curl -X POST \ - -H "Authorization: Bearer ${IAM_TOKEN}" \ - --data-binary "@speech.ogg" \ - "https://stt.{{ api-host }}/speech/v1/stt:recognize?topic=general&folderId=${FOLDER_ID}" - ``` + ```bash + export FOLDER_ID= + export IAM_TOKEN= + curl \ + --request POST \ + --header "Authorization: Bearer ${IAM_TOKEN}" \ + --data-binary "@speech.ogg" \ + "https://stt.{{ api-host }}/speech/v1/stt:recognize?topic=general&folderId=${FOLDER_ID}" + ``` - Where: + Where: - * `FOLDER_ID`: [Folder ID](../../../resource-manager/operations/folder/get-id.md). - * `IAM_TOKEN`: [IAM token](../../../iam/concepts/authorization/iam-token.md). - * `--data-binary`: Name of the audio file for recognition. - * `topic`: [Language model](../models.md). + * `FOLDER_ID`: [Folder ID](../../../resource-manager/operations/folder/get-id.md). + * `IAM_TOKEN`: [IAM token](../../../iam/concepts/authorization/iam-token.md). + * `--data-binary`: Name of the audio file for recognition. + * `topic`: [Language model](../models.md). - Python 3 {#python} - Send a [request](../request.md) to convert speech to text: + Send a [request](../request.md) to convert speech to text: - ```python - import urllib.request - import json + ```python + import urllib.request + import json - FOLDER_ID = "" # Folder ID - IAM_TOKEN = "" # IAM token + FOLDER_ID = "" # Folder ID + IAM_TOKEN = "" # IAM token - with open("speech.ogg", "rb") as f: - data = f.read() + with open("speech.ogg", "rb") as f: + data = f.read() - params = "&".join([ - "topic=general", - "folderId=%s" % FOLDER_ID, - "lang=ru-RU" - ]) + params = "&".join([ + "topic=general", + "folderId=%s" % FOLDER_ID, + "lang=ru-RU" + ]) - url = urllib.request.Request("https://stt.{{ api-host }}/speech/v1/stt:recognize?%s" % params, data=data) - # Authentication via the IAM token. - url.add_header("Authorization", "Bearer %s" % IAM_TOKEN) + url = urllib.request.Request("https://stt.{{ api-host }}/speech/v1/stt:recognize?%s" % params, data=data) + # Authentication with an IAM token + url.add_header("Authorization", "Bearer %s" % IAM_TOKEN) - responseData = urllib.request.urlopen(url).read().decode('UTF-8') - decodedData = json.loads(responseData) + responseData = urllib.request.urlopen(url).read().decode('UTF-8') + decodedData = json.loads(responseData) - if decodedData.get("error_code") is None: - print(decodedData.get("result")) - ``` + if decodedData.get("error_code") is None: + print(decodedData.get("result")) + ``` - Where: + Where: - * `FOLDER_ID`: [Folder ID](../../../resource-manager/operations/folder/get-id.md). - * `IAM_TOKEN`: [IAM token](../../../iam/concepts/authorization/iam-token.md). - * `speech.ogg`: Name of the audio file for recognition. - * `topic`: [Language model](../models.md). - * `lang`: [Recognition language](../index.md#langs). + * `FOLDER_ID`: [Folder ID](../../../resource-manager/operations/folder/get-id.md). + * `IAM_TOKEN`: [IAM token](../../../iam/concepts/authorization/iam-token.md). + * `speech.ogg`: Name of the audio file for recognition. + * `topic`: [Language model](../models.md). + * `lang`: [Recognition language](../index.md#langs). - PHP {#php} - Send a [request](../request.md) to convert speech to text: - - ```php - '; # IAM token - $folderId = ""; # Folder ID - $audioFileName = "speech.ogg"; - - $file = fopen($audioFileName, 'rb'); - - $ch = curl_init(); - curl_setopt($ch, CURLOPT_URL, "https://stt.{{ api-host }}/speech/v1/stt:recognize?lang=ru-RU&folderId=${folderId}&format=oggopus"); - curl_setopt($ch, CURLOPT_HTTPHEADER, array('Authorization: Bearer ' . $token)); - curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); - curl_setopt($ch, CURLOPT_POST, true); - curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); - curl_setopt($ch, CURLOPT_BINARYTRANSFER, true); - - curl_setopt($ch, CURLOPT_INFILE, $file); - curl_setopt($ch, CURLOPT_INFILESIZE, filesize($audioFileName)); - $res = curl_exec($ch); - curl_close($ch); - $decodedResponse = json_decode($res, true); - if (isset($decodedResponse["result"])) { - echo $decodedResponse["result"]; - } else { - echo "Error code: " . $decodedResponse["error_code"] . "\r\n"; - echo "Error message: " . $decodedResponse["error_message"] . "\r\n"; - } - - fclose($file); - ``` - - Where: - - * `token`: [IAM token](../../../iam/concepts/authorization/iam-token.md). - * `folderId`: [Folder ID](../../../resource-manager/operations/folder/get-id.md). - * `audioFileName`: Name of the audio file for recognition. - * `lang`: [Recognition language](../index.md#langs). - * `format`: [Format](../../formats.md) of the submitted audio. + Send a [request](../request.md) to convert speech to text: + + ```php + '; # IAM token + $folderId = ""; # Folder ID + $audioFileName = "speech.ogg"; + + $file = fopen($audioFileName, 'rb'); + + $ch = curl_init(); + curl_setopt($ch, CURLOPT_URL, "https://stt.{{ api-host }}/speech/v1/stt:recognize?lang=ru-RU&folderId=${folderId}&format=oggopus"); + curl_setopt($ch, CURLOPT_HTTPHEADER, array('Authorization: Bearer ' . $token)); + curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); + curl_setopt($ch, CURLOPT_POST, true); + curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); + curl_setopt($ch, CURLOPT_BINARYTRANSFER, true); + + curl_setopt($ch, CURLOPT_INFILE, $file); + curl_setopt($ch, CURLOPT_INFILESIZE, filesize($audioFileName)); + $res = curl_exec($ch); + curl_close($ch); + $decodedResponse = json_decode($res, true); + if (isset($decodedResponse["result"])) { + echo $decodedResponse["result"]; + } else { + echo "Error code: " . $decodedResponse["error_code"] . "\r\n"; + echo "Error message: " . $decodedResponse["error_message"] . "\r\n"; + } + + fclose($file); + ``` + + Where: + + * `token`: [IAM token](../../../iam/concepts/authorization/iam-token.md). + * `folderId`: [Folder ID](../../../resource-manager/operations/folder/get-id.md). + * `audioFileName`: Name of the audio file for recognition. + * `lang`: [Recognition language](../index.md#langs). + * `format`: [Format](../../formats.md) of the submitted audio file. {% endlist %} diff --git a/en/speechkit/stt/api/transcribation-api-v3.md b/en/speechkit/stt/api/transcribation-api-v3.md index c1dce0ddcf7..93f0a17749f 100644 --- a/en/speechkit/stt/api/transcribation-api-v3.md +++ b/en/speechkit/stt/api/transcribation-api-v3.md @@ -145,205 +145,7 @@ If you do not have a WAV audio file, you can use [this sample file](https://{{ s python3 results.py ``` - {% cut "Result example" %} + {% include [transcribation-result](../../../_includes/speechkit/transcribe-result-example.md) %} - ```bash - [session_uuid { - uuid: "df49eaa2-25a55218-ae967fa1-********" - user_request_id: "f8dkup42nmhk********" - } - audio_cursors { - received_data_ms: 6600 - partial_time_ms: 6600 - final_time_ms: 6600 - } - response_wall_time_ms: 204 - final { - alternatives { - words { - text: "I'm" - start_time_ms: 380 - end_time_ms: 420 - } - words { - "text": "Yandex" - start_time_ms: 539 - end_time_ms: 919 - } - words { - "text": "SpeechKit" - start_time_ms: 960 - end_time_ms: 1719 - } - words { - text: "I" - start_time_ms: 2159 - end_time_ms: 2200 - } - words { - "text": "can" - start_time_ms: 2260 - end_time_ms: 2440 - } - words { - text: "turn" - start_time_ms: 2520 - end_time_ms: 3000 - } - words { - "text": "any" - start_time_ms: 3060 - end_time_ms: 3320 - } - words { - "text": "text" - start_time_ms: 3419 - end_time_ms: 3740 - } - words { - "text": "into" - start_time_ms: 3780 - end_time_ms: 3800 - } - words { - "text": "speech" - start_time_ms: 3860 - end_time_ms: 4279 - } - words { - "text": "now" - start_time_ms: 4680 - end_time_ms: 5240 - } - words { - "text": "you" - start_time_ms: 5339 - end_time_ms: 5380 - } - words { - "text": "can" - start_time_ms: 5460 - end_time_ms: 5766 - } - words { - text: "too" - start_time_ms: 5920 - end_time_ms: 6393 - } - text: "I'm Yandex SpeechKit I can turn any text into speech now you can too" - end_time_ms: 6600 - } - channel_tag: "0" - } - channel_tag: "0" - , session_uuid { - uuid: "df49eaa2-25a55218-ae967fa1-********" - user_request_id: "f8dkup42nmhk********" - } - audio_cursors { - received_data_ms: 6600 - partial_time_ms: 6600 - final_time_ms: 6600 - } - response_wall_time_ms: 204 - final_refinement { - normalized_text { - alternatives { - words { - text: "I'm" - start_time_ms: 380 - end_time_ms: 420 - } - words { - "text": "Yandex" - start_time_ms: 539 - end_time_ms: 919 - } - words { - "text": "SpeechKit" - start_time_ms: 960 - end_time_ms: 1719 - } - words { - text: "I'm" - start_time_ms: 2159 - end_time_ms: 2200 - } - words { - "text": "can" - start_time_ms: 2260 - end_time_ms: 2440 - } - words { - text: "turn" - start_time_ms: 2520 - end_time_ms: 3000 - } - words { - "text": "any" - start_time_ms: 3060 - end_time_ms: 3320 - } - words { - "text": "text" - start_time_ms: 3419 - end_time_ms: 3740 - } - words { - "text": "into" - start_time_ms: 3780 - end_time_ms: 3800 - } - words { - "text": "speech" - start_time_ms: 3860 - end_time_ms: 4279 - } - words { - "text": "now" - start_time_ms: 4680 - end_time_ms: 5240 - } - words { - "text": "you" - start_time_ms: 5339 - end_time_ms: 5380 - } - words { - "text": "can" - start_time_ms: 5460 - end_time_ms: 5766 - } - words { - text: "too" - start_time_ms: 5920 - end_time_ms: 6393 - } - text: "I'm Yandex SpeechKit I can turn any text into speech now you can too" - end_time_ms: 6600 - } - channel_tag: "0" - } - } - channel_tag: "0" - , session_uuid { - uuid: "df49eaa2-25a55218-ae967fa1-********" - user_request_id: "f8dkup42nmhk********" - } - audio_cursors { - received_data_ms: 6600 - partial_time_ms: 6600 - final_time_ms: 6600 - eou_time_ms: 6600 - } - response_wall_time_ms: 204 - eou_update { - time_ms: 6600 - } - channel_tag: "0" - ] - ``` - - {% endcut %} {% endlist %} diff --git a/en/speechkit/stt/api/transcribation-ogg.md b/en/speechkit/stt/api/transcribation-ogg.md index f92664d9004..21d7350604e 100644 --- a/en/speechkit/stt/api/transcribation-ogg.md +++ b/en/speechkit/stt/api/transcribation-ogg.md @@ -1,5 +1,5 @@ --- -title: Asynchronous OggOpus audio file recognition in {{ speechkit-full-name }} +title: Asynchronous recognition of OggOpus audio files in {{ speechkit-full-name }} description: Follow this guide to use asynchronous OggOpus audio file recognition. --- @@ -9,7 +9,7 @@ Here are examples of [asynchronous recognition of speech](../transcribation.md) * [Language](../models.md#languages): Russian. * Audio stream format: [OggOpus](../../formats.md#OggOpus) with an OPUS file. -* Other parameters left by default. +* Other parameters are left at their defaults. You can generate and send a speech recognition request using the [cURL](https://curl.haxx.se) utility or a Python script. @@ -25,7 +25,7 @@ If you do not have an OggOpus audio file, you can download a [sample file](https {% note warning %} -For two-channel OggOpus audio files, do not specify the number of channels in the `audioChannelCount` parameter. +For two-channel OggOpus audio files, do not specify the number of channels using the `audioChannelCount` parameter. {% endnote %} @@ -33,8 +33,8 @@ For two-channel OggOpus audio files, do not specify the number of channels in th - cURL {#curl} - 1. [Get a link to an audio file](../../../storage/operations/objects/link-for-download.md) in {{ objstorage-name }}. - 1. Create a file, e.g., `body.json`, and paste the following code to it: + 1. [Get a link to an audio file](../../../storage/operations/objects/link-for-download.md) in {{ objstorage-name }}. + 1. Create a file, e.g., `body.json`, and add the following code to it: ```json { @@ -51,8 +51,8 @@ For two-channel OggOpus audio files, do not specify the number of channels in th Where: - * `languageCode`: [Recognition language](../models.md#languages) - * `uri`: Link to the audio file in {{ objstorage-name }}, e.g., Sample link: `https://{{ s3-storage-host }}/speechkit/speech.opus`. + * `languageCode`: [Recognition language](../models.md#languages). + * `uri`: Link to the audio file in {{ objstorage-name }}. Here is an example of such a link: `https://{{ s3-storage-host }}/speechkit/speech.opus`. The link contains additional query parameters (after `?`) for buckets with restricted access. You do not need to provide these parameters in {{ speechkit-name }} as they are ignored. @@ -64,14 +64,15 @@ For two-channel OggOpus audio files, do not specify the number of channels in th {% endnote %} - 1. Run the created file: + 1. Run the created file: ```bash export IAM_TOKEN= && \ - curl -X POST \ - -H "Authorization: Bearer ${IAM_TOKEN}" \ - -d "@body.json" \ - https://transcribe.{{ api-host }}/speech/stt/v2/longRunningRecognize + curl \ + --request POST \ + --header "Authorization: Bearer ${IAM_TOKEN}" \ + --data "@body.json" \ + https://transcribe.{{ api-host }}/speech/stt/v2/longRunningRecognize ``` Where `IAM_TOKEN` is the IAM token of the service account. @@ -88,14 +89,15 @@ For two-channel OggOpus audio files, do not specify the number of channels in th } ``` - Save the recognition operation `id` that you received in the response. + Save the recognition operation `id` you get in the response. - 1. Wait for the recognition to complete. It takes about 10 seconds to recognize one minute of an audio file. - 1. Send a request to [get information about the operation](../../../api-design-guide/concepts/operation.md#monitoring): + 1. Wait for the recognition to complete. It takes about 10 seconds to recognize a one-minute audio. + 1. Send a request to [get information about the operation](../../../api-design-guide/concepts/operation.md#monitoring): ```bash - curl -H "Authorization: Bearer ${IAM_TOKEN}" \ - https://operation.{{ api-host }}/operations/ + curl \ + --header "Authorization: Bearer ${IAM_TOKEN}" \ + https://operation.{{ api-host }}/operations/ ``` Result example: @@ -126,13 +128,13 @@ For two-channel OggOpus audio files, do not specify the number of channels in th - Python 3 {#python} - 1. Install the `requests` package using the [pip](https://pip.pypa.io/en/stable/) package manager: + 1. Use the [pip package](https://pip.pypa.io/en/stable/) manager to install the `requests` package: - ```bash - pip install requests - ``` + ```bash + pip install requests + ``` - 1. Create a file, e.g.,`test.py`, and paste the following code to it: + 1. Create a file, e.g., `test.py`, and add the following code to it: ```python # -*- coding: utf-8 -*- @@ -183,7 +185,7 @@ For two-channel OggOpus audio files, do not specify the number of channels in th print("Response:") print(json.dumps(req, ensure_ascii=False, indent=2)) - # Only show text from recognition results. + # Show only text from recognition results. print("Text chunks:") for chunk in req['response']['chunks']: print(chunk['alternatives'][0]['text']) @@ -191,10 +193,10 @@ For two-channel OggOpus audio files, do not specify the number of channels in th Where: - * `key`: IAM token of the service account - * `filelink`: Link to the audio file in {{ objstorage-name }} + * `key`: Service account IAM token. + * `filelink`: Link to the audio file in {{ objstorage-name }}. - 1. Run the created file: + 1. Run the created file: ```bash python3 test.py diff --git a/en/speechkit/tts/api/tts-ogg.md b/en/speechkit/tts/api/tts-ogg.md index 61d576a6acb..51015cf0271 100644 --- a/en/speechkit/tts/api/tts-ogg.md +++ b/en/speechkit/tts/api/tts-ogg.md @@ -1,220 +1,221 @@ # Speech synthesis in OggOpus format using the API v1 -With the [API v1](../request.md), you can synthesize speech from text with [TTS markup](../markup/tts-markup.md) to an [OggOpus](../../formats.md) file. +With the [API v1](../request.md), you can synthesize speech from text in [TTS markup](../markup/tts-markup.md) to an [OggOpus](../../formats.md) file. The example uses the following synthesis parameters: * [Language](../index.md#langs): Russian. * [Voice](../voices.md): `filipp`. -* Other parameters left by default. +* Other parameters are left at their defaults. -The Yandex account or federated account are authenticated using an [IAM token](../../../iam/concepts/authorization/iam-token.md). If you use your service account, you do not need to include the folder ID in the request. For more information about authentication in the {{ speechkit-name }} API, see [{#T}](../../concepts/auth.md). +The Yandex account or federated account are authenticated using an [IAM token](../../../iam/concepts/authorization/iam-token.md). If using a service account, you do not need to include the folder ID in the request. To learn more about {{ speechkit-name }} API authentication, see [{#T}](../../concepts/auth.md). {% list tabs group=programming_language %} - cURL {#curl} - Send the [request](../request.md) to convert speech to text: - - ```bash - read -r -d '' TEXT << EOM - > I'm Yandex Speech+Kit. - > I can turn any text into speech. - > Now y+ou can, too! - EOM - export FOLDER_ID= - export IAM_TOKEN= - curl -X POST \ - -H "Authorization: Bearer ${IAM_TOKEN}" \ - --data-urlencode "text=${TEXT}" \ - -d "lang=ru-RU&voice=filipp&folderId=${FOLDER_ID}" \ - "https://tts.{{ api-host }}/speech/v1/tts:synthesize" > speech.ogg - ``` - - Where: - - * `TEXT`: Text in [TTS markup](../markup/tts-markup.md) for synthesis. - * `FOLDER_ID`: [Folder ID](../../../resource-manager/operations/folder/get-id.md). - * `IAM_TOKEN`: [IAM token](../../../iam/concepts/authorization/iam-token.md). - * `lang`: [Language](../index.md#langs) of the text. - * `voice`: [Voice](../voices.md) for speech synthesis. - - The synthesized speech will be written to the `speech.ogg` file in the directory that you sent your request from. + Submit a text-to-speech conversion [request](../request.md): + + ```bash + read -r -d '' TEXT << EOM + > I'm Yandex Speech+Kit. + > I can turn any text into speech. + > Now y+ou can, too! + EOM + export FOLDER_ID= + export IAM_TOKEN= + curl \ + --request POST \ + --header "Authorization: Bearer ${IAM_TOKEN}" \ + --data-urlencode "text=${TEXT}" \ + --data "lang=ru-RU&voice=filipp&folderId=${FOLDER_ID}" \ + "https://tts.{{ api-host }}/speech/v1/tts:synthesize" > speech.ogg + ``` + + Where: + + * `TEXT`: Text for synthesis in [TTS markup](../markup/tts-markup.md). + * `FOLDER_ID`: [Folder ID](../../../resource-manager/operations/folder/get-id.md). + * `IAM_TOKEN`: [IAM token](../../../iam/concepts/authorization/iam-token.md). + * `lang`: Text [language](../index.md#langs). + * `voice`: [Voice](../voices.md) for speech synthesis. + + The synthesized speech will be written to the `speech.ogg` file in the folder you sent your request from. - C# {#csharp} - Send the [request](../request.md) to convert speech to text: - - ```c# - using System; - using System.Collections.Generic; - using System.Net.Http; - using System.Threading.Tasks; - using System.IO; - - namespace TTS - { - class Program - { - static void Main() - { - Tts().GetAwaiter().GetResult(); - } - - static async Task Tts() - { - const string iamToken = ""; - const string folderId = ""; - - HttpClient client = new HttpClient(); - client.DefaultRequestHeaders.Add("Authorization", "Bearer " + iamToken); - var values = new Dictionary - { - { "text", "I'm Yandex Speech+Kit. I can turn any text into speech. Now y+ou can, too! }, - { "lang", "ru-RU" }, - { "voice", "filipp" }, - { "folderId", folderId } - }; - var content = new FormUrlEncodedContent(values); - var response = await client.PostAsync("https://tts.{{ api-host }}/speech/v1/tts:synthesize", content); - var responseBytes = await response.Content.ReadAsByteArrayAsync(); - File.WriteAllBytes("speech.ogg", responseBytes); - } - } - } - ``` - - Where: - - * `iamToken`: [IAM token](../../../iam/concepts/authorization/iam-token.md). - * `folderId`: [Folder ID](../../../resource-manager/operations/folder/get-id.md). - * `TEXT`: Text in [TTS markup](../markup/tts-markup.md) for synthesis. - * `lang`: [Language](../index.md#langs) of the text. - * `voice`: [Voice](../voices.md) for speech synthesis. - - The synthesized speech will be written to the `speech.ogg` file in the directory that you sent your request from. + Submit a text-to-speech conversion [request](../request.md): + + ```c# + using System; + using System.Collections.Generic; + using System.Net.Http; + using System.Threading.Tasks; + using System.IO; + + namespace TTS + { + class Program + { + static void Main() + { + Tts().GetAwaiter().GetResult(); + } + + static async Task Tts() + { + const string iamToken = ""; + const string folderId = ""; + + HttpClient client = new HttpClient(); + client.DefaultRequestHeaders.Add("Authorization", "Bearer " + iamToken); + var values = new Dictionary + { + { "text", "I'm Yandex Speech+Kit. I can turn any text into speech. Now y+ou can, too!" }, + { "lang", "ru-RU" }, + { "voice", "filipp" }, + { "folderId", folderId } + }; + var content = new FormUrlEncodedContent(values); + var response = await client.PostAsync("https://tts.{{ api-host }}/speech/v1/tts:synthesize", content); + var responseBytes = await response.Content.ReadAsByteArrayAsync(); + File.WriteAllBytes("speech.ogg", responseBytes); + } + } + } + ``` + + Where: + + * `iamToken`: [IAM token](../../../iam/concepts/authorization/iam-token.md). + * `folderId`: [Folder ID](../../../resource-manager/operations/folder/get-id.md). + * `text`: Text for synthesis in [TTS markup](../markup/tts-markup.md). + * `lang`: Text [language](../index.md#langs). + * `voice`: [Voice](../voices.md) for speech synthesis. + + The synthesized speech will be written to the `speech.ogg` file in the folder you sent your request from. - Python 3 {#python} - 1. Create a file (for example, `test.py`), and add the following code to it: - - ```python - import argparse - import requests - - def synthesize(folder_id, iam_token, text): - url = 'https://tts.{{ api-host }}/speech/v1/tts:synthesize' - headers = { - 'Authorization': 'Bearer ' + iam_token, - } - - data = { - 'text': text, - 'lang': 'ru-RU', - 'voice': 'filipp', - 'folderId': folder_id - } - - with requests.post(url, headers=headers, data=data, stream=True) as resp: - if resp.status_code != 200: - raise RuntimeError("Invalid response received: code: %d, message: %s" % (resp.status_code, resp.text)) - - for chunk in resp.iter_content(chunk_size=None): - yield chunk - - if __name__ == "__main__": - parser = argparse.ArgumentParser() - parser.add_argument("--token", required=True, help="IAM token") - parser.add_argument("--folder_id", required=True, help="Folder id") - parser.add_argument("--text", required=True, help="Text for synthesize") - parser.add_argument("--output", required=True, help="Output file name") - args = parser.parse_args() - - with open(args.output, "wb") as f: - for audio_content in synthesize(args.folder_id, args.token, args.text): - f.write(audio_content) + 1. Create a file (e.g., `test.py`), and add the following code to it: + + ```python + import argparse + import requests + + def synthesize(folder_id, iam_token, text): + url = 'https://tts.{{ api-host }}/speech/v1/tts:synthesize' + headers = { + 'Authorization': 'Bearer ' + iam_token, + } + + data = { + 'text': text, + 'lang': 'ru-RU', + 'voice': 'filipp', + 'folderId': folder_id + } + + with requests.post(url, headers=headers, data=data, stream=True) as resp: + if resp.status_code != 200: + raise RuntimeError("Invalid response received: code: %d, message: %s" % (resp.status_code, resp.text)) + + for chunk in resp.iter_content(chunk_size=None): + yield chunk + + if __name__ == "__main__": + parser = argparse.ArgumentParser() + parser.add_argument("--token", required=True, help="IAM token") + parser.add_argument("--folder_id", required=True, help="Folder id") + parser.add_argument("--text", required=True, help="Text for synthesize") + parser.add_argument("--output", required=True, help="Output file name") + args = parser.parse_args() + + with open(args.output, "wb") as f: + for audio_content in synthesize(args.folder_id, args.token, args.text): + f.write(audio_content) ``` - Where: + Where: - * `lang`: [Language](../index.md#langs) of the text. - * `voice`: [Voice](../voices.md) for speech synthesis. + * `lang`: Text [language](../index.md#langs). + * `voice`: [Voice](../voices.md) for speech synthesis. - 1. Run the created file: + 1. Run the created file: - ```bash - export FOLDER_ID= - export IAM_TOKEN= - python3 test.py - --token ${IAM_TOKEN} \ + ```bash + export FOLDER_ID= + export IAM_TOKEN= + python3 test.py + --token ${IAM_TOKEN} \ --folder_id ${FOLDER_ID} \ --output speech.ogg \ - --text "I'm Yandex Speech+Kit. I can turn any text into speech. Now y+ou can, too! - ``` + --text "I'm Yandex Speech+Kit. I can turn any text into speech. Now y+ou can, too!" + ``` - Where: + Where: - * `FOLDER_ID`: [Folder ID](../../../resource-manager/operations/folder/get-id.md). - * `IAM_TOKEN`: [IAM token](../../../iam/concepts/authorization/iam-token.md). - * `--output`: Name of the file for audio recording. - * `--text`: Text in [TTS markup](../markup/tts-markup.md) for synthesis. + * `FOLDER_ID`: [Folder](../../../resource-manager/operations/folder/get-id.md) ID. + * `IAM_TOKEN`: [IAM token](../../../iam/concepts/authorization/iam-token.md). + * `--output`: Name of the file for the audio. + * `--text`: Text for synthesis in [TTS markup](../markup/tts-markup.md). - The synthesized speech will be written to the `speech.ogg` file in the directory where you executed the file. + The synthesized speech will be written to the `speech.ogg` file in the folder you ran your file from. - PHP {#php} - Send the [request](../request.md) to convert speech to text: - - ```php - '; # Specify an IAM token. - $folderId = ""; # Specify folder ID. - - $url = "https://tts.{{ api-host }}/speech/v1/tts:synthesize"; - $headers = ['Authorization: Bearer ' . $token]; - $post = array( - 'text' => "I'm Yandex Sp+eechkit. I can turn any text into speech. Now y+ou can, too!", - 'folderId' => $folderId, - 'lang' => 'ru-RU', - 'voice' => 'filipp'); - - $ch = curl_init(); - - curl_setopt($ch, CURLOPT_AUTOREFERER, TRUE); - curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); - curl_setopt($ch, CURLOPT_URL, $url); - curl_setopt($ch, CURLOPT_FOLLOWLOCATION, TRUE); - curl_setopt($ch, CURLOPT_HEADER, false); - if ($post !== false) { - curl_setopt($ch, CURLOPT_POST, 1); - curl_setopt($ch, CURLOPT_POSTFIELDS, $post); - } - curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); - - $response = curl_exec($ch); - if (curl_errno($ch)) { - print "Error: " . curl_error($ch); - } - if (curl_getinfo($ch, CURLINFO_HTTP_CODE) != 200) { - $decodedResponse = json_decode($response, true); - echo "Error code: " . $decodedResponse["error_code"] . "\r\n"; - echo "Error message: " . $decodedResponse["error_message"] . "\r\n"; - } else { - file_put_contents("speech.ogg", $response); - } - curl_close($ch); - ``` - - Where: - - * `token`: [IAM token](../../../iam/concepts/authorization/iam-token.md). - * `folderId`: [Folder ID](../../../resource-manager/operations/folder/get-id.md). - * `TEXT`: Text in [TTS markup](../markup/tts-markup.md) for synthesis. - * `lang`: [Language](../index.md#langs) of the text. - * `voice`: [Voice](../voices.md) for speech synthesis. - - The synthesized speech will be written to the `speech.ogg` file in the directory that you sent your request from. + Submit a text-to-speech conversion [request](../request.md): + + ```php + '; # Specify the IAM token. + $folderId = ""; # Specify the folder ID. + + $url = "https://tts.{{ api-host }}/speech/v1/tts:synthesize"; + $headers = ['Authorization: Bearer ' . $token]; + $post = array( + 'text' => "I'm Yandex Speech+Kit. I can turn any text into speech. Now y+ou can, too!", + 'folderId' => $folderId, + 'lang' => 'ru-RU', + 'voice' => 'filipp'); + + $ch = curl_init(); + + curl_setopt($ch, CURLOPT_AUTOREFERER, TRUE); + curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); + curl_setopt($ch, CURLOPT_URL, $url); + curl_setopt($ch, CURLOPT_FOLLOWLOCATION, TRUE); + curl_setopt($ch, CURLOPT_HEADER, false); + if ($post !== false) { + curl_setopt($ch, CURLOPT_POST, 1); + curl_setopt($ch, CURLOPT_POSTFIELDS, $post); + } + curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); + + $response = curl_exec($ch); + if (curl_errno($ch)) { + print "Error: " . curl_error($ch); + } + if (curl_getinfo($ch, CURLINFO_HTTP_CODE) != 200) { + $decodedResponse = json_decode($response, true); + echo "Error code: " . $decodedResponse["error_code"] . "\r\n"; + echo "Error message: " . $decodedResponse["error_message"] . "\r\n"; + } else { + file_put_contents("speech.ogg", $response); + } + curl_close($ch); + ``` + + Where: + + * `token`: [IAM token](../../../iam/concepts/authorization/iam-token.md). + * `folderId`: [Folder ID](../../../resource-manager/operations/folder/get-id.md). + * `text`: Text for synthesis in [TTS markup](../markup/tts-markup.md). + * `lang`: Text [language](../index.md#langs). + * `voice`: [Voice](../voices.md) for speech synthesis. + + The synthesized speech will be written to the `speech.ogg` file in the folder you sent your request from. - Node.js {#nodejs} @@ -224,7 +225,7 @@ The Yandex account or federated account are authenticated using an [IAM token](. npm install --save axios form-data ``` - Send the [request](../request.md) to convert speech to text: + Submit a text-to-speech conversion [request](../request.md): ```javascript import FormData from 'form-data'; @@ -237,7 +238,7 @@ The Yandex account or federated account are authenticated using an [IAM token](. const formData = new FormData(); formData.append('voice', 'filipp'); - formData.append('text', 'I'm Yandex Speechk+it. I can turn any text into speech. Now y+ou can, too!'); + formData.append('text', 'I'm Yandex Speech+Kit. I can turn any text into speech. Now y+ou can, too!'); formData.append('lang', 'ru-RU'); formData.append('folderId', FOLDER_ID); @@ -257,12 +258,12 @@ The Yandex account or federated account are authenticated using an [IAM token](. Where: * `IAM_TOKEN`: [IAM token](../../../iam/concepts/authorization/iam-token.md). - * `FOLDER_ID`: [Folder ID](../../../resource-manager/operations/folder/get-id.md). - * `TEXT`: Text in [TTS markup](../markup/tts-markup.md) for synthesis. - * `lang`: [Language](../index.md#langs) of the text. + * `FOLDER_ID`: [Folder](../../../resource-manager/operations/folder/get-id.md) ID. + * `text`: Text for synthesis in [TTS markup](../markup/tts-markup.md). + * `lang`: Text [language](../index.md#langs). * `voice`: [Voice](../voices.md) for speech synthesis. - The synthesized speech will be written to the `speech.ogg` file in the directory that you sent your request from. + The synthesized speech will be written to the `speech.ogg` file in the folder you sent your request from. {% endlist %} @@ -271,4 +272,4 @@ The Yandex account or federated account are authenticated using an [IAM token](. * [{#T}](../request.md) * [{#T}](tts-wav.md) * [{#T}](tts-ssml.md) -* [{#T}](../../concepts/auth.md) \ No newline at end of file +* [{#T}](../../concepts/auth.md) diff --git a/en/speechkit/tts/api/tts-ssml.md b/en/speechkit/tts/api/tts-ssml.md index 70400292bca..3435f4fe921 100644 --- a/en/speechkit/tts/api/tts-ssml.md +++ b/en/speechkit/tts/api/tts-ssml.md @@ -6,40 +6,41 @@ The example uses the following synthesis parameters: * [Language](../index.md#langs): Russian. * [Voice](../voices.md): `jane`. -* Other parameters left by default. +* Other parameters are left at their defaults. The text file is read using the [cat](https://en.wikipedia.org/wiki/Cat_(Unix)) utility. -The Yandex account or federated account are authenticated using an [IAM token](../../../iam/concepts/authorization/iam-token.md). If you use your service account, you do not need to include the folder ID in the request. For more information about authentication in the {{ speechkit-name }} API, see [{#T}](../../concepts/auth.md). +The Yandex account or federated account are authenticated using an [IAM token](../../../iam/concepts/authorization/iam-token.md). If you use your service account, you do not need to include the folder ID in the request. To learn more about {{ speechkit-name }} API authentication, see [{#T}](../../concepts/auth.md). {% list tabs group=programming_language %} - Bash {#bash} - 1. Create a file, e.g., `text.xml`, and enter text in the SSML format: + 1. Create a file, e.g., `text.xml`, and add to it this text in SSML format: - {% include [ssml-example](../../../_includes/speechkit/ssml-example.md) %} + {% include [ssml-example](../../../_includes/speechkit/ssml-example.md) %} - 1. Send a request with the text to the server: + 1. Send a request with the text to the server: - ```bash - export FOLDER_ID= - export IAM_TOKEN= - curl -X POST \ - -H "Authorization: Bearer ${IAM_TOKEN}" \ - --data-urlencode "ssml=`cat text.xml`" \ - -d "lang=ru-RU&voice=jane&folderId=${FOLDER_ID}" \ - "https://tts.{{ api-host }}/speech/v1/tts:synthesize" > speech.ogg - ``` + ```bash + export FOLDER_ID= + export IAM_TOKEN= + curl \ + --request POST \ + --header "Authorization: Bearer ${IAM_TOKEN}" \ + --data-urlencode "ssml=`cat text.xml`" \ + --data "lang=ru-RU&voice=jane&folderId=${FOLDER_ID}" \ + "https://tts.{{ api-host }}/speech/v1/tts:synthesize" > speech.ogg + ``` - Where: + Where: - * `FOLDER_ID`: [Folder ID](../../../resource-manager/operations/folder/get-id.md). - * `IAM_TOKEN`: [IAM token](../../../iam/concepts/authorization/iam-token.md). - * `ssml`: File with text marked up according to [SSML](../markup/ssml.md) rules. - * `lang`: [Language](../index.md#langs) of the text. + * `FOLDER_ID`: [Folder ID](../../../resource-manager/operations/folder/get-id.md). + * `IAM_TOKEN`: [IAM token](../../../iam/concepts/authorization/iam-token.md). + * `ssml`: File with text marked up according to [SSML](../markup/ssml.md) rules. + * `lang`: Text [language](../index.md#langs). - The synthesized speech will be written to the `speech.ogg` file in the directory that you sent your request from. + The synthesized speech will be written to the `speech.ogg` file in the folder you sent your request from. {% endlist %} diff --git a/en/speechkit/tts/api/tts-v3-rest.md b/en/speechkit/tts/api/tts-v3-rest.md index 3156f179b67..139fa10db9b 100644 --- a/en/speechkit/tts/api/tts-v3-rest.md +++ b/en/speechkit/tts/api/tts-v3-rest.md @@ -4,49 +4,48 @@ You can use the REST API v3 in {{ speechkit-name }} to synthesize speech if you The example uses the following synthesis parameters: -* [Voice](../voices.md): `marina` +* [Voice](../voices.md): `marina` * Role: `friendly` * Audio format: WAV (default) -Authentication takes place under a Yandex account or a federated account using an [IAM token](../../../iam/concepts/authorization/iam-token.md). Authentication requires the ID of the folder in which the user has the `{{ roles-speechkit-tts }}` role [to work with {{ speechkit-name }}](../../security/index.md). If you use your service account, you do not need to include the folder ID in the request. For more information about authentication in the {{ speechkit-name }} API, see [{#T}](../../concepts/auth.md). +Authentication takes place under a Yandex account or a federated account using an [IAM token](../../../iam/concepts/authorization/iam-token.md). Authentication requires the ID of the folder in which the user has the `{{ roles-speechkit-tts }}` role [to work with {{ speechkit-name }}](../../security/index.md). If you use your service account, you do not need to include the folder ID in the request. To learn more about {{ speechkit-name }} API authentication, see [{#T}](../../concepts/auth.md). {% list tabs group=programming_language %} - cURL {#curl} - To reproduce this example, you will need the [jq](https://github.com/jqlang/jq) utility to work with JSON files. + To reproduce this example, you will need the [jq](https://github.com/jqlang/jq) utility to work with JSON files. - 1. Create a file called `request.json` with the following request parameters: + 1. Create the `request.json` file with the following request parameters: - ```json - {"text": "Hi, I'm Yandex Speech+Kit. I can turn any text into speech. Now yo+u can, too!", "hints": [{"voice": "marina"}, {"role": "friendly"}]} - ``` + ```json + {"text": "Hello! I'm Yandex Speech+Kit. I can turn any text into speech. Now y+ou can, too!", "hints": [{"voice": "marina"}, {"role": "friendly"}]} + ``` - Where: - * `text`: Text to synthesize - * `hints`: List of synthesis parameters: - * `voice`: Voice for synthesis - * `role`: Role + Where: + * `text`: Text to synthesize + * `hints`: List of synthesis parameters: + * `voice`: Voice for synthesis + * `role`: Role + 1. Get the folder ID and the IAM token for the account you will use with {{ speechkit-name }}, and include them in the request headers. - 1. Get the folder ID and the IAM token for the account you will use with {{ speechkit-name }}, and include them in the request headers. + ```bash + export FOLDER_ID= + export IAM_TOKEN= - ```bash - export FOLDER_ID= - export IAM_TOKEN= - - curl -H "Authorization: Bearer $IAM_TOKEN" \ - -H "x-folder-id: $FOLDER_ID" \ - -d @request.json https://tts.{{ api-host }}:443/tts/v3/utteranceSynthesis | - jq -r '.result.audioChunk.data' | - while read chunk; do base64 -d <<< "$chunk" >> audio.wav; done - ``` + curl \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --header "x-folder-id: $FOLDER_ID" \ + --data @request.json https://tts.{{ api-host }}:443/tts/v3/utteranceSynthesis | \ + jq -r '.result.audioChunk.data' | \ + while read chunk; do base64 -d <<< "$chunk" >> audio.wav; done + ``` - Where: - * `FOLDER_ID`: [ID of the folder](../../../resource-manager/operations/folder/get-id.md) for which your account has the `{{ roles-speechkit-tts }}` role or higher. - * `IAM_TOKEN`: IAM token of your [Yandex account](../../../iam/operations/iam-token/create.md) or [federated account](../../../iam/operations/iam-token/create-for-federation.md). + Where: + * `FOLDER_ID` is the [ID of the folder](../../../resource-manager/operations/folder/get-id.md) for which your account has the `{{ roles-speechkit-tts }}` role or higher. + * `IAM_TOKEN`: IAM token of your [Yandex account](../../../iam/operations/iam-token/create.md) or [federated account](../../../iam/operations/iam-token/create-for-federation.md). + The synthesized speech will be Base64 encoded and saved to a file named `audio.wav`. - You will get the synthesized speech Base64-encoded and saved to the `audio.wav` file. - -{% endlist %} \ No newline at end of file +{% endlist %} diff --git a/en/speechkit/tts/api/tts-wav.md b/en/speechkit/tts/api/tts-wav.md index 399ded937df..9d10d6871cd 100644 --- a/en/speechkit/tts/api/tts-wav.md +++ b/en/speechkit/tts/api/tts-wav.md @@ -1,15 +1,15 @@ # Speech synthesis in WAV format using the API v1 -The example shows how you can synthesize speech from text with [TTS markup](../markup/tts-markup.md) to a [WAV](https://en.wikipedia.org/wiki/WAV) file using the [API v1](../request.md). +The example shows how you can use the [API v1](../request.md) to synthesize speech from text in [TTS markup](../markup/tts-markup.md) to a [WAV file](https://en.wikipedia.org/wiki/WAV). The example uses the following synthesis parameters: -* Synthesized audio file [format](../../formats.md): LPCM with a sample rate of 48000 Hz, [WAV](https://en.wikipedia.org/wiki/WAV) container +* Synthesized audio file [format](../../formats.md): LPCM with a sample rate of 48,000 Hz, [WAV](https://en.wikipedia.org/wiki/WAV) container. * [Language](../index.md#langs): Russian * [Voice](../voices.md): `filipp` Conversion and recording the result in WAV are performed using the [SoX](http://sox.sourceforge.net/) utility. -The Yandex account or federated account are authenticated using an [IAM token](../../../iam/concepts/authorization/iam-token.md). If you use your service account, you do not need to include the folder ID in the request. For more information about authentication in the {{ speechkit-name }} API, see [{#T}](../../concepts/auth.md). +The Yandex account or federated account are authenticated using an [IAM token](../../../iam/concepts/authorization/iam-token.md). If you use your service account, you do not need to include the folder ID in the request. To learn more about {{ speechkit-name }} API authentication, see [{#T}](../../concepts/auth.md). 1. Synthesize a file in LPCM format: @@ -17,215 +17,216 @@ The Yandex account or federated account are authenticated using an [IAM token](. - cURL {#curl} - Send the [request](../request.md) to convert speech to text: - - ```bash - read -r -d '' TEXT << EOM - > I'm Yandex Speech+Kit. - > I can turn any text into speech. - > Now y+ou can, too! - EOM - export FOLDER_ID= - export IAM_TOKEN= - curl -X POST \ - -H "Authorization: Bearer ${IAM_TOKEN}" \ - -o speech.raw \ + Submit a text-to-speech conversion [request](../request.md): + + ```bash + read -r -d '' TEXT << EOM + > I'm Yandex Speech+Kit. + > I can turn any text into speech. + > Now y+ou can, too! + EOM + export FOLDER_ID= + export IAM_TOKEN= + curl \ + --request POST \ + --header "Authorization: Bearer ${IAM_TOKEN}" \ + --output speech.raw \ --data-urlencode "text=${TEXT}" \ - -d "lang=ru-RU&voice=filipp&folderId=${FOLDER_ID}&format=lpcm&sampleRateHertz=48000" \ + --data "lang=ru-RU&voice=filipp&folderId=${FOLDER_ID}&format=lpcm&sampleRateHertz=48000" \ https://tts.{{ api-host }}/speech/v1/tts:synthesize - ``` + ``` - Where: + Where: - * `TEXT`: Text in [TTS markup](../markup/tts-markup.md) for synthesis. - * `FOLDER_ID`: [Folder ID](../../../resource-manager/operations/folder/get-id.md). - * `IAM_TOKEN`: [IAM token](../../../iam/concepts/authorization/iam-token.md). - * `lang`: [Language](../index.md#langs) of the text. - * `voice`: [Voice](../voices.md) for speech synthesis. - * `format`: Synthesized audio file [format](../../formats.md). - * `sampleRateHertz`: Sample rate of an [LPCM](../../formats.md#LPCM) audio file. + * `TEXT`: Text for synthesis in [TTS markup](../markup/tts-markup.md). + * `FOLDER_ID`: [Folder ID](../../../resource-manager/operations/folder/get-id.md). + * `IAM_TOKEN`: [IAM token](../../../iam/concepts/authorization/iam-token.md). + * `lang`: Text [language](../index.md#langs). + * `voice`: [Voice](../voices.md) for speech synthesis. + * `format`: Synthesized audio file [format](../../formats.md). + * `sampleRateHertz`: Sample rate of the [LPCM](../../formats.md#LPCM) audio file. - C# {#csharp} - Send the [request](../request.md) to convert speech to text: - - ```c# - using System; - using System.Collections.Generic; - using System.Net.Http; - using System.Threading.Tasks; - using System.IO; - - namespace TTS - { - class Program - { - static void Main() - { - Tts().GetAwaiter().GetResult(); - } - - static async Task Tts() - { - const string iamToken = ""; - const string folderId = ""; - - HttpClient client = new HttpClient(); - client.DefaultRequestHeaders.Add("Authorization", "Bearer " + iamToken); - var values = new Dictionary - { - { "text", "I'm Yandex Speech+Kit. I can turn any text into speech. Now y+ou can, too! }, - { "lang", "ru-RU" }, - { "voice", "filipp" }, - { "folderId", folderId }, - { "format", "lpcm" }, - { "sampleRateHertz", "48000" } - }; - var content = new FormUrlEncodedContent(values); - var response = await client.PostAsync("https://tts.{{ api-host }}/speech/v1/tts:synthesize", content); - var responseBytes = await response.Content.ReadAsByteArrayAsync(); - File.WriteAllBytes("speech.raw", responseBytes); - } - } - } - ``` - - Where: - - * `iamToken`: [IAM token](../../../iam/concepts/authorization/iam-token.md). - * `folderId`: [Folder ID](../../../resource-manager/operations/folder/get-id.md). - * `TEXT`: Text in [TTS markup](../markup/tts-markup.md) for synthesis. - * `lang`: [Language](../index.md#langs) of the text. - * `voice`: [Voice](../voices.md) for speech synthesis. - * `format`: Synthesized audio file [format](../../formats.md). - * `sampleRateHertz`: Sample rate of an [LPCM](../../formats.md#LPCM) audio file. + Submit a text-to-speech conversion [request](../request.md): + + ```c# + using System; + using System.Collections.Generic; + using System.Net.Http; + using System.Threading.Tasks; + using System.IO; + + namespace TTS + { + class Program + { + static void Main() + { + Tts().GetAwaiter().GetResult(); + } + + static async Task Tts() + { + const string iamToken = ""; + const string folderId = ""; + + HttpClient client = new HttpClient(); + client.DefaultRequestHeaders.Add("Authorization", "Bearer " + iamToken); + var values = new Dictionary + { + { "text", "I'm Yandex Speech+Kit. I can turn any text into speech. Now y+ou can, too!" }, + { "lang", "ru-RU" }, + { "voice", "filipp" }, + { "folderId", folderId }, + { "format", "lpcm" }, + { "sampleRateHertz", "48000" } + }; + var content = new FormUrlEncodedContent(values); + var response = await client.PostAsync("https://tts.{{ api-host }}/speech/v1/tts:synthesize", content); + var responseBytes = await response.Content.ReadAsByteArrayAsync(); + File.WriteAllBytes("speech.raw", responseBytes); + } + } + } + ``` + + Where: + + * `iamToken`: [IAM token](../../../iam/concepts/authorization/iam-token.md). + * `folderId`: [Folder ID](../../../resource-manager/operations/folder/get-id.md). + * `text`: Text for synthesis in [TTS markup](../markup/tts-markup.md). + * `lang`: Text [language](../index.md#langs). + * `voice`: [Voice](../voices.md) for speech synthesis. + * `format`: Synthesized audio file [format](../../formats.md). + * `sampleRateHertz`: Sample rate of the [LPCM](../../formats.md#LPCM) audio file. - Python 3 {#python} - * Create a file (for example, `test.py`), and add the following code to it: - - ```python - import argparse - import requests - - def synthesize(folder_id, iam_token, text): - url = 'https://tts.{{ api-host }}/speech/v1/tts:synthesize' - headers = { - 'Authorization': 'Bearer ' + iam_token, - } - - data = { - 'text': text, - 'lang': 'ru-RU', - 'voice': 'filipp', - 'folderId': folder_id, - 'format': 'lpcm', - 'sampleRateHertz': 48000, - } - - with requests.post(url, headers=headers, data=data, stream=True) as resp: - if resp.status_code != 200: - raise RuntimeError("Invalid response received: code: %d, message: %s" % (resp.status_code, resp.text)) - - for chunk in resp.iter_content(chunk_size=None): - yield chunk - - - if __name__ == "__main__": - parser = argparse.ArgumentParser() - parser.add_argument("--token", required=True, help="IAM token") - parser.add_argument("--folder_id", required=True, help="Folder id") - parser.add_argument("--text", required=True, help="Text for synthesize") - parser.add_argument("--output", required=True, help="Output file name") - args = parser.parse_args() - - with open(args.output, "wb") as f: - for audio_content in synthesize(args.folder_id, args.token, args.text): - f.write(audio_content) - ``` - - Where: - - * `lang`: [Language](../index.md#langs) of the text. - * `voice`: [Voice](../voices.md) for speech synthesis. - * `format`: Synthesized audio file [format](../../formats.md). - * `sampleRateHertz`: Sample rate of an [LPCM](../../formats.md#LPCM) audio file. - - * Run the created file: - - ```bash - export FOLDER_ID= - export IAM_TOKEN= - python3 test.py - --token ${IAM_TOKEN} - --folder_id ${FOLDER_ID} - --output speech.raw - --text "I'm Yandex Speech+Kit. I can turn any text into speech. Now y+ou can, too! - ``` - - Where: - - * `FOLDER_ID`: [Folder ID](../../../resource-manager/operations/folder/get-id.md). - * `IAM_TOKEN`: [IAM token](../../../iam/concepts/authorization/iam-token.md). - * `--output`: Name of the file for audio recording. - * `--text`: Text in [TTS markup](../markup/tts-markup.md) for synthesis. + * Create a file (e.g., `test.py`), and add the following code to it: + + ```python + import argparse + import requests + + def synthesize(folder_id, iam_token, text): + url = 'https://tts.{{ api-host }}/speech/v1/tts:synthesize' + headers = { + 'Authorization': 'Bearer ' + iam_token, + } + + data = { + 'text': text, + 'lang': 'ru-RU', + 'voice': 'filipp', + 'folderId': folder_id, + 'format': 'lpcm', + 'sampleRateHertz': 48000, + } + + with requests.post(url, headers=headers, data=data, stream=True) as resp: + if resp.status_code != 200: + raise RuntimeError("Invalid response received: code: %d, message: %s" % (resp.status_code, resp.text)) + + for chunk in resp.iter_content(chunk_size=None): + yield chunk + + + if __name__ == "__main__": + parser = argparse.ArgumentParser() + parser.add_argument("--token", required=True, help="IAM token") + parser.add_argument("--folder_id", required=True, help="Folder id") + parser.add_argument("--text", required=True, help="Text for synthesize") + parser.add_argument("--output", required=True, help="Output file name") + args = parser.parse_args() + + with open(args.output, "wb") as f: + for audio_content in synthesize(args.folder_id, args.token, args.text): + f.write(audio_content) + ``` + + Where: + + * `lang`: Text [language](../index.md#langs). + * `voice`: [Voice](../voices.md) for speech synthesis. + * `format`: Synthesized audio file [format](../../formats.md). + * `sampleRateHertz`: Sample rate of the [LPCM](../../formats.md#LPCM) audio file. + + * Run the created file: + + ```bash + export FOLDER_ID= + export IAM_TOKEN= + python3 test.py + --token ${IAM_TOKEN} + --folder_id ${FOLDER_ID} + --output speech.raw + --text "I'm Yandex Speech+Kit. I can turn any text into speech. Now y+ou can, too!" + ``` + + Where: + + * `FOLDER_ID`: [Folder ID](../../../resource-manager/operations/folder/get-id.md). + * `IAM_TOKEN`: [IAM token](../../../iam/concepts/authorization/iam-token.md). + * `--output`: Name of the file for the audio. + * `--text`: Text for synthesis in [TTS markup](../markup/tts-markup.md). - PHP {#php} - Send the [request](../request.md) to convert speech to text: - - ```php - '; # Specify an IAM token. - $folderId = ""; # Specify folder ID. - - $url = "https://tts.{{ api-host }}/speech/v1/tts:synthesize"; - $headers = ['Authorization: Bearer ' . $token]; - $post = array( - 'text' => "I'm Yandex Sp+eechkit. I can turn any text into speech. Now y+ou can, too!", - 'folderId' => $folderId, - 'lang' => 'ru-RU', - 'voice' => 'filipp', - 'format' => 'lpcm', - 'sampleRateHertz' => '48000'); - - $ch = curl_init(); - - curl_setopt($ch, CURLOPT_AUTOREFERER, TRUE); - curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); - curl_setopt($ch, CURLOPT_URL, $url); - curl_setopt($ch, CURLOPT_FOLLOWLOCATION, TRUE); - curl_setopt($ch, CURLOPT_HEADER, false); - if ($post !== false) { - curl_setopt($ch, CURLOPT_POST, 1); - curl_setopt($ch, CURLOPT_POSTFIELDS, $post); - } - curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); - - $response = curl_exec($ch); - if (curl_errno($ch)) { - print "Error: " . curl_error($ch); - } - if (curl_getinfo($ch, CURLINFO_HTTP_CODE) != 200) { - $decodedResponse = json_decode($response, true); - echo "Error code: " . $decodedResponse["error_code"] . "\r\n"; - echo "Error message: " . $decodedResponse["error_message"] . "\r\n"; - } else { - file_put_contents("speech.raw", $response); - } - curl_close($ch); - ``` - - Where: - - * `token`: [IAM token](../../../iam/concepts/authorization/iam-token.md). - * `folderId`: [Folder ID](../../../resource-manager/operations/folder/get-id.md). - * `TEXT`: Text in [TTS markup](../markup/tts-markup.md) for synthesis. - * `lang`: [Language](../index.md#langs) of the text. - * `voice`: [Voice](../voices.md) for speech synthesis. - * `format`: Synthesized audio file [format](../../formats.md). - * `sampleRateHertz`: Sample rate of an [LPCM](../../formats.md#LPCM) audio file. + Submit a text-to-speech conversion [request](../request.md): + + ```php + '; # Specify the IAM token. + $folderId = ""; # Specify the folder ID. + + $url = "https://tts.{{ api-host }}/speech/v1/tts:synthesize"; + $headers = ['Authorization: Bearer ' . $token]; + $post = array( + 'text' => "I'm Yandex Speech+Kit. I can turn any text into speech. Now y+ou can, too!", + 'folderId' => $folderId, + 'lang' => 'ru-RU', + 'voice' => 'filipp', + 'format' => 'lpcm', + 'sampleRateHertz' => '48000'); + + $ch = curl_init(); + + curl_setopt($ch, CURLOPT_AUTOREFERER, TRUE); + curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); + curl_setopt($ch, CURLOPT_URL, $url); + curl_setopt($ch, CURLOPT_FOLLOWLOCATION, TRUE); + curl_setopt($ch, CURLOPT_HEADER, false); + if ($post !== false) { + curl_setopt($ch, CURLOPT_POST, 1); + curl_setopt($ch, CURLOPT_POSTFIELDS, $post); + } + curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); + + $response = curl_exec($ch); + if (curl_errno($ch)) { + print "Error: " . curl_error($ch); + } + if (curl_getinfo($ch, CURLINFO_HTTP_CODE) != 200) { + $decodedResponse = json_decode($response, true); + echo "Error code: " . $decodedResponse["error_code"] . "\r\n"; + echo "Error message: " . $decodedResponse["error_message"] . "\r\n"; + } else { + file_put_contents("speech.raw", $response); + } + curl_close($ch); + ``` + + Where: + + * `token`: [IAM token](../../../iam/concepts/authorization/iam-token.md). + * `folderId`: [Folder ID](../../../resource-manager/operations/folder/get-id.md). + * `text`: Text for synthesis in [TTS markup](../markup/tts-markup.md). + * `lang`: Text [language](../index.md#langs). + * `voice`: [Voice](../voices.md) for speech synthesis. + * `format`: Synthesized audio file [format](../../formats.md). + * `sampleRateHertz`: Sample rate of the [LPCM](../../formats.md#LPCM) audio file. {% endlist %} diff --git a/en/speechsense/concepts/dialogs.md b/en/speechsense/concepts/dialogs.md index 5c366a9c4ab..d210e2a28c2 100644 --- a/en/speechsense/concepts/dialogs.md +++ b/en/speechsense/concepts/dialogs.md @@ -16,20 +16,52 @@ Analyze dialogs in SpeechSense to evaluate the agents' performance. There are tw * In the dialog list, [find](../operations/data/manage-dialogs.md) the one you need and view its detailed info. * [Build a report](../operations/data/manage-reports.md) on dialogs. -## Detailed info about a dialog {#detail} +## Detailed info about a dialog {#details} You [can get](../operations/data/manage-dialogs.md#view-dialog) the following information for each dialog: * Metadata, e.g., full names of agent and customer, call or message date, dialog language, etc. The metadata list is [defined in the connection](../operations/connection/create.md). * Conversation audio (only for audio). -* Summary automatically generated by [{{ yagpt-full-name }}](../../yandexgpt/) based on full semantic analysis of the dialog. Technically, a summary provides {{ yagpt-full-name }}'s **Yes**/**No** answers to questions. -* Text transcript of the audio automatically generated by [{{ speechkit-full-name }}](../../speechkit/) (only for audio). -* Text chat messages (only for chats). +* Conversation contents. +* [{{ yagpt-full-name }} analysis](../../foundation-models/concepts/yandexgpt/index.md). + +### Dialog contents {#contents} + +On the dialog page, see the **Dialog** tab for the dialog contents: + +* For audio: Text transcript of the dialog, automatically generated by [{{ speechkit-full-name }}](../../speechkit/index.yaml). +* For chats: Text messages. You can [search for a text fragment](../operations/data/manage-dialogs.md#find-dialogs) through an audio text transcript or text chat messages in either the customer's or the agent's channel. The search returns exact matches. The found fragments are highlighted in yellow. The text is automatically tagged with agent and customer [tags](tags.md). These indicate things like whether the agent greeted the customer, whether the customer was in good humor, etc. +### {{ yagpt-name }} analysis {#yandexgpt} + +On the dialog page, see the **Analysis by {{ yagpt-name }}** tab for the autogenerated summary based on semantic analysis of the dialog. The summary has the following sections: + +* **Analysis**: Answers to questions helpful for evaluation of the agent’s performance and customer’s behavior during the conversation. +* **Summary**: Reasons for having the conversation and its outcomes. This section also includes information on the evaluation criteria, e.g., the participants’ emotions or objections during the conversation. +* **Reasons**: Why this dialog took place. Examples of reasons: + + * Incoming contact: Customer has a service down. + * Outgoing contact: Agent is advertising a service subscription. + +* **Subject**: What the customer and agent discussed. +* **Outcomes**: What the conversation led to. The outcomes are described for each of the listed reasons. Examples: + + * Incoming contact: Agent helped to resolve the customer’s issue. + * Outgoing contact: Customer purchased the subscription. + +To get more accurate analysis results in the future, evaluate them on the **Analysis by {{ yagpt-name }}** tab for each dialog. {{ yagpt-name }} learns from your feedback. + +When building a [report](reports/index.md), you can use a [neuroparameter](reports/neuro-parameters.md). It is a dialog characteristic {{ speechsense-name }} uses for semantic analysis to see if the dialog contains this characteristic. There are two ways you can use neuroparameters: + +* As filters for dialogs. For example, you can build a report only for dialogs on a specific topic. +* As an evaluation parameter (only for _Evaluation form_ reports). For example, you can view dialogs with a certain outcome as a proportion of all the dialogs included in the report. + +See this [guide](../operations/data/manage-reports.md#apply-neuro-parameter) to learn how you can configure neuroparameters. + ## Dialog filtering {#filters} Filters define the conditions for [searching through dialogs](../operations/data/manage-dialogs.md#filters-dialogs). @@ -40,9 +72,9 @@ There are the following types of filters: * **Customer**: Customer data. * **Bot** (only for chats): Bot data. * **Speech statistics** (only for audio): Agent and customer speech quality criteria, e.g., speech rate, mutual interruptions, etc. -* **General metadata**: Data about a conversation audio or text chat. +* **General metadata**: Data about the conversation audio or text chat. * **Customer tags** and **Agent tags**: Classifiers applied to conversation audio recognition results or text messages. You can learn more about tags [here](tags.md). -* **YandexGPT analysis**: Agent's performance criteria and customer's behavioral characteristics during the dialog, such as whether the agent was polite, whether the customer was on the rude side, etc. +* **{{ yagpt-name }} analysis**: Agent’s performance criteria and customer’s behavioral characteristics during the dialog, such as whether the agent was polite, whether the customer acted in a rude manner, etc. For each filter, you can specify one or more filtering conditions. These can be of four types: @@ -52,3 +84,13 @@ For each filter, you can specify one or more filtering conditions. These can be * Boolean: **Yes** or **No**. You can use multiple filters at the same time to find the dialogs satisfying all the conditions you specified. + +## Related dialogs {#related-dialogs} + +In some CRM systems, chats may be grouped by task. For example, you can group together all chats with a customer who has contacted support multiple times with the same request. When [uploading data into {{ speechsense-name }}](../operations/data/upload-chat-text.md), you can specify the additional `ticket_id` parameter to group such chats into _related dialogs_. + +In each of the related chats, you will see the ![image](../../_assets/console-icons/link.svg) button you can use to [navigate](../operations/data/related-dialogs.md#list) to the page of the related dialogs. There you can view the following dialog info: + +* Chat metadata at the top of the page. +* Contents of all related chats on the **Dialog** tab. It shows a tag hierarchy for each individual chart. You can use text search within a single chat. +* Chat summaries autogenerated by {{ yagpt-full-name }} based on semantic analysis, on the **{{ yagpt-name }} analysis** tab. diff --git a/en/speechsense/concepts/reports/evaluation-form.md b/en/speechsense/concepts/reports/evaluation-form.md index b9cb1e4d277..43c53a1f96a 100644 --- a/en/speechsense/concepts/reports/evaluation-form.md +++ b/en/speechsense/concepts/reports/evaluation-form.md @@ -13,7 +13,7 @@ You can analyze and evaluate agent performance using the **Evaluation form** rep ## How to build a report {#form} -To generate the **Evaluation form** report, specify the following settings: +Use the following settings to generate an **Evaluation form** report: * [Evaluation parameters](#parameters): Define a list of criteria for agent performance evaluation. * [Weight](#weight): Indicates how critical an evaluation parameter is for agent performance evaluation. @@ -29,7 +29,7 @@ Where: * `value`: Evaluation parameter value. * `criterion`: Number of filtered dialogs that meet the condition specified in the evaluation parameter. -* `filters`: Total number of filtered dialogs. +* `filters`: Number of all filtered dialogs. * `weight`: Evaluation parameter weight as a percentage. > Example. Source data: @@ -47,11 +47,21 @@ Where: _Evaluation parameters_ are criteria for agent performance evaluation. A value or range of values is specified for each evaluation parameter. {{ speechsense-name }} scans the dialog between the agent and the customer for the parameters specified in the report. If a dialog meets the criteria specified in the evaluation parameter, data about that dialog is added to the report. -> For example, the report has the **Agent interrupted the customer, times** evaluation parameter enabled. The range specified for it is from two times upwards. {{ speechsense-name }} analyzes the conversation recording to find how many times the agent has interrupted the customer. If the value is two or more, the information is added to the report. +> For example, the report has the **Agent interrupted the customer, times** evaluation parameter enabled. The range of values specified for this parameter starts from two times. {{ speechsense-name }} analyzes the conversation recording to find out how many times the agent has interrupted the customer. If the value is two or more, the information is added to the report. There are several types of evaluation parameters: -{% include [description-of-parameters](../../../_includes/speechsense/reports/parameters.md) %} +* **Agent**: Agent data. +* **Customer**: Customer data. +* **Bot** (only for chats): Bot data. +* **Speech statistics** (only for audio): Agent and customer speech quality criteria, e.g., speech rate, mutual interruptions, etc. +* **General metadata**: Data about the conversation audio (collected via PBX) or text chat. Metadata is uploaded to {{ speechsense-name }} together with the conversation audio or text chat and contains its key characteristics, e.g., date, topic, and dialog language. +* **Customer tags** and **Agent tags**: Classifiers applied to conversation audio recognition results or text chat messages. {{ speechsense-name }} detects certain keywords, phrases, or intonations in a dialog, classifies the dialog, and adds a tag to it. + + {{ speechsense-name }} has preconfigured tags. These can give you a clue as to whether there was an informal greeting or goodbye, whether the agent thanked the customer for waiting, whether it was the customer's repeat call to support, etc. You can learn more about tags [here](../../../speechsense/concepts/tags.md). + +* **{{ yagpt-name }} analysis**: Agent’s performance criteria and customer’s behavioral characteristics during the dialog, such as whether the agent was polite, whether the customer was on the rude side, etc. +* **Neuroparameters**: Reasons, topics, or outcomes of dialogs. You can learn more about neuroparameters [here](neuro-parameters.md). ### Evaluation parameter weight {#weight} @@ -59,15 +69,24 @@ _Evaluation parameter weight_ is a setting that indicates how critical an evalua > For example, there are two evaluation parameters in the report: **Agent speech rate** and **Customer speech rate**. The agent and the customer had the same speech rate, but the first parameter's weight is 70%, while that of the second one is 30%. The report will, therefore, display a higher value for the **Agent speech rate** parameter. -You can set different weights for multiple evaluation parameters with the same name but different values. For example, you add two parameters named **Share of silence in dialog** with the ranges from `0.1` to `0.3` and from `0.3` upwards. You can set a different weight for each range. The `0.3` boundary value falls within both the ranges and is displayed for both the parameters in the report. +You can set different weights for multiple evaluation parameters with the same name but different values. For example, you add two parameters named **Share of silence in dialog** with the ranges from `0,1` to `0,3` and from `0,3` upwards. You can set a different weight for each range. The `0,3` boundary value falls within both ranges and is displayed in the report for both parameters. + +### Filtering in the report {#filters} + +You can use filtering to select the dialogs to include in your report. To do this, use the following settings: + +* **Period**: Time period of the report. +* **Filters**: Use the same fields as for the parameters. +* **Grouping**: Choose how to group data in your report. You can only group by metadata fields, e.g.: -### Report filtering {#filters} + * By agent, to analyze the performance of each one. + * By product, to learn which products agents make fewer mistakes presenting in dialogs. -{% include notitle [filters](../../../_includes/speechsense/reports/filters.md) %} +Data cross-sections depend on the dialog metadata. For example, if you want to filter or group data by product, make sure there is a relevant field in the [metadata file](../../../speechsense/quickstart.md#set-space). If you need a new set of metadata, prepare dialog recordings or chats with relevant metadata and [upload these recordings](../../../speechsense/operations/data/upload-data.md) or [chats](../../../speechsense/operations/data/upload-chat-text.md). -## Visualizing and using data in reports {#display} +## Visualizing and using the report data {#display} -A report provides quantitative agent performance characteristics. You can view the report in the {{ speechsense-name }} web interface as a chart and table, as well as download it in CSV format. +The report provides quantitative agent performance characteristics. You can view the report in the {{ speechsense-name }} web interface in chart and table form or download it in CSV format. The available **Evaluation form** report formats include: diff --git a/en/speechsense/concepts/reports/neuro-parameters.md b/en/speechsense/concepts/reports/neuro-parameters.md new file mode 100644 index 00000000000..a048b61345b --- /dev/null +++ b/en/speechsense/concepts/reports/neuro-parameters.md @@ -0,0 +1,23 @@ +# Neuroparameters + +{% include [preview-note](../../../_includes/note-preview.md) %} + +In reports, a _neuroparameter_ is a dialog property. {{ speechsense-name }} uses it for semantic analysis to determine whether a dialog matches this property. Let's assume you specified a particular topic as a neuroparameter. {{ speechsense-name }} will check whether that topic was mentioned in the dialog. + +As a neuroparameter, you can select a reason, topic, or outcome suggested by {{ speechsense-name }} as a possible option. You can also specify your own property, in which case it will not depend on the choice between reasons, topics, or outcomes. + +For reports, {{ speechsense-name }} divides dialogs into two groups: those that match the specified property and those that do not. You choose which group to use in the report. + +The neuroparameter application method depends on the report type: + +* [Evaluation form](evaluation-form.md): Neuroparameters are available as evaluation parameters and dialog filters. + + If a neuroparameter is used as an evaluation parameter, the report shows the share of dialogs that semantically match or do not match the specified property (based on what you selected). For more info on how evaluation parameter values are calculated, see [{#T}](evaluation-form.md#form). + + In each report, a neuroparameter can only be used once: either as a parameter or as a filter. + +* [Detailing](details.md): Neuroparameters are only available as dialog filters. You can only set a single filter with a neuroparameter. + +To use neuroparameters, there must be at least 100 dialogs in the sample for the report. There are no restrictions on the maximum number; however, if the sample contains more than 1,000 dialogs, not all of them will be analyzed. {{ speechsense-name }} will randomly select only 1,000 dialogues for analysis. + +To learn how to set neuroparameters, see this [guide](../../operations/data/manage-reports.md#apply-neuro-parameter). diff --git a/en/speechsense/operations/data/manage-dialogs.md b/en/speechsense/operations/data/manage-dialogs.md index cdfbbac587f..f94fdfaa843 100644 --- a/en/speechsense/operations/data/manage-dialogs.md +++ b/en/speechsense/operations/data/manage-dialogs.md @@ -30,7 +30,7 @@ To perform a search: 1. Open the {{ speechsense-name }} [home page]({{ link-speechsense-main }}). 1. Go to the space you need and select a project. 1. On the **Dialogs** tab, enter the desired text fragment in the search bar. -1. (Optional) To the right of the search bar, select from the dropdown list the channel you want to search in: **Customer** or **Agent**. +1. (Optional) To the right of the search bar, select the channel you want to search from the drop-down list: **Customer** or **Agent**. ## Viewing a dialog {#view-dialog} @@ -39,16 +39,25 @@ To perform a search: 1. Find the required dialog using [filters](#filters-dialogs) and the [search bar](#find-dialogs). 1. Open the dialog in one of the following ways: - * To open a dialog preview, click the dialog line. - * To open the dialog in a new window, click ![image](../../../_assets/console-icons/arrow-up-right-from-square.svg) on the right in the dialog line. + * To open a dialog preview, click the dialog line. + * To open the dialog in a new window, click ![image](../../../_assets/console-icons/arrow-up-right-from-square.svg) on the right in the dialog line. -For more information on dialogs, see [{#T}](../../concepts/dialogs.md). +The dialog page displays the following information: + +* Metadata such as agent and customer names, call or message date, dialog language. +* Conversation audio (only for audio). +* Contents of the conversation on the **Dialog** tab. +* Semantic analysis of the conversation on the **Analysis by {{ yagpt-name }}** tab. + + The tab contains several sections. If you want to leave only a specific section, click on it. + +For more information, see [{#T}](../../concepts/dialogs.md#details). ## Example of searching dialogs by time period and text fragment {#example-find-dialogs-by-period-and-text} Search criteria: -* For the period between `10/11/2023 and 16/11/2023`. +* Period: `10/11/2023 - 16/11/2023`. * Contains the customer's utterance: `good service`. Follow these steps: @@ -67,7 +76,7 @@ Example of ranking dialogs depending on the found text fragments: #| || **No.** | **Dialog date** | **Dialog fragment** || -|| 1 | 16/11/2023 | Thank you for the `good service` || -|| 2 | 13/11/2023 | `Good` equipment and `service` || -|| 3 | 15/11/2023 | Full system `service` || +|| 1 | 16/11/2023 | thank you for `good service` || +|| 2 | 13/11/2023 | `good` equipment and `service` || +|| 3 | 15/11/2023 | full system `service` || |# diff --git a/en/speechsense/operations/data/manage-reports.md b/en/speechsense/operations/data/manage-reports.md index 0c049743f82..15ca7418509 100644 --- a/en/speechsense/operations/data/manage-reports.md +++ b/en/speechsense/operations/data/manage-reports.md @@ -5,6 +5,8 @@ You can use [{{ speechsense-name }} reports](../../concepts/reports/index.md) to * [Evaluation form](#build-an-evaluation-form): To analyze several evaluation parameters. * [Details](#build-a-details-report): To analyze changes in a single evaluation parameter over time. +If you want to use a reason, topic, or dialog outcome as a filter or evaluation parameter, [use a neuroparameter in your report](#apply-neuro-parameter). + ## Building the _Evaluation form_ report {#build-an-evaluation-form} 1. Open the {{ speechsense-name }} [home page]({{ link-speechsense-main }}). @@ -18,16 +20,21 @@ You can use [{{ speechsense-name }} reports](../../concepts/reports/index.md) to Evaluation parameters are used as criteria for assessment of agent performance. For more information about the parameters and how to generate a report based on them, see [{#T}](../../concepts/reports/evaluation-form.md#parameters). + If you want to select a reason, topic, or dialog outcome as an evaluation parameter, [use a neuroparameter](#apply-neuro-parameter). + 1. In the **Weight** field, enter a percentage value. Weight indicates how critical a parameter is for agent performance evaluation. The higher the parameter's weight, the greater its value in the report. The total weight of all evaluation parameters must equal 100%. For more information about weight and its use, see [{#T}](../../concepts/reports/evaluation-form.md#weight). 1. (Optional) In the **Parameter name in report** field, specify the name that will be used to caption the parameter on the chart and in the table. By default, this name matches the **Evaluation parameters** field value. -1. To add more evaluation parameters, click ![image](../../../_assets/console-icons/plus.svg) **Add parameter**. +1. If you need to add more evaluation parameters, click ![image](../../../_assets/console-icons/plus.svg) **Add parameter**. 1. Specify how to group the report data. For example, you can group by product, agent, or customer. Different grouping settings produce different data cross-sections. 1. Select the report generation period. -1. (Optional) Using the ![image](../../../_assets/console-icons/plus.svg) button next to the **Period** field, select filters by which dialogs will be selected for the report. For more information about filters, see [{#T}](../../concepts/reports/evaluation-form.md#filters). +1. (Optional) Use the ![image](../../../_assets/console-icons/plus.svg) button next to the **Period** field to select the filters to screen dialogs for the report. For more information about filters, see [{#T}](../../concepts/reports/evaluation-form.md#filters). + + If you want to pick dialogs by their content, [use a neuroparameter](#apply-neuro-parameter) as a filter. + 1. Click **Create report**. 1. To reuse the report, click **Save report**. Specify its name and, optionally, a description. @@ -60,8 +67,52 @@ To switch from a report to a dialog list: 1. Specify how to group the report data. For example, you can group by product, agent, or customer. Different grouping settings produce different data cross-sections. 1. Select the report generation period. -1. (Optional) Using the ![image](../../../_assets/console-icons/plus.svg) button next to the **Period** field, select filters by which dialogs will be selected for the report. For more information about filters, see [{#T}](../../concepts/reports/details.md#filters). +1. (Optional) Use the ![image](../../../_assets/console-icons/plus.svg) button next to the **Period** field to select the filters to screen dialogs for the report. For more information about filters, see [{#T}](../../concepts/reports/details.md#filters). + + If you want to pick dialogs by their content, [use a neuroparameter](#apply-neuro-parameter) as a filter. + 1. Click **Create report**. 1. To reuse the report, click **Save report**. Specify its name and, optionally, a description. The report will be available in the selected project in the **Reports** tab. + +## Applying a neuroparameter in a report {#apply-neuro-parameter} + +A [neuroparameter](../../concepts/reports/neuro-parameters.md) is a dialog property. {{ speechsense-name }} uses it for semantic analysis to determine whether a dialog matches this property. Let's assume you specified a particular topic as a neuroparameter. {{ speechsense-name }} will check whether that topic was mentioned in the dialog. + +{% include [preview-note](../../../_includes/note-preview.md) %} + +To apply a neuroparameter to dialogs in your reports: + +1. Open a list of evaluation parameters or filters. In the list, select **Neuroparameter**. +1. In the **Neuroparameter setting** window that opens, specify the period to pick the dialogs from. Add filters as needed. + + As the result, you will see the number of dialogs in the selection for the report. To apply a neuroparameter, you need at least 100 dialogs. There are no restrictions on the maximum number; however, if the selection contains more than 1,000 dialogs, not all of them will be analyzed. {{ speechsense-name }} will randomly select only 1,000 dialogues for analysis. + + If there is not enough or too much data in the selection, adjust the period and your filters. This will change the number of dialogs in the selection. + +1. Under **Criteria**, select the criteria for the service to analyze: **Reasons**, **Topics**, or **Outcomes**. +1. Put the cursor to the row of the selected criterion and wait for options to appear. + + {{ speechsense-name }} will semantically analyze all dialogs in the selection for the report. The service automatically highlights the reasons, topics, or outcomes of all dialogs (depending on which criterion you selected). + +1. Select one of the suggested criterion values. + + If none of them are suitable, enter your own. In this case, the specified property will not depend on the choice between reasons, topics, or outcomes. + +1. Click **Find**. + + After that, {{ speechsense-name }} will analyze dialogs again and find out which ones meet the specified criterion. The service will put the results of the analysis in two columns: one with dialogs that match the specified neuroparameter and the other one with those that do not. Only one of the two mentioned groups can be added to the report. + +1. If the suggested dialog grouping is not satisfactory, change the neuroparameter. The dialogs will then be regrouped. + + You may need to change the criterion more than once. + +1. Once you are satisfied with the dialog grouping, specify which group is to be used. + + > For example, if your criterion is **Topics**, click one of the two buttons: + > + > * **Containing topic** to use only dialogs on the specified topic. + > * **Not containing topic** to use dialogs on any topic other than the specified one. + +With that done, you can add more filters and parameters and build your report. diff --git a/en/speechsense/operations/data/related-dialogs.md b/en/speechsense/operations/data/related-dialogs.md new file mode 100644 index 00000000000..d48ad8eeb0e --- /dev/null +++ b/en/speechsense/operations/data/related-dialogs.md @@ -0,0 +1,33 @@ +# Viewing related dialogs + +From a [related dialog](../../concepts/dialogs.md#related-dialogs), you can go to the related dialogs page and view information about each dialog. From the related dialogs page, you can return to viewing an individual dialog. + +## Navigating to related dialogs {#list} + +1. Open the {{ speechsense-name }} [home page]({{ link-speechsense-main }}). +1. Go to the space you need and select a project. +1. On the **Dialogs** tab, [find](manage-dialogs.md#filters-dialogs) the dialog you need. +1. Navigate to related dialogs using one of these methods: + + * In the list of dialogs, click the link in the field with the task number. + + If a dialog has related dialogs, the related dialogs page will open. If a dialog has no related dialogs, the single dialog view page will open. + + * [Go](manage-dialogs.md#view-dialog) to the dialog and click **![image](../../../_assets/console-icons/link.svg)** to the right of its header. + + If there is no such button, it means that there are no related dialogs for the dialog you opened. + +## Viewing information about a related dialog {#view} + +1. Navigate to related dialogs. +1. To view metadata about the required dialog (for example, the start date or the direction of the dialog), click the **General metadata** section. +1. To view the metadata of a client, agent, or bot, click the relevant section. +1. To view information about a dialog, select the one you need. + + Within a single dialog, you can search by text and view the dialog tags. + +1. To view the semantic analysis for a dialog, click the **Analysis by {{ yagpt-name }}** tab. + +## Navigating to the individual dialog view + +To switch from the related dialogs page to the single dialog view page, click ![image](../../../_assets/console-icons/arrow-up-right-from-square.svg) for the required dialog on either the **Dialogs** or **Analysis by {{ yagpt-name }}** tab. diff --git a/en/speechsense/operations/data/upload-chat-text.md b/en/speechsense/operations/data/upload-chat-text.md index a2ac170acb3..fc185f20076 100644 --- a/en/speechsense/operations/data/upload-chat-text.md +++ b/en/speechsense/operations/data/upload-chat-text.md @@ -15,6 +15,9 @@ If you want to upload the voice call audio instead of chat text, follow [this gu Prepare to upload a chat conversation: 1. [Create a connection](../connection/create.md#create-chat-connection) of the **Chat** type. + + If you want to upload [linked conversations](../../concepts/dialogs.md#related-dialogs), add the `ticket_id` string key in the general metadata for your connection. The chats will be linked by this key. + 1. [Create a project](../project/create.md) with the new connection. Text messages will be uploaded to the project and connection you created. @@ -31,71 +34,71 @@ Prepare to upload a chat conversation: 1. In the `upload_data` folder, create the `upload_text.py` Python script to upload the chat conversation to {{ speechsense-name }}: - ```python - import argparse - import json - from typing import Dict - import grpc - - from yandex.cloud.speechsense.v1 import talk_service_pb2 - from yandex.cloud.speechsense.v1 import talk_service_pb2_grpc - from yandex.cloud.speechsense.v1 import text_pb2 - from google.protobuf.timestamp_pb2 import Timestamp - - # To authenticate with an IAM token, replace the api_key parameter with iam_token - def upload_talk(connection_id: str, metadata: Dict[str, str], api_key: str, text_data): - credentials = grpc.ssl_channel_credentials() - channel = grpc.secure_channel('api.talk-analytics.yandexcloud.net:443', credentials) - - talk_service_stub = talk_service_pb2_grpc.TalkServiceStub(channel) - - messageList = [] - for message in text_data['messages']: - timestamp = Timestamp() - timestamp.FromJsonString(value=str(message['timestamp'])) - messageProto = text_pb2.Message( - user_id=str(message['user_id']), - text=text_pb2.TextPayload(text=str(message['text'])), - timestamp=timestamp + ```python + import argparse + import json + from typing import Dict + import grpc + + from yandex.cloud.speechsense.v1 import talk_service_pb2 + from yandex.cloud.speechsense.v1 import talk_service_pb2_grpc + from yandex.cloud.speechsense.v1 import text_pb2 + from google.protobuf.timestamp_pb2 import Timestamp + + # For IAM token authentication, replace the `api_key` parameter with `iam_token` + def upload_talk(connection_id: str, metadata: Dict[str, str], api_key: str, text_data): + credentials = grpc.ssl_channel_credentials() + channel = grpc.secure_channel('api.speechsense.yandexcloud.net:443', credentials) + + talk_service_stub = talk_service_pb2_grpc.TalkServiceStub(channel) + + messageList = [] + for message in text_data['messages']: + timestamp = Timestamp() + timestamp.FromJsonString(value=str(message['timestamp'])) + messageProto = text_pb2.Message( + user_id=str(message['user_id']), + text=text_pb2.TextPayload(text=str(message['text'])), + timestamp=timestamp + ) + messageList.append(messageProto) + + # Forming a request to the API + request = talk_service_pb2.UploadTextRequest( + metadata=talk_service_pb2.TalkMetadata( + connection_id=str(connection_id), + fields=metadata), + text_content=text_pb2.TextContent( + messages=messageList) ) - messageList.append(messageProto) - - # Generating an API request - request = talk_service_pb2.UploadTextRequest( - metadata=talk_service_pb2.TalkMetadata( - connection_id=str(connection_id), - fields=metadata), - text_content=text_pb2.TextContent( - messages=messageList) - ) - - # Authentication type: API key - response = talk_service_stub.UploadText(request, metadata=( - ('authorization', f'Api-Key {api_key}'), - # To authenticate with an IAM token, provide the header - # ('authorization', f'Bearer {iam_token}'), - )) - - # Display dialog ID - print(f'Dialog ID: {response.talk_id}') - - if __name__ == '__main__': - parser = argparse.ArgumentParser() - parser.add_argument('--key', required=True, help='API key or IAM token', type=str) - parser.add_argument('--connection-id', required=True, help='Connection ID', type=str) - parser.add_argument('--text-path', required=True, help='JSON with text chat data', type=str) - parser.add_argument('--meta-path', required=False, help='JSON with the dialog metadata', type=str, default=None) - args = parser.parse_args() - - with open(args.meta_path, 'r') as fp: - metadata = json.load(fp) - - with open(args.text_path, 'r') as fp: - text_data = json.load(fp) - upload_talk(args.connection_id, metadata, args.key, text_data) - ``` -1. In the `upload_data` folder, create a file named `metadata.json` with conversation metadata: + # Authentication type: API key + response = talk_service_stub.UploadText(request, metadata=( + ('authorization', f'Api-Key {api_key}'), + # For IAM token authentication, provide the header + # ('authorization', f'Bearer {iam_token}'), + )) + + # Displaying the dialog ID + print(f'Dialog ID: {response.talk_id}') + + if __name__ == '__main__': + parser = argparse.ArgumentParser() + parser.add_argument('--key', required=True, help='API key or IAM token', type=str) + parser.add_argument('--connection-id', required=True, help='Connection ID', type=str) + parser.add_argument('--text-path', required=True, help='JSON with text chat data', type=str) + parser.add_argument('--meta-path', required=False, help='JSON with the dialog metadata', type=str, default=None) + args = parser.parse_args() + + with open(args.meta_path, 'r') as fp: + metadata = json.load(fp) + + with open(args.text_path, 'r') as fp: + text_data = json.load(fp) + upload_talk(args.connection_id, metadata, args.key, text_data) + ``` + +1. In the `upload_data` folder, create a file named `metadata.json` with your conversation metadata: ```json { @@ -112,9 +115,16 @@ Prepare to upload a chat conversation: } ``` - The file's fields must match the parameters of the connection you are uploading text messages to. The template above shows the required fields for **Chat** type connections. If you added other parameters to the connection, specify them in the `metadata.json` file. + Set the `date` field value in `YYYY-MM-DDTHH:MM:SS.SSS` format. + + The file's fields must match the parameters of the connection you are uploading text messages to. The template above shows the required fields for **Chat** type connections. If you added other parameters to the connection, specify them in the `metadata.json` file; e.g., to upload linked chats, add the following parameter to your file: - Specify the `date` in `YYYY-MM-DDTHH:MM:SS.SSS` format. + ```json + { + ... + "ticket_id": "task_number" + } + ``` 1. In the `upload_data` folder, create a file named `chat.json` with your text messages in the following format: @@ -122,9 +132,9 @@ Prepare to upload a chat conversation: { "messages": [ { - "user_id": , + "user_id": , "text" : "", - "timestamp" : "" + "timestamp" : "" }, ... ] @@ -134,7 +144,7 @@ Prepare to upload a chat conversation: Where: * `messages`: Array of text messages. For each message, create a separate object in this array. - * `user_id`: Sender ID. The ID must match the ID of the customer, agent, or bot in the JSON file with metadata. + * `user_id`: ID of the message sender. The ID must match the ID of the customer, agent, or bot in the JSON file with metadata. * `timestamp`: Message send time. Use the `YYYY-MM-DDTHH:MM:SS.SSSZ` time format. 1. {% include [api-key](../../../_includes/speechsense/data/api-key.md) %} diff --git a/en/speechsense/pricing.md b/en/speechsense/pricing.md index c2e2a7db967..713df53a320 100644 --- a/en/speechsense/pricing.md +++ b/en/speechsense/pricing.md @@ -31,7 +31,7 @@ When analyzing text dialogs, the cost of using {{ speechsense-name }} depends on {% note warning %} -The prices listed below will be effective starting September 10, 2024. +The price listed below will be effective starting September 10, 2024. {% endnote %} diff --git a/en/speechsense/quickstart.md b/en/speechsense/quickstart.md index 337c8775a65..97df4c90814 100644 --- a/en/speechsense/quickstart.md +++ b/en/speechsense/quickstart.md @@ -1,14 +1,16 @@ # Getting started with {{ speechsense-full-name }} -{{ speechsense-full-name }} enables you to analyze your business communication channels based on conversation audio recordings or text chat messages and supports integration with your PBX and CRM systems. {{ speechsense-name }} utilizes {{ speechkit-full-name }} voice technologies to transcribe speech and perform statistical and qualitative analysis of recorded audio dialogs. +{{ speechsense-full-name }} allows you to analyze your business communication channels based on dialog audio recordings or text chat messages and supports integration with your PBX and CRM systems. {{ speechsense-name }} utilizes {{ speechkit-full-name }} voice technologies to transcribe speech and perform statistical and qualitative analysis of recorded audio dialogs. + +{{ speechsense-name }} can analyze audio and text dialogs in Russian. You can upload your data to {{ speechsense-name }} or use a [demo recording](https://storage.yandexcloud.net/doc-files/speechsense-demo-dialog.wav) synthesized using {{ speechkit-name }}. ## Getting started {#before-you-begin} -1. Go to the [management console]({{ link-console-main }}) and log in to {{ yandex-cloud }} or sign up if you are not signed up yet. For information on how to get started with {{ yandex-cloud }}, see [Getting started with {{ yandex-cloud }}](../getting-started/). +1. Go to the [management console]({{ link-console-main }}) and log in to {{ yandex-cloud }} or sign up if not signed up yet. For information on how to get started with {{ yandex-cloud }}, see [Getting started with {{ yandex-cloud }}](../getting-started/). 1. Accept the user agreement. -1. In [{{ billing-name }}]({{ link-console-billing }}), make sure you have a [billing account](../billing/concepts/billing-account.md) linked and that it has the `ACTIVE` or `TRIAL_ACTIVE` status. If you do not have a billing account yet, [create one](../billing/quickstart/index.md#create_billing_account). +1. In [{{ billing-name }}]({{ link-console-billing }}), make sure you have a [billing account](../billing/concepts/billing-account.md) linked and its status is `ACTIVE` or `TRIAL_ACTIVE`. If you do not have a billing account yet, [create one](../billing/quickstart/index.md#create_billing_account). 1. [Make sure](../iam/operations/roles/get-assigned-roles.md) that your account has the `speech-sense.spaces.creator` role assigned. 1. Open the {{ speechsense-name }} [home page]({{ link-speechsense-main }}). 1. Select the organization to work with {{ speechsense-name }} in or [create](../organization/operations/enable-org.md) a new one. @@ -20,7 +22,7 @@ You can upload your data to {{ speechsense-name }} or use a [demo recording](htt {% note tip %} - You can only manage a billing account if you have a [Yandex account](../iam/concepts/users/accounts.md#passport). If you use {{ yandex-cloud }} through an [identity federation](../organization/concepts/add-federation.md), [contact]({{ link-console-support }}) support. + You can only manage a billing account if you have a [Yandex account](../iam/concepts/users/accounts.md#passport). If using {{ yandex-cloud }} through an [identity federation](../organization/concepts/add-federation.md), [contact]({{ link-console-support }}) support. {% endnote %} @@ -42,7 +44,7 @@ You can upload your data to {{ speechsense-name }} or use a [demo recording](htt "date_to": "2023-09-29T09:15:07.897Z", "language": "RU", "operator_id": "123", - "operator_name": "Jane Smith" + "operator_name": "Jane Doe" } ``` @@ -57,10 +59,10 @@ You can upload your data to {{ speechsense-name }} or use a [demo recording](htt To upload data: 1. [Create a service account](../iam/operations/sa/create.md). -1. [Add the service account to the space](operations/space/add-user-to-space.md) with the `speech-sense.data.editor` role. To learn more about the roles available in the service, see [{#T}](security/index.md). +1. [Add the service account to the namespace](operations/space/add-user-to-space.md) with the `speech-sense.data.editor` role. To learn more about the roles available in the service, see [{#T}](security/index.md). 1. [Create an API key](../iam/operations/api-key/create.md) or [IAM token](../iam/operations/iam-token/create-for-sa.md) for the service account to authenticate with the API. [Learn more about authentication in the {{ speechsense-name }} API](api-ref/authentication.md). 1. [Upload your audio data](operations/data/upload-data.md) or [chat history data](operations/data/upload-chat-text.md) using a Python data transfer script. - Use one message for the whole audio. + Use one message for the whole audio. - {% include [supported-formats](../_includes/speechsense/formats.md) %} + {% include [supported-formats](../_includes/speechsense/formats.md) %} diff --git a/en/speechsense/toc.yaml b/en/speechsense/toc.yaml index bbff4017c6e..a0fd0dc671d 100644 --- a/en/speechsense/toc.yaml +++ b/en/speechsense/toc.yaml @@ -17,6 +17,8 @@ items: href: operations/data/search-data.md - name: Working with dialogs href: operations/data/manage-dialogs.md + - name: Viewing related dialogs + href: operations/data/related-dialogs.md - name: Working with reports href: operations/data/manage-reports.md - name: Spaces @@ -51,7 +53,7 @@ items: href: operations/project/tag/create.md - name: Changing a tag href: operations/project/tag/change.md - - name: Removing a tag + - name: Deleting a tag href: operations/project/tag/delete.md - name: Dictionaries items: @@ -81,6 +83,8 @@ items: href: concepts/reports/evaluation-form.md - name: Usage details href: concepts/reports/details.md + - name: Neuroparameters + href: concepts/reports/neuro-parameters.md - name: Supported audio formats href: concepts/formats.md - name: API reference diff --git a/en/storage/_includes_service/storage-get-link-for-download.md b/en/storage/_includes_service/storage-get-link-for-download.md index ecb7ef46a65..e5ec8a5bbc2 100644 --- a/en/storage/_includes_service/storage-get-link-for-download.md +++ b/en/storage/_includes_service/storage-get-link-for-download.md @@ -2,7 +2,7 @@ 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_storage }}**. 1. Click the name of the bucket you need. 1. Click the object name. -1. Click **{{ ui-key.yacloud.storage.file.button_generate }}** in the top-right corner. -1. If your bucket has restricted access, specify the link **{{ ui-key.yacloud.storage.file.label_lifetime }}** in hours or days (the maximum time is thirty days). +1. Click ![link](../../_assets/storage/link.svg) **{{ ui-key.yacloud.storage.file.button_generate }}** in the top-right corner. +1. For a bucket with restricted access, specify the link **{{ ui-key.yacloud.storage.file.label_lifetime }}** in hours or days (the maximum time is 30 days). 1. Click **{{ ui-key.yacloud.storage.file.button_generate }}**. 1. Copy the link. diff --git a/en/storage/api-ref/authentication.md b/en/storage/api-ref/authentication.md index b700cc2e416..9ee2be47d05 100644 --- a/en/storage/api-ref/authentication.md +++ b/en/storage/api-ref/authentication.md @@ -24,7 +24,7 @@ For a full list of S3 API methods, see [S3 API reference](../s3/api-ref/). If you want to use the AWS S3 API directly (without an SDK or apps), you will need to [sign requests](../s3/signing-requests.md) yourself. You can test the request and signature generation process using the AWS CLI in [debug mode](../s3/signing-requests.md#debugging). -### AWS S3 API usage example {#s3-api-example} +### AWS S3 API use case {#s3-api-example} Starting from version [8.3.0](https://curl.se/changes.html), the `curl` utility supports automatic generation of the [signature string](../s3/signing-requests.md#string-to-sign-gen), [request signing](../s3/signing-requests.md#signing), and substitution of the required headers when working with the AWS S3 API. @@ -40,7 +40,7 @@ Below are examples of requests for uploading an object to a bucket. {% list tabs %} -- Curl 8.3.0 and higher +- curl 8.3.0 and higher ```bash AWS_KEY_ID="" @@ -85,7 +85,7 @@ Below are examples of requests for uploading an object to a bucket. Where `DIRECTORY_PATH` is the path to the directory you want to archive. -- Curl 8.2.1 and lower +- curl 8.2.1 and lower ```bash AWS_KEY_ID="" @@ -134,7 +134,7 @@ For authentication in the {{ yandex-cloud }} gRPC and REST APIs, get an IAM toke For a full list of {{ yandex-cloud }} API calls and methods, see [gRPC API](../api-ref/grpc/) and [REST API](../api-ref/) references. -### {{ yandex-cloud }} API usage example {#example} +### {{ yandex-cloud }} API use case {#example} In the example, a 50GB bucket is created with a standard storage class. @@ -192,10 +192,11 @@ In the example, a 50GB bucket is created with a standard storage class. ```bash export IAM_TOKEN="" - curl -X POST \ - -H 'Content-Type: application/json' \ - -H "Authorization: Bearer $IAM_TOKEN" \ - -d '{ + curl \ + --request POST \ + --header 'Content-Type: application/json' \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --data '{ "name": "", "folderId": "", "defaultStorageClass": "STANDARD", diff --git a/en/storage/concepts/bucket.md b/en/storage/concepts/bucket.md index 29cdd9d064e..e48c11b3459 100644 --- a/en/storage/concepts/bucket.md +++ b/en/storage/concepts/bucket.md @@ -1,6 +1,6 @@ --- title: Bucket -description: A bucket is an {{ objstorage-name }} storage unit allocated for user data. A bucket name is used as part of a URL to access data. Bucket names are unique across {{ yandex-cloud }}, i.e., you cannot create two buckets with identical names even if the folders they reside in belong to different clouds. You should keep this in mind if you are going to create buckets automatically through the API. +description: A bucket is an {{ objstorage-name }} storage unit allocated for user data. A bucket name is used as part of a URL to access data. Bucket names are unique across {{ yandex-cloud }}, i.e., you cannot create buckets with identical names even if the folders they reside in belong to different clouds. You should keep this in mind if you are going to create buckets automatically through the API. keywords: - what is a bucket - bucket @@ -81,7 +81,7 @@ You can: {% include [intro-access-via-vpc](../../_includes/storage/intro-access-via-vpc.md) %} -For more information on configuring access, see [{#T}](../operations/buckets/access-via-vpc.md). +For more information on configuring the access, see [{#T}](../operations/buckets/access-via-vpc.md). ## Public access to buckets {#bucket-access} @@ -100,14 +100,14 @@ You can also access aggregate bucket statistics [through the {{ yandex-cloud }} ## Recommendations and limitations {#details-of-usage} +- Updating bucket statistics may take up to 20 minutes. Therefore, sometimes the specified maximum bucket capacity may be exceeded (e.g., during fast sequential upload of multiple objects). +- In the management console, the information about the number of objects in the bucket and used up space is updated with a delay. - You cannot rename buckets. - The number of buckets does not affect the performance of {{ objstorage-name }}. How many buckets you use to store your data is up to you. - Buckets cannot be nested. -- In the management console, information about the number of objects in a bucket and the used space is updated with a few minutes' delay. - You can delete only an empty bucket. -- After deleting a bucket, you may not be able to immediately create a new bucket with the same name. There is also a risk that another {{ yandex-cloud }} user might create a bucket with the name you released before you claim it again. Do not delete buckets without a reason. -- Uploading objects quickly one by one may lead to exceeding the specified maximum bucket size. -- After deleting objects from a bucket, their storage capacity is retained for some time. +- After you delete objects from a bucket, the vacated space is not considered free for a while longer. +- After deleting a bucket, you may not be able to create a new one with the same name right away. There is also a risk that another {{ yandex-cloud }} user may create a bucket with this name before you claim it again. Do not delete buckets without a good reason. {% note info %} diff --git a/en/storage/concepts/s3-select-language.md b/en/storage/concepts/s3-select-language.md index 53c3531a9ea..8de8c22ea78 100644 --- a/en/storage/concepts/s3-select-language.md +++ b/en/storage/concepts/s3-select-language.md @@ -193,9 +193,9 @@ SELECT s.CAST FROM S3Object s `WHERE` and `SELECT` clauses may contain SQL scalar expressions returning scalar values. These may appear as follows: -* `literal`: SQL literal. A literal is an explicit numeric, character, string, or boolean value (constant) not represented by an ID. +* `literal`. SQL literal. A literal is an explicit numeric, character, string, or boolean value (constant) not represented by an ID. -* `column_reference`: A reference to a column in `column_name` or `alias.column_name` format used to access a column using column header. +* `column_reference`. A reference to a column in `column_name` or `alias.column_name` format used to access a column using column header. Example: @@ -203,7 +203,7 @@ SELECT s.CAST FROM S3Object s SELECT city.name FROM S3Object city ``` -* `unary_op expression`: In this expression, `unary_op` is a unary SQL operator. Unary operators perform operations on a single operand. They include, for instance, the unary minus, which changes the sign of a number. +* `unary_op expression`. In this expression, `unary_op` is a unary SQL operator. Unary operators perform operations on a single operand. They include, for instance, the unary minus, which changes the sign of a number. Example: @@ -211,7 +211,7 @@ SELECT s.CAST FROM S3Object s SELECT -5 FROM S3Object ``` -* `expression binary_op expression`: In this expression, `binary_op` is a binary SQL operator. Binary operators perform an operation on two operands. For instance, binary operators include arithmetic, logical, and comparison operators. +* `expression binary_op expression`. In this expression, `binary_op` is a binary SQL operator. Binary operators perform an operation on two operands. For instance, binary operators include arithmetic, logical, and comparison operators. Examples: @@ -223,7 +223,7 @@ SELECT s.CAST FROM S3Object s SELECT result FROM S3Object WHERE result>=1 AND result<=5 ``` -* `func_name`: In this expression, `func_name` is the name of a callable scalar function. +* `func_name`. In this expression, `func_name` is the name of a callable scalar function. Example: @@ -231,7 +231,7 @@ SELECT s.CAST FROM S3Object s SELECT CAST(status AS INT) FROM S3Object ``` -* `expression [ NOT ] BETWEEN expression AND expression`: Checks if a value belongs to a range. +* `expression [ NOT ] BETWEEN expression AND expression`. Checks if a value belongs to a range. Example: diff --git a/en/storage/operations/buckets/access-via-vpc.md b/en/storage/operations/buckets/access-via-vpc.md index d7aa5d8fb5d..53d546a498e 100644 --- a/en/storage/operations/buckets/access-via-vpc.md +++ b/en/storage/operations/buckets/access-via-vpc.md @@ -5,30 +5,34 @@ {% include [intro-access-via-vpc](../../../_includes/storage/intro-access-via-vpc.md) %} To enable access to a bucket using a service connection from {{ vpc-short-name }}: +1. [Create a {{ vpc-short-name }} service connection](#create-endpoint). +1. [Configure the access policy for the bucket](#setup-policy). -1. [Create](../../../vpc/operations/private-endpoint-create.md) a service connection (Private Endpoint). +## Create a {{ vpc-short-name }} service connection {#create-endpoint} - {% include [private-endpoint-create-roles](../../../_includes/vpc/private-endpoint-create-roles.md) %} +{% include [private-endpoint-create-roles](../../../_includes/vpc/private-endpoint-create-roles.md) %} - {% list tabs group=instructions %} +{% list tabs group=instructions %} - - CLI {#cli} +- CLI {#cli} - {% include [private-endpoint-create-cli](../../../_includes/vpc/private-endpoint-create-cli.md) %} + {% include [private-endpoint-create-cli](../../../_includes/vpc/private-endpoint-create-cli.md) %} - {% endlist %} +{% endlist %} - {{ objstorage-name }} buckets are now accessible via {{ vpc-short-name }} internal IP addresses with no Internet access needed. +Save the service connection ID. -1. Save the connection ID from the `ID` column. +{{ objstorage-name }} buckets are now accessible via the {{ vpc-short-name }} internal IP address without any internet access. -1. To restrict access to a bucket to _{{ vpc-short-name }} internal IP addresses only_, [assign](../../../vpc/operations/private-endpoint-storage-policy.md) a bucket policy for a service connection. +## Configure the access policy for the bucket {#setup-policy} - {% include [private-endpoint-policy-tabs](../../../_includes/storage/private-endpoint-policy-tabs.md) %} +To restrict access to a bucket to _{{ vpc-short-name }} internal IP addresses only_, assign a bucket policy for the service connection. + +{% include [private-endpoint-policy-tabs](../../../_includes/storage/private-endpoint-policy-tabs.md) %} #### See also {#see-also} -* [{{ vpc-short-name }} service connections](../../../vpc/operations/index.md#private-endpoint) -* [Managing {{ vpc-short-name }} service connections](../../../vpc/concepts/private-endpoint.md) +* [{{ vpc-short-name }} service connections](../../../vpc/concepts/private-endpoint.md) +* [Managing {{ vpc-short-name }} service connections](../../../vpc/operations/index.md#private-endpoint) * [Bucket policy](../../../storage/concepts/policy.md) * [Connecting to {{ objstorage-name }} from {{ vpc-name }}](../../../storage/tutorials/storage-vpc-access.md) diff --git a/en/storage/operations/buckets/bucket-availability.md b/en/storage/operations/buckets/bucket-availability.md index 27719dfe875..eddd5d6c490 100644 --- a/en/storage/operations/buckets/bucket-availability.md +++ b/en/storage/operations/buckets/bucket-availability.md @@ -19,7 +19,7 @@ By default, [buckets](../../concepts/bucket.md) are created with restricted [acc - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the appropriate folder. + 1. In the [management console]({{ link-console-main }}), select the folder. 1. Select **{{ objstorage-name }}**. 1. Click the bucket name. 1. Go to the **{{ ui-key.yacloud.storage.bucket.switch_settings }}** tab. @@ -169,7 +169,7 @@ If your bucket has access policies, you will also need to [configure](./policy.m - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the appropriate folder. + 1. In the [management console]({{ link-console-main }}), select the folder. 1. Select **{{ objstorage-name }}**. 1. Click the bucket name. 1. Go to the **{{ ui-key.yacloud.storage.bucket.switch_settings }}** tab. @@ -305,4 +305,4 @@ If your bucket has access policies, you will also need to [configure](./policy.m {% endlist %} -When disabling public access to the bucket, make sure the `All users` [public group](../../../iam/concepts/access-control/public-group.md) has no `viewer`, `storage.viewer`, or higher [role](../../security/index.md#service-roles) assigned for the folder or bucket. Otherwise, the bucket will still be publicly accessible. +When disabling public access to the bucket, make sure the `All users` [public group](../../../iam/concepts/access-control/public-group.md) has no `viewer`, `storage.viewer`, or higher [role](../../security/index.md#service-roles) assigned for the folder or bucket. Otherwise, the bucket will still be publicly accessible. \ No newline at end of file diff --git a/en/storage/operations/buckets/configure-object-lock.md b/en/storage/operations/buckets/configure-object-lock.md index 3baf8224291..1134e8362e5 100644 --- a/en/storage/operations/buckets/configure-object-lock.md +++ b/en/storage/operations/buckets/configure-object-lock.md @@ -1,6 +1,6 @@ # Managing object locks in buckets -You can set up _[object locks](../../concepts/object-lock.md)_ in [versioned](versioning.md) buckets. When object lock is enabled, you can lock an object version so that it would not be deleted or overwritten. You can also set default object locks for a bucket that will apply to all new object versions. +You can set up _[object locks](../../concepts/object-lock.md)_ in [versioned](versioning.md) buckets. When object lock is enabled, you can lock an object version so that it would not be deleted or overwritten. You can also set default object locks for a bucket that will apply to all new object versions. {% note info %} diff --git a/en/storage/operations/buckets/cors.md b/en/storage/operations/buckets/cors.md index 8dbf9cbe029..5cce6f6c269 100644 --- a/en/storage/operations/buckets/cors.md +++ b/en/storage/operations/buckets/cors.md @@ -17,7 +17,7 @@ {% include [default-catalogue](../../../_includes/default-catalogue.md) %} - 1. View a description of the CLI command to update a bucket: + 1. See the description of the CLI command to update a bucket: ```bash yc storage bucket update --help @@ -57,7 +57,7 @@ * `expose-headers`: List of headers that can be displayed in a JavaScript app in the browser. This is an optional parameter. * `max-age-seconds`: Time in seconds during which the browser caches the results of requests to an object. This is an optional parameter. - Parameter values are specified in quotes and square brackets. List items in values are separated by commas with no spaces, e.g., `--cors allowed-methods='[method-get,method-head]',allowed-origins='[example.com]'`. + Parameter values are specified in quotes and square brackets. List items in values are separated by commas with no spaces. For example, `--cors allowed-methods='[method-get,method-head]',allowed-origins='[example.com]'`. Permissions specified in the command override the current CORS settings of the bucket. You can retrieve the current permissions using the `yc storage bucket get --full`. @@ -85,7 +85,7 @@ To upload a configuration via the [AWS CLI](../../tools/aws-cli.md): - 1. Describe the CORS object configurations in JSON format. For example: + 1. Describe the CORS object configurations in JSON format. Here is an example: ```json { @@ -134,7 +134,7 @@ name = "" } - // Assigning roles to a service account + // Assigning a role to a service account resource "yandex_resourcemanager_folder_iam_member" "sa-admin" { folder_id = "" role = "storage.admin" @@ -175,13 +175,13 @@ `CORS` parameters: * `allowed_headers`: Allowed headers. This is an optional parameter. - * `allowed_methods`: Allowed methods. Possible values: `GET`, `PUT`, `POST`, `DELETE`, and `HEAD`. This is a required parameter. + * `allowed_methods`: Allowed methods. The possible values are `GET`, `PUT`, `POST`, `DELETE` or `HEAD`. This is a required parameter. * `allowed_origins`: Website that allows sending cross-domain requests to a bucket. This is a required parameter. * `expose_headers`: Header that can be displayed in a JavaScript app in the browser. This is an optional parameter. * `max_age_seconds`: Time in seconds during which the browser caches the results of requests to an object. This is an optional parameter. * `server_side_encryption_configuration`: Bucket encryption settings on the server side. This is an optional parameter. - For more information about the resources that you can create with {{ TF }}, see the [provider documentation]({{ tf-provider-link }}/). + For more information about the resources you can create with {{ TF }}, see the [provider documentation]({{ tf-provider-link }}/). 1. Make sure the configuration files are correct. 1. In the command line, go to the folder where you created the configuration file. diff --git a/en/storage/operations/buckets/delete.md b/en/storage/operations/buckets/delete.md index b3ad625d2fd..73605cea452 100644 --- a/en/storage/operations/buckets/delete.md +++ b/en/storage/operations/buckets/delete.md @@ -30,7 +30,7 @@ To delete the bucket that [stores the logs](../../concepts/server-logs.md) of an {% include [default-catalogue](../../../_includes/default-catalogue.md) %} - 1. View a description of the CLI command to delete a bucket: + 1. See the description of the CLI command to delete a bucket: ```bash yc storage bucket delete --help @@ -59,7 +59,7 @@ To delete the bucket that [stores the logs](../../concepts/server-logs.md) of an yc storage bucket delete --name ``` - Where `--name`: Name of the bucket to delete. + Where `--name` is the name of the bucket to delete. {% include [work-with-multiple-buckets](../../../_includes/storage/work-with-multiple-buckets.md) %} @@ -99,7 +99,7 @@ To delete the bucket that [stores the logs](../../concepts/server-logs.md) of an --output text | xargs -I {} aws s3api delete-bucket --endpoint-url=https://{{ s3-storage-host }} --bucket {} ``` - Where `--query`: Query in [JMESPath](https://jmespath.org/) format. + Where `--query` is the query in [JMESPath](https://jmespath.org/) format. Example of the command for deleting all buckets whose names start with `samplebucket`: @@ -122,7 +122,7 @@ To delete the bucket that [stores the logs](../../concepts/server-logs.md) of an --bucket $x} ``` - Where `--query`: Query in [JMESPath](https://jmespath.org/) format. + Where `--query` is the query in [JMESPath](https://jmespath.org/) format. Example of the command for deleting all buckets whose names start with `samplebucket`: @@ -189,7 +189,7 @@ To delete the bucket that [stores the logs](../../concepts/server-logs.md) of an terraform apply ``` - 1. Confirm the changes: type `yes` into the terminal and click **Enter**. + 1. Confirm the changes: type `yes` into the terminal and press **Enter**. You can check the changes in the [management console]({{ link-console-main }}). diff --git a/en/storage/operations/buckets/edit-acl.md b/en/storage/operations/buckets/edit-acl.md index 562132637f0..61a9c79bb35 100644 --- a/en/storage/operations/buckets/edit-acl.md +++ b/en/storage/operations/buckets/edit-acl.md @@ -1,6 +1,6 @@ --- title: Editing a bucket's ACL in {{ objstorage-full-name }} -description: Apart from {{ iam-short-name }}, you can also use an access control list (ACL) to manage access to an {{ objstorage-name }} bucket. +description: To manage an {{ objstorage-name }} bucket access, apart from {{ iam-short-name }}, you can also use an access control list, or ACL. --- # Editing a bucket's ACL @@ -17,7 +17,7 @@ If an [ACL](../../concepts/acl.md) has already been set for a [bucket](../../con - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the appropriate folder. + 1. In the [management console]({{ link-console-main }}), select the folder. 1. Select **{{ objstorage-name }}**. 1. To edit an ACL, click ![image](../../../_assets/console-icons/ellipsis.svg) to the right of the bucket name and select **{{ ui-key.yacloud.storage.buckets.button_permissions }}**. @@ -81,7 +81,7 @@ If an [ACL](../../concepts/acl.md) has already been set for a [bucket](../../con Setting up individual permissions - : 1. To grant ACL permissions to a {{ yandex-cloud }} user, service account, or user group, get their ID: + : 1. To grant ACL permissions to a {{ yandex-cloud }} user, service account, or user group, get their IDs: * [User](../../../iam/operations/users/get.md). @@ -97,16 +97,15 @@ If an [ACL](../../concepts/acl.md) has already been set for a [bucket](../../con ``` Where: - * `grant-type`: Permission grantee type. The possible values are as follows: + * `grant-type`: Permission grantee type. The possible values are: * `grant-type-account`: User, [service account](../../../iam/concepts/users/service-accounts.md), or [user group](../../../organization/concepts/groups.md). * `grant-type-all-authenticated-users`: [Public group](../../concepts/acl.md#public-groups) that includes all authenticated {{ yandex-cloud }} users. * `grant-type-all-users`: Public group that includes all internet users. - * `grantee-id`: ID of the user, service account, or user group you need to grant a permission to. Specify only if `grant-type=grant-type-account`. - * `permission`: ACL permission type. The possible values are as follows: + * `grantee-id`: ID of the user, service account, or user group you need to grant a permission to. Specified only if `grant-type=grant-type-account`. + * `permission`: ACL permission type. The possible values are: * `permission-read`: Permission to access the list of objects in the bucket, read various bucket settings (lifecycle, CORS, or static hosting), and read all objects in the bucket. * `permission-write`: Permission to write, overwrite, and delete objects in the bucket. Can only be used together with `permission-read`. * `permission-full-control`: Full access to the bucket and the objects in it. - For more information about permissions, see [{#T}](../../concepts/acl.md#permissions-types). To configure multiple permissions, specify the `--grants` parameter multiple times. For example, to grant a write permission for a bucket, run the following command: @@ -123,7 +122,7 @@ If an [ACL](../../concepts/acl.md) has already been set for a [bucket](../../con {% note info %} - To manage bucket ACLs, assign the `storage.admin` [role](../../security/index.md#storage-admin) to the service account through which the AWS CLI works. + To manage bucket ACL settings, assign the `storage.admin` [role](../../security/index.md#storage-admin) to the service account used by the AWS CLI. {% endnote %} @@ -158,10 +157,10 @@ If an [ACL](../../concepts/acl.md) has already been set for a [bucket](../../con * `--endpoint`: {{ objstorage-name }} endpoint. * `--bucket`: Bucket name. * `--acl`: Predefined ACL. For the list of values, see [{#T}](../../concepts/acl.md#predefined-acls). - + Setting up individual permissions - : 1. To grant ACL permissions to a {{ yandex-cloud }} user, service account, or user group, get their ID: + : 1. To grant ACL permissions to a {{ yandex-cloud }} user, service account, or user group, get their IDs: * [User](../../../iam/operations/users/get.md). @@ -239,7 +238,7 @@ If an [ACL](../../concepts/acl.md) has already been set for a [bucket](../../con * `secret_key`: Private access key value. * `bucket`: Bucket name. This is a required parameter. * `grant`: [ACL](../../concepts/acl.md) settings. This is an optional parameter. To manage this parameter, the service account for which the static access keys were obtained must have the `storage.admin` [role](../../security/index.md#roles-list) for a bucket or folder. - * `type`: Permission grantee type. The possible values are as follows: + * `type`: Permission grantee type. The possible values are: * `CanonicalUser`: For a user, [service account](../../../iam/concepts/users/service-accounts.md), or [user group](../../../organization/concepts/groups.md). * `Group`: For a [public group](../../concepts/acl.md#public-groups). * `permissions`: Type of ACL [permissions](../../concepts/acl.md#permissions-types). The possible values are: @@ -258,13 +257,13 @@ If an [ACL](../../concepts/acl.md) has already been set for a [bucket](../../con * User group: Navigate to the [**{{ ui-key.yacloud_org.pages.groups }}**]({{ link-org-main }}groups) tab in the {{ org-name }} interface. - * `uri`: Public group ID. Used with the `Group` type of permission grantee. The possible values are as follows: + * `uri`: Public group ID. Used with the `Group` type of permission grantee. The possible values are: * `http://acs.amazonaws.com/groups/global/AllUsers`: All internet users. * `http://acs.amazonaws.com/groups/global/AuthenticatedUsers`: All authenticated {{ yandex-cloud }} users. Instead of `grant`, you can specify `acl`, i.e., the [predefined ACL](../../../storage/concepts/acl.md#predefined-acls) of the bucket. The default value is `private`: {{ yandex-cloud }} users get permissions based on their roles in {{ iam-short-name }}. - For more information about the resources that you can create with {{ TF }}, see the [provider documentation]({{ tf-provider-link }}/). + For more information about the resources you can create with {{ TF }}, see the [provider documentation]({{ tf-provider-link }}/). 1. Make sure the configuration files are correct. diff --git a/en/storage/operations/buckets/iam-access.md b/en/storage/operations/buckets/iam-access.md index ba04deb790b..fe51c3266be 100644 --- a/en/storage/operations/buckets/iam-access.md +++ b/en/storage/operations/buckets/iam-access.md @@ -13,15 +13,16 @@ To configure access to a [bucket](../../concepts/bucket.md) using [{{ iam-name } - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the appropriate folder. - 1. Select **{{ objstorage-name }}**. - 1. Click the name of the bucket you want to grant access to. - 1. Go to the **{{ ui-key.yacloud.common.resource-acl.label_access-bindings }}** tab. - 1. Click **{{ ui-key.yacloud.common.resource-acl.button_new-bindings }}**. - 1. Select a user from the list or search by user. - 1. Click **{{ ui-key.yacloud_components.acl.button.add-role }}**. - 1. Select a role for the user. - 1. Click **{{ ui-key.yacloud_components.acl.action.apply }}**. + 1. In the [management console]({{ link-console-main }}), select the folder. + 1. Select **{{ objstorage-name }}**. + 1. Click the name of the bucket you want to grant access to. + 1. In the left-hand menu, select **{{ ui-key.yacloud.storage.bucket.switch_security }}**. + 1. Go to the **{{ ui-key.yacloud.common.resource-acl.label_access-bindings }}** tab. + 1. Click **{{ ui-key.yacloud.common.resource-acl.button_new-bindings }}**. + 1. Select a user from the list or search by user. + 1. Click **{{ ui-key.yacloud_components.acl.button.add-role }}**. + 1. Select a role for the user. + 1. Click **{{ ui-key.yacloud_components.acl.action.apply }}**. {% endlist %} diff --git a/en/storage/operations/buckets/limit-max-volume.md b/en/storage/operations/buckets/limit-max-volume.md index bf1afc83cf0..bf06825f3a1 100644 --- a/en/storage/operations/buckets/limit-max-volume.md +++ b/en/storage/operations/buckets/limit-max-volume.md @@ -8,7 +8,7 @@ For example, if you provide the users of your service with the ability to upload - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the appropriate folder. + 1. In the [management console]({{ link-console-main }}), select a folder. 1. Select **{{ objstorage-name }}**. 1. Click the name of the bucket you need. 1. Go to the **{{ ui-key.yacloud.storage.bucket.switch_settings }}** tab. @@ -23,7 +23,7 @@ For example, if you provide the users of your service with the ability to upload {% include [default-catalogue](../../../_includes/default-catalogue.md) %} - 1. View a description of the CLI command to update a bucket: + 1. See the description of the CLI command to update a bucket: ```bash yc storage bucket update --help @@ -128,7 +128,7 @@ For example, if you provide the users of your service with the ability to upload terraform apply ``` - 1. Confirm the changes: type `yes` into the terminal and click **Enter**. + 1. Confirm the changes: type `yes` into the terminal and press **Enter**. You can verify changes to your bucket in the [management console]({{ link-console-main }}). diff --git a/en/storage/operations/buckets/policy.md b/en/storage/operations/buckets/policy.md index 7b6df6d6c82..58c58fe740f 100644 --- a/en/storage/operations/buckets/policy.md +++ b/en/storage/operations/buckets/policy.md @@ -32,14 +32,14 @@ To apply or edit a bucket access policy: 1. Configure rule settings: * **{{ ui-key.yacloud.storage.bucket.policy.field_effect }}**: Allow or forbid. * **{{ ui-key.yacloud.storage.bucket.policy.field_principal-type }}**: Include or exclude users. - * **{{ ui-key.yacloud.storage.bucket.policy.field_user }}**: All users or specific users. To list specific users or service accounts, select their names in the drop-down list. + * **{{ ui-key.yacloud.storage.bucket.policy.field_user }}**: All users or specific users. To specify a list of specific users or service accounts, select their names in the drop-down list. * **{{ ui-key.yacloud.storage.bucket.policy.field_action }}** for which the rule is being created. You can also select the **All actions** option. * **{{ ui-key.yacloud.storage.bucket.policy.field_resource }}**: Selected bucket specified by default. To add other resources to the rule, click **{{ ui-key.yacloud.storage.bucket.policy.button_add-resource }}**. - + {% note info %} - + {% include [policy-bucket-objects](../../../_includes/storage/policy-bucket-objects.md) %} - + {% endnote %} 1. If required, add a [condition](../../s3/api-ref/policy/conditions.md) for the rule: @@ -66,7 +66,7 @@ To apply or edit a bucket access policy: ```bash yc storage bucket update --help ``` - + 1. Describe your access policy configuration as a [data schema](../../s3/api-ref/policy/scheme.md) in JSON format: ```json @@ -90,15 +90,15 @@ To apply or edit a bucket access policy: * `Version`: Version of the bucket policy description. This is an optional parameter. * `Statement`: Bucket policy rules: - * `Effect`: Deny or allow the requested action. Possible values: `Allow` and `Deny`. + * `Effect`: Deny or allow the requested action. The possible values are `Allow` and `Deny`. * `Principal`: Requested permission subject ID. You can request permissions for a [user](../../../iam/operations/users/get.md), [service account](../../../iam/operations/sa/get-id.md), or [user group](../../../organization/operations/manage-groups.md). The possible values are `*` and ``. This is an optional parameter. - + You can get the IDs in any of the following ways: * [User](../../../iam/operations/users/get.md). * [Service account](../../../iam/operations/sa/get-id.md) * User group: Navigate to the [**{{ ui-key.yacloud_org.pages.groups }}**]({{ link-org-main }}groups) tab in the {{ org-name }} interface. - + * `Action`: [Action](../../s3/api-ref/policy/actions.md) to allow when the policy is triggered. The possible values are `s3:GetObject`, `s3:PutObject`, and `*` (if you need to apply the policy to all actions). * `Resource`: Resource to apply the rule to. @@ -171,15 +171,15 @@ To apply or edit a bucket access policy: * `Version`: Version of the bucket policy description. This is an optional parameter. * `Statement`: Bucket policy rules: - * `Effect`: Deny or allow the requested action. Possible values: `Allow` and `Deny`. + * `Effect`: Deny or allow the requested action. The possible values are `Allow` and `Deny`. * `Principal`: Requested permission subject ID. You can request permissions for a [user](../../../iam/operations/users/get.md), [service account](../../../iam/operations/sa/get-id.md), or [user group](../../../organization/operations/manage-groups.md). The possible values are `*` and ``. This is an optional parameter. - + You can get the IDs in any of the following ways: * [User](../../../iam/operations/users/get.md). * [Service account](../../../iam/operations/sa/get-id.md) * User group: Navigate to the [**{{ ui-key.yacloud_org.pages.groups }}**]({{ link-org-main }}groups) tab in the {{ org-name }} interface. - + * `Action`: [Action](../../s3/api-ref/policy/actions.md) to allow when the policy is triggered. The possible values are `s3:GetObject`, `s3:PutObject`, and `*` (if you need to apply the policy to all actions). * `Resource`: Resource to apply the rule to. @@ -265,20 +265,20 @@ To apply or edit a bucket access policy: * `secret_key`: Private access key value. * `bucket`: Bucket name. This is a required parameter. * `policy`: Policy name. This is a required parameter. - + Policy settings: * `Version`: Version of the bucket policy description. This is an optional parameter. * `Statement`: Bucket policy rules: - * `Effect`: Deny or allow the requested action. Possible values: `Allow` and `Deny`. + * `Effect`: Deny or allow the requested action. The possible values are `Allow` and `Deny`. * `Principal`: Requested permission subject ID. You can request permissions for a [user](../../../iam/operations/users/get.md), [service account](../../../iam/operations/sa/get-id.md), or [user group](../../../organization/operations/manage-groups.md). The possible values are `*` and ``. This is an optional parameter. - + You can get the IDs in any of the following ways: * [User](../../../iam/operations/users/get.md). * [Service account](../../../iam/operations/sa/get-id.md) * User group: Navigate to the [**{{ ui-key.yacloud_org.pages.groups }}**]({{ link-org-main }}groups) tab in the {{ org-name }} interface. - + * `Action`: [Action](../../s3/api-ref/policy/actions.md) to allow when the policy is triggered. The possible values are `s3:GetObject`, `s3:PutObject`, and `*` (if you need to apply the policy to all actions). * `Resource`: Resource to apply the rule to. @@ -289,7 +289,6 @@ To apply or edit a bucket access policy: {% include [conditions-combining-or](../../../_includes/storage/conditions-combining-or.md) %} For more information about the resources you can create with {{ TF }}, see the [provider documentation]({{ tf-provider-link }}/). - 1. Make sure the configuration files are correct. 1. In the command line, go to the folder where you created the configuration file. 1. Run a check using this command: @@ -442,7 +441,7 @@ To delete a bucket policy: 1. Type `yes` and press **Enter**. - Afterwards, the bucket policy will be deleted from the specified folder. You can check the bucket policy's deletion using the [management console]({{ link-console-main }}). + This will delete the bucket policy from the specified folder. You can check that the bucket policy is gone in the [management console]({{ link-console-main }}). - API {#api} diff --git a/en/storage/operations/buckets/versioning.md b/en/storage/operations/buckets/versioning.md index 5b9c4138a20..4c6216e56ed 100644 --- a/en/storage/operations/buckets/versioning.md +++ b/en/storage/operations/buckets/versioning.md @@ -23,7 +23,7 @@ Enable bucket versioning: {% include [default-catalogue](../../../_includes/default-catalogue.md) %} - 1. View a description of the CLI command to edit a bucket ACL: + 1. See the description of the CLI command to edit a bucket ACL: ```bash yc storage bucket update --help diff --git a/en/storage/operations/hosting/setup.md b/en/storage/operations/hosting/setup.md index 6c055bbdab3..1ecfb22e25f 100644 --- a/en/storage/operations/hosting/setup.md +++ b/en/storage/operations/hosting/setup.md @@ -24,10 +24,9 @@ You can host your static website in {{ objstorage-name }}. A static website is b 1. [Allow](../buckets/bucket-availability.md) public access to operations with the bucket. 1. Go to the ![website](../../../_assets/console-icons/globe.svg) **{{ ui-key.yacloud.storage.bucket.switch_website }}** tab. 1. Under **{{ ui-key.yacloud.storage.bucket.website.switch_hosting }}**: - * In the **{{ ui-key.yacloud.storage.bucket.website.field_index }}** field, specify the absolute path to the file of the website homepage. - * (Optional) In the **{{ ui-key.yacloud.storage.bucket.website.field_error }}** field, specify the absolute path to the file to be displayed in the event of 4xx errors. By default, {{ objstorage-name }} returns its own page. + * In the **{{ ui-key.yacloud.storage.bucket.website.field_index }}** field, specify the absolute path to the file in the bucket for the website home page, e.g., `pages/index.html`. + * (Optional) In the **{{ ui-key.yacloud.storage.bucket.website.field_error }}** field, specify the absolute path to the file in the bucket to be displayed in case of 4xx errors, e.g., `pages/error404.html`. By default, {{ objstorage-name }} returns its own page. 1. Click **{{ ui-key.yacloud.storage.bucket.website.button_save }}**. - - {{ yandex-cloud }} CLI {#cli} {% include [cli-install](../../../_includes/cli-install.md) %} @@ -39,7 +38,9 @@ You can host your static website in {{ objstorage-name }}. A static website is b ```bash yc storage bucket update --help ``` - + + 1. Create a hosting settings file in JSON format. Here is an example: + ```json { "index": "index.html", @@ -49,19 +50,19 @@ You can host your static website in {{ objstorage-name }}. A static website is b Where: - * `index`: Absolute path to the file of the website home page. + * `index`: Absolute path to the website home page file. * `error`: Absolute path to the file the user will see in case of 4xx errors. - + 1. Run the following command: ```bash yc storage bucket update --name \ --website-settings-from-file ``` - + Where: * `--name`: Bucket name. - * `--website-settings-from-file`: Path to the hosting configuration file. + * `--website-settings-from-file`: Path to the hosting settings file. Result: @@ -131,12 +132,12 @@ You can host your static website in {{ objstorage-name }}. A static website is b secret_key = yandex_iam_service_account_static_access_key.sa-static-key.secret_key bucket = "" acl = "public-read" - + website { index_document = "index.html" error_document = "error.html" } - + } ``` @@ -145,12 +146,12 @@ You can host your static website in {{ objstorage-name }}. A static website is b Where: * `access_key`: Static access key ID. - * `secret_key`: Secret access key value. + * `secret_key`: Private access key value. * `bucket`: Bucket name. - * `acl`: Parameters for [ACL](../../concepts/acl.md#predefined-acls). + * `acl`: [ACL](../../concepts/acl.md#predefined-acls) access management parameters. * `website`: Website parameters: - * `index_document`: Absolute path to the file of the website home page. This is a required parameter. - * `error_document`: Absolute path to the file the user will see in case of `4xx` errors. This is an optional parameter. + * `index_document`: Absolute path to the website home page file. This is a required parameter. + * `error_document`: Absolute path to the file the user will see in case of 4xx errors. This is an optional parameter. 1. Make sure the configuration files are correct. @@ -170,7 +171,7 @@ You can host your static website in {{ objstorage-name }}. A static website is b ``` terraform apply ``` - + 1. Confirm that you want to create the resources. All the resources you need will then be created in the specified folder. You can check the new resources and their configuration using the [management console]({{ link-console-main }}). @@ -221,7 +222,7 @@ You can host your static website in {{ objstorage-name }}. A static website is b Where: * `protocol`: Data transfer protocol, `PROTOCOL_HTTP` or `PROTOCOL_HTTPS`. By default, the original request's protocol is used. * `hostname`: Domain name of the host to act as the redirect target for all requests to the current bucket. - + 1. Run the following command: ```bash @@ -246,7 +247,7 @@ You can host your static website in {{ objstorage-name }}. A static website is b ``` - {{ TF }} {#tf} - + {% include [terraform-definition](../../../_tutorials/_tutorials_includes/terraform-definition.md) %} @@ -264,7 +265,7 @@ You can host your static website in {{ objstorage-name }}. A static website is b secret_key = "" bucket = "" acl = "public-read" - + website { index_document = "" error_document = "" @@ -276,12 +277,12 @@ You can host your static website in {{ objstorage-name }}. A static website is b Where: * `access_key`: Static access key ID. - * `secret_key`: Secret access key value. + * `secret_key`: Private access key value. * `bucket`: Bucket name. - * `acl`: Parameters for [ACL](../../concepts/acl.md#predefined-acls). + * `acl`: [ACL](../../concepts/acl.md#predefined-acls) access management parameters. * `website`: Website parameters: - * `index_document`: Absolute path to the file of the website home page. This is a required parameter. - * `error_document`: Absolute path to the file the user will see in case of `4xx` errors. This is an optional parameter. + * `index_document`: Absolute path to the website home page file. This is a required parameter. + * `error_document`: Absolute path to the file the user will see in case of 4xx errors. This is an optional parameter. * `redirect_all_requests_to`: Domain name of the host to act as the redirect target for all requests to the current bucket. You can specify a protocol prefix (`http://` or `https://`). By default, the original request's protocol is used. For more information about the `yandex_storage_bucket` resource parameters in {{ TF }}, see the [provider documentation]({{ tf-provider-resources-link }}/storage_bucket#static-website-hosting). @@ -291,9 +292,9 @@ You can host your static website in {{ objstorage-name }}. A static website is b ```bash terraform validate ``` - + If the configuration is correct, you will get this message: - + ```bash Success! The configuration is valid. ``` @@ -303,7 +304,7 @@ You can host your static website in {{ objstorage-name }}. A static website is b ```bash terraform plan ``` - + The terminal will display a list of resources with parameters. No changes will be made at this step. If the configuration contains any errors, {{ TF }} will point them out. 1. Apply the configuration changes: @@ -311,7 +312,7 @@ You can host your static website in {{ objstorage-name }}. A static website is b ```bash terraform apply ``` - + 1. Confirm the changes: type `yes` into the terminal and press **Enter**. You can use the [management console]({{ link-console-main }}) to check the request redirect settings. @@ -345,7 +346,7 @@ Using routing rules, you can redirect requests based on the object name prefixes * Response code to determine the redirect type. * Replace the key: **{{ ui-key.yacloud.storage.bucket.website.select_redirect_none }}**, **{{ ui-key.yacloud.storage.bucket.website.select_redirect_key }}**, or **{{ ui-key.yacloud.storage.bucket.website.select_redirect_prefix }}** specified in the condition. 1. Click **{{ ui-key.yacloud.storage.bucket.website.button_save }}**. - + - {{ yandex-cloud }} CLI {#cli} {% include [cli-install](../../../_includes/cli-install.md) %} @@ -357,9 +358,9 @@ Using routing rules, you can redirect requests based on the object name prefixes ```bash yc storage bucket update --help ``` - - 1. Create a file with conditional redirect settings in JSON format. For example: - + + 1. Create a file with conditional redirect settings in JSON format. Here is an example: + ```json { "routingRules": [ @@ -382,18 +383,18 @@ Using routing rules, you can redirect requests based on the object name prefixes Where: * `condition`: Condition to trigger a redirect: - + * `httpErrorCodeReturnedEquals`: HTTP response code. * `keyPrefixEquals`: Object key prefix. - + * `redirect`: Redirect settings: - + * `hostname`: Domain name of the host to act as the redirect target for all requests to the current bucket. * `httpRedirectCode`: New HTTP response code. * `protocol`: New data transfer protocol, `PROTOCOL_HTTP` or `PROTOCOL_HTTPS`. By default, the original request's protocol is used. * `replaceKeyPrefixWith`: New object key prefix. * `replaceKeyWith`: New object key. - + 1. Run the following command: ```bash @@ -418,10 +419,10 @@ Using routing rules, you can redirect requests based on the object name prefixes ``` - {{ TF }} {#tf} - + {% include [terraform-definition](../../../_tutorials/_tutorials_includes/terraform-definition.md) %} - + {% include [terraform-install](../../../_includes/terraform-install.md) %} @@ -436,7 +437,7 @@ Using routing rules, you can redirect requests based on the object name prefixes secret_key = "" bucket = "" acl = "public-read" - + website { index_document = "" error_document = "" @@ -465,13 +466,13 @@ Using routing rules, you can redirect requests based on the object name prefixes Where: * `access_key`: Static access key ID. - * `secret_key`: Secret access key value. + * `secret_key`: Private access key value. * `bucket`: Bucket name. - * `acl`: Parameters for [ACL](../../concepts/acl.md#predefined-acls). + * `acl`: [ACL](../../concepts/acl.md#predefined-acls) access management parameters. * `website`: Website parameters: - * `index_document`: Absolute path to the file of the website home page. This is a required parameter. - * `error_document`: Absolute path to the file the user will see in case of `4xx` errors. This is an optional parameter. - * `routing_rules`: Rules for redirecting requests in JSON format. Each rule's `Condition` and `Redirect` fields must contain at least one key-value pair. For more information about the supported fields, see the [data schema](../../s3/api-ref/hosting/upload.md#request-scheme) of the respective API method (the **For conditionally redirecting requests** tab). + * `index_document`: Absolute path to the website home page file. This is a required parameter. + * `error_document`: Absolute path to the file the user will see in case of 4xx errors. This is an optional parameter. + * `routing_rules`: Rules for redirecting requests in JSON format. Each rule's `Condition` and `Redirect` fields must contain at least one key-value. For more information about the supported fields, see the [data schema](../../s3/api-ref/hosting/upload.md#request-scheme) of the respective API method (the **For conditionally redirecting requests** tab). For more information about the `yandex_storage_bucket` resource parameters in {{ TF }}, see the [provider documentation]({{ tf-provider-resources-link }}/storage_bucket#static-website-hosting). @@ -480,9 +481,9 @@ Using routing rules, you can redirect requests based on the object name prefixes ```bash terraform validate ``` - + If the configuration is correct, you will get this message: - + ```bash Success! The configuration is valid. ``` @@ -492,7 +493,7 @@ Using routing rules, you can redirect requests based on the object name prefixes ```bash terraform plan ``` - + The terminal will display a list of resources with parameters. No changes will be made at this step. If the configuration contains any errors, {{ TF }} will point them out. 1. Apply the configuration changes: @@ -500,11 +501,11 @@ Using routing rules, you can redirect requests based on the object name prefixes ```bash terraform apply ``` - + 1. Confirm the changes: type `yes` into the terminal and press **Enter**. You can use the [management console]({{ link-console-main }}) to check the settings for conditionally redirecting requests. - + - API {#api} To set up a conditional redirect of bucket requests, use the [update](../../api-ref/Bucket/update.md) REST API method for the [Bucket](../../api-ref/Bucket/index.md) resource, the [BucketService/Update](../../api-ref/grpc/Bucket/update.md) gRPC API call, or the [upload](../../s3/api-ref/hosting/upload.md) S3 API method. diff --git a/en/storage/operations/objects/copy.md b/en/storage/operations/objects/copy.md index e4591c614db..59da7665d21 100644 --- a/en/storage/operations/objects/copy.md +++ b/en/storage/operations/objects/copy.md @@ -44,7 +44,7 @@ You can copy either the [entire bucket contents](#copy-from-bucket-to-bucket) or copy: s3:/// to s3:/// ``` - For more information about the `aws s3 cp` command, see the [AWS CLI Command Reference](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3/cp.html). + For more information about the `aws s3 cp` command, see the [AWS CLI Command Reference](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/sns/publish.html). {% endlist %} @@ -130,6 +130,6 @@ To copy objects to a bucket hosted in a different [organization](../../../overvi copy: s3:/// to s3:/// ``` - For more information about the `aws s3 cp` command, see the [AWS CLI Command Reference](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3/cp.html). + For more information about the `aws s3 cp` command, see the [AWS CLI Command Reference](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/sns/publish.html). {% endlist %} diff --git a/en/storage/operations/objects/delete.md b/en/storage/operations/objects/delete.md index f584d927419..b92dc5a7927 100644 --- a/en/storage/operations/objects/delete.md +++ b/en/storage/operations/objects/delete.md @@ -22,7 +22,7 @@ To delete an object: 1. In the [management console]({{ link-console-main }}), select the folder. 1. Select **{{ objstorage-name }}**. 1. Click the name of the bucket you need. - 1. To delete a single object, click ![image](../../../_assets/console-icons/ellipsis.svg) to the right of the object name and click **{{ ui-key.yacloud.storage.file.button_delete }}** in the menu that opens. + 1. To delete a single object, click ![image](../../../_assets/console-icons/ellipsis.svg) to the right of the object name; in the menu that opens, click **{{ ui-key.yacloud.storage.file.button_delete }}**. To do the same with multiple objects, select them in the list and click **{{ ui-key.yacloud.common.delete }}** at the bottom of the screen. @@ -208,7 +208,7 @@ To delete an object: terraform apply ``` - 1. Confirm the changes: type `yes` into the terminal and click **Enter**. + 1. Confirm the changes: type `yes` into the terminal and press **Enter**. You can check the changes in the [management console]({{ link-console-main }}). diff --git a/en/storage/operations/objects/download.md b/en/storage/operations/objects/download.md index 681486afa94..e917fae0003 100644 --- a/en/storage/operations/objects/download.md +++ b/en/storage/operations/objects/download.md @@ -48,7 +48,7 @@ To download an object group with a specified prefix (a [directory](../../concept * `--endpoint-url`: {{ objstorage-name }} endpoint. * ``: Name of the bucket you want to download the object from. * ``: [Key](../../concepts/object.md#key) of the object you want to download. - * ``: Path to the folder to save the downloaded object to. e.g., `~/downloads/`. + * ``: Path to the folder to save the downloaded object to. For example: `~/downloads/`. **Downloading a directory (all objects with a specified prefix)** diff --git a/en/storage/operations/objects/edit-acl.md b/en/storage/operations/objects/edit-acl.md index 14be8228b40..cee2a201fdc 100644 --- a/en/storage/operations/objects/edit-acl.md +++ b/en/storage/operations/objects/edit-acl.md @@ -19,7 +19,7 @@ If an [ACL](../../concepts/acl.md) has been set for an object, it will be comple - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the appropriate folder. + 1. In the [management console]({{ link-console-main }}), select the folder. 1. Select **{{ objstorage-name }}**. 1. Click the bucket name. 1. To edit an ACL, click ![image](../../../_assets/console-icons/ellipsis.svg) to the right of the object name and select **{{ ui-key.yacloud.storage.bucket.button_action-permissions }}**. @@ -40,7 +40,7 @@ If an [ACL](../../concepts/acl.md) has been set for an object, it will be comple {% note info %} - To manage object ACLs, assign the `storage.admin` [role](../../security/index.md#storage-admin) to the service account through which the AWS CLI works. + To manage bucket ACL settings, assign the `storage.admin` [role](../../security/index.md#storage-admin) to the service account used by the AWS CLI. {% endnote %} @@ -83,7 +83,7 @@ If an [ACL](../../concepts/acl.md) has been set for an object, it will be comple **Setting up individual permissions** - 1. To grant ACL permissions to a {{ yandex-cloud }} user, service account, or user group, get their ID: + 1. To grant ACL permissions to a {{ yandex-cloud }} user, service account, or user group, get their IDs: * [User](../../../iam/operations/users/get.md). @@ -178,7 +178,7 @@ If an [ACL](../../concepts/acl.md) has been set for an object, it will be comple terraform apply ``` - 1. Confirm the changes: type `yes` into the terminal and click **Enter**. + 1. Confirm the changes: type `yes` into the terminal and press **Enter**. You can check the security group update in the [management console]({{ link-console-main }}). diff --git a/en/storage/operations/objects/edit-object-lock.md b/en/storage/operations/objects/edit-object-lock.md index 301a912de1d..796c4c0da0e 100644 --- a/en/storage/operations/objects/edit-object-lock.md +++ b/en/storage/operations/objects/edit-object-lock.md @@ -42,7 +42,7 @@ To put or configure a retention: * `GOVERNANCE`: Temporary managed lock. You cannot set this type if an object version is already locked in compliance mode. * `COMPLIANCE`: Temporary strict lock. - * `RetainUntilDate`: Lock end date and time in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format, e.g., `2025-01-01T00:00:00`. The lock end time value is specified in the [UTC±00:00](https://en.wikipedia.org/wiki/UTC%2B00:00) time zone. To use a different time zone, add `+` or `-` and a UTC±00:00 offset to the end of the record. For more information, see [this example](#example-lock). If a version object is already locked in compliance mode, you can only extend it by setting new retain until date and time that are later than the current ones. + * `RetainUntilDate`: Lock end date and time in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format. For example: `2025-01-01T00:00:00`. The lock end time value is specified in the [UTC±00:00](https://en.wikipedia.org/wiki/UTC%2B00:00) time zone. To use a different time zone, add `+` or `-` and a UTC±00:00 offset to the end of the record. For more information, see [this example](#example-lock). If a version object is already locked in compliance mode, you can only extend it by setting new retain until date and time that are later than the current ones. * `--bypass-governance-retention`: Flag that shows that a lock is bypassed. Select it if an object version is already locked in governance mode. diff --git a/en/storage/operations/objects/upload.md b/en/storage/operations/objects/upload.md index 3bb2e140ead..a5e5d795943 100644 --- a/en/storage/operations/objects/upload.md +++ b/en/storage/operations/objects/upload.md @@ -42,7 +42,7 @@ You can use [tools](../../tools/index.md) that support {{ objstorage-name }} and ```bash aws --endpoint-url=https://{{ s3-storage-host }}/ \ - s3 cp / s3:/// + s3 cp s3:/// ``` Where: diff --git a/en/storage/pricing.md b/en/storage/pricing.md index dc1011f9784..f7c7ee067b5 100644 --- a/en/storage/pricing.md +++ b/en/storage/pricing.md @@ -27,7 +27,7 @@ The {{ objstorage-name }} usage cost is based on: ### Using storage {#rules-storage} -Storage usage is measured in GB per month. The volume of data stored during a month is taken as the month's average based on granulated per-second data. The minimum billing unit is **1 hour of storing 1 MB of data**. +Storage usage is measured in GB per month. The volume of data stored during a month is taken as the month's average based on granulated per-second data. The minimum billing unit is 1 hour of storing 1 MB of data. ### Performing operations with data {#rules-operations} @@ -62,7 +62,7 @@ Here is an example of proportional calculation. Let's assume a user stores 15 GB Storage_price = Price_per_GB_per_month × 15 × 12 / 24 / 30 ``` -^2^ The first 1 GB of data stored in regular storage per month is free of charge. +^2^ The first 1 GB of data in standard storage per month is free of charge. @@ -125,4 +125,4 @@ The first 100 GB of outgoing traffic per month for {{ objstorage-name }} are fre - {% include [usd-egress](../_pricing_examples/storage/usd-egress.md) %} +{% include [usd-egress](../_pricing_examples/storage/usd-egress.md) %} diff --git a/en/storage/quickstart.md b/en/storage/quickstart.md index d873692a02b..fe645ba133a 100644 --- a/en/storage/quickstart.md +++ b/en/storage/quickstart.md @@ -5,7 +5,7 @@ description: Follow this guide to create a bucket and upload an object to it usi # Getting started with {{ objstorage-full-name }} -In this section, you will learn how to use the service via the {{ yandex-cloud }} management console. For guidelines on using the AWS CLI, see [{#T}](./quickstart/quickstart-aws-cli.md). +In this section, you will learn how to use {{ objstorage-full-name }} via the {{ yandex-cloud }} management console. For instructions on how to use the AWS CLI, see [{#T}](./quickstart/quickstart-aws-cli.md). To get started with {{ objstorage-name }}: @@ -25,26 +25,26 @@ To get started with {{ objstorage-name }}: To create your first bucket in {{ objstorage-name }}: -1. In the [management console]({{ link-console-main }}), select the folder where you want to create a bucket. -1. Click **{{ ui-key.yacloud.iam.folder.dashboard.button_add }}** and select **{{ ui-key.yacloud.iam.folder.dashboard.value_storage }}**. +1. In the [management console]({{ link-console-main }}), select the folder you want to create a bucket in. +1. Click **{{ ui-key.yacloud.iam.folder.dashboard.button_add }}** and select ![bucket](../_assets/storage/bucket.svg) **{{ ui-key.yacloud.iam.folder.dashboard.value_storage }}**. 1. Enter the name of the bucket. - The bucket name must be unique across {{ objstorage-name }}. It is used as part of the data access URL and is visible to your data users. + The bucket name must be unique across {{ objstorage-name }}. It is used as part of the data access URL and is visible to your data users. 1. Limit the maximum bucket size, if required. - {% include [storage-no-max-limit](_includes_service/storage-no-max-limit.md) %} + {% include [storage-no-max-limit](_includes_service/storage-no-max-limit.md) %} -1. For the files you upload to be always accessible from outside of {{ yandex-cloud }}, select the public [access type](concepts/bucket.md#bucket-access). +1. If you want the files you upload to be always accessible from outside of {{ yandex-cloud }}, configure public [access](concepts/bucket.md#bucket-access). - {% include [public-access-warning](../_includes/storage/security/public-access-warning.md) %} + {% include [public-access-warning](../_includes/storage/security/public-access-warning.md) %} - In a bucket with restricted access, you can also make the uploaded files accessible with the help of [temporary links](./concepts/pre-signed-urls.md). + In a bucket with restricted access, you can also make the uploaded files accessible with the help of [temporary links](./concepts/pre-signed-urls.md). 1. Choose the default [storage class](concepts/storage-class.md) to be used when uploading objects: - * _Standard storage_ is designed for storing frequently used objects. - * _Cold storage_ is designed for long-term storage of objects that are rarely read. - * _Ice storage_ is designed for storing objects that are very rarely read for one year and longer. -1. Click **{{ ui-key.yacloud.storage.buckets.button_create }}** to complete the operation. + * _Standard storage_ is designed for storing frequently used objects. + * _Cold storage_ is designed for long-term storage of objects that are rarely read. + * _Ice storage_ is designed for objects you need to store for at least one year and which rarely get read requests. +1. Click **{{ ui-key.yacloud.storage.buckets.button_create }}**. ## Uploading files to a bucket {#upload-files} @@ -53,7 +53,7 @@ To upload an object to a bucket: 1. In the [management console]({{ link-console-main }}), select the folder. 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_storage }}**. 1. Click the name of the bucket you need. -1. To upload files to the bucket, drag them to the bucket screen or click **{{ ui-key.yacloud.storage.bucket.button_upload }}**. +1. To upload files to the bucket, drag them to the bucket screen or click ![bucket](../_assets/storage/upload.svg) **{{ ui-key.yacloud.storage.bucket.button_upload }}** and confirm the upload of the files. ## Getting a file download link {#get-link} diff --git a/en/storage/quickstart/quickstart-aws-cli.md b/en/storage/quickstart/quickstart-aws-cli.md index 14c4d76f117..e9fb2a75b49 100644 --- a/en/storage/quickstart/quickstart-aws-cli.md +++ b/en/storage/quickstart/quickstart-aws-cli.md @@ -23,7 +23,7 @@ To get started with the AWS CLI: - Management console {#console} 1. Go to the [management console]({{ link-console-main }}) and log in to {{ yandex-cloud }} or sign up if not signed up yet. - 1. On the [**{{ ui-key.yacloud.billing.label_service }}**]({{ link-console-billing }}) page, make sure you have a [billing account](../../billing/concepts/billing-account.md) linked and it has the `ACTIVE` or `TRIAL_ACTIVE` status. If you do not have a billing account, [create one](../../billing/quickstart/index.md#create_billing_account). + 1. On the [**{{ ui-key.yacloud_billing.billing.label_service }}**]({{ link-console-billing }}) page, make sure you have a [billing account](../../billing/concepts/billing-account.md) linked and it has the `ACTIVE` or `TRIAL_ACTIVE` status. If you do not have a billing account, [create one](../../billing/quickstart/index.md#create_billing_account). 1. On the [{{ ui-key.yacloud.common.resource-acl.label_access-bindings }}]({{ link-console-access-management }}) page, make sure you have the following _minimum_ roles: * To create a [service account](../../iam/concepts/users/service-accounts.md) and get access keys for it: [iam.serviceAccounts.admin](../../iam/roles-reference.md#iam-serviceAccounts-admin) for a [folder](../../resource-manager/concepts/resources-hierarchy.md#folder). If you want to use an existing service account, the `iam.serviceAccounts.admin` role for that service account will be enough. * To assign a role to a service account: [storage.admin](../../storage/security/index.md#storage-admin) for a bucket or folder. @@ -91,7 +91,7 @@ To get started with the AWS CLI: 1. In the terminal, run this command: ```bash - curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip" + curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" --output "awscliv2.zip" unzip awscliv2.zip sudo ./aws/install ``` @@ -103,7 +103,7 @@ To get started with the AWS CLI: 1. In the terminal, run this command: ```bash - curl "https://awscli.amazonaws.com/AWSCLIV2.pkg" -o "AWSCLIV2.pkg" + curl "https://awscli.amazonaws.com/AWSCLIV2.pkg" --output "AWSCLIV2.pkg" sudo installer -pkg AWSCLIV2.pkg -target / ``` @@ -130,7 +130,7 @@ To get started with the AWS CLI: aws configure ``` - 1. Enter the values for the parameters: + 1. Enter the values for these parameters: * `AWS Access Key ID`: Previously obtained static key ID. * `AWS Secret Access Key`: Previously obtained secret key. @@ -145,7 +145,7 @@ To get started with the AWS CLI: {% include [store-aws-key-in-lockbox](../../_includes/storage/store-aws-key-in-lockbox.md) %} - 1. Set a {{ objstorage-name }} endpoint: + 1. Set the {{ objstorage-name }} endpoint: ```bash aws configure set endpoint_url https://{{ s3-storage-host }}/ @@ -218,7 +218,7 @@ Give consideration to the [special aspects](../tools/aws-cli.md#specifics) of us In the terminal, run the command below stating the bucket name, object key, and link lifetime in seconds: ```bash - aws s3 presign s3:/// --expires-in + aws s3 presign s3:/// --expires-in ``` You can share the received link or use it in your service to access the file. diff --git a/en/storage/release-notes.md b/en/storage/release-notes.md index dd1907e697a..4978f89d11a 100644 --- a/en/storage/release-notes.md +++ b/en/storage/release-notes.md @@ -7,14 +7,14 @@ description: This section contains {{ objstorage-name }} release notes. ## Q2 2024 {#q2-2024} -Improved the management console design: bucket settings are now grouped under ![image](../_assets/console-icons/wrench.svg) **{{ ui-key.yacloud.storage.bucket.switch_settings }}** and ![image](../_assets/console-icons/persons-lock.svg) **{{ ui-key.yacloud.storage.bucket.switch_security }}**. +Improved the management console design: bucket settings are now grouped under the ![image](../_assets/console-icons/wrench.svg) **{{ ui-key.yacloud.storage.bucket.switch_settings }}** and ![image](../_assets/console-icons/persons-lock.svg) **{{ ui-key.yacloud.storage.bucket.switch_security }}** tabs. ## Q1 2024 {#q1-2024} * Improved object [lifecycle](./concepts/lifecycles.md) management in a bucket: * Added support for new filters for grouping objects: [object labels](./concepts/tags.md#object-tags) and the `AND` operator. * Implemented the new filter feature in the management console, YC CLI, {{ TF }}, and for the [tools](./tools/) that support the S3 API. -* Added support for working with [bucket labels](./concepts/tags.md#bucket-tags) in the management console, YC CLI, and {{ TF }}. +* Added support for [bucket labels](./concepts/tags.md#bucket-tags) in the management console, YC CLI, and {{ TF }}. * Implemented adding {{ org-full-name }} [user groups](../organization/concepts/groups.md) to an [access control list (ACL)](./security/acl.md) and a [bucket policy](./security/policy.md) in the management console, YC CLI, and {{ TF }}. * Improved the management console interface: * Added filtering by prefix in the list of bucket objects. diff --git a/en/storage/s3/api-ref/bucket/deletebuckettagging.md b/en/storage/s3/api-ref/bucket/deletebuckettagging.md index 5772cd98ef8..71b440eea31 100644 --- a/en/storage/s3/api-ref/bucket/deletebuckettagging.md +++ b/en/storage/s3/api-ref/bucket/deletebuckettagging.md @@ -32,7 +32,7 @@ Use [common request headers](../common-request-headers.md) in your requests. ### Headers {#response-headers} -Responses can only contain [common response headers](../common-response-headers.md). +Responses can only contain [common headers](../common-response-headers.md). ### Response codes {#response-codes} diff --git a/en/storage/s3/api-ref/bucket/getBucketLogging.md b/en/storage/s3/api-ref/bucket/getBucketLogging.md index 64579642071..ed217a2068b 100644 --- a/en/storage/s3/api-ref/bucket/getBucketLogging.md +++ b/en/storage/s3/api-ref/bucket/getBucketLogging.md @@ -31,7 +31,7 @@ Use [common request headers](../common-request-headers.md) in your requests. ### Headers {#response-headers} -Responses can only contain [common response headers](../common-response-headers.md). +Responses can only contain [common headers](../common-response-headers.md). ### Response codes {#response-codes} diff --git a/en/storage/s3/api-ref/bucket/getbuckettagging.md b/en/storage/s3/api-ref/bucket/getbuckettagging.md index b95f36ba245..16fd3ed485e 100644 --- a/en/storage/s3/api-ref/bucket/getbuckettagging.md +++ b/en/storage/s3/api-ref/bucket/getbuckettagging.md @@ -32,7 +32,7 @@ Use [common request headers](../common-request-headers.md) in your requests. ### Headers {#response-headers} -Responses can only contain [common response headers](../common-response-headers.md). +Responses can only contain [common headers](../common-response-headers.md). ### Response codes {#response-codes} diff --git a/en/storage/s3/api-ref/bucket/listObjectVersions.md b/en/storage/s3/api-ref/bucket/listObjectVersions.md index 4c437108207..1f0fa9b6ff0 100644 --- a/en/storage/s3/api-ref/bucket/listObjectVersions.md +++ b/en/storage/s3/api-ref/bucket/listObjectVersions.md @@ -26,18 +26,18 @@ Parameter | Description `delimiter` | Delimiter character.

If this parameter is specified, {{ objstorage-name }} interprets the key as the path to the file with folders separated by the `delimiter` character. In the response to the request, the user will get a list of files and folders in the bucket. Files will be output in the `Contents` elements, and folders in the `CommonPrefixes` elements.

If the request also specifies the `prefix` parameter, {{ objstorage-name }} will return the list of files and folders in the folder named `prefix`. `encoding-type` | Encoding of server response.

{{ objstorage-name }} can encode responses in the format requested by the client.

Possible values: `url`. `key-marker` | Key to start the output from.

In the resulting output, {{ objstorage-name }} will leave the keys starting from the one following `key-marker`. -`max-keys` | Maximum number of elements in a response.

By default, {{ objstorage-name }} outputs no more than 1,000 `Contents` and `CommonPrefixes` elements. Use this parameter if you need less than 1,000 elements in a single response.

If the selection criteria are met by more keys than can fit into the output, the response contains `true`.

To get all output elements if their number exceeds `max-keys`, run multiple requests to {{ objstorage-name }} with the `key-marker` parameter, where `key-marker` and `version-id-marker` of each request is equal to the value of the `NextKeyMarker` and `NextVersionIdMarker` elements in the previous response. -`prefix` | String to start the key from.

{{ objstorage-name }} selects only those keys which start with `prefix`.

You can use this parameter along with `delimiter`. In this case, the output logic is the same as that specified in the `delimiter` parameter description. +`max-keys` | Maximum number of elements in a response.

By default, {{ objstorage-name }} outputs no more than 1,000 `Contents` and `CommonPrefixes` elements. Use this parameter if you need less than 1,000 elements in a single response.

If the selection criteria are met by more keys than can fit into the output, the response contains `true`.

To get all the output elements if their number exceeds `max-keys`, run multiple consecutive requests to {{ objstorage-name }} with the `key-marker` parameter, where the `key-marker` and `version-id-marker` of each request are equal to the values of the `NextKeyMarker` and `NextVersionIdMarker` elements in the previous response. +`prefix` | String to start the key from.

{{ objstorage-name }} selects only those keys which start with `prefix`.

You can use this parameter at the same time with `delimiter`. In this case, the output logic is the same as that specified in the `delimiter` parameter description. `version-id-marker` | Object version to start the output from.

In the resulting output, {{ objstorage-name }} will leave the versions starting from the one following `version-id-marker`. ### Headers {#request-headers} -Use only [common request headers](../common-request-headers.md) in your requests. +Use only [common headers](../common-request-headers.md) in your requests. ## Response {#response} ### Headers {#response-headers} -Responses can only contain [common response headers](../common-response-headers.md). +Responses can only contain [common headers](../common-response-headers.md). ### Response codes {#response-codes} @@ -98,7 +98,7 @@ Element | Description `CommonPrefixes` | Key name part identified when processing the `delimiter` and `prefix` query parameters.

Path: `/ListVersionsResult/CommonPrefixes`. `DeleteMarker` | Container for an object that is a delete marker.

Path: `/ListVersionsResult/DeleteMarker`. `Delimiter` | Value of the `delimiter` query parameter.

Path: `/ListVersionsResult/Delimiter`. -`EncodingType` | Encoding used by {{ objstorage-name }} to provide a key in an XML response.

Appears if the client provided the `encoding-type` parameter in the request.

Path: `/ListVersionsResult/EncodingType`. +`EncodingType` | Encoding used by {{ objstorage-name }} to provide a key in an XML response.

You will get this tag if the client provided the `encoding-type` parameter in the request.

Path: `/ListVersionsResult/EncodingType`. `IsTruncated` | Marker indicating that a list is incomplete.

If `IsTruncated` is `true`, this means {{ objstorage-name }} returned an incomplete list of parts.

Path: `/ListVersionsResult/IsTruncated`. `KeyMarker` | The last key returned in the incomplete response.

Path: `/ListVersionsResult/KeyMarker`. `MaxKeys` | Value of the `max-keys` query parameter.

Path: `/ListBucketResult/MaxKeys`. diff --git a/en/storage/s3/api-ref/bucket/listobjects.md b/en/storage/s3/api-ref/bucket/listobjects.md index 98346e36167..2662765f32e 100644 --- a/en/storage/s3/api-ref/bucket/listobjects.md +++ b/en/storage/s3/api-ref/bucket/listobjects.md @@ -38,21 +38,21 @@ All parameters listed in the table are optional. Parameter | Description ----- | ----- -`continuation-token` | Used to get the next part of the list if all results do not fit in a single response.
To get the next part of the list, use the `NextContinuationToken` value from the previous response. -`delimiter` | Delimiter character.

If this parameter is specified, {{ objstorage-name }} interprets the key as the path to the file with folders separated by the `delimiter` character. In response to the request, the user gets a list of files and folders in the bucket. Files will be output in the `Contents` elements, and folders, in the `CommonPrefixes` elements.

If the request also specifies the `prefix` parameter, {{ objstorage-name }} will return the list of files and folders in the folder named `prefix`. -`encoding-type` | Encoding of server response.

{{ objstorage-name }} can encode responses in the format requested by the client.

Possible values: `url`. -`max-keys` | Maximum number of elements in a response.

By default, {{ objstorage-name }} outputs no more than 1,000 `Contents` and `CommonPrefixes` elements. Use this parameter if you need less than 1,000 elements in a single response.

If the selection criteria are met by more keys than can fit into the output, the response contains `true`.

To get all output elements if their number exceeds `max-keys`, run multiple requests to {{ objstorage-name }} with the `continuation-token` parameter, where the `continuation-token` of each request is equal to the value of the `NextContinuationToken` element in the previous response. -`prefix` | String to start the key from.

{{ objstorage-name }} selects only those keys which start with `prefix`.

You can use this parameter along with `delimiter`. In this case, the output logic is determined by the `delimiter` parameter. +`continuation-token` | Use this parameter to get the next part of the list if all results do not fit in a single response.
To get the next part of the list, use the `NextContinuationToken` value from the previous response. +`delimiter` | Delimiter character.

If this parameter is specified, {{ objstorage-name }} interprets the key as the path to the file with folders separated by the `delimiter` character. In response to the request, the user will get a list of files and folders in the bucket. Files will be output in the `Contents` elements, and folders, in the `CommonPrefixes` elements.

If the request also specifies the `prefix` parameter, {{ objstorage-name }} will return a list of files and folders in the `prefix` folder. +`encoding-type` | Encoding of server responses.

{{ objstorage-name }} can encode responses in the format requested by the client.

Possible values: `url`. +`max-keys` | Maximum number of elements in a response.

By default, {{ objstorage-name }} outputs no more than 1,000 `Contents` and `CommonPrefixes` elements. Use this parameter if you need fewer than 1,000 elements in a single response.

If the selection criteria are met by more keys than can fit into the output, the response will contain `true`.

To get all the output elements if their number exceeds `max-keys`, run multiple requests to {{ objstorage-name }} with the `continuation-token` parameter, where the `continuation-token` of each request is equal to the value of the `NextContinuationToken` element in the previous response. +`prefix` | String to start the key from.

{{ objstorage-name }} selects only those keys which start with `prefix`.

You can use this parameter at the same time with `delimiter`. In this case, the output logic is determined by the `delimiter` parameter. `start-after` | Key to start the listing from. #### Headers {#request-headersV2} -Use only [common request headers](../common-request-headers.md) in your requests. +Use only [common headers](../common-request-headers.md) in your requests. ### Response {#responseV2} #### Headers {#response-headersV2} -Responses can only contain [common response headers](../common-response-headers.md). +Responses can only contain [common headers](../common-response-headers.md). #### Response codes {#response-codesV2} @@ -97,7 +97,7 @@ Element | Description `Contents` | Object description.

The response contains as many `Contents` elements as there are keys that meet the request criteria.

Path: `/ListBucketResult/Contents`. `ETag` | MD5 hash of the object. No metadata is included in the hash value calculation.

Path: `/ListBucketResult/Contents/ETag`. `Key` | Object key.

Path: `/ListBucketResult/Contents/Key`. -`LastModified` | Object’s last update date.

Path: `/ListBucketResult/Contents/LastModified`. +`LastModified` | Date and time when the object was last modified.

Path: `/ListBucketResult/Contents/LastModified`. `Size` | Object size in bytes.

Path: `/ListBucketResult/Contents/Size`. `StorageClass` | Object [storage class](../../../concepts/storage-class.md): `STANDARD`, `COLD`, or `ICE`.

Path: `/ListBucketResult/Contents/StorageClass`. `Name` | Bucket name.

Path: `/ListBucketResult/Name`. @@ -105,7 +105,7 @@ Element | Description `Delimiter` | Value of the `delimiter` query parameter.

Path: `/ListBucketResult/Delimiter`. `MaxKeys` | Value of the `max-keys` query parameter.

Path: `/ListBucketResult/MaxKeys`. `CommonPrefixes` | Key name part identified when processing the `delimiter` and `prefix` query parameters.

Path: `/ListBucketResult/CommonPrefixes`. -`EncodingType` | Encoding used by {{ objstorage-name }} to provide a key in an XML response.

Appears if the client provided the `encoding-type` parameter in the request.

Path: `/ListBucketResult/EncodingType`. +`EncodingType` | Encoding used by {{ objstorage-name }} to provide a key in an XML response.

You will get this tag if the client provided the `encoding-type` parameter in the request.

Path: `/ListBucketResult/EncodingType`. `KeyCount` | Number of keys the request returns.
The number of keys is always less than or equal to `MaxKeys`.

Path: `/ContinuationToken/KeyCount`. `ContinuationToken` | Value of the `continuation-token` query parameter.

Path: `/ContinuationToken/ContinuationToken`. `NextContinuationToken` | Value to insert in the `continuation-token` query parameter to get the next part of the list if the entire list does not fit in the current response.
It is returned only in case `IsTruncated = true`.

Path: `/ListBucketResult/NextContinuationToken`. @@ -131,20 +131,20 @@ All parameters listed in the table are optional. Parameter | Description ----- | ----- -`delimiter` | Delimiter character.

If this parameter is specified, {{ objstorage-name }} interprets the key as the path to the file with folders separated by the `delimiter` character. In response to the request, the user gets a list of files and folders in the bucket. Files will be output in the `Contents` elements, and folders in the `CommonPrefixes` elements.

If the request also specifies the `prefix` parameter, {{ objstorage-name }} will return the list of files and folders in the folder named `prefix`. -`encoding-type` | Encoding of server response.

{{ objstorage-name }} can encode responses in the format requested by the client.

Possible values: `url`. +`delimiter` | Delimiter character.

If this parameter is specified, {{ objstorage-name }} interprets the key as the path to the file with folders separated by the `delimiter` character. In response to the request, the user will get a list of files and folders in the bucket. Files will be output in the `Contents` elements, and folders, in the `CommonPrefixes` elements.

If the request also specifies the `prefix` parameter, {{ objstorage-name }} will return a list of files and folders in the `prefix` folder. +`encoding-type` | Encoding of server responses.

{{ objstorage-name }} can encode responses in the format requested by the client.

Possible values: `url`. `marker` | Key to start the output from.

In the resulting output, {{ objstorage-name }} will leave the keys starting from the one following `marker`. -`max-keys` | Maximum number of elements in a response.

By default, {{ objstorage-name }} outputs no more than 1,000 `Contents` and `CommonPrefixes` elements. Use this parameter if you need less than 1,000 elements in a single response.

If the selection criteria are met by more keys than can fit into the output, the response contains `true`.

To get all output elements if their number exceeds `max-keys`, run multiple requests to {{ objstorage-name }} with the `marker` parameter, where the `marker` of each request is equal to the value of the `NextMarker` element in the previous response. -`prefix` | String to start the key from.

{{ objstorage-name }} selects only those keys which start with `prefix`.

You can use this parameter along with `delimiter`. In this case, the output logic is determined by the `delimiter` parameter. +`max-keys` | Maximum number of elements in a response.

By default, {{ objstorage-name }} outputs no more than 1,000 `Contents` and `CommonPrefixes` elements. Use this parameter if you need fewer than 1,000 elements in a single response.

If the selection criteria are met by more keys than can fit into the output, the response will contain `true`.

To get all the output elements if their number exceeds `max-keys`, run multiple requests to {{ objstorage-name }} with the `marker` parameter, where the `marker` of each request is equal to the value of the `NextMarker` element in the previous response. +`prefix` | String to start the key from.

{{ objstorage-name }} selects only those keys which start with `prefix`.

You can use this parameter at the same time with `delimiter`. In this case, the output logic is determined by the `delimiter` parameter. #### Headers {#request-headersV1} -Use only [common request headers](../common-request-headers.md) in your requests. +Use only [common headers](../common-request-headers.md) in your requests. ### Response {#responseV1} #### Headers {#response-headersV1} -Responses can only contain [common response headers](../common-response-headers.md). +Responses can only contain [common headers](../common-response-headers.md). #### Response codes {#response-codesV1} @@ -189,7 +189,7 @@ Element | Description `Contents` | Object description.

The response contains as many `Contents` elements as there are keys that meet the request criteria.

Path: `/ListBucketResult/Contents`. `ETag` | MD5 hash of the object. No metadata is included in the hash value calculation.

Path: `/ListBucketResult/Contents/ETag`. `Key` | Object key.

Path: `/ListBucketResult/Contents/Key`. -`LastModified` | Object’s last update date.

Path: `/ListBucketResult/Contents/LastModified`. +`LastModified` | Date and time when the object was last modified.

Path: `/ListBucketResult/Contents/LastModified`. `Size` | Object size in bytes.

Path: `/ListBucketResult/Contents/Size`. `StorageClass` | Object [storage class](../../../concepts/storage-class.md): `STANDARD`, `COLD`, or `ICE`.

Path: `/ListBucketResult/Contents/StorageClass`. `Name` | Bucket name.

Path: `/ListBucketResult/Name`. @@ -197,6 +197,6 @@ Element | Description `Delimiter` | Value of the `delimiter` query parameter.

Path: `/ListBucketResult/Delimiter`. `MaxKeys` | Value of the `max-keys` query parameter.

Path: `/ListBucketResult/MaxKeys`. `CommonPrefixes` | Key name part identified when processing the `delimiter` and `prefix` query parameters.

Path: `/ListBucketResult/CommonPrefixes`. -`EncodingType` | Encoding used by {{ objstorage-name }} to provide a key in an XML response.

Appears if the client provided the `encoding-type` parameter in the request.

Path: `/ListBucketResult/EncodingType`. +`EncodingType` | Encoding used by {{ objstorage-name }} to provide a key in an XML response.

You will get this tag if the client provided the `encoding-type` parameter in the request.

Path: `/ListBucketResult/EncodingType`. {% include [the-s3-api-see-also-include](../../../../_includes/storage/the-s3-api-see-also-include.md) %} \ No newline at end of file diff --git a/en/storage/s3/api-ref/hosting/upload.md b/en/storage/s3/api-ref/hosting/upload.md index 1049f8d1c4f..2fd4f07227b 100644 --- a/en/storage/s3/api-ref/hosting/upload.md +++ b/en/storage/s3/api-ref/hosting/upload.md @@ -53,7 +53,7 @@ You can configure a bucket: Element | Description ----- | ----- `WebsiteConfiguration` | Top-level header of the website description. - `IndexDocument/Suffix` | Website home page.

Path: `/WebsiteConfiguration/IndexDocument/Suffix`. + `IndexDocument/Suffix` | Home page of the website.

Path: `/WebsiteConfiguration/IndexDocument/Suffix`. `ErrorDocument/Key` | Document the user sees in case of `4xx` errors.

Path: `/WebsiteConfiguration/ErrorDocument/Key`. - To redirect all requests @@ -75,7 +75,7 @@ You can configure a bucket: Element | Description ----- | ----- `WebsiteConfiguration` | Top-level header of the website description. - `RedirectAllRequestsTo` | It contains a redirect configuration for all requests.

Path: `/WebsiteConfiguration/RedirectAllRequestsTo`. + `RedirectAllRequestsTo` | Contains configuration for redirecting all requests.

Path: `/WebsiteConfiguration/RedirectAllRequestsTo`. `HostName` | Host to which all requests to the bucket are redirected.

Path: `/WebsiteConfiguration/RedirectAllRequestsTo/HostName`. `Protocol` | Protocol used for redirects: `http` or `https`. This is an optional parameter.

Path: `/WebsiteConfiguration/RedirectAllRequestsTo/Protocol`. @@ -115,10 +115,10 @@ You can configure a bucket: `RoutingRules` | `RoutingRule` container.
It must include at least one rule. `RoutingRule` | Routing rule.
It defines the conditions and conditional redirects. `Condition` | Container of conditions to trigger the redirect.
If a routing rule does not contain any conditions, all requests are redirected.
The container must include at least one rule. - `KeyPrefixEquals` | The condition sets the name prefix for the object the requests are redirected from.
`KeyPrefixEquals` is required if `HttpErrorCodeReturnedEquals` is not set. If `KeyPrefixEquals` and `HttpErrorCodeReturnedEquals` are set, the condition is met when both the parameters are `true`. - `HttpErrorCodeReturnedEquals` | The condition specifies the error code that triggers a redirect.
`HttpErrorCodeReturnedEquals` is required if `KeyPrefixEquals` is not set. If `KeyPrefixEquals` and `HttpErrorCodeReturnedEquals` are set, the condition is met when both the parameters are `true`. + `KeyPrefixEquals` | This condition sets the name prefix for the object the requests are redirected from.
`KeyPrefixEquals` is required if `HttpErrorCodeReturnedEquals` is not set. If `KeyPrefixEquals` and `HttpErrorCodeReturnedEquals` are set, the condition is met when both the parameters are `true`. + `HttpErrorCodeReturnedEquals` | This condition specifies the error code that triggers a redirect.
`HttpErrorCodeReturnedEquals` is required if `KeyPrefixEquals` is not set. If `KeyPrefixEquals` and `HttpErrorCodeReturnedEquals` are set, the condition is met when both the parameters are `true`. `Redirect` | Redirect container.
You can redirect a request to a different page, different host, or change the protocol.
`RoutingRule` must contain at least one `Redirect` element.
A redirect must contain at least one of the following elements: `Protocol`, `HostName`, `ReplaceKeyPrefixWith`, `ReplaceKeyWith`, or `HttpRedirectCode`. - `Protocol` | In the `Location` response header, the redirect indicates the protocol to use (`http` or `https`).
This parameter is optional if other redirects apply. + `Protocol` | In the `Location` header of the response, a redirect indicates which protocol, `http` or `https`, should be used.
This parameter is optional if other redirects apply. `HostName` | In the `Location` response header, the redirect indicates the host name to use.
This parameter is optional if other redirects apply. `ReplaceKeyPrefixWith` | The redirect specifies the object key name prefix to replace the `KeyPrefixEquals` value in the redirect request.
It is incompatible with `ReplaceKeyWith`.
This parameter is optional if other redirects apply. `ReplaceKeyWith` | The redirect specifies the object key to use in the `Location` header.
It is incompatible with `ReplaceKeyPrefixWith`.
This parameter is optional if other redirects apply. @@ -130,7 +130,7 @@ You can configure a bucket: ### Headers {#response-headers} -Responses can only contain [common response headers](../common-response-headers.md). +Responses can only contain [common headers](../common-response-headers.md). ### Response codes {#response-codes} diff --git a/en/storage/s3/api-ref/object/copy.md b/en/storage/s3/api-ref/object/copy.md index 0e0a9e0cf16..dd6200bf3db 100644 --- a/en/storage/s3/api-ref/object/copy.md +++ b/en/storage/s3/api-ref/object/copy.md @@ -1,4 +1,4 @@ -# copy method +# Copy method Creates a copy of an object stored in {{ objstorage-name }}. Objects up to 5 GB can be copied with a single `copy` operation. For objects larger than 5 GB, use the [copyPart](../multipart/copypart.md) operation. @@ -42,7 +42,7 @@ Required headers are listed in the table below. Header | Description ----- | ----- -`X-Amz-Copy-Source` | The name of the bucket and the key of the object to copy, separated by the `/` character.

E.g., `X-Amz-Copy-Source: /source_bucket/sourceObject`.

If the bucket has [versioning](../../../../storage/concepts/versioning.md) enabled, you can copy a specific version of the object. To do this, specify the object version ID in the header by adding `?versionId=` to the header value, e.g., `/mybucket/image.png?versionId=0005E4A66AD990A4`. If you do not specify a version ID, the most recent version of the object will be copied. +`X-Amz-Copy-Source` | The name of the bucket and the key of the object to copy, separated by the `/` character.

Example: `rc1b-cfazv1db********.{{ dns-zone }} port=6432`.

If the bucket has [versioning](../../../../storage/concepts/versioning.md) enabled, you can copy a specific version of the object. To do this, specify the object version ID in the header by adding `?versionId=` to the header value, e.g., `/mybucket/image.png?versionId=0005E4A66AD990A4`. If you do not specify a version ID, the most recent version of the object will be copied. Make sure to also use the required [common request headers](../common-request-headers.md). @@ -51,7 +51,7 @@ Use the headers from the table below if you need to change the way the `copy` me Header | Description ----- | ----- -`X-Amz-Metadata-Directive` | Metadata copying mode.

If the header value is `COPY`, the object metadata is copied and all `X-Amz-Meta-*` headers are ignored. This is how the `copy` method works by default.

If the header value is `REPLACE`, the object metadata is replaced with that provided in the request.

The `X-Amz-Storage-Class` header is not copied; you have to add it to the request manually, if requied. +`X-Amz-Metadata-Directive` | Metadata copying mode.

If the header value is `COPY`, the object metadata is copied and all `X-Amz-Meta-*` headers are ignored. This is how the `copy` method works by default.

If the header value is `REPLACE`, the object metadata is replaced with that provided in the request.

The `X-Amz-Storage-Class` header is not copied; you have to add it to the request manually, if required. `X-Amz-Copy-Source-If-Match` | Object copying condition.

If `ETag` of an object is the same as in the header, the object is copied.

If the condition is not met, {{ objstorage-name }} returns the 412 error.

You can use it with the `X-Amz-Copy-Source-If-Unmodified-Since` header. `X-Amz-Copy-Source-If-None-Match` | Object copying condition.

If `ETag` of an object is not the same as in the header, the object is copied.

If the condition is not met, {{ objstorage-name }} returns the 412 error.

You can use it with the `X-Amz-Copy-Source-If-Modified-Since` header. `X-Amz-Copy-Source-If-Unmodified-Since` | Object copying condition.

The object is copied if it has not been modified since the specified time.

If the condition is not met, {{ objstorage-name }} returns the 412 error.

You can use it with the `X-Amz-Copy-Source-If-Match` header. @@ -62,7 +62,7 @@ Header | Description `X-Amz-Object-Lock-Mode` |

Type of [retention](../../../concepts/object-lock.md) put on the object (if the bucket is [versioned](../../../concepts/versioning.md) and object lock is enabled in it):

  • `GOVERNANCE`: Object lock with governance-mode retention.
  • `COMPLIANCE`: Object lock with compliance-mode retention.

For an object version, you can use only retention (`X-Amz-Object-Lock-Mode` and `X-Amz-Object-Lock-Retain-Until-Date` headers), only legal hold (`X-Amz-Object-Lock-Legal-Hold`), or both at the same time. For more information about their combined use, see [{#T}](../../../concepts/object-lock.md#types).

`X-Amz-Object-Lock-Retain-Until-Date` | Date and time of end of retention in any format described in the [HTTP standard](https://www.rfc-editor.org/rfc/rfc9110#name-date-time-formats), e.g., `Mon, 12 Dec 2022 09:00:00 GMT`. Specify it only with the `X-Amz-Object-Lock-Mode` header. `X-Amz-Object-Lock-Legal-Hold` |

Type of [legal hold](../../../concepts/object-lock.md) put on the object (if the bucket is [versioned](../../../concepts/versioning.md) and object lock is enabled in it):

  • `ON`: Enabled.
  • `OFF`: Disabled.

For an object version, you can use only retention (`X-Amz-Object-Lock-Mode` and `X-Amz-Object-Lock-Retain-Until-Date` headers), only legal hold (`X-Amz-Object-Lock-Legal-Hold`), or both at the same time. For more information about their combined use, see [{#T}](../../../concepts/object-lock.md#types).

-`X-Amz-Meta-*` | User-defined object metadata.

{{ objstorage-name }} converts all headers starting with `X-Amz-Meta-` according to the following rule: `X-Amz-Meta-foo-bar_baz` → `X-Amz-Meta-Foo-Bar_baz`.

The total size of user-defined headers must not exceed 2 KB. The size of user-defined data is determined as the length of the UTF-8 encoded string. The header names and their values are included when calculating the size.

With `X-Amz-Metadata-Directive: COPY`, these headers are ignored. +`X-Amz-Meta-*` | User-defined object metadata.

{{ objstorage-name }} сonverts all headers starting with `X-Amz-Meta-` according to the following rule: `X-Amz-Meta-foo-bar_baz` → `X-Amz-Meta-Foo-Bar_baz`.

The total size of user-defined headers must not exceed 2 KB. The size of user-defined data is determined as the length of the UTF-8 encoded string. The header names and their values are included when calculating the size.

With `X-Amz-Metadata-Directive: COPY`, these headers are ignored. @@ -93,6 +93,6 @@ Element | Description ----- | ----- `CopyObjectResult` | It contains response elements.

Path: `/CopyObjectResult`. `ETag` | `ETag` of the resulting object. Since metadata does not count when calculating `ETag`, the source and resulting object `ETag`s must match.>
Path: `/CopyObjectResult/ETag`. -`LastModified` | Object’s last update date.

Path: `/CopyObjectResult/LastModified`. +`LastModified` | Date and time of the object’s last update.

Path: `/CopyObjectResult/LastModified`. {% include [the-s3-api-see-also-include](../../../../_includes/storage/the-s3-api-see-also-include.md) %} \ No newline at end of file diff --git a/en/storage/s3/signing-requests.md b/en/storage/s3/signing-requests.md index f00f94a4357..a876f29ed6b 100644 --- a/en/storage/s3/signing-requests.md +++ b/en/storage/s3/signing-requests.md @@ -11,7 +11,7 @@ The signing process consists of the following stages: 1. [Generating a signing key](#signing-key-gen). 1. [Signing a string with a key](#signing). -Use [HMAC](https://ru.wikipedia.org/wiki/HMAC) with the [SHA256](https://ru.wikipedia.org/wiki/SHA-2) hash function to sign. Many programming languages support relevant methods. The examples assume that there is a `sign(KEY, STRING)` function that encodes the input string with the specified key. +Use [HMAC](https://ru.wikipedia.org/wiki/HMAC) with the [SHA256](https://ru.wikipedia.org/wiki/SHA-2) hash function to sign. Many programming languages support relevant methods. The examples assume the existence of the `sign(KEY, STRING)` function that encodes the input string with the specified key. ## Generate a string to sign {#string-to-sign-gen} @@ -23,6 +23,8 @@ The string to sign (`StringToSign`) depends on the {{ objstorage-name }} usage s ## Generating a signing key {#signing-key-gen} +To generate a signing key, you need static access keys for {{ objstorage-name }}. To learn how to get them, see [Getting started](index.md#before-you-begin). + {% include [generate-signing-key](../../_includes/storage/generate-signing-key.md) %} ## Sign a string with a key {#signing} @@ -39,7 +41,7 @@ To debug the process of generating a [сanonical request](../concepts/pre-signed {% note info %} -Make sure that the service account you are using to run `aws` commands has the permissions to perform the requested actions. For example, to create a bucket, [assign](../../iam/operations/sa/assign-role-for-sa.md) the `storage.editor` [role](../security/index.md#storage-uploader) for the [folder](../../resource-manager/concepts/resources-hierarchy.md#folder) to the service account. For more information, see [{#T}](../security/overview.md). +Make sure that the service account you are using to run `aws` commands has the permissions required to perform the requested actions. For example, to create a bucket, [assign](../../iam/operations/sa/assign-role-for-sa.md) the `storage.editor` [role](../security/index.md#storage-uploader) for the [folder](../../resource-manager/concepts/resources-hierarchy.md#folder) to the service account. For more information, see [{#T}](../security/overview.md). {% endnote %} @@ -47,38 +49,38 @@ Make sure that the service account you are using to run `aws` commands has the p - AWS CLI {#aws-cli} - In the terminal, run the bucket creation command and see how request parameters are generated: + In the terminal, run the bucket creation command and see how request parameters are generated: - ```bash - aws s3api create-bucket \ - --endpoint-url=https://{{ s3-storage-host }} \ - --bucket \ - --debug - ``` + ```bash + aws s3api create-bucket \ + --endpoint-url=https://{{ s3-storage-host }} \ + --bucket \ + --debug + ``` - Result: + Result: - ```text - 2024-06-03 13:02:36,238 - MainThread - botocore.auth - DEBUG - CanonicalRequest: - PUT - / + ```text + 2024-06-03 13:02:36,238 - MainThread - botocore.auth - DEBUG - CanonicalRequest: + PUT + / - host:{{ s3-storage-host }} - x-amz-content-sha256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b******** - x-amz-date:20240603T100236Z + host:{{ s3-storage-host }} + x-amz-content-sha256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b******** + x-amz-date:20240603T100236Z - host;x-amz-content-sha256;x-amz-date - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b******** + host;x-amz-content-sha256;x-amz-date + e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b******** - 2024-06-03 13:02:36,238 - MainThread - botocore.auth - DEBUG - StringToSign: - AWS4-HMAC-SHA256 - 20240603T100236Z - 20240603/{{ region-id }}/s3/aws4_request - 7877a13bafaa45f9751e7f345b64a63acc6de279ff927736e906d7c5******** + 2024-06-03 13:02:36,238 - MainThread - botocore.auth - DEBUG - StringToSign: + AWS4-HMAC-SHA256 + 20240603T100236Z + 20240603/{{ region-id }}/s3/aws4_request + 7877a13bafaa45f9751e7f345b64a63acc6de279ff927736e906d7c5******** - 2024-06-03 13:02:36,238 - MainThread - botocore.auth - DEBUG - Signature: - 90545034742d1e057c8eeb2cca3c23a38a3ced5ef847f61ac80cb8e1******** - ``` + 2024-06-03 13:02:36,238 - MainThread - botocore.auth - DEBUG - Signature: + 90545034742d1e057c8eeb2cca3c23a38a3ced5ef847f61ac80cb8e1******** + ``` {% endlist %} diff --git a/en/storage/toc.yaml b/en/storage/toc.yaml index 0d00071a2d8..71748d4de57 100644 --- a/en/storage/toc.yaml +++ b/en/storage/toc.yaml @@ -133,7 +133,7 @@ items: href: tutorials/opensearch-to-object-storage.md - name: Automatically copying objects from one bucket to another href: tutorials/bucket-to-bucket.md - - name: Regular recognition of audio files in buckets + - name: Regular recognition of audio files in a bucket href: tutorials/batch-recognition-stt.md - name: >- Training a model in {{ ml-platform-full-name }} on data from {{ @@ -169,6 +169,10 @@ items: href: tutorials/gatsby-static-website.md - name: Storing a static access key in a {{ lockbox-name }} secret href: tutorials/static-key-in-lockbox.md + - name: >- + Exporting {{ GP }} data to a cold storage in {{ objstorage-full-name + }} + href: tutorials/greenplum-yezzey.md - name: >- Loading data from {{ yandex-direct }} to a {{ mch-full-name }} data mart using {{ sf-full-name }}, {{ objstorage-full-name }}, and {{ @@ -190,7 +194,7 @@ items: href: tutorials/static/terraform.md - name: Publishing game updates href: tutorials/prefetch.md - - name: Creating a VM backup with Hystax Acura Backup + - name: Backing up a VM with Hystax Acura Backup href: tutorials/hystax-backup.md - name: Backup to {{ objstorage-name }} via CloudBerry Desktop Backup href: tutorials/object-storage-cloudberry.md @@ -228,7 +232,7 @@ items: href: concepts/pre-signed-urls.md - name: Multipart upload href: concepts/multipart.md - - name: Access control lists (ACLs) + - name: Access control list (ACL) href: concepts/acl.md - name: Bucket policy href: concepts/policy.md @@ -302,7 +306,7 @@ items: href: security/overview.md - name: '{{ iam-name }}' href: security/index.md - - name: Access control lists (ACLs) + - name: Access control list (ACL) href: security/acl.md - name: Bucket policy href: security/policy.md diff --git a/en/storage/tools/aws-cli.md b/en/storage/tools/aws-cli.md index 7190679b031..0914a58912c 100644 --- a/en/storage/tools/aws-cli.md +++ b/en/storage/tools/aws-cli.md @@ -19,7 +19,7 @@ To work with {{ objstorage-name }} via the AWS CLI, you can use the following co ## Setup {#setup} -To configure the AWS CLI, run the `aws configure` command in your terminal. The command requests values for the following parameters: +To configure the AWS CLI, run the `aws configure` command in your terminal. The command will request values for the following parameters: 1. `AWS Access Key ID`: ID of the static key created when [getting started](#before-you-begin). 1. `AWS Secret Access Key`: Contents of the static access key. 1. `Default region name`: `{{ region-id }}`. @@ -107,7 +107,7 @@ Give consideration to the special aspects of using the AWS CLI with {{ objstorag {{ storage-aws-cli-alias }} ls ``` -## Example operations {#aws-cli-examples} +## Examples of operations {#aws-cli-examples} {% note info %} @@ -174,7 +174,7 @@ You can upload all objects within a directory, use a filter, or upload objects o ```text upload: ./testfile.txt to s3://bucket-name/path_style_prefix/textfile.txt ``` - + ### Getting a list of objects {#getting-objects-list} ```bash @@ -182,7 +182,6 @@ aws s3 ls --recursive s3://bucket-name ``` Result: - ```text 2022-09-05 17:10:34 10023 other/test1.png 2022-09-05 17:10:34 57898 other/test2.png diff --git a/en/storage/tools/geesefs.md b/en/storage/tools/geesefs.md index 7dacbc3654e..449c2641b8b 100644 --- a/en/storage/tools/geesefs.md +++ b/en/storage/tools/geesefs.md @@ -53,7 +53,7 @@ GeeseFS does not support the following: * ID of the owner of all files and directories in the `--uid` option value. * ID of the group all files and directories belong to in the `--gid` option value. - For example: + Here is an example: ```bash geesefs \ @@ -80,7 +80,7 @@ GeeseFS does not support the following: - Linux {#linux} - 1. Install the utilities required by FUSE, e.g.: + 1. Install the utilities required by FUSE. Here is an example: * Debian, Ubuntu: @@ -242,7 +242,7 @@ When mounting a bucket, you can also configure GeeseFS settings related to syste start=auto ``` - Where `binPath` is the path to the `geesefs.exe` file with the required mounting parameters. For example: `C:\geesefs\geesefs.exe `. + Where `binPath` is the path to the `geesefs.exe` file with the required mounting parameters. Here is an example: `C:\geesefs\geesefs.exe `. Result: diff --git a/en/storage/tutorials/greenplum-yezzey.md b/en/storage/tutorials/greenplum-yezzey.md new file mode 100644 index 00000000000..c58425e1bc0 --- /dev/null +++ b/en/storage/tutorials/greenplum-yezzey.md @@ -0,0 +1,9 @@ +--- +canonical: '{{ link-docs }}/tutorials/dataplatform/greenplum-yezzey' +--- + +# Exporting {{ GP }} data to a cold storage in {{ objstorage-full-name }} + +{% include notitle [greenplum-yezzey.md](../../_tutorials/dataplatform/mgp/greenplum-yezzey.md) %} + +{% include [greenplum-trademark](../../_includes/mdb/mgp/trademark.md) %} diff --git a/en/storage/tutorials/index.md b/en/storage/tutorials/index.md index 95556c3dea0..d1a3242a1db 100644 --- a/en/storage/tutorials/index.md +++ b/en/storage/tutorials/index.md @@ -40,6 +40,7 @@ description: This page presents a list of {{ objstorage-name }} tutorials. * [{#T}](./static-key-in-lockbox.md) * [{#T}](./opensearch-to-object-storage.md) * [{#T}](./ydb-to-object-storage.md) +* [{#T}](./greenplum-yezzey.md) * [{#T}](./static-key-in-lockbox.md) * [{#T}](./terraform-state-storage.md) -* [{#T}](./terraform-state-lock.md) \ No newline at end of file +* [{#T}](./terraform-state-lock.md) diff --git a/en/storage/tutorials/object-storage-to-greenplum.md b/en/storage/tutorials/object-storage-to-greenplum.md index ce63fa604dd..cde6131598c 100644 --- a/en/storage/tutorials/object-storage-to-greenplum.md +++ b/en/storage/tutorials/object-storage-to-greenplum.md @@ -1,5 +1,6 @@ --- noIndex: true +canonical: '{{ link-docs }}/tutorials/dataplatform/object-storage-to-greenplum' --- # Loading data from {{ objstorage-name }} to {{ mgp-full-name }} using {{ data-transfer-full-name }} diff --git a/en/storage/tutorials/server-side-encryption.md b/en/storage/tutorials/server-side-encryption.md index bea446ed93a..13bbcb1a77b 100644 --- a/en/storage/tutorials/server-side-encryption.md +++ b/en/storage/tutorials/server-side-encryption.md @@ -26,7 +26,7 @@ If you no longer need to encrypt new bucket objects, [disable encryption](#disab The cost of maintaining a bucket with encryption includes: * Fee for storing data in a bucket (see [{{ objstorage-name }} pricing](../pricing.md#prices-storage)). -* Fee for data operations (see [{{ objstorage-name }} pricing](../pricing.md#prices-operations)). +* Fee for operations with data (see [{{ objstorage-name }} pricing](../pricing.md#prices-operations)). * Fee for using KMS keys (see [{{ kms-name }} pricing](../../kms/pricing.md#prices)). @@ -38,7 +38,7 @@ You can create a new bucket or use an existing one. To create a bucket, run: - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the folder where you wish to create the bucket. + 1. In the [management console]({{ link-console-main }}), select the folder you want to create a bucket in. 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_storage }}**. 1. Click **{{ ui-key.yacloud.storage.buckets.button_create }}**. 1. In the **{{ ui-key.yacloud.storage.bucket.settings.field_name }}** field, enter a name for the bucket. @@ -83,10 +83,10 @@ You can create a new bucket or use an existing one. To create a bucket, run: zone = "{{ region-id }}-a" sa_name = "new-buckets-account" - sa_desc = "{{ objstorage-name }} bucket management account" + sa_desc = "Account for managing {{ objstorage-name }} buckets" sa_key_desc = "Static key for ${local.sa_name}" - bucket_name = "Bucket name" # Name of the new bucket. If you do not specify a bucket name for the `yandex_storage_bucket` resource, the name will be generated automatically. + bucket_name = "Bucket name" # Name of the bucket you are creating. If you do not specify a bucket name for the `yandex_storage_bucket` resource, the name will be generated automatically. } terraform { @@ -127,7 +127,7 @@ You can create a new bucket or use an existing one. To create a bucket, run: } ``` - For more information about the resources that you can create with [{{ TF }}](https://www.terraform.io/docs/language/index.html), see the [provider documentation]({{ tf-provider-link }}). + For more information about the resources you can create with [{{ TF }}](https://www.terraform.io/docs/language/index.html), see the [provider documentation]({{ tf-provider-link }}). 1. Make sure the configuration files are correct. @@ -197,7 +197,7 @@ Create a new key or use an existing one. To create a key: * `--name`: Key name. * `--default-algorithm`: Encryption algorithm: `aes-128`, `aes-192`, or `aes-256`. - * `--rotation-period`: Key rotation period. The value is set in hours, minutes, and seconds and cannot be less than 24 hours, e.g.: `--rotation-period 27h14m27s`. + * `--rotation-period`: Key rotation period. The value is set in hours, minutes, and seconds and cannot be less than 24 hours, e.g., `--rotation-period 27h14m27s`. To create a key without automatic rotation, do not specify the `--rotation-period` parameter. @@ -215,10 +215,10 @@ Create a new key or use an existing one. To create a key: zone = "{{ region-id }}-a" sa_name = "new-buckets-account" - sa_desc = "{{ objstorage-name }} bucket management account" + sa_desc = "Account for managing {{ objstorage-name }} buckets" sa_key_desc = "Static key for ${local.sa_name}" - key_name = "bucket-key" # KMS key name. + key_name = "bucket-key" # KMS key name key_desc = "Bucket encryption key" bucket_name = "Bucket name" @@ -318,7 +318,8 @@ To enable bucket encryption with a {{ kms-short-name }} key: 1. In the [management console]({{ link-console-main }}), select the folder the bucket is in. 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_storage }}**. 1. Select the previously created bucket. - 1. Go to the **{{ ui-key.yacloud.storage.bucket.switch_encryption }}** tab. + 1. In the left-hand panel, select **{{ ui-key.yacloud.storage.bucket.switch_security }}**. + 1. Open the **{{ ui-key.yacloud.storage.bucket.switch_encryption }}** tab. 1. In the **{{ ui-key.yacloud.storage.bucket.encryption.field_key }}** field, select `bucket-key`. 1. Click **{{ ui-key.yacloud.storage.bucket.encryption.button_save }}**. @@ -355,10 +356,10 @@ To enable bucket encryption with a {{ kms-short-name }} key: zone = "{{ region-id }}-a" sa_name = "new-buckets-account" - sa_desc = "{{ objstorage-name }} bucket management account" + sa_desc = "Account for managing {{ objstorage-name }} buckets" sa_key_desc = "Static key for ${local.sa_name}" - key_name = "bucket-key" # KMS key name. + key_name = "bucket-key" # KMS key name key_desc = "Bucket encryption key" bucket_name = "Bucket name" # Bucket name. @@ -470,8 +471,9 @@ After you disable bucket encryption, previously uploaded objects will be stored 1. In the [management console]({{ link-console-main }}), select the folder the bucket is in. 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_storage }}**. 1. Select the previously created bucket. - 1. Go to the **{{ ui-key.yacloud.storage.bucket.switch_encryption }}** tab. - 1. In the **{{ ui-key.yacloud.storage.bucket.encryption.field_key }}** field, select **{{ ui-key.yacloud.component.symmetric-key-select.label_no-symmetric-key }}**. + 1. In the left-hand panel, select **{{ ui-key.yacloud.storage.bucket.switch_security }}**. + 1. Open the **{{ ui-key.yacloud.storage.bucket.switch_encryption }}** tab. + 1. In the **{{ ui-key.yacloud.storage.bucket.encryption.field_key }}** field, select `{{ ui-key.yacloud.component.symmetric-key-select.label_no-symmetric-key }}`. 1. Click **{{ ui-key.yacloud.storage.bucket.encryption.button_save }}**. - AWS CLI {#aws-cli} @@ -496,11 +498,11 @@ After you disable bucket encryption, previously uploaded objects will be stored zone = "{{ region-id }}-a" sa_name = "new-buckets-account" - sa_desc = "{{ objstorage-name }} bucket management account" + sa_desc = "Account for managing {{ objstorage-name }} buckets" sa_key_desc = "Static key for ${local.sa_name}" key_name = "bucket-key" - key_desc = "Bucket encryption key" + key_desc = "Bucket encryption key" bucket_name = "Bucket name" } diff --git a/en/support/toc.yaml b/en/support/toc.yaml index da5a27b3ad8..5586bac8a18 100644 --- a/en/support/toc.yaml +++ b/en/support/toc.yaml @@ -1,11 +1,11 @@ title: About technical support href: index.yaml items: - - name: Technical support procedure + - name: Technical support terms href: overview.md - name: Support Center href: support-center.md - - name: '{{ yandex-cloud }} notifications' + - name: Notifications from {{ yandex-cloud }} href: notify.md - name: Telegram chat href: tg-chat.md diff --git a/en/tracker/access.md b/en/tracker/access.md index 3e5f496c032..8f1902ea561 100644 --- a/en/tracker/access.md +++ b/en/tracker/access.md @@ -25,9 +25,9 @@ User's access level covers their operations on {{ tracker-name }} entities in th 1. Open the [{{ tracker-name }} page]({{ link-tracker }}) and [log in to the admin account](user/login.md). -1. In the left-hand panel, click **Administration** → **{{ ui-key.startrek.ui_components_page-admin_PageAdmin.menu-item-users }}**. +1. In the left-hand panel, click **Administration** → **{{ ui-key.startrek.ui_Common_smart-components_page-admin_PageAdmin.menu-item-users }}**. -1. For all employees who need to manage issues, select **{{ ui-key.startrek.ui_components_page-admin_OrgUsersPane.access-level_full-access }}** in the **{{ ui-key.startrek.ui_components_page-admin_OrgUsersPane.title_access }}** column. +1. For all employees who need to manage issues, select **{{ ui-key.startrek.ui_Common_smart-components_page-admin_OrgGroupsPane.access-level_full-access }}** in the **{{ ui-key.startrek.ui_Common_smart-components_page-admin_OrgGroupsPane.title_access }}** column. {% note info %} @@ -49,7 +49,7 @@ To make sure all new users added to {{ tracker-name }} automatically get full ac 1. Open the [{{ tracker-name }} page]({{ link-tracker }}) and [log in to the admin account](user/login.md). -1. In the left-hand panel, click **Admin settings** → **{{ ui-key.startrek.ui_components_page-admin_PageAdmin.menu-item-users }}**. +1. In the left-hand panel, click **Admin settings** → **{{ ui-key.startrek.ui_Common_smart-components_page-admin_PageAdmin.menu-item-users }}**. 1. In the top-right corner of the page, select **Full access for all new users**: @@ -67,7 +67,7 @@ When enabling or disabling **Full access for all new users**, the access rights If your company uses {{ yandex-360 }} for Business, you can create employee groups and set up access for them. For more information about creating a group, see the [Yandex 360 for Business documentation](https://yandex.ru/support/business/projects.html). To configure full access for a group of users, [link a billing account](billing-account.md). -To configure access for a group of users, open **Administration** → **{{ ui-key.startrek.ui_components_page-admin_PageAdmin.menu-item-groups }}** and select the required access level for each group. +To configure access for a group of users, open **Administration** → **{{ ui-key.startrek.ui_Common_smart-components_page-admin_PageAdmin.menu-item-groups }}** and select the required access level for each group. {% note warning %} diff --git a/en/tracker/add-users.md b/en/tracker/add-users.md index 1ca3585f1d1..6546857d5ba 100644 --- a/en/tracker/add-users.md +++ b/en/tracker/add-users.md @@ -73,9 +73,9 @@ To create an identity federation for an organization: 1. Open the [{{ tracker-name }} page]({{ link-tracker }}) and [log in to the admin account](user/login.md). - 1. In the left-hand panel, click **Administration** → **{{ ui-key.startrek.ui_components_page-admin_PageAdmin.menu-item-orgs }}** (if you do not see this section, click ![](../_assets/horizontal-ellipsis.svg) **More**). + 1. In the left-hand panel, click **Administration** → **{{ ui-key.startrek.ui_Common_smart-components_page-admin_PageAdmin.menu-item-orgs }}** (if you do not see this section, click ![](../_assets/horizontal-ellipsis.svg) **More**). - 1. Under **{{ ui-key.startrek.ui_components_page-admin_OrgPanes_CloudOrgPane.source-title }}**, click **{{ ui-key.startrek.ui_components_page-admin_OrgPanes_CloudOrgPane.federation-task-action }}**. The {{ org-full-name }} page will open. + 1. Under **{{ ui-key.startrek.ui_Common_smart-components_page-admin_OrgPanes_CloudOrgPane.source-title }}**, click **{{ ui-key.startrek.ui_Common_smart-components_page-admin_OrgPanes_CloudOrgPane.federation-task-action }}**. The {{ org-full-name }} page will open. 1. Specify the federation settings and click **{{ ui-key.yacloud_org.form.federation.create.action.create }}**. @@ -95,9 +95,9 @@ To create user accounts, connect your company's email domain in [{{ ya-360 }}]({ 1. Open the [{{ tracker-name }} page]({{ link-tracker }}) and [log in to the admin account](user/login.md). -1. In the left-hand panel, click **Administration** → **{{ ui-key.startrek.ui_components_page-admin_PageAdmin.menu-item-orgs }}** (if you do not see this section, click ![](../_assets/horizontal-ellipsis.svg) **More**). +1. In the left-hand panel, click **Administration** → **{{ ui-key.startrek.ui_Common_smart-components_page-admin_PageAdmin.menu-item-orgs }}** (if you do not see this section, click ![](../_assets/horizontal-ellipsis.svg) **More**). -1. Under **{{ ui-key.startrek.ui_components_page-admin_OrgPanes_DirectoryOrgPane.source-title }}**, click **{{ ui-key.startrek.ui_components_page-admin_OrganizationSmallPane.add-org-button }}**. A window with your organizations will open. You can create a new organization or go to an existing one. +1. Under **{{ ui-key.startrek.ui_Common_smart-components_page-admin_OrgPanes_DirectoryOrgPane.source-title }}**, click **{{ ui-key.startrek.ui_Common_smart-components_page-admin_OrganizationSmallPane.add-org-button }}**. A window with your organizations will open. You can create a new organization or go to an existing one. {% note info %} diff --git a/en/tracker/billing-account.md b/en/tracker/billing-account.md index 283e31c4b33..f5fdc27bcc4 100644 --- a/en/tracker/billing-account.md +++ b/en/tracker/billing-account.md @@ -17,7 +17,7 @@ If you link a billing account with a valid [trial period](../getting-started/fre To link a billing account: 1. Open the [{{ tracker-name }} page]({{ link-tracker }}) and [log in to the admin account](user/login.md). 1. Go to the **Administration** → **Billing** section. The page shows all your billing accounts from {{ yandex-cloud }}. -1. Click **{{ ui-key.startrek.ui_components_page-admin_BillingAccountList.bind }}** next to the relevant billing account. +1. Click **Link** next to the relevant billing account. {% note warning %} @@ -29,7 +29,7 @@ If different users are responsible for {{ tracker-name }} and billing account ad 1. Open the [{{ tracker-name }} page]({{ link-tracker }}) and [log in to the admin account](user/login.md). -1. Go to **Administration** → **Billing** and click **+ {{ ui-key.startrek.ui_components_page-admin_BillingAccountList.create-account }}**. +1. Go to **Administration** → **Billing** and click **+ Create new account**. 1. Select the country that the payer is a resident of. @@ -61,11 +61,11 @@ If different users are responsible for {{ tracker-name }} and billing account ad {% include [payment-card-validation](../_includes/billing/payment-card-validation.md) %} -1. Click **{{ ui-key.startrek.ui_components_page-admin_BillingScreen.create-account }}**. +1. Click **Create**. {% note info %} - By clicking **{{ ui-key.startrek.ui_components_page-admin_BillingScreen.create-account }}**, you accept the [{{ yandex-cloud }} offer]({{ link-cloud-oferta }}). + By clicking **Create**, you accept the [{{ yandex-cloud }} offer]({{ link-cloud-oferta }}). {% endnote %} @@ -103,7 +103,7 @@ Once the billing account is created, [link it to {{ tracker-name }}](#bind). You You can only change an organization's billing account once a month. To change a billing account: 1. Go to the **Admin settings** → **Billing** section. The page displays the billing account linked to {{ tracker-name }}. -1. Click **{{ ui-key.startrek.ui_components_page-admin_BillingAccountInfo.rebind-account }}** in the top-right corner. Select the billing account you want to use instead of the current one or click **+ {{ ui-key.startrek.ui_components_page-admin_BillingAccountList.create-account }}**. +1. Click **Change billing account** in the top-right corner. Select the billing account you want to use instead of the current one or click **+ Create new account**. If you want to create a new account, follow [this guide](#create). ![](../_assets/tracker/changelogs/change-ba.png =690x) diff --git a/en/tracker/cloud-vs-360.md b/en/tracker/cloud-vs-360.md index 20b1dedd9ef..0b6b7642123 100644 --- a/en/tracker/cloud-vs-360.md +++ b/en/tracker/cloud-vs-360.md @@ -54,7 +54,7 @@ Starting April 17, 2023, you will be able to choose which service to use: A {{ ya-360 }} organization administrator can change an organization for {{ tracker-name }} and switch to {{ org-full-name }}. -* If you already have an organization enabled in {{ org-full-name }}, you will be switched to it automatically with no additional actions required. You can check this by going to ![](../_assets/tracker/svg/admin.svg) **Admin** → ![](../_assets/tracker/svg/organizations.svg) [**{{ ui-key.startrek.ui_components_page-admin_PageAdmin.menu-item-orgs }}**]({{ link-tracker }}admin/orgs). +* If you already have an organization enabled in {{ org-full-name }}, you will be switched to it automatically with no additional actions required. You can check this by going to ![](../_assets/tracker/svg/admin.svg) **Admin** → ![](../_assets/tracker/svg/organizations.svg) [**{{ ui-key.startrek.ui_Common_smart-components_page-admin_PageAdmin.menu-item-orgs }}**]({{ link-tracker }}admin/orgs). * If you have a {{ org-full-name }} organization you want to switch to, but it is linked to a different {{ tracker-name }}, {{ wiki-name }}, or {{ forms-name }}, contact [support](troubleshooting.md). This is required because, when switching organizations, all data will be deleted. @@ -62,7 +62,7 @@ The steps below can only be completed by a {{ ya-360 }} organization administrat 1. If you do not have an organization in {{ org-full-name }}, create one following [this guide](../organization/operations/enable-org.md). If you already have an organization, skip this step. -1. In {{ tracker-name }}, click ![](../_assets/tracker/svg/admin.svg) **Admin settings** → ![](../_assets/tracker/svg/organizations.svg) [**{{ ui-key.startrek.ui_components_page-admin_PageAdmin.menu-item-orgs }}**]({{ link-tracker }}admin/orgs) in the left-hand panel. In the {{ org-full-name }} organizations section, click **{{ ui-key.startrek.ui_components_page-admin_OrgPanes_DirectoryOrgPane.domain-task-action }}** and select the organization you need. Wait until the users and groups from {{ org-full-name }} are synced in {{ tracker-name }}, which may take up to 30 minutes. +1. In {{ tracker-name }}, click ![](../_assets/tracker/svg/admin.svg) **Admin settings** → ![](../_assets/tracker/svg/organizations.svg) [**{{ ui-key.startrek.ui_Common_smart-components_page-admin_PageAdmin.menu-item-orgs }}**]({{ link-tracker }}admin/orgs) in the left-hand panel. In the {{ org-full-name }} organizations section, click **{{ ui-key.startrek.ui_Common_smart-components_page-admin_OrgPanes_DirectoryOrgPane.domain-task-action }}** and select the organization you need. Wait until the users and groups from {{ org-full-name }} are synced in {{ tracker-name }}, which may take up to 30 minutes. 1. In {{ org-full-name }}, add [users](../organization/operations/manage-users.md) and [groups](../organization/operations/manage-groups.md) in the same way as in {{ ya-360 }}. A group name in {{ tracker-name }} is generated based on the **Description** field value, or, if it is not provided, on the **Name** field value. @@ -78,7 +78,7 @@ The steps below can only be completed by a {{ ya-360 }} organization administrat {% note info %} - In the group access settings, under ![](../_assets/tracker/svg/admin.svg) **Admin settings** → [**{{ ui-key.startrek.ui_components_page-admin_PageAdmin.menu-item-groups }}**]({{ link-tracker }}admin/groups), you will see two **All employees** groups: one with the {{ ya-360 }} organization employees and the other with the employees from both organizations. + In the group access settings, under ![](../_assets/tracker/svg/admin.svg) **Admin settings** → [**{{ ui-key.startrek.ui_Common_smart-components_page-admin_PageAdmin.menu-item-groups }}**]({{ link-tracker }}admin/groups), you will see two **All employees** groups: one with the {{ ya-360 }} organization employees and the other with the employees from both organizations. {% endnote %} diff --git a/en/tracker/dev-process-templates.md b/en/tracker/dev-process-templates.md index c6bd7c76b6a..ac8c58af285 100644 --- a/en/tracker/dev-process-templates.md +++ b/en/tracker/dev-process-templates.md @@ -6,7 +6,7 @@ To create an issue template for your queue and allow team members to use it: 1. In the panel on the left, click ![](../_assets/tracker/svg/settings.svg) **Settings**. Then select ![](../_assets/tracker/svg/interface.svg) **Interface** and click **Template management**. You can also follow the [{{ link-tracker-templates }}]({{ link-tracker-templates }}) link. -1. Select the **Issues** option and click **{{ ui-key.startrek.ui_components_issue-comments-templates.create-template-item }}**. +1. Select the **Issues** option and click **{{ ui-key.startrek.ui_Issues_pure-components_issue-comments-templates.create-template-item }}**. 1. Set the template's name and description. diff --git a/en/tracker/disable-tracker.md b/en/tracker/disable-tracker.md index 7863316be58..2ebf256be18 100644 --- a/en/tracker/disable-tracker.md +++ b/en/tracker/disable-tracker.md @@ -15,17 +15,17 @@ To avoid service deactivation and deletion of your data, log in to {{ tracker-na {% note info %} -To avoid paying for {{ tracker-name }}, you can disable the paid features leaving only the free [*{{ ui-key.startrek.ui_components_page-admin_OrgUsersPane.access-level_read_only }}*](access.md#readonly) mode for your employees. You cannot fully disable {{ tracker-name }}. +To avoid paying for {{ tracker-name }}, you can disable the paid features leaving only the free [*{{ ui-key.startrek.ui_Common_smart-components_page-admin_OrgGroupsPane.access-level_read_only }}*](access.md#readonly) mode for your employees. You cannot fully disable {{ tracker-name }}. {% endnote %} To stop using the paid features {{ tracker-full-name }}, revoke full access to {{ tracker-name }} from your company's employees. If only 5 or fewer users have full access, you can use {{ tracker-name }} free of charge. For more information, see [{#T}](pricing.md). -1. In the {{ tracker-name }} left-hand panel, click **Administration** → **{{ ui-key.startrek.ui_components_page-admin_PageAdmin.menu-item-users }}**. +1. In the {{ tracker-name }} left-hand panel, click **Administration** → **{{ ui-key.startrek.ui_Common_smart-components_page-admin_PageAdmin.menu-item-users }}**. 1. Make sure the **Full access for all new users** option is disabled. -1. For the employees whose access needs to be revoked, in the **{{ ui-key.startrek.ui_components_page-admin_OrgUsersPane.title_access }}** column, select **{{ ui-key.startrek.ui_components_page-admin_OrgUsersPane.access-level_read_only }}**. +1. For the employees whose access needs to be revoked, in the **{{ ui-key.startrek.ui_Common_smart-components_page-admin_OrgGroupsPane.title_access }}** column, select **{{ ui-key.startrek.ui_Common_smart-components_page-admin_OrgGroupsPane.access-level_read_only }}**. Once you revoke access to {{ tracker-name }} from the employees, they will not be able to create and update issues. However, they will still be able to view information in {{ tracker-name }}. \ No newline at end of file diff --git a/en/tracker/faq.md b/en/tracker/faq.md index 5556bb0c4ae..6facd849251 100644 --- a/en/tracker/faq.md +++ b/en/tracker/faq.md @@ -65,7 +65,7 @@ To delete a queue: 1. Go to the **Basic settings** tab. -1. Click **{{ ui-key.startrek.ui_components_page-queue-admin_QueueActionsMenu.remove-queue-action }}**. +1. Click **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueActionsMenu.remove-queue-action }}**. 1. Confirm the deletion. @@ -91,7 +91,7 @@ If you can access the queue page but some of the issues remain inaccessible, the ## How can I find the queue owner? {#section_hgc_xyk_nbb} -The owner is specified on the **{{ ui-key.startrek.ui_components_IssueTabs.description-tab }}** tab on the queue page. For more information, see [List of queue issues](user/queue.md). +The owner is specified on the **Description** tab on the queue page. For more information, see [List of queue issues](user/queue.md). ## Why cannot I use widgets grouped by the {{ ui-key.startrek-backend.fields.issue.summary-key-value }} field? {#section_del_widget} diff --git a/en/tracker/gantt/list-of-projects.md b/en/tracker/gantt/list-of-projects.md index 571d33de944..9cf2eadb054 100644 --- a/en/tracker/gantt/list-of-projects.md +++ b/en/tracker/gantt/list-of-projects.md @@ -8,13 +8,13 @@ To go to the Gantt chart: 1. Go to the [projects page]({{ link-tracker }}pages/projects) or select ![](../../_assets/tracker/svg/project.svg) **Projects** in the [left-hand panel]({{ link-tracker }}) and click **Full list of my projects**. -1. Select the **{{ ui-key.startrek.ui_components_filter-pane_ViewModeSwitch.mode-gantt }}** tab. +1. Select the **Gantt chart** tab. * The project list is displayed to the left of the chart. To open the list of project issues, click ![](../../_assets/tracker/svg/arrow.svg) next to the project name. The issues are displayed as a hierarchical list. * The project timeframes are shown on the chart as bars plotted along the time axis. The left edge of each bar indicates the start date of work on the project, while the end of the bar shows its deadline. -1. To see only specific issues within your projects, set up filtering by issue. You can do this in the right-hand panel above the chart, under **{{ ui-key.startrek.ui_components_portfolios_portfolio-page_ListFilterPane.filter-issues }}**, by adding the parameters you need one by one and setting their values. +1. To see only specific issues within your projects, set up filtering by issue. You can do this in the right-hand panel above the chart, under **Issues**, by adding the parameters you need one by one and setting their values. -1. To set up the time scale, select **{{ ui-key.startrek.ui_components_Gantt.scale-days }}**, **{{ ui-key.startrek.ui_components_Gantt.scale-month }}**, or **{{ ui-key.startrek.ui_components_Gantt.scale-quarters }}** in the bottom-right corner of the chart. The scale settings persist after refreshing the page or opening the chart again. +1. To set up the time scale, select **Week**, **Month**, or **Quarter** in the bottom-right corner of the chart. The scale settings persist after refreshing the page or opening the chart again. ## Changing project timeframes {#timing} @@ -34,7 +34,7 @@ On a Gantt chart for a list of projects, you can appoint or change an employee i {% note info %} -If you do not see the ![](../../_assets/tracker/svg/pick-user.svg) button on the project bar, go to ![](../../_assets/tracker/svg/gantt-settings-button.svg) **{{ ui-key.startrek.ui_components_Gantt.timeline-config }}** and select the **{{ ui-key.startrek.ui_components_Gantt.show-issue-assignee }}** item in the **Issue bar** section. +If you do not see the ![](../../_assets/tracker/svg/pick-user.svg) button on the project bar, go to ![](../../_assets/tracker/svg/gantt-settings-button.svg) **Chart settings** and select the **assignee** item in the **Issue bar** section. {% endnote %} @@ -54,8 +54,8 @@ In a similar way, you can also use the chart to appoint and change assignees for ## Displaying the issue list section {#tasks-view} -* To find an issue or project in the list, enter text in the **{{ ui-key.startrek.ui_components_portfolios_portfolio-page_ListFilterPane.search-placeholder }}** field. +* To find an issue or project in the list, enter text in the **Search** field. -* To set up their display order in the list, click ![](../../_assets/tracker/svg/sorting.svg) **{{ ui-key.startrek.ui_components_SortButton.default-title }}**, specify the parameter, and click ![](../../_assets/tracker/svg/new-first.svg). In this case, you will not be able to move issues manually. +* To set up their display order in the list, click ![](../../_assets/tracker/svg/sorting.svg) **{{ ui-key.startrek.ui_Common_smart-components_SortButton.default-title }}**, specify the parameter, and click ![](../../_assets/tracker/svg/new-first.svg). In this case, you will not be able to move issues manually. -* To filter the project list, use the filter builder. For this, in the ![](../../_assets/tracker/svg/filter.svg) **Filters** panel, under **{{ ui-key.startrek.ui_components_portfolios_portfolio-page_ListFilterPane.filter-projects }}**, select the parameters and specify the values to use for generating a project list. Under **{{ ui-key.startrek.ui_components_portfolios_portfolio-page_ListFilterPane.filter-issues }}**, you can also set up additional filtering by issues within your projects. +* To filter the project list, use the filter builder. For this, in the ![](../../_assets/tracker/svg/filter.svg) **Filters** panel, under **Projects**, select the parameters and specify the values to use for generating a project list. Under **Issues**, you can also set up additional filtering by issues within your projects. diff --git a/en/tracker/gantt/portfolio.md b/en/tracker/gantt/portfolio.md index 5eedbb00fe7..8f11bb8f3df 100644 --- a/en/tracker/gantt/portfolio.md +++ b/en/tracker/gantt/portfolio.md @@ -8,7 +8,7 @@ To go to the Gantt chart: 1. In the [left-hand panel]({{ link-tracker }}), select ![](../../_assets/tracker/svg/project.svg) **Projects** or follow the [direct link]({{ link-tracker }}pages/projects) and open the portfolio page. -1. Select the **{{ ui-key.startrek.ui_components_filter-pane_ViewModeSwitch.mode-gantt }}** tab. +1. Select the **Gantt chart** tab. * The portfolio and project list is displayed to the left of the chart. To open the list of nested items, click ![](../../_assets/tracker/svg/arrow.svg) next to its name. The issues are displayed as a hierarchical list. * The portfolio, project, and issue timeframes are shown on the chart as bars plotted along the time axis. The left edge of each bar indicates the start date of a portfolio, project, or issue, while the right edge marks its deadline. @@ -38,7 +38,7 @@ On a Gantt chart for portfolios, you can assign or change an employee in charge {% note info %} -If you do not see the ![](../../_assets/tracker/svg/pick-user.svg) button on the portfolio or project bar, go to ![](../../_assets/tracker/svg/gantt-settings-button.svg) **{{ ui-key.startrek.ui_components_Gantt.timeline-config }}** and select the **{{ ui-key.startrek.ui_components_Gantt.show-issue-assignee }}** item in the **Issue bar** section. +If you do not see the ![](../../_assets/tracker/svg/pick-user.svg) button on the portfolio or project bar, go to ![](../../_assets/tracker/svg/gantt-settings-button.svg) **Chart settings** and select the **assignee** item in the **Issue bar** section. {% endnote %} @@ -64,7 +64,7 @@ In a similar way, you can also use the chart to appoint and change assignees for ## Displaying the project and portfolio list section {#tasks-view} -* To filter the project and portfolio list, use the filter builder. On the ![](../../_assets/tracker/svg/filter.svg) **{{ ui-key.startrek.ui_components_page-issues_touch_FilterSettingsMenu.item-filters }}** panel, define the selection parameters and their values. The panel allows you to use filtering on portfolios or projects only. +* To filter the project and portfolio list, use the filter builder. On the ![](../../_assets/tracker/svg/filter.svg) **Filters** panel, define the selection parameters and their values. The panel allows you to use filtering on portfolios or projects only. {% note info %} diff --git a/en/tracker/gantt/project.md b/en/tracker/gantt/project.md index 028ab647a01..84cea84c0b4 100644 --- a/en/tracker/gantt/project.md +++ b/en/tracker/gantt/project.md @@ -18,13 +18,13 @@ To go to the Gantt chart: * If an issue has blockers outside the current project, you will see the ![](../../_assets/tracker/svg/blocker.svg) icon with their number to the left of the issue bar. - * To enable the display of external blockers in the issue list, go to [](../../_assets/tracker/svg/gantt-settings-button.svg) **{{ ui-key.startrek.ui_components_Gantt.timeline-config }}** → **{{ ui-key.startrek.ui_components_Gantt.show-external-blockers }}**. + * To enable the display of external blockers in the issue list, go to [](../../_assets/tracker/svg/gantt-settings-button.svg) **Chart settings** → **Show external blockers**. * External blockers are highlighted in gray and can be found under the dependent issue in the issue list. If you enable [displaying issues as a hierarchy](#trees), blockers are shown under an issue branch. You cannot move external blockers in the list, but you can still open and edit them. * You can [change](#timing) the start date and deadline of external blockers. - * To delete links between external blockers and their dependent issues, click ![](../../_assets/tracker/svg/blocker.svg), and then ![](../../_assets/tracker/svg/del-link.svg) **{{ ui-key.startrek.ui_components_Gantt.delete-link }}**. + * To delete links between external blockers and their dependent issues, click ![](../../_assets/tracker/svg/blocker.svg), and then ![](../../_assets/tracker/svg/del-link.svg) **Remove link**. ## Changing issue deadlines {#timing} @@ -96,12 +96,12 @@ To turn off comparison mode, hover over ![](../../_assets/console-icons/clock-ar ## Actions with issues {#issue-actions} -To open the issue actions menu in the issue list section, click ![](../../_assets/tracker/svg/actions.svg) **{{ ui-key.startrek.ui_components_Gantt_IssueActionsCell.issue-action-menu-title }}** to the right of the issue name. +To open the issue actions menu in the issue list section, click ![](../../_assets/tracker/svg/actions.svg) **Issue actions menu** to the right of the issue name. In the menu, you have the following actions available: -* ![](../../_assets/tracker/text-edit/link.svg) **{{ ui-key.startrek.ui_components_projects_hooks.copy-to-clipboard }}**. -* ![](../../_assets/tracker/svg/move-up.svg) **{{ ui-key.startrek.ui_components_projects_hooks.issue-actions--move-up }}** (for manual sorting only). -* ![](../../_assets/tracker/svg/move-down.svg) **{{ ui-key.startrek.ui_components_projects_hooks.issue-actions--move-down }}** (for manual sorting only). +* ![](../../_assets/tracker/text-edit/link.svg) **Copy link**. +* ![](../../_assets/tracker/svg/move-up.svg) **Move to top of list** (for manual sorting only). +* ![](../../_assets/tracker/svg/move-down.svg) **Move to bottom of list** (for manual sorting only). * ![](../../_assets/tracker/svg/convert.svg) **Convert to a [milestone](../manager/milestones.md) or issue**. -* ![](../../_assets/tracker/svg/icon-remove.svg) **{{ ui-key.startrek.ui_components_projects_hooks.delete-from-project }}**. -* ![](../../_assets/tracker/svg/gantt-palette.svg) **Choose color** (only when the **{{ ui-key.startrek.ui_components_Gantt.color-type-by-manual }}** setting is enabled). \ No newline at end of file +* ![](../../_assets/tracker/svg/icon-remove.svg) **Delete from project**. +* ![](../../_assets/tracker/svg/gantt-palette.svg) **Choose color** (only when the **manual** setting is enabled). \ No newline at end of file diff --git a/en/tracker/hr-process-basic-queue.md b/en/tracker/hr-process-basic-queue.md index f168d741c93..372c8f4ebad 100644 --- a/en/tracker/hr-process-basic-queue.md +++ b/en/tracker/hr-process-basic-queue.md @@ -8,7 +8,7 @@ description: Follow this guide to create an HR management queue. To enable the HR department employees to plan and track general HR tasks, create a queue and invite them to it: 1. Create a queue: - 1. In the left-hand panel, select ![](../_assets/tracker/svg/queues-ni.svg) **{{ ui-key.startrek.ui_components_TrackerSearch.queues }}** → **Create queue**. + 1. In the left-hand panel, select ![](../_assets/tracker/svg/queues-ni.svg) **{{ ui-key.startrek.ui_Common_smart-components_TrackerSearch.queues }}** → **Create queue**. 1. Select the basic **Start now** queue template. 1. Give the queue a name, e.g., `HR Tasks`. 1. Click **Create**. diff --git a/en/tracker/hr-process-candidate-queue.md b/en/tracker/hr-process-candidate-queue.md index ea01bf2015e..1f58197423d 100644 --- a/en/tracker/hr-process-candidate-queue.md +++ b/en/tracker/hr-process-candidate-queue.md @@ -15,11 +15,11 @@ To allow candidates to submit a request on their own, create a queue and a reque ### Create a form 1. In the panel on the left, click ![](../_assets/tracker/svg/icon-add.svg) **Create issue**. -1. Under **{{ ui-key.startrek.ui_components_PageCreateIssue.try-yandex-forms }}**, click **{{ ui-key.startrek.ui_components_PageCreateIssue.create-new }}**. +1. Under **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssue.try-yandex-forms }}**, click **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssue.create-new }}**. 1. Create a new form: * Name it `Candidate`. * Add a description, e.g., `Vacancy request form`. - * Click **{{ ui-key.startrek.ui_components_PageCreateIssueForm.continue }}**. + * Click **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssueForm.continue }}**. 1. Wait for the page to load and select the **Text** widget. 1. In the **Question** field, enter `Full name`. 1. Click ![](../_assets/tracker/svg/icon-add.svg) **Add question** and select **Text**. @@ -47,7 +47,7 @@ To allow candidates to submit a request on their own, create a queue and a reque ### Create a test issue -1. On the issue creation page, select **{{ ui-key.startrek.ui_components_QueueAdminTemplateOptions.never }}** in the **{{ ui-key.startrek.ui_components_QueueAdminTemplateOptions.allow-empty-template }}** field at the top right. +1. On the issue creation page, select **{{ ui-key.startrek.ui_Queues_smart-components_QueueAdminTemplateOptions.never }}** in the **{{ ui-key.startrek.ui_Queues_smart-components_QueueAdminTemplateOptions.allow-empty-template }}** field at the top right. 1. Click the widget named `Candidate`. 1. Fill out the form. Specify your own email address. 1. Click **Send**. diff --git a/en/tracker/hr-process-employment-queue.md b/en/tracker/hr-process-employment-queue.md index 0fc5f5f90ec..f51ad1cca09 100644 --- a/en/tracker/hr-process-employment-queue.md +++ b/en/tracker/hr-process-employment-queue.md @@ -14,7 +14,7 @@ To manage the workflows for official employment and onboarding of new employees, Create separate issue types for various procedures related to employment and onboarding of new employees. For example, to grant access permissions and provide equipment, create an issue type named *Access permissions and equipment*: -1. In the top-right corner of the `Employment Queue` page, click ![](../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner of the `Employment Queue` page, click ![](../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. In the left-hand panel, select **Issue types**. 1. Wait for the page to load and click **Add issue type**. 1. In the form that appears: @@ -37,7 +37,7 @@ Make sure the issue types are unique. To automate replication of issues from the `Candidates Queue` to the `Employment Queue`, create a trigger that will fire when the candidate issue status changes to Hired: -1. In the top-right corner of the `Candidates Queue` page, click ![](../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner of the `Candidates Queue` page, click ![](../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. On the left-hand panel, select **Automation** → **Triggers** and click **Create trigger**. 1. In the **Name** field, enter a trigger name, e.g., `employ_candidate`. 1. Under **Trigger conditions**, select **{{ ui-key.startrek-backend.fields.issue.fields.system }}** → **{{ ui-key.startrek-backend.fields.issue.status-key-value }}**. @@ -85,7 +85,7 @@ Once the candidate issue is copied to the `Employment Queue`, you need to create ### Create a trigger -1. In the top-right corner of the `Employment Queue` page, click ![](../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner of the `Employment Queue` page, click ![](../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. On the left-hand panel, select **Automation** → **Triggers** and click **Create trigger**. 1. In the **Name** field, enter a trigger name, e.g., `start_employment`. 1. Under **Trigger conditions**, select **{{ui-key.startrek-backend.fields.issue.fields.system }}** → **{{ ui-key.startrek-backend.fields.issue.status-key-value }}**. diff --git a/en/tracker/hr-process-probation-queue.md b/en/tracker/hr-process-probation-queue.md index 702106b766c..1e1c9561b75 100644 --- a/en/tracker/hr-process-probation-queue.md +++ b/en/tracker/hr-process-probation-queue.md @@ -6,7 +6,7 @@ Employees on a probation period perform routine actions whose tracking can be au To have the probation period end date set automatically, create a trigger that will fire when an issue is created: -1. In the top-right corner of the `Employment Queue` page, click ![](../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner of the `Employment Queue` page, click ![](../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. On the left-hand panel, select **Automation** → **Triggers** and click **Create trigger**. 1. In the **Name** field, enter a trigger name, e.g., `probation_setup`. 1. Under **Trigger conditions**, select **{{ ui-key.startrek-backend.fields.issue.fields.system }}** → **{{ ui-key.startrek-backend.fields.issue.type-key-value }}**. @@ -23,7 +23,7 @@ To have the probation period end date set automatically, create a trigger that w To make sure you do not miss anything important in the course of new employee onboarding, add checklist creation to trigger actions: 1. Under **Trigger actions**, select **Create checklist** in the **Add new action** field. -1. In the form that opens, click **{{ ui-key.startrek.ui_components_entity-page_checklist_Footer.new-item-button-caption }}** and enter a description of the first item, such as `Assign a supervisor`. +1. In the form that opens, click **{{ ui-key.startrek.ui_Common_smart-components_entity-page_checklist_Footer.new-item-button-caption }}** and enter a description of the first item, such as `Assign a supervisor`. 1. Repeat the steps to add other items to the checklist. 1. To save the trigger, click **Create**. diff --git a/en/tracker/hr-process-vacancy-queue.md b/en/tracker/hr-process-vacancy-queue.md index 746315ef17d..7a9652bf3b6 100644 --- a/en/tracker/hr-process-vacancy-queue.md +++ b/en/tracker/hr-process-vacancy-queue.md @@ -15,7 +15,7 @@ You can set up multiple workflows for different types of issues in a single queu ### Configure a built-in workflow 1. Open the queue page. -1. In the top-right corner, click ![](../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}** and select **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. +1. In the top-right corner, click ![](../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}** and select **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. 1. Select the built-in **Recruiting** workflow. 1. On the workflow page, rename the workflow to **Qualified personnel**. 1. Specify the type of issues this workflow applies to. To do this, click ![](../_assets/tracker/svg/icon-add.svg) to the right of the workflow name and enter a name for a new issue type, such as `Experts`. @@ -41,11 +41,11 @@ You can use {{ forms-full-name }} to create standard issues in a queue more easi ### Create a form for the first workflow 1. In the panel on the left, click ![](../_assets/tracker/svg/icon-add.svg) **Create issue**. -1. Under **{{ ui-key.startrek.ui_components_PageCreateIssue.try-yandex-forms }}**, click **{{ ui-key.startrek.ui_components_PageCreateIssue.create-new }}**. +1. Under **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssue.try-yandex-forms }}**, click **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssue.create-new }}**. 1. Create a new form: * Name it `Expert`. * Add a description, e.g., `Vacancy form for qualified personnel`. - * Click **{{ ui-key.startrek.ui_components_PageCreateIssueForm.continue }}**. + * Click **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssueForm.continue }}**. 1. Wait for the page to load and select the **Text** widget. 1. In the **Question** field, enter `Name`. 1. Click ![](../_assets/tracker/svg/icon-add.svg) **Add question**. @@ -66,7 +66,7 @@ You can use {{ forms-full-name }} to create standard issues in a queue more easi If you want to restrict access to the form: 1. On the issue creation page, hover over the widget with the name of the form you need, e.g., `Expert`. -1. Click ![](../_assets/tracker/svg/actions.svg) and select ![](../_assets/tracker/icon-edit.png)**{{ ui-key.startrek.ui_components_PageCreateIssue.change-template }}**. +1. Click ![](../_assets/tracker/svg/actions.svg) and select ![](../_assets/tracker/icon-edit.png)**{{ ui-key.startrek.ui_Issues_pages_PageCreateIssue.change-template }}**. 1. At the bottom of the page, follow the **{{ forms-full-name }} full version** link. 1. In the **Settings** tab, select **Only employees of the organization** under **Who can fill out the form**. 1. Click **Save**. @@ -74,11 +74,11 @@ If you want to restrict access to the form: ### Create a form for the second workflow Repeat the steps to create and set up a form for vacancies that require no qualification. -Open the issue creation page, click **{{ ui-key.startrek.ui_components_PageCreateIssue.create-new-template }}**, and perform the same actions as described above using the values corresponding to the second workflow. +Open the issue creation page, click **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssue.create-new-template }}**, and perform the same actions as described above using the values corresponding to the second workflow. ### Create test issues and group them by type -1. On the issue creation page, select **{{ ui-key.startrek.ui_components_QueueAdminTemplateOptions.never }}** in the **{{ ui-key.startrek.ui_components_QueueAdminTemplateOptions.allow-empty-template }}** field at the top right. +1. On the issue creation page, select **{{ ui-key.startrek.ui_Queues_smart-components_QueueAdminTemplateOptions.never }}** in the **{{ ui-key.startrek.ui_Queues_smart-components_QueueAdminTemplateOptions.allow-empty-template }}** field at the top right. 1. Click the widget with the name of the form you need, e.g., `Expert`. 1. Fill out the form and click **Submit**. 1. In the same way, create an issue of the `Nonexpert` type. diff --git a/en/tracker/hr-process-vacations-queue.md b/en/tracker/hr-process-vacations-queue.md index f440aedf015..464bb331059 100644 --- a/en/tracker/hr-process-vacations-queue.md +++ b/en/tracker/hr-process-vacations-queue.md @@ -14,11 +14,11 @@ For your employees to be able to easily submit a vacation or sick leave in advan ### Create a form 1. In the panel on the left, click ![](../_assets/tracker/svg/icon-add.svg) **Create issue**. -1. Under **{{ ui-key.startrek.ui_components_PageCreateIssue.try-yandex-forms }}**, click **{{ ui-key.startrek.ui_components_PageCreateIssue.create-new }}**. +1. Under **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssue.try-yandex-forms }}**, click **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssue.create-new }}**. 1. Create a new form: * Name it `Vacation request`. * Add a description, e.g., `Form for vacation requests`. - * Click **{{ ui-key.startrek.ui_components_PageCreateIssueForm.continue }}**. + * Click **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssueForm.continue }}**. 1. Wait for the page to load and click **{{ forms-full-name }} full version**. 1. Create a request form, e.g., with the following fields: * `Full name` (short text, required field). @@ -43,7 +43,7 @@ For your employees to be able to easily submit a vacation or sick leave in advan 1. Click **Save** to save the form. 1. Return to the form builder by clicking **To builder** at the top of the page. 1. Click **Publish** and copy the link to the form in the dialog box that opens. -1. Return to the `Vacations Queue` settings and click **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-forms }}**. +1. Return to the `Vacations Queue` settings and click **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-forms }}**. 1. Click **Add form** and fill out the form that opens pasting the link you copied earlier into the **Link to form** field. 1. Click **Save** to save the form integration. @@ -51,7 +51,7 @@ For your employees to be able to easily submit a vacation or sick leave in advan {{ tracker-name }} has the [auto actions](user/autoactions.md) feature to perform regular actions in a queue. Use an auto action to set up regular checks of the `Vacations Queue` for requests that work is not started on yet. To avoid overloading the employees responsible for registration of vacations with reminders, configure them to be sent once a day and not earlier than two weeks prior to the vacation start date specified in the request. -1. Return to the `Vacations Queue` settings and click **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-autoactions }}**. +1. Return to the `Vacations Queue` settings and click **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-autoactions }}**. 1. Wait for the page to load and click **Create auto action**. 1. In the **Auto action type** field, enable **Issue update**. 1. In the **Name** field, enter a name, such as `vacation_warning`. @@ -72,7 +72,7 @@ For your employees to be able to easily submit a vacation or sick leave in advan ## Test the auto action -1. On the issue creation page, select **{{ ui-key.startrek.ui_components_QueueAdminTemplateOptions.never }}** in the **{{ ui-key.startrek.ui_components_QueueAdminTemplateOptions.allow-empty-template }}** field at the top right. +1. On the issue creation page, select **{{ ui-key.startrek.ui_Queues_smart-components_QueueAdminTemplateOptions.never }}** in the **{{ ui-key.startrek.ui_Queues_smart-components_QueueAdminTemplateOptions.allow-empty-template }}** field at the top right. 1. Click the `Vacation` widget. 1. Fill out the form. In the **Start** field, specify a date that is a week from now. 1. Submit the form. diff --git a/en/tracker/local-fields.md b/en/tracker/local-fields.md index 0fdd63a0773..9940d6c80fa 100644 --- a/en/tracker/local-fields.md +++ b/en/tracker/local-fields.md @@ -20,7 +20,7 @@ By default, [only the queue owner](manager/queue-access.md) can configure a queu 1. Open the [queue page](user/queue.md). -1. In the top-right corner of the page, click ![](../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner of the page, click ![](../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. Go to the **Queue fields** tab. diff --git a/en/tracker/manager/add-ticket-type.md b/en/tracker/manager/add-ticket-type.md index 77459be1abb..8bf8cf1e4b8 100644 --- a/en/tracker/manager/add-ticket-type.md +++ b/en/tracker/manager/add-ticket-type.md @@ -16,13 +16,13 @@ To add a new issue type to the queue: 1. Go to the queue page. -1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Go to the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab. It shows the list of workflows in the queue and the issue types and resolutions set in each workflow. +1. Go to the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab. It shows the list of workflows in the queue and the issue types and resolutions set in each workflow. 1. To add an issue type to an existing workflow, click **Add issue type** in the respective workflow section and select the appropriate issue type from the list of system issue types. To learn how to add an issue type to a new workflow, see the [guide on creating workflows](add-workflow.md#create). -To set the default type for a queue issue, select one of the options in the {{ ui-key.startrek.ui_components_queue-admin-tab-workflows_WorkflowsStateList.default-type-title }} field. +To set the default type for a queue issue, select one of the options in the {{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-workflows_WorkflowsStateList.default-type-title }} field. ## Creating an issue type {#create-ticket-type} @@ -51,9 +51,9 @@ You can also create a new issue type on the workflows page. The created issue ty 1. Go to the queue page. -1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Go to the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab. It shows the list of workflows in the queue. Select the workflow to add the new issue type to and click ![](../../_assets/tracker/svg/arrow.svg) in the respective workflow line. +1. Go to the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab. It shows the list of workflows in the queue. Select the workflow to add the new issue type to and click ![](../../_assets/tracker/svg/arrow.svg) in the respective workflow line. 1. Click **Add issue type**, start typing the name of the new issue type, and click the create button. @@ -72,8 +72,8 @@ Before removing an issue type from the queue, make sure it is not used in any of 1. Use filters to [find all the queue issues](quick-filters.md) that belong to the type you want to remove and change it to any other type the queue supports. -1. In the top-right corner of the queue page, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner of the queue page, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Go to the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab. It shows the list of workflows in the queue. Select the workflow containing the issue type you want to remove. +1. Go to the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab. It shows the list of workflows in the queue. Select the workflow containing the issue type you want to remove. 1. Hover over the line with the issue type to be removed, click the issue type and then click ![](../../_assets/tracker/svg/actions.svg) → **Remove issue type from the queue** in the respective workflow line. diff --git a/en/tracker/manager/add-workflow.md b/en/tracker/manager/add-workflow.md index fa69b7868f9..80baa02c2cc 100644 --- a/en/tracker/manager/add-workflow.md +++ b/en/tracker/manager/add-workflow.md @@ -26,9 +26,9 @@ To create a workflow: 1. Go to the queue page. -1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Go to the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab and click **{{ ui-key.startrek.ui_components_queue-admin-tab-workflows_WorkflowsStateList.action-new-process }}**. The workflow visual editor will open. +1. Go to the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab and click **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-workflows_WorkflowsStateList.action-new-process }}**. The workflow visual editor will open. 1. [Add statuses to the diagram](./workflow-status-edit.md#add-status) and [set up transitions](./workflow-action-edit.md#add-action) between them. Stick to the [rules](#rules). @@ -37,13 +37,13 @@ To create a workflow: To copy a workflow from a different queue: 1. Go to the page of the queue to copy the workflow to. -1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. -1. In the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab, click ![](../../_assets/tracker/svg/copy-process.svg). +1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. +1. In the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab, click ![](../../_assets/tracker/svg/copy-process.svg). 1. In the window that opens, fill in the fields: - * **{{ ui-key.startrek.ui_components_queue-admin-tab-workflows_CopyWorkflowDialog.label-queue }}**. - * **{{ ui-key.startrek.ui_components_queue-admin-tab-workflows_CopyWorkflowDialog.label-workflow }}**. - * **{{ ui-key.startrek.ui_components_queue-admin-tab-workflows_CopyWorkflowDialog.label-name }}**. -1. Click **{{ ui-key.startrek.ui_components_queue-admin-tab-workflows_CopyWorkflowDialog.action-copy }}**. + * **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-workflows_CopyWorkflowDialog.label-queue }}**. + * **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-workflows_CopyWorkflowDialog.label-workflow }}**. + * **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-workflows_CopyWorkflowDialog.label-name }}**. +1. Click **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-workflows_CopyWorkflowDialog.action-copy }}**. ## Deleting a workflow {#section_s35_xz5_vbb} @@ -57,8 +57,8 @@ To delete a workflow: 1. Open the queue page. -1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Go to the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab. +1. Go to the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab. 1. Select the appropriate workflow and click ![](../../_assets/tracker/button-delete.png). diff --git a/en/tracker/manager/agile-new-columns.md b/en/tracker/manager/agile-new-columns.md index 141c15c71c1..6c98c57b067 100644 --- a/en/tracker/manager/agile-new-columns.md +++ b/en/tracker/manager/agile-new-columns.md @@ -6,25 +6,25 @@ Go to the board page, click ![](../../_assets/tracker/svg/boards.svg) **Boa ## Columns by status {#status} -To go to columns by status, click **{{ ui-key.startrek.ui_components_agile_common_ViewModeControl.columns }}** → **{{ ui-key.startrek.ui_components_agile_common_ViewModeControl.columnsByStatus }}** in the board's top panel. +To go to columns by status, click **Columns** → **Columns by statuses** in the board's top panel. ### Adding a column {#add-status-cols} To add a column by status to the issue board: -1. On the board page, click **{{ ui-key.startrek.ui_components_agile_backlog_BacklogAddColumnButton.add-column }}**. +1. On the board page, click **Add column**. 1. Enter the parameters of the new column: - * In the **{{ ui-key.startrek.ui_components_agile_common_ColumnForm.create-column-label--statuses }}** field, enter one or more statuses. For this, start entering the status name, then select its value from the list. + * In the **Column statuses** field, enter one or more statuses. For this, start entering the status name, then select its value from the list. * Enter a name for the column. * Set the maximum number of issues per column. If there are more issues, the column will turn yellow, but you will still be able to add issues to it, exceeding the limit. -1. Click **{{ ui-key.startrek.ui_components_agile_common_ColumnForm.create-column-submit-button--create }}**. +1. Click **Add**. -1. To view a list of statuses that aren't used on the board, click ![](../../_assets/tracker/svg/unused-status.svg) next to the rightmost column. Add relevant statuses to the board: in the status card, click ![](../../_assets/tracker/svg/actions.svg), then click **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardUnusedStatuses.unused-statuses-create-column }}** or **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardUnusedStatuses.unused-statuses-add-to-column }}**. +1. To view a list of statuses that aren't used on the board, click ![](../../_assets/tracker/svg/unused-status.svg) next to the rightmost column. Add relevant statuses to the board: in the status card, click ![](../../_assets/tracker/svg/actions.svg), then click **Create column** or **Add to column**. {% note info %} @@ -32,13 +32,13 @@ To add a column by status to the issue board: {% endnote %} -1. To add a note with text to appear under the column name, hover over the column, then click ![](../../_assets/tracker/svg/actions.svg) → ![](../../_assets/tracker/svg/icon-note.svg) **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardColumnHeader.column-menu--add-note }}**. +1. To add a note with text to appear under the column name, hover over the column, then click ![](../../_assets/tracker/svg/actions.svg) → ![](../../_assets/tracker/svg/icon-note.svg) **Add note**. ### Editing a column {#edit-status-cols} You can change the column's parameters and its position on the board. -* To rename the column, change the maximum number of issues per column, or update statuses, hover over the column and click ![](../../_assets/tracker/svg/actions.svg) → ![](../../_assets/tracker/svg/icon-edit.svg) **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardColumnHeader.column-menu--edit }}**. +* To rename the column, change the maximum number of issues per column, or update statuses, hover over the column and click ![](../../_assets/tracker/svg/actions.svg) → ![](../../_assets/tracker/svg/icon-edit.svg) **Edit**. * To reposition the column on the board, drag it around the board. @@ -46,21 +46,21 @@ You can change the column's parameters and its position on the board. ### Deleting a column {#delete-status-cols} -To delete a column from the board, hover over the column, then click ![](../../_assets/tracker/svg/actions.svg) → ![](../../_assets/tracker/svg/icon-remove.svg) **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardColumnHeader.column-menu--delete }}**. +To delete a column from the board, hover over the column, then click ![](../../_assets/tracker/svg/actions.svg) → ![](../../_assets/tracker/svg/icon-remove.svg) **Delete**. -If the deleted column contained issues, they will be moved to **{{ ui-key.startrek.ui_components_agile_common_UnusedStatusesButton.unused-statuses-button }}**. To view such issues, next to the rightmost column, click ![](../../_assets/tracker/svg/unused-status.svg), then click the status name. +If the deleted column contained issues, they will be moved to **Unused statuses**. To view such issues, next to the rightmost column, click ![](../../_assets/tracker/svg/unused-status.svg), then click the status name. ## Custom columns {#user-columns} You can create, move, and delete custom columns on boards, except the first column that contains non-assigned issues. In addition, you can create issues inside custom columns and move them both within and across the columns. -To go to custom columns, click **{{ ui-key.startrek.ui_components_agile_common_ViewModeControl.columns }}**→ **{{ ui-key.startrek.ui_components_agile_common_ViewModeControl.customColumns }}** in the board's top panel. +To go to custom columns, click **Columns**→ **Custom columns** in the board's top panel. ### Adding a column {#add-user-cols} To add a custom column to the issue board: -1. On the board page, click **{{ ui-key.startrek.ui_components_agile_backlog_BacklogAddColumnButton.add-column }}**. +1. On the board page, click **Add column**. 1. Enter the parameters of the new column: @@ -68,13 +68,13 @@ To add a custom column to the issue board: * Set the maximum number of issues per column. If there are more issues, the column will turn yellow, but you will still be able to add issues to it, exceeding the limit. -1. Click **{{ ui-key.startrek.ui_components_agile_common_ColumnForm.create-column-submit-button--create }}**. +1. Click **Add**. 1. Add issues to a column: click ![](../../_assets/tracker/svg/add-task.svg) next to it and add an existing issue or create a new one. {% note info %} - If you add the **Story Points** field to the issue card, the total number of **Story Points** in the column will be shown in its heading. To add the **Story Points** field to the issue card, click ![](../../_assets/tracker/svg/actions.svg) → **{{ ui-key.startrek.ui_components_agile_common_FieldsSelect.fields-settings }}** in the right-hand corner of the search, sort, and group panel on the board page and select the **Story Points** field. + If you add the **Story Points** field to the issue card, the total number of **Story Points** in the column will be shown in its heading. To add the **Story Points** field to the issue card, click ![](../../_assets/tracker/svg/actions.svg) → **Card fields** in the right-hand corner of the search, sort, and group panel on the board page and select the **Story Points** field. {% endnote %} @@ -82,7 +82,7 @@ To add a custom column to the issue board: You can change the column's parameters and its position on the board. -* To rename a column or change the maximum number of issues in it, hover over the column and click ![](../../_assets/tracker/svg/actions.svg) → ![](../../_assets/tracker/svg/icon-edit.svg) **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardColumnHeader.column-menu--edit }}**. +* To rename a column or change the maximum number of issues in it, hover over the column and click ![](../../_assets/tracker/svg/actions.svg) → ![](../../_assets/tracker/svg/icon-edit.svg) **Edit**. * To reposition the column on the board, drag it around the board. @@ -90,4 +90,4 @@ You can change the column's parameters and its position on the board. ### Deleting a column {#delete-user-cols} -To delete a column from the board, hover over the column, then click ![](../../_assets/tracker/svg/actions.svg) → ![](../../_assets/tracker/svg/icon-remove.svg) **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardColumnHeader.column-menu--delete }}**. +To delete a column from the board, hover over the column, then click ![](../../_assets/tracker/svg/actions.svg) → ![](../../_assets/tracker/svg/icon-remove.svg) **Delete**. diff --git a/en/tracker/manager/agile-new-create.md b/en/tracker/manager/agile-new-create.md index 7110cd6b299..ac36e2b0267 100644 --- a/en/tracker/manager/agile-new-create.md +++ b/en/tracker/manager/agile-new-create.md @@ -7,27 +7,27 @@ description: In this tutorial, you will learn how to create a board in {{ tracke ## Creating a basic board {#basic} -**{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardCreateModal.board-type--simple }}** can be used by any teams and allow issues to be arranged in columns based on their status. +**Basic** can be used by any teams and allow issues to be arranged in columns based on their status. To create a basic board: 1. In the left-hand panel, click **Boards** → **Create board**. -1. Select the **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardCreateModal.board-type--simple }}** board type and click **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardCreateModal.submit-btn }}**. This will create a new board named **New board**. This board field is editable, so you can change its value and rename the board. +1. Select the **Basic** board type and click **Create**. This will create a new board named **New board**. This board field is editable, so you can change its value and rename the board. It already has some columns with **Open**, **In progress**, and **Closed** statuses. You can delete the columns, add other ones, or create custom columns not associated with issue statuses. -After [adding issues to the board](agile-new-set-board.md#add-task), you can customize the layout of issue cards, group and filter issues, and move them across the board columns. Basic boards allow you to [enable a backlog](backlog.md#add-backlog) to convert your board to **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardCreateModal.board-type--scrum }}** format. No rollback is possible. +After [adding issues to the board](agile-new-set-board.md#add-task), you can customize the layout of issue cards, group and filter issues, and move them across the board columns. Basic boards allow you to [enable a backlog](backlog.md#add-backlog) to convert your board to **With backlog and sprints** format. No rollback is possible. ## Creating a board with a backlog and sprints {#backlog-and-sprints} -**{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardCreateModal.board-type--scrum }}** boards are good for Agile teams and allow creating a [backlog](backlog.md), managing [sprints](create-agile-sprint.md), [estimating issue complexity](poker.md), and analyzing [burn down charts](burndown-diagram.md). +**With backlog and sprints** boards are good for Agile teams and allow creating a [backlog](backlog.md), managing [sprints](create-agile-sprint.md), [estimating issue complexity](poker.md), and analyzing [burn down charts](burndown-diagram.md). To create a board with a backlog and sprints: 1. In the left-hand panel, click **Boards** → **Create board**. -1. Select the **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardCreateModal.board-type--scrum }}** board type and click **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardCreateModal.submit-btn }}**. This will create a new board named **New board**. This board field is editable, so you can change its value and rename the board. +1. Select the **With backlog and sprints** board type and click **Create**. This will create a new board named **New board**. This board field is editable, so you can change its value and rename the board. It consists of three tabs: * Backlog: Use it to create an issue backlog and sprints. diff --git a/en/tracker/manager/agile-new-issues.md b/en/tracker/manager/agile-new-issues.md index b92f976b752..54fb29f717d 100644 --- a/en/tracker/manager/agile-new-issues.md +++ b/en/tracker/manager/agile-new-issues.md @@ -10,7 +10,7 @@ Customize the layout of issue cards to see only relevant parameters on the board By default, the issue card displays the values of such fields as the key, name, assignee, and some others. To set up the fields to be displayed on the issue card: -1. On the board page, click ![](../../_assets/tracker/svg/actions.svg) → **{{ ui-key.startrek.ui_components_agile_common_FieldsSelect.fields-settings }}** in the right-hand corner of the search, sort, and group panel. +1. On the board page, click ![](../../_assets/tracker/svg/actions.svg) → **Card fields** in the right-hand corner of the search, sort, and group panel. 1. Select the issue fields to be shown on the card. You can add or remove any field, except for the issue name (the **Issue** field) that can't be removed. @@ -36,9 +36,9 @@ Managing issues on {{ tracker-name }} boards is like working with stickers on a {% endnote %} -* To move a card within the column, hover over it, click ![](../../_assets/tracker/svg/actions.svg) in the top-right corner, and select **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardIssue.issue-actions--move-up }}** or **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardIssue.issue-actions--move-down }}**. +* To move a card within the column, hover over it, click ![](../../_assets/tracker/svg/actions.svg) in the top-right corner, and select **Move to top of column** or **Move to bottom of column**. -* To delete an issue from the board, in the top-right corner of the card, click ![](../../_assets/tracker/svg/actions.svg), then select **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardIssue.issue-actions--delete-from-board }}**. +* To delete an issue from the board, in the top-right corner of the card, click ![](../../_assets/tracker/svg/actions.svg), then select **Remove from board**. {% note info %} @@ -54,21 +54,21 @@ If there are too many issues on the board, you can always hide some of them usin To create a filter on the board: -1. In the top-right corner, click ![](../../_assets/tracker/svg/filter.svg) **{{ ui-key.startrek.ui_components_page-issues_touch_FilterSettingsMenu.item-filters }}**. The filter setup panel will be shown above the board's columns. +1. In the top-right corner, click ![](../../_assets/tracker/svg/filter.svg) **Filters**. The filter setup panel will be shown above the board's columns. 1. Click ![](../../_assets/tracker/svg/add-filter.svg). Select the parameter to filter your issues and set the value for it. Add multiple parameters to the filter if needed. -1. To reset the filter, click ![](../../_assets/tracker/svg/clear-filter.svg) **{{ ui-key.startrek.ui_components_agile_common_AgileFilters.reset-button }}**. +1. To reset the filter, click ![](../../_assets/tracker/svg/clear-filter.svg) **Reset**. -1. To save the filter, click ![](../../_assets/tracker/svg/save-filter.svg) **{{ ui-key.startrek.ui_components_agile_common_AgileFilters.action-title-save }}**: +1. To save the filter, click ![](../../_assets/tracker/svg/save-filter.svg) **Save**: 1. Name the filter. 1. Select for whom the filter will be fixed at the top of the board: only for yourself or for every user. Fixed filters are shown as buttons at the top of the board. - 1. Click **{{ ui-key.startrek.ui_components_agile_common_AgileFilters.action-title-save }}**. + 1. Click **Save**. Saved filters are available for all users. @@ -80,11 +80,11 @@ To create a filter on the board: {% endnote %} - 1. Click ![](../../_assets/tracker/svg/settings.svg) in the filters panel or click ![](../../_assets/horizontal-ellipsis.svg) in the top-right corner of the page and select **{{ ui-key.startrek.ui_components_agile_common_QuickFilterPopup.filters-manage }}**. + 1. Click ![](../../_assets/tracker/svg/settings.svg) in the filters panel or click ![](../../_assets/horizontal-ellipsis.svg) in the top-right corner of the page and select **Manage filters**. 1. Select the filters to be shown on the board and click **Apply**. -1. To edit or delete a saved filter, in the top-right corner, click ![](../../_assets/horizontal-ellipsis.svg) and select **{{ ui-key.startrek.ui_components_agile_common_QuickFilterPopup.filters-manage }}**. After that, next to the filter name, click ![](../../_assets/tracker/svg/settings.svg). +1. To edit or delete a saved filter, in the top-right corner, click ![](../../_assets/horizontal-ellipsis.svg) and select **Manage filters**. After that, next to the filter name, click ![](../../_assets/tracker/svg/settings.svg). ## Grouping issues {#group} @@ -110,11 +110,11 @@ You can move issues across groups on a [board](agile-new.md) or in a [backlog](b ## Sorting issues on a board {#sorting} -You can sort issues on a board manually or based on preset parameters, such as priority, deadline, or assignee. To sort issues, click ![](../../_assets/tracker/svg/sorting.svg) **{{ ui-key.startrek.ui_components_dashboard_IssuesStatEditor.editor-sort-by-field-label }}** at the top of the board and select the appropriate parameter from the list. Next to the sorting button, there is a button that allows you to manage the sorting direction. +You can sort issues on a board manually or based on preset parameters, such as priority, deadline, or assignee. To sort issues, click ![](../../_assets/tracker/svg/sorting.svg) **Sorting** at the top of the board and select the appropriate parameter from the list. Next to the sorting button, there is a button that allows you to manage the sorting direction. ## Bulk changes to issues {#bulk} -You can make bulk changes to issues on a board. Open an issue card on the board, click ![](../../_assets/tracker/svg/actions.svg) → **{{ ui-key.startrek.ui_components_agile_common_IssueActionsMenu.select-issue }}** and then click other issues to perform the same action on. Once you select all issues, choose the appropriate action in the board's bottom panel: +You can make bulk changes to issues on a board. Open an issue card on the board, click ![](../../_assets/tracker/svg/actions.svg) → **Select** and then click other issues to perform the same action on. Once you select all issues, choose the appropriate action in the board's bottom panel: * Move the issue up or down the column. * Change the issue status. diff --git a/en/tracker/manager/agile-new-set-board.md b/en/tracker/manager/agile-new-set-board.md index 62a60f85818..aad05b841ea 100644 --- a/en/tracker/manager/agile-new-set-board.md +++ b/en/tracker/manager/agile-new-set-board.md @@ -8,7 +8,7 @@ You can create a new issue directly on the board. You only need to specify its n 1. Open the board page. -1. In the leftmost column, click ![](../../_assets/tracker/svg/add-task.svg) and select **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardEmptyScreen.empty-screen--new-issue }}**. +1. In the leftmost column, click ![](../../_assets/tracker/svg/add-task.svg) and select **New issue**. 1. Enter a name for the issue. @@ -38,7 +38,7 @@ You can add no more than 2000 issues per board. 1. Open the issue page. -1. Click the **{{ ui-key.startrek-backend.fields.issue.boards }}** field in the right-hand panel. If you do not see the **{{ ui-key.startrek-backend.fields.issue.boards }}** field, add it by clicking **{{ ui-key.startrek.ui_components_entity-page_sidebar_SidebarFieldsSelect.add-sidebar-field }}**. +1. Click the **{{ ui-key.startrek-backend.fields.issue.boards }}** field in the right-hand panel. If you do not see the **{{ ui-key.startrek-backend.fields.issue.boards }}** field, add it by clicking **{{ ui-key.startrek.ui_Common_smart-components_entity-page_sidebar_SidebarFieldsSelect.add-sidebar-field }}**. 1. Start typing the board name and pick the option you need from the list that appears. @@ -48,7 +48,7 @@ You can add no more than 2000 issues per board. 1. Select the issues that you want to add to the board. -1. In the left-hand panel, click ![](../../_assets/horizontal-ellipsis.svg) and select **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.add-to-board }}**. +1. In the left-hand panel, click ![](../../_assets/horizontal-ellipsis.svg) and select **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.add-to-board }}**. 1. Start typing the board name and pick the option you need from the list that appears. @@ -58,8 +58,8 @@ You can add no more than 2000 issues per board. To automatically add issues, such as all issues with a certain assignee, to a board, use issue auto-import: -1. On the board, click **{{ ui-key.startrek.ui_components_PageAgileBoard_PageAgileBoardHeader.settings }}** → **{{ ui-key.startrek.ui_components_agile_settings_AgileSettingsLayout.issue-updates }}**. -1. Under **{{ ui-key.startrek.ui_components_agile_settings_BoardIssueUpdatesSettings.import-title }}**, click **+ {{ ui-key.startrek.ui_components_issues-import_IssuesImportFilters.add-parameters }}**. Select a parameter from the list and set its value. For example, to add all issues where you are the assignee to the board, select the **Assignee** parameter and set it to **Me**. To add more parameters, repeat the step. +1. On the board, click **{{ ui-key.startrek.ui_Boards_pages_PageAgileBoard_PageAgileBoardHeader.settings }}** → **Automatic issues addition and removal**. +1. Under **Adding issues to the board**, click **+ Add parameters**. Select a parameter from the list and set its value. For example, to add all issues where you are the assignee to the board, select the **Assignee** parameter and set it to **Me**. To add more parameters, repeat the step. The page will show the number of issues added to the board. During the first export, the issues that meet the preset condition will be added, except for issues that: @@ -74,8 +74,8 @@ At further updates, the board will be added all the issues that meet the paramet There is a limit on the number of issues per board: a maximum of 2,000. To make sure your board does not get overloaded, you can set up automatic issue removal, e.g., to remove any closed issues or issues that were closed several months ago. -1. On the board, click **{{ ui-key.startrek.ui_components_PageAgileBoard_PageAgileBoardHeader.settings }}** → **{{ ui-key.startrek.ui_components_agile_settings_AgileSettingsLayout.issue-updates }}**. -1. Under **{{ ui-key.startrek.ui_components_agile_settings_BoardIssueUpdatesSettings.removal-title }}**, add all appropriate statuses and specify how long an issue should be in a certain status. +1. On the board, click **{{ ui-key.startrek.ui_Boards_pages_PageAgileBoard_PageAgileBoardHeader.settings }}** → **Automatic issues addition and removal**. +1. Under **Removal of issues from the board**, add all appropriate statuses and specify how long an issue should be in a certain status. Once the condition is met, the issue will be removed from the board. @@ -115,6 +115,6 @@ Board owners can delete boards that they no longer need. All the issues present 1. Open the board. -1. In the top-right corner, click ![](../../_assets/horizontal-ellipsis.svg) and select **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardActionsMenu.delete-board-menu-item }}**. +1. In the top-right corner, click ![](../../_assets/horizontal-ellipsis.svg) and select **Delete board**. 1. Confirm the deletion. diff --git a/en/tracker/manager/agile.md b/en/tracker/manager/agile.md index 233c3da0930..fb0f5b30c11 100644 --- a/en/tracker/manager/agile.md +++ b/en/tracker/manager/agile.md @@ -32,7 +32,7 @@ Managing issue boards in {{ tracker-name }} is similar to [working with a regula - **Scrum** boards allow you to display statuses and offer [sprint](#dlen_sprint) management tools, [issue estimation](planning-poker.md), and [burn down charts](#dlen_burndown). -- **Kanban** boards are similar to basic boards, but all issues with the **Open** status are automatically moved to the [**{{ ui-key.startrek.ui_components_agile_backlog_BacklogIssue.backlog-default-column }}**](#dlen_backlog) column. +- **Kanban** boards are similar to basic boards, but all issues with the **Open** status are automatically moved to the [**Backlog**](#dlen_backlog) column. For more information about working with an issue boards: diff --git a/en/tracker/manager/attach-form.md b/en/tracker/manager/attach-form.md index 9ac38c8b8ff..3cabd089b09 100644 --- a/en/tracker/manager/attach-form.md +++ b/en/tracker/manager/attach-form.md @@ -33,7 +33,7 @@ You can use {{ forms-full-name }} to set up your form to act as a template for c 1. {% include [go to settings](../../_includes/tracker/transition-page.md) %} -1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. Under **Forms integration**, click **Add form**. diff --git a/en/tracker/manager/backlog.md b/en/tracker/manager/backlog.md index 41ae8374a35..fab429ffb6d 100644 --- a/en/tracker/manager/backlog.md +++ b/en/tracker/manager/backlog.md @@ -2,7 +2,7 @@ A backlog is a list of issues or product requirements to be completed. Backlog issues are usually sorted by priority. -You can use the **{{ ui-key.startrek.ui_components_agile_common_AgileTabs.backlog }}** tab to store your team's critical issues, sort them by priority, and distribute them across sprints. You can create new issues or add existing ones to both the backlog and directly to a sprint. To move an issue from the backlog to a sprint, just drag its card from one list to another. +You can use the **Backlog** tab to store your team's critical issues, sort them by priority, and distribute them across sprints. You can create new issues or add existing ones to both the backlog and directly to a sprint. To move an issue from the backlog to a sprint, just drag its card from one list to another. Track an issue's [validity](agile-new.md#tips) in the backlog: it should not contain any closed issues, duplicate issues, or issues that work cannot be started on in the near future. @@ -10,20 +10,20 @@ In addition to backlog and sprint columns, you can create [custom columns](agile ## Enabling a backlog on basic boards {#add-backlog} -The **{{ ui-key.startrek.ui_components_agile_common_AgileTabs.backlog }}** tab with a backlog and sprints is by default available on**{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardCreateModal.board-type--scrum }}** boards. The tab is missing on **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardCreateModal.board-type--simple }}**, but you can enable it. +The **Backlog** tab with a backlog and sprints is by default available on**With backlog and sprints** boards. The tab is missing on **Basic**, but you can enable it. {% note warning %} -Currently, you cannot disable the **{{ ui-key.startrek.ui_components_agile_common_AgileTabs.backlog }}** tab and sprints. We will add this feature later. +Currently, you cannot disable the **Backlog** tab and sprints. We will add this feature later. {% endnote %} To enable a backlog and sprints on **Basic** boards: -1. Click **{{ ui-key.startrek.ui_components_PageAgileBoard_PageAgileBoardHeader_EnableBacklogButton.enable-backlog }}** at the top of the screen. +1. Click **{{ ui-key.startrek.ui_Boards_pages_PageAgileBoard_PageAgileBoardHeader_EnableBacklogButton.enable-backlog }}** at the top of the screen. 1. If the issue board already contains issues, select where to move them: to the backlog or sprint. -This opens the **{{ ui-key.startrek.ui_components_agile_common_AgileTabs.backlog }}** tab with a list of backlog issues and sprints. +This opens the **Backlog** tab with a list of backlog issues and sprints. ## Adding issues to a backlog {#add-new-backlog} @@ -36,8 +36,8 @@ To add a single issue: To add a group of issues, such as all issues from a queue with a certain assignee, use issue auto-import: -1. On the board, click **{{ ui-key.startrek.ui_components_PageAgileBoard_PageAgileBoardHeader.settings }}** → **{{ ui-key.startrek.ui_components_agile_settings_AgileSettingsLayout.issue-updates }}**. -1. Under **{{ ui-key.startrek.ui_components_agile_settings_BoardIssueUpdatesSettings.import-title }}**, click **+ {{ ui-key.startrek.ui_components_issues-import_IssuesImportFilters.add-parameters }}**. Select a parameter from the list and set its value. For example, to add all issues where you are the assignee to the board, select the **Assignee** parameter and set it to **Me**. To add more parameters, repeat the step. +1. On the board, click **{{ ui-key.startrek.ui_Boards_pages_PageAgileBoard_PageAgileBoardHeader.settings }}** → **Automatic issues addition and removal**. +1. Under **Adding issues to the board**, click **+ Add parameters**. Select a parameter from the list and set its value. For example, to add all issues where you are the assignee to the board, select the **Assignee** parameter and set it to **Me**. To add more parameters, repeat the step. You can also add a group of issues using [bulk edits](agile-new-issues.md#bulk): 1. On the [search issues]({{ link-tracker }}issues) page, select the issues to add by selecting the checkboxes to the left of the issue names. diff --git a/en/tracker/manager/backward-compatibility.md b/en/tracker/manager/backward-compatibility.md index 79a20ef5d99..6d85eb7db84 100644 --- a/en/tracker/manager/backward-compatibility.md +++ b/en/tracker/manager/backward-compatibility.md @@ -28,9 +28,9 @@ Before deleting a workflow, make sure you maintain backward compatibility for ex Once you ensured backward compatibility for the issue types of the workflow to be deleted, you can proceed to deleting it: -1. Open the queue page and go to its settings by clicking ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. Open the queue page and go to its settings by clicking ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. In the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab, find the workflow you want to delete. +1. In the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab, find the workflow you want to delete. 1. Delete the [resolutions](./create-resolution.md#delete-resolution) and [issue types](./add-ticket-type.md#delete-ticket-type) in this workflow. diff --git a/en/tracker/manager/boards-convertor.md b/en/tracker/manager/boards-convertor.md index fb337510e73..cca159ac484 100644 --- a/en/tracker/manager/boards-convertor.md +++ b/en/tracker/manager/boards-convertor.md @@ -28,7 +28,7 @@ When migrating the board, the following is retained: * Name * Issues added * Status distribution by column -* {{ ui-key.startrek.ui_components_IssuesPresetSelect.preset_author }} and {{ ui-key.startrek.ui_components_IssuesPresetSelect.preset_assignee }} filters +* {{ ui-key.startrek.ui_Issues_smart-components_IssuesPresetSelect.preset_author }} and {{ ui-key.startrek.ui_Issues_smart-components_IssuesPresetSelect.preset_assignee }} filters * Filter for adding issues The board type is also retained during migration: **Basic** and **Kanban** (have the same functionality) boards are converted into basic boards, while **Scrum** boards become boards with a backlog and sprints. @@ -61,11 +61,11 @@ To perform migration: 1. Review the migration window: * If there are errors, follow the recommendations on how to fix them and try again. - * If there are no errors, click **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardMigrationForm.submit-btn }}**. This may take a few minutes. + * If there are no errors, click **Start switching**. This may take a few minutes. ## Switching back to the old board version {#backward} -If, after switching to our new technologies, you decide that they do not suit you, you can roll your board back to its original view. To do this, click ![](../../_assets/tracker/svg/actions.svg) → **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardActionsMenu.migration-rollback }}** in the board's top panel and wait until it switches back. +If, after switching to our new technologies, you decide that they do not suit you, you can roll your board back to its original view. To do this, click ![](../../_assets/tracker/svg/actions.svg) → **Switch back to the old version** in the board's top panel and wait until it switches back. {% note warning %} diff --git a/en/tracker/manager/bulk-change.md b/en/tracker/manager/bulk-change.md index 3f7ddd301ff..6809335fdfc 100644 --- a/en/tracker/manager/bulk-change.md +++ b/en/tracker/manager/bulk-change.md @@ -12,7 +12,7 @@ To change the issue status: If you want to select all the issues on the queue or filter page at once, check the box ![](../../_assets/tracker/svg/check.svg) above the list of issues. -1. Click **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.change-status }}** under the issue list and select the status. +1. Click **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.change-status }}** under the issue list and select the status. Only status transitions that are included in the [workflow](workflow.md) are available for bulk change. If you select a status change that is available only to part of the issues, only this part will change their status. @@ -30,7 +30,7 @@ To edit the issue queue: If you want to select all the issues on the queue or filter page at once, check the box ![](../../_assets/tracker/svg/check.svg) above the list of issues. -1. Click **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.move }}** under the issue list. +1. Click **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.move }}** under the issue list. 1. Select the queue that the issues will be moved to. @@ -50,7 +50,7 @@ To add a link to multiple issues at once: If you want to select all the issues on the queue or filter page at once, check the box ![](../../_assets/tracker/svg/check.svg) above the list of issues. -1. Click **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.add-link }}** under the list of issues, select the [link type](../user/links.md), and create the link: +1. Click **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.add-link }}** under the list of issues, select the [link type](../user/links.md), and create the link: * To create an issue, click the **New issue** tab. Give your issue a name and press **Enter**. @@ -68,9 +68,9 @@ To add issues to a board or project: 1. Click ![](../../_assets/horizontal-ellipsis.svg) under the issue list. - * To add issues to the board, click **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.add-to-board }}**. Select one or more boards, then click **{{ ui-key.startrek.ui_components_bulk_BulkChangeParametersDialog.button-submit-text }}**. + * To add issues to the board, click **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.add-to-board }}**. Select one or more boards, then click **{{ ui-key.startrek.ui_Common_smart-components_bulk_BulkChangeParametersDialog.button-submit-text }}**. - * To add the issue to a project, select **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.add-to-projects }}**. All the subissues will also be added to the project + * To add the issue to a project, select **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.add-to-projects }}**. All the subissues will also be added to the project ## Changing field settings {#change-parameters} @@ -82,7 +82,7 @@ To edit issue parameters: If you want to select all the issues on the queue or filter page at once, check the box ![](../../_assets/tracker/svg/check.svg) above the list of issues. -1. Click ![](../../_assets/horizontal-ellipsis.svg) under the issue list and select **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.edit-parameters }}**. +1. Click ![](../../_assets/horizontal-ellipsis.svg) under the issue list and select **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.edit-parameters }}**. 1. Select relevant parameters. If the fields you need are not in the list, use the **Edit parameter list** button to add them. @@ -90,11 +90,11 @@ To edit issue parameters: Some fields, such as **Followers**, **{{ ui-key.startrek-backend.messages.workflow.field.maillists }}**, or **Tags**, may contain a list of values. New values are added to the end of the list by default. To overwrite a field, select **Delete values**. -1. Click **{{ ui-key.startrek.ui_components_BulkSuggestPopup.apply }}**. +1. Click **{{ ui-key.startrek.ui_Common_smart-components_BulkSuggestPopup.apply }}**. ## Becoming an issue participant {#change-my-tickets} -To add or remove oneself from the **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.assignee }}** or **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.followers }}** field in an issue: +To add or remove oneself from the **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.assignee }}** or **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.followers }}** field in an issue: 1. Open the issue list. @@ -104,6 +104,6 @@ To add or remove oneself from the **{{ ui-key.startrek.ui_components_IssueBulkAc 1. Click ![](../../_assets/horizontal-ellipsis.svg) under the issue list and select one of the options. - * To become an issue participant, select **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.add-me-to-followers }}** or **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.assignee-me }}**. + * To become an issue participant, select **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.add-me-to-followers }}** or **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.assignee-me }}**. - * To withdraw your participation in the issue, select **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.remove-me-from }}** and specify **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.followers }}**, **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.assignee }}**, or **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.remove-from-both-fields }}**. + * To withdraw your participation in the issue, select **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.remove-me-from }}** and specify **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.followers }}**, **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.assignee }}**, or **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.remove-from-both-fields }}**. diff --git a/en/tracker/manager/create-agile-board.md b/en/tracker/manager/create-agile-board.md index a6571866677..7886ba1a21c 100644 --- a/en/tracker/manager/create-agile-board.md +++ b/en/tracker/manager/create-agile-board.md @@ -25,7 +25,7 @@ To create a board: Select this board if you are using the Scrum methodology. - - **Kanban** boards are similar to basic boards, but all issues with the **Open** status are automatically moved to the [**{{ ui-key.startrek.ui_components_agile_backlog_BacklogIssue.backlog-default-column }}**](agile.md#dlen_backlog) column. + - **Kanban** boards are similar to basic boards, but all issues with the **Open** status are automatically moved to the [**Backlog**](agile.md#dlen_backlog) column. Select this board if your team deals with a massive flow of issues (for example, to support customers). @@ -51,6 +51,6 @@ To create a board: 1. Specify the queue where the issues will be created. This way, you can quickly create issues in this queue directly from the board page. -1. Click **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardCreateModal.submit-btn }}**. The new board appears in the **Boards** menu in the {{ tracker-name }} top panel. +1. Click **Create**. The new board appears in the **Boards** menu in the {{ tracker-name }} top panel. 1. You can also [customize the columns and appearance of the issue card](edit-agile-board.md) if needed. diff --git a/en/tracker/manager/create-agile-sprint.md b/en/tracker/manager/create-agile-sprint.md index b16fb7f425c..d5964f9bf41 100644 --- a/en/tracker/manager/create-agile-sprint.md +++ b/en/tracker/manager/create-agile-sprint.md @@ -18,36 +18,36 @@ Use [Planning Poker on the issue board](poker.md) to assess the complexity of is #### Step 2. Create a new sprint {#create_sprint} -After you create an issue board in the **{{ ui-key.startrek.ui_components_agile_common_AgileTabs.backlog }}** tab, it already has the first sprint created. If you have not planned it yet, proceed to the next step. If your first sprint is already completed and you want to create a new one: +After you create an issue board in the **Backlog** tab, it already has the first sprint created. If you have not planned it yet, proceed to the next step. If your first sprint is already completed and you want to create a new one: -1. Click **+ {{ ui-key.startrek.ui_components_agile_common_SprintForm.create-sprint }}** in the **{{ ui-key.startrek.ui_components_agile_common_AgileTabs.backlog }}** tab to the right of the board. +1. Click **+ Create sprint** in the **Backlog** tab to the right of the board. -1. Enter a name for the sprint, its duration, and start and end time. To start working on the sprint immediately, leave the **{{ ui-key.startrek.ui_components_agile_common_SprintFormFields.take-sprint-to-work }}** option enabled. +1. Enter a name for the sprint, its duration, and start and end time. To start working on the sprint immediately, leave the **Take to work** option enabled. -1. Click **{{ ui-key.startrek.ui_components_agile_common_SprintForm.create-sprint }}**. +1. Click **Create sprint**. #### Step 3. Add issues to the sprint There are several ways to add an issue to a sprint: -- In the **{{ ui-key.startrek.ui_components_agile_common_AgileTabs.backlog }}** tab, drag an issue from the **{{ ui-key.startrek.ui_components_agile_backlog_BacklogIssue.backlog-default-column }}** column to the sprint's column. +- In the **Backlog** tab, drag an issue from the **Backlog** column to the sprint's column. - On the issue page, enter the board name or ID in the **{{ ui-key.startrek-backend.fields.issue.boards }}** field of the left-hand panel and select the appropriate sprint in the **{{ ui-key.startrek-backend.fields.issue.sprint }}** field under **{{ ui-key.startrek-backend.fields.issue.fields.agile }}**. -- To quickly add multiple issues, use [bulk edits](agile-new-issues.md#bulk): click ![](../../_assets/tracker/svg/actions.svg) → **{{ ui-key.startrek.ui_components_agile_common_IssueActionsMenu.select-issue }}** in an issue card on the board and then click other issues you want to add to the sprint. Once you select all issues, click **{{ ui-key.startrek.ui_components_agile_common_BulkActionsPanel.add-to-sprint }}** in the board's bottom panel and select the one you need. +- To quickly add multiple issues, use [bulk edits](agile-new-issues.md#bulk): click ![](../../_assets/tracker/svg/actions.svg) → **Select** in an issue card on the board and then click other issues you want to add to the sprint. Once you select all issues, click **Add to sprint** in the board's bottom panel and select the one you need. ## Editing a sprint {#sprint-edit} To edit a sprint: -1. To the right of the sprint header, click ![](../../_assets/horizontal-ellipsis.svg) → ![](../../_assets/tracker/svg/icon-edit.svg) **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardColumnHeader.column-menu--edit }}**. +1. To the right of the sprint header, click ![](../../_assets/horizontal-ellipsis.svg) → ![](../../_assets/tracker/svg/icon-edit.svg) **Edit**. -1. In the window that opens, you can rename the sprint, change its duration and start and end time, as well as enable the **{{ ui-key.startrek.ui_components_agile_common_SprintFormFields.take-sprint-to-work }}** option. +1. In the window that opens, you can rename the sprint, change its duration and start and end time, as well as enable the **Take to work** option. -1. To save your changes, tap **{{ ui-key.startrek.ui_components_agile_common_SprintForm.edit-sprint }}**. +1. To save your changes, tap **Edit sprint**. ## Changing sprint status {#sprint-status} -When all the sprint issues are planned and the sprint date has arrived, click **{{ ui-key.startrek.ui_components_agile_common_StartSprintButton.start }}** in the board's **{{ ui-key.startrek.ui_components_agile_common_AgileTabs.backlog }}** tab next to the sprint. +When all the sprint issues are planned and the sprint date has arrived, click **Start** in the board's **Backlog** tab next to the sprint. -Once you complete your work on the sprint, click **Complete** next to it. If the sprint has any incomplete issues, you will be prompted to leave them in the current sprint, return them to the backlog, or move them to a new sprint that can be created immediately. As soon as all the issues are completed, the sprint will be displayed under **{{ ui-key.startrek.ui_components_agile_common_FinishedSprintsButton.finished-sprints }}**. +Once you complete your work on the sprint, click **Complete** next to it. If the sprint has any incomplete issues, you will be prompted to leave them in the current sprint, return them to the backlog, or move them to a new sprint that can be created immediately. As soon as all the issues are completed, the sprint will be displayed under **Finished sprints**. diff --git a/en/tracker/manager/create-macroses.md b/en/tracker/manager/create-macroses.md index 88c0b95d290..1cdd31addff 100644 --- a/en/tracker/manager/create-macroses.md +++ b/en/tracker/manager/create-macroses.md @@ -14,7 +14,7 @@ Each {{ tracker-name }} queue has its own set of macros. To create a new macro f 1. {% include [go to settings](../../_includes/tracker/transition-page.md) %} -1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. On the left-hand panel, select **Automation** → **Macros** and click **Create macro**. @@ -37,7 +37,7 @@ By default, [only the queue owner](queue-access.md) can configure a queue. 1. {% include [go to settings](../../_includes/tracker/transition-page.md) %} -1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. On the left-hand panel, select **Automation** → **Macros** and hover over the macro you need. @@ -59,7 +59,7 @@ To execute the macro: You can select multiple macros at the same time. If the macros affect the same parameter, the last selected macro will be applied to the parameter. -1. To execute the macro, click **{{ ui-key.startrek.ui_components_entity-page_macros_MacrosExecutor.apply-button-label }}**. +1. To execute the macro, click **Run**. ## Example of a macro {#macro_example} @@ -94,4 +94,4 @@ To execute the created macro: 1. Click ![](../../_assets/tracker/svg/macros.svg) **Macros** and select a macro from the drop-down list. -1. Click **{{ ui-key.startrek.ui_components_entity-page_macros_MacrosExecutor.apply-button-label }}**. The issue will be forwarded to Tier 2 support. \ No newline at end of file +1. Click **Run**. The issue will be forwarded to Tier 2 support. \ No newline at end of file diff --git a/en/tracker/manager/create-portfolio.md b/en/tracker/manager/create-portfolio.md index 918a5cfd8b3..33e0132fbee 100644 --- a/en/tracker/manager/create-portfolio.md +++ b/en/tracker/manager/create-portfolio.md @@ -24,7 +24,7 @@ To create a project portfolio: 1. Enter a name for the portfolio, set its end date, and click **Create**. -1. In the **{{ ui-key.startrek.ui_components_portfolios_Header.description-tab }}** tab, add the following information: +1. In the **About the portfolio** tab, add the following information: * Portfolio description: What you are working on and what goals you want to achieve. * Attachments: Working materials of the portfolio. @@ -142,4 +142,4 @@ To delete a portfolio: 1. In the left-hand panel, select ![](../../_assets/tracker/svg/project.svg) **Projects** or follow the [direct link]({{ link-tracker }}pages/projects) and open the portfolio page. -1. In the top-right corner, click ![](../../_assets/horizontal-ellipsis.svg) and select **{{ ui-key.startrek.ui_components_portfolios_PortfolioMenu.remove-portfolio }}**. +1. In the top-right corner, click ![](../../_assets/horizontal-ellipsis.svg) and select **Delete portfolio**. diff --git a/en/tracker/manager/create-project.md b/en/tracker/manager/create-project.md index a87fe927477..aca9f9427d2 100644 --- a/en/tracker/manager/create-project.md +++ b/en/tracker/manager/create-project.md @@ -62,7 +62,7 @@ To create a project based on an issue: 1. Open the issue page. The issue should not belong to another project. To delete an issue from the project, clear the **{{ ui-key.startrek-backend.fields.issue.project-key-value }}** field in the right-hand panel. -1. In the top-right corner, select **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.convert-to-project }}**, then click **Convert**. +1. In the top-right corner, select **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.convert-to-project }}**, then click **Convert**. ## Adding issues to a project {#add-tickets} @@ -77,7 +77,7 @@ You can add your issue to up to 40 projects, including the main one. ### From the project page {#from-project} -1. Go to the **Issue list** tab, then click **{{ ui-key.startrek.ui_components_projects_Table.add-issue }}**. +1. Go to the **Issue list** tab, then click **Add issue**. 1. To create a new issue: @@ -93,7 +93,7 @@ You can add your issue to up to 40 projects, including the main one. 1. Open the issue page. -1. Click the **Project** field on the right-hand panel. If you do not see the **Project** field, add it by clicking **{{ ui-key.startrek.ui_components_issues-import_IssuesImportFilters.add-parameters }}**. +1. Click the **Project** field on the right-hand panel. If you do not see the **Project** field, add it by clicking **Add parameters**. 1. In the **Main** or **Additional** field, start typing the project name and pick the option you need from the list. Click **Save**. @@ -103,7 +103,7 @@ You can add your issue to up to 40 projects, including the main one. 1. Select the issues that you want to add to the project. -1. In the left-hand panel, click ![](../../_assets/horizontal-ellipsis.svg) and select **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.add-to-projects }}**. +1. In the left-hand panel, click ![](../../_assets/horizontal-ellipsis.svg) and select **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.add-to-projects }}**. 1. Start typing the project name and pick the option you need from the list that appears. @@ -115,9 +115,9 @@ You can add your issue to up to 40 projects, including the main one. 1. In the top-right corner, click **Import issues**. -1. Click ![](../../_assets/tracker/svg/add-task.svg) **{{ ui-key.startrek.ui_components_issues-import_IssuesImportFilters.add-parameters }}** and specify an issue selection criterion. +1. Click ![](../../_assets/tracker/svg/add-task.svg) **Add parameters** and specify an issue selection criterion. -1. Click **{{ ui-key.startrek.ui_components_issues-import_IssuesImportDialog.import }}** and wait until your issues are imported. +1. Click **Import** and wait until your issues are imported. ## Adding links for a project {#links} diff --git a/en/tracker/manager/create-queue.md b/en/tracker/manager/create-queue.md index 9224e4c5167..012b4ae0e63 100644 --- a/en/tracker/manager/create-queue.md +++ b/en/tracker/manager/create-queue.md @@ -13,7 +13,7 @@ The user who created the queue becomes its owner. The owner either configures th To create a new queue: -1. In the left-hand panel, select ![](../../_assets/tracker/svg/queues.svg) **{{ ui-key.startrek.ui_components_TrackerSearch.queues }}** → **New queue**. +1. In the left-hand panel, select ![](../../_assets/tracker/svg/queues.svg) **{{ ui-key.startrek.ui_Common_smart-components_TrackerSearch.queues }}** → **New queue**. 1. Select queue template Depending on the issue types and statuses, templates belong to one of the categories: @@ -56,7 +56,7 @@ You can use the queue key in order to: If you want to use the settings of an existing queue, copy the queue: -1. In the left-hand panel, select ![](../../_assets/tracker/svg/queues.svg) **{{ ui-key.startrek.ui_components_TrackerSearch.queues }}** → **New queue**. +1. In the left-hand panel, select ![](../../_assets/tracker/svg/queues.svg) **{{ ui-key.startrek.ui_Common_smart-components_TrackerSearch.queues }}** → **New queue**. 1. Click **Copy queue**. @@ -82,7 +82,7 @@ If you want to use the settings of an existing queue, copy the queue: If none of the preset queue types fit your issues, you can set all parameters for your new queue manually: -1. In the left-hand panel, select ![](../../_assets/tracker/svg/queues.svg) **{{ ui-key.startrek.ui_components_TrackerSearch.queues }}** → **New queue**. +1. In the left-hand panel, select ![](../../_assets/tracker/svg/queues.svg) **{{ ui-key.startrek.ui_Common_smart-components_TrackerSearch.queues }}** → **New queue**. 1. Click **Configure the queue manually**. diff --git a/en/tracker/manager/create-resolution.md b/en/tracker/manager/create-resolution.md index 45675a6daf1..2e21695f12c 100644 --- a/en/tracker/manager/create-resolution.md +++ b/en/tracker/manager/create-resolution.md @@ -12,9 +12,9 @@ To add a resolution to a queue: 1. Go to the queue page. -1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Go to the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab. It shows the list of workflows in the queue. To see what issue types and resolutions are set in each workflow, click ![](../../_assets/tracker/svg/arrow.svg) in the respective workflow line. +1. Go to the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab. It shows the list of workflows in the queue. To see what issue types and resolutions are set in each workflow, click ![](../../_assets/tracker/svg/arrow.svg) in the respective workflow line. 1. To add a resolution to an existing workflow, hover over the part of this workflow line containing resolutions. Click the ![](../../_assets/tracker/svg/add-filter.svg) icon that appears and select a resolution from the list. To learn how to add a resolution to a new workflow, see the [guide on creating workflows](./add-workflow.md#create). @@ -45,9 +45,9 @@ You can also create a resolution on the workflows page. The new resolution will 1. Go to the queue page. -1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Go to the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab. It shows the list of workflows in the queue. Select the workflow to add your new resolution to. +1. Go to the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab. It shows the list of workflows in the queue. Select the workflow to add your new resolution to. 1. Hover over the part of the line with resolutions. Click the ![](../../_assets/tracker/svg/add-filter.svg) icon that appears, start typing the name of the new resolution, and click the **Create** button. @@ -66,8 +66,8 @@ Before removing a resolution from the queue, make sure none of the queue issues 1. Use filters to [find all the issues in the queue](quick-filters.md) that include the resolution to be deleted. After that, change the resolution for such issues or update their status. -1. In the top-right corner of the queue page, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner of the queue page, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Go to the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab. It shows the list of workflows in the queue. Select the workflow containing the resolution you want to remove. +1. Go to the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab. It shows the list of workflows in the queue. Select the workflow containing the resolution you want to remove. 1. Hover over the line with the resolution to be removed and click the cross icon next to this resolution. diff --git a/en/tracker/manager/create-work-process.md b/en/tracker/manager/create-work-process.md index a741810a442..a032c2305ca 100644 --- a/en/tracker/manager/create-work-process.md +++ b/en/tracker/manager/create-work-process.md @@ -2,7 +2,7 @@ A workflow template is a set of {{ tracker-name }} tools grouped and configured for most common workflows. -## {{ ui-key.startrek.ui_components_new-process_ProcessTypeStepRedesign.process-type-project }} {#manage-process-template} +## {{ ui-key.startrek.ui_Queues_smart-components_new-process_ProcessTypeStepRedesign.process-type-project }} {#manage-process-template} This template is good for projects that are limited in time and number of issues. A project is aimed to achieve the same result by one or more teams. By using projects, you can easily group issues of several teams focused on the same goal, set the [issue hierarchy](project-list.md), and plan deadlines. @@ -12,7 +12,7 @@ When you select this template, the following items are created automatically: You can create additional queues separately. -## {{ ui-key.startrek.ui_components_new-process_ProcessTypeStepRedesign.process-type-development }} {#for-developers-template} +## {{ ui-key.startrek.ui_Queues_smart-components_new-process_ProcessTypeStepRedesign.process-type-development }} {#for-developers-template} This template is suitable for software development teams that use [Scrum]({{ link-wiki-scrum }}). With the {{ tracker-name }} tools, you can decompose projects using [epics](epic.md) and [stories](agile.md#sec_basics), plan sprints, and [estimate issues](planning-poker.md). @@ -22,7 +22,7 @@ When you select this template, the following items are created automatically: If you are using cloud-based services, such as GitHub, GitLab, or Bitbucket, you can [connect](../user/add-repository.md) any number of repositories and [link](../user/ticket-links.md#section_commit) commits to issues. -## {{ ui-key.startrek.ui_components_new-process_ProcessTypeStepRedesign.process-type-support }} {#for-support-template} +## {{ ui-key.startrek.ui_Queues_smart-components_new-process_ProcessTypeStepRedesign.process-type-support }} {#for-support-template} This template is good for internal and external support services. You can create issues [from emails](queue-mail.md) sent to the support team's email address or via the [feedback form](forms-integration.md) on your website, as well as from the {{ tracker-name }} interface using the embedded form. This template has sample response templates, [SLA](sla.md) timers, and auto responses pre-configured. @@ -31,7 +31,7 @@ When you select this template, the following items are created automatically: * [Basic issue board](boards-project.md). * [Queue](create-queue.md) with a basic set of issue [types and statuses](workflow.md). -## {{ ui-key.startrek.ui_components_new-process_ProcessTypeStepRedesign.process-type-standard }} {#basic-template} +## {{ ui-key.startrek.ui_Queues_smart-components_new-process_ProcessTypeStepRedesign.process-type-standard }} {#basic-template} It is good for getting started with {{ tracker-name }}. If you select this template, you can then configure and extend it. @@ -41,14 +41,14 @@ When you select this template, the following items are created automatically: ## Creating a workflow based on a template {#create-from-template} -1. On the [**My page**](https://tracker.yandex.ru/pages/my) home page, click **{{ ui-key.startrek.ui_components_dashboard_InfoPresetsWidget.choose-template-button }}** in the **{{ ui-key.startrek.ui_components_dashboard_InfoPresetsWidget.widget-title }}** widget. -1. Select the template you need and click **{{ ui-key.startrek.ui_components_new-process_QueueSetupForm.next-button }}**. +1. On the [**My page**](https://tracker.yandex.ru/pages/my) home page, click **{{ ui-key.startrek.ui_Dashboards_smart-components_InfoPresetsWidget.choose-template-button }}** in the **{{ ui-key.startrek.ui_Dashboards_smart-components_InfoPresetsWidget.widget-title }}** widget. +1. Select the template you need and click **{{ ui-key.startrek.ui_Queues_smart-components_new-process_QueueSetupForm.next-button }}**. 1. Specify the queue parameters: * Issue queue name * [Queue key](create-queue.md#key) * Permissions -1. Click **{{ ui-key.startrek.ui_components_new-process_QueueSetupForm.next-button }}**. Depending on the selected template, one of the following items will open: - * [{{ ui-key.startrek.ui_components_new-process_ProcessTypeStepRedesign.process-type-project }}](create-work-process.md#manage-process-template): New project page. - * [{{ ui-key.startrek.ui_components_new-process_ProcessTypeStepRedesign.process-type-development }}](create-work-process.md#for-developers-template): Board with a backlog. - * [{{ ui-key.startrek.ui_components_new-process_ProcessTypeStepRedesign.process-type-support }}](create-work-process.md#for-support-template): Issue queue. - * [{{ ui-key.startrek.ui_components_new-process_ProcessTypeStepRedesign.process-type-standard }}](create-work-process.md#basic-template): Issue board. \ No newline at end of file +1. Click **{{ ui-key.startrek.ui_Queues_smart-components_new-process_QueueSetupForm.next-button }}**. Depending on the selected template, one of the following items will open: + * [{{ ui-key.startrek.ui_Queues_smart-components_new-process_ProcessTypeStepRedesign.process-type-project }}](create-work-process.md#manage-process-template): New project page. + * [{{ ui-key.startrek.ui_Queues_smart-components_new-process_ProcessTypeStepRedesign.process-type-development }}](create-work-process.md#for-developers-template): Board with a backlog. + * [{{ ui-key.startrek.ui_Queues_smart-components_new-process_ProcessTypeStepRedesign.process-type-support }}](create-work-process.md#for-support-template): Issue queue. + * [{{ ui-key.startrek.ui_Queues_smart-components_new-process_ProcessTypeStepRedesign.process-type-standard }}](create-work-process.md#basic-template): Issue board. \ No newline at end of file diff --git a/en/tracker/manager/delete-queue.md b/en/tracker/manager/delete-queue.md index c161d2db53d..87ca95b292c 100644 --- a/en/tracker/manager/delete-queue.md +++ b/en/tracker/manager/delete-queue.md @@ -23,9 +23,9 @@ To delete a queue and all the issues in it: 1. Open the [queue page](../user/queue.md). -1. In the top-right corner of the page, click ![](../../_assets/tracker/svg/settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner of the page, click ![](../../_assets/tracker/svg/settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. In the top-right corner of the page, click ![](../../_assets/horizontal-ellipsis.svg) → ![](../../_assets/tracker/svg/icon-remove.svg) **{{ ui-key.startrek.ui_components_page-queue-admin_QueueActionsMenu.remove-queue-action }}**. +1. In the top-right corner of the page, click ![](../../_assets/horizontal-ellipsis.svg) → ![](../../_assets/tracker/svg/icon-remove.svg) **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueActionsMenu.remove-queue-action }}**. 1. Confirm the deletion. diff --git a/en/tracker/manager/edit-agile-board.md b/en/tracker/manager/edit-agile-board.md index 475c16819ce..e115543db18 100644 --- a/en/tracker/manager/edit-agile-board.md +++ b/en/tracker/manager/edit-agile-board.md @@ -23,7 +23,7 @@ description: In this tutorial, you will learn how to edit or delete a board in { 1. Use the **Columns** tab to customize the settings and appearance of your board's columns: - - Creating columns: Click **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardAddColumnButton.new-column-button }}** to the right of the board's column list. + - Creating columns: Click **Add column** to the right of the board's column list. - Renaming columns: click the ![](../../_assets/tracker/button-edit.png) button to the right of the column name. To save your changes, click ![](../../_assets/tracker/approve-checkmark.png). diff --git a/en/tracker/manager/edit-queue-general.md b/en/tracker/manager/edit-queue-general.md index 0dab1eab714..1e055c7028d 100644 --- a/en/tracker/manager/edit-queue-general.md +++ b/en/tracker/manager/edit-queue-general.md @@ -16,7 +16,7 @@ To set up the basic parameters of the queue: 1. Open the [queue page](../user/queue.md). -1. In the top-right corner of the page, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner of the page, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. Go to the **Basic settings** tab. diff --git a/en/tracker/manager/epic-new.md b/en/tracker/manager/epic-new.md index 115f55f45a6..80470aa5099 100644 --- a/en/tracker/manager/epic-new.md +++ b/en/tracker/manager/epic-new.md @@ -17,7 +17,7 @@ You can only create an epic in a queue that has epic as an issue type. 1. On the board, click ![](../../_assets/tracker/svg/icon-add.svg) **Create issue**. 1. Go to the page with the full issue creation form. To do this, click ![](../../_assets/tracker/svg/open-full.svg) (**Open full form**). 1. Fill in all the required issue fields. In the **Type** field, specify `{{ ui-key.startrek-backend.fields.issue.epic }}`. -1. Click **{{ ui-key.startrek.ui_components_CreateIssueForm.create-issue }}**. +1. Click **Create issue**. ## Adding an issue to an epic {#add-to-epic} @@ -25,7 +25,7 @@ You can add an issue to an epic via a [link](../user/ticket-links.md) either fro ### Adding an issue from the epic page {#add-from-epic} -1. On the epic page under **{{ ui-key.startrek.ui_components_issue-links_InternalLinksCollapse.relations }}**, click **Add link**. +1. On the epic page under **Related issues**, click **Add link**. 1. Select the **{{ ui-key.startrek-backend.fields.issue.links.relationship.has.epic }}** link type. @@ -33,7 +33,7 @@ You can add an issue to an epic via a [link](../user/ticket-links.md) either fro ### Adding an issue from the issue page {#add-from-task} -1. On the issue page under **{{ ui-key.startrek.ui_components_issue-links_InternalLinksCollapse.relations }}**, click **Add link**. +1. On the issue page under **Related issues**, click **Add link**. 1. Select the **{{ ui-key.startrek-backend.fields.issue.epic }}** link type. @@ -57,11 +57,11 @@ You can remove an issue from an epic either on the issue page or on a board. ### Removing an issue on the issue page {#remove-from-task} -On the issue page under **{{ ui-key.startrek.ui_components_issue-links_InternalLinksCollapse.relations }}**, remove the link to the epic in the **{{ ui-key.startrek-backend.fields.issue.epic }}** section. +On the issue page under **Related issues**, remove the link to the epic in the **{{ ui-key.startrek-backend.fields.issue.epic }}** section. ### Removing an issue on a board {#remove-on-board} -Open the board, [group issues by epic](#group-by-epic), and drag the issue card to **{{ ui-key.startrek.ui_components_IssuesGroupHeader.no-epic }}**. +Open the board, [group issues by epic](#group-by-epic), and drag the issue card to **No epic**. ## Grouping issues by epic {#group-by-epic} @@ -77,7 +77,7 @@ You can set up issue display by epic on your board or queue page. To filter issues by epic on your board: -1. In the top-right corner, click ![](../../_assets/tracker/svg/filter.svg) **{{ ui-key.startrek.ui_components_page-issues_touch_FilterSettingsMenu.item-filters }}**. The filter setup panel will be shown above the board's columns. +1. In the top-right corner, click ![](../../_assets/tracker/svg/filter.svg) **Filters**. The filter setup panel will be shown above the board's columns. 1. Click ![](../../_assets/tracker/svg/add-filter.svg). Select **{{ ui-key.startrek-backend.fields.issue.epic }}**. 1. In the dialog box that opens, enter the key of the epic by which you want to filter issues. @@ -85,7 +85,7 @@ To filter issues by epic on your board: You can also filter issues in a queue or on the issue page using the [query language](../user/query-filter.md): -1. In the top-right corner of the page, click ![](../../_assets/tracker/svg/query-language.svg) **{{ ui-key.startrek.ui_components_dashboard_FilterEditor.editor-source-radio-query }}**. All the current search parameters that were set using quick filters and conditions will be shown in the query string. +1. In the top-right corner of the page, click ![](../../_assets/tracker/svg/query-language.svg) **Query language**. All the current search parameters that were set using quick filters and conditions will be shown in the query string. 1. Add the filtering conditions by epic to the string, e.g.: * Show all issues that have an epic: diff --git a/en/tracker/manager/epic.md b/en/tracker/manager/epic.md index 5a7797c3a06..49a400ddd56 100644 --- a/en/tracker/manager/epic.md +++ b/en/tracker/manager/epic.md @@ -42,7 +42,7 @@ On the sprint page, drag an issue from the backlog or any sprint to the epic car You can also add issues to epics using [links](../user/ticket-links.md): -1. Click **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.title }}** → **Add link** on the issue page. +1. Click **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.title }}** → **Add link** on the issue page. 1. Select the **{{ ui-key.startrek-backend.fields.issue.links.relationship.has.epic }}** link type. diff --git a/en/tracker/manager/history.md b/en/tracker/manager/history.md index 4b6b406604e..18e6f1b052e 100644 --- a/en/tracker/manager/history.md +++ b/en/tracker/manager/history.md @@ -15,6 +15,6 @@ The revision history saves: By default, entries in the revision history are listed chronologically. -To change the order of entries, click the ![](../../_assets/tracker/svg/new-first.svg) **{{ ui-key.startrek.ui_components_entity-page_ActivitySection.new-activity-on-top }}** button to the right of the **{{ ui-key.startrek.ui_components_entity-page_ActivitySection.activity }}** section. +To change the order of entries, click the ![](../../_assets/tracker/svg/new-first.svg) **New comments first** button to the right of the **Activity** section. The project or portfolio comments will also get reordered. diff --git a/en/tracker/manager/my-projects.md b/en/tracker/manager/my-projects.md index 2631b044db3..505b7b10b10 100644 --- a/en/tracker/manager/my-projects.md +++ b/en/tracker/manager/my-projects.md @@ -34,7 +34,7 @@ You can use filters to perform a search in any of these tabs: * To find a portfolio or project by name, enter it in the **Search** field. If your current tab is **Structure**, you will automatically switch to the **List** tab. -* To select a search parameter by a portfolio or project field, click its name above the list. To select advanced search parameters, click ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_components_filter-pane_FieldsSelectButton.add-filter-field-button-title }}** and select a field. +* To select a search parameter by a portfolio or project field, click its name above the list. To select advanced search parameters, click ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_Common_smart-components_filter-pane_FieldsSelectButton.add-filter-field-button-title }}** and select a field. {% note info %} @@ -42,7 +42,7 @@ You can use filters to perform a search in any of these tabs: {% endnote %} -* To set up the display order, click ![](../../_assets/tracker/svg/sorting.svg) **{{ ui-key.startrek.ui_components_SortButton.default-title }}** and select a parameter. +* To set up the display order, click ![](../../_assets/tracker/svg/sorting.svg) **{{ ui-key.startrek.ui_Common_smart-components_SortButton.default-title }}** and select a parameter. {% note info %} diff --git a/en/tracker/manager/planning-poker.md b/en/tracker/manager/planning-poker.md index 0f0d00aa470..8f5a5f562e3 100644 --- a/en/tracker/manager/planning-poker.md +++ b/en/tracker/manager/planning-poker.md @@ -12,7 +12,7 @@ Planning poker is only available for **Scrum** boards. ## Estimating effort for issues {#section_estimate} -1. To go to the planning poker page, open your board and click **{{ ui-key.startrek.ui_components_agile_poker_PokerButton.poker }}** in the top-right corner. +1. To go to the planning poker page, open your board and click **Poker** in the top-right corner. 1. Ask other planners to go to the poker page. All users visiting the page can be seen in the **Team** section. @@ -24,11 +24,11 @@ Planning poker is only available for **Scrum** boards. 1. Wait until the other planners assign their values. In the **Team** section, you will see ![](../../_assets/tracker/estimate-done.png) under planner names. -1. Click **{{ ui-key.startrek.ui_components_agile_poker_PokerIssueForm.show-estimates }}**. The scores chosen by the other users appear under their names. +1. Click **Show estimates**. The scores chosen by the other users appear under their names. The final score will be [calculated automatically](#section_calc) and then saved in the **Estimate** field. You can change this value if needed. -1. Click **{{ ui-key.startrek.ui_components_agile_poker_PokerIssueForm.apply-estimate }}** to finalize the score. The score value from the **Estimate** field is copied to the **{{ ui-key.startrek-backend.fields.issue.storyPoints }}** field in the issue, and the issue disappears from the poker page. +1. Click **Set an estimate** to finalize the score. The score value from the **Estimate** field is copied to the **{{ ui-key.startrek-backend.fields.issue.storyPoints }}** field in the issue, and the issue disappears from the poker page. ## Configuring the estimation scale {#section_scale} @@ -52,6 +52,6 @@ You can select how the values assigned by planners will affect the final effort 1. Go to the **Planning poker** tab. -1. In the **{{ ui-key.startrek.ui_components_agile_settings_PokerSettings.aggregation-function-field-label }}** field, choose a calculation function. **{{ ui-key.startrek-backend.messages.boards.poker.aggregate.function.maximum.double }}** is selected by default. +1. In the **Calculation of the final score** field, choose a calculation function. **{{ ui-key.startrek-backend.messages.boards.poker.aggregate.function.maximum.double }}** is selected by default. 1. Click **Save**. diff --git a/en/tracker/manager/poker.md b/en/tracker/manager/poker.md index 123c5980e64..d4c36b3f0df 100644 --- a/en/tracker/manager/poker.md +++ b/en/tracker/manager/poker.md @@ -12,47 +12,47 @@ Planning Poker is enabled by default on boards with a **Backlog and sprints**. I ## Estimating effort for issues {#section_estimate} -1. To switch to poker mode, open your board and click **{{ ui-key.startrek.ui_components_agile_common_AgileTabs.poker }}** in any of its tabs. +1. To switch to poker mode, open your board and click **Planning poker** in any of its tabs. 1. In the window that opens, copy the poker link and send it to other team members. The poker page will list all the users who followed the link. 1. There are several ways to add an issue to a poker: * Drag the issue to the poker section from a sprint or backlog. - * Click ![](../../_assets/tracker/svg/actions.svg) → **{{ ui-key.startrek.ui_components_agile_poker_hooks.add-issue-to-poker }}** on the issue card. + * Click ![](../../_assets/tracker/svg/actions.svg) → **Add to poker** on the issue card. 1. Select the appropriate score for the issue and wait until other planners assign their values: you should see the green check mark in the card of each of them. -1. Tap **{{ ui-key.startrek.ui_components_agile_poker_PokerIssueForm.show-estimates }}**. The scores chosen by the other users appear under their names. +1. Tap **Show estimates**. The scores chosen by the other users appear under their names. The final score will be [calculated automatically](#section_calc) and then saved in the **Estimate** field. You can change this value if needed. -1. Click **{{ ui-key.startrek.ui_components_agile_poker_PokerIssueForm.apply-estimate }}** to finalize the score. The score value from the **Estimate** field is copied to the **Story Points** field in the issue, and the issue disappears from the poker page. +1. Click **Set an estimate** to finalize the score. The score value from the **Estimate** field is copied to the **Story Points** field in the issue, and the issue disappears from the poker page. ## Configuring the estimation scale {#section_scale} The estimation system used in planning poker usually includes Fibonacci numbers and similar number sequences. To change the scoring system: -1. Open your board and click **{{ ui-key.startrek.ui_components_PageAgileBoard_PageAgileBoardHeader.settings }}** → **{{ ui-key.startrek.ui_components_agile_settings_AgileSettingsLayout.poker }}** in the top-right corner. +1. Open your board and click **{{ ui-key.startrek.ui_Boards_pages_PageAgileBoard_PageAgileBoardHeader.settings }}** → **Poker** in the top-right corner. -1. To add a number to the scoring system, enter it in the **{{ ui-key.startrek.ui_components_agile_settings_PokerSettings.deck-field-label }}** field. +1. To add a number to the scoring system, enter it in the **Deck of estimates** field. 1. To remove a number from the scoring system, click ![](../../_assets/tracker/delete-agile-status.png). -1. Tap **{{ ui-key.startrek.ui_components_agile_settings_PokerSettings.save }}**. +1. Tap **Save**. ## Configuring how the final score is calculated {#section_calc} You can select how the values assigned by planners will affect the final effort estimate for your issues. To do this: -1. Open your board and click **{{ ui-key.startrek.ui_components_PageAgileBoard_PageAgileBoardHeader.settings }}** → **{{ ui-key.startrek.ui_components_agile_settings_AgileSettingsLayout.poker }}** in the top-right corner. +1. Open your board and click **{{ ui-key.startrek.ui_Boards_pages_PageAgileBoard_PageAgileBoardHeader.settings }}** → **Poker** in the top-right corner. -1. In the **{{ ui-key.startrek.ui_components_agile_settings_PokerSettings.aggregation-function-field-label }}** field, choose a calculation function. **Maximum value** is set by default. +1. In the **Calculation of the final score** field, choose a calculation function. **Maximum value** is set by default. -1. Tap **{{ ui-key.startrek.ui_components_agile_settings_PokerSettings.save }}**. +1. Tap **Save**. ## Hide issues with Story Points set {#hide-estimated} When you enable Planning Poker, issues that have a value set in the **Story Points** field are hidden automatically. To display these issues when poker mode is on, disable this option in the settings: -1. Open your board and click **{{ ui-key.startrek.ui_components_PageAgileBoard_PageAgileBoardHeader.settings }}** → **{{ ui-key.startrek.ui_components_agile_settings_AgileSettingsLayout.poker }}** in the top-right corner. -1. Enable the **{{ ui-key.startrek.ui_components_agile_settings_PokerSettings.display-estimated-field-label }}** option. \ No newline at end of file +1. Open your board and click **{{ ui-key.startrek.ui_Boards_pages_PageAgileBoard_PageAgileBoardHeader.settings }}** → **Poker** in the top-right corner. +1. Enable the **Display estimated issues** option. \ No newline at end of file diff --git a/en/tracker/manager/portfolio.md b/en/tracker/manager/portfolio.md index 8adb2cff5a4..cb9d72d129b 100644 --- a/en/tracker/manager/portfolio.md +++ b/en/tracker/manager/portfolio.md @@ -14,9 +14,9 @@ In {{ tracker-name }}, you can open any portfolio available to you from the navi The project portfolio page shows information about the portfolio team and current status and specifies the projects included in the portfolio: -* **{{ ui-key.startrek.ui_components_portfolios_Header.description-tab }}** tab. Portfolio description, status, timeline, portfolio author and owner, list of team members, comments, customers, [links](./create-portfolio.md#links) to other portfolios and projects, tags. +* **About the portfolio** tab. Portfolio description, status, timeline, portfolio author and owner, list of team members, comments, customers, [links](./create-portfolio.md#links) to other portfolios and projects, tags. -* **{{ ui-key.startrek.ui_components_portfolios_Header.projects-tab }}** tab. The list shows both open and closed portfolios and projects. You can reorder them, move across portfolios, and filter by the parameters you specify. +* **Projects** tab. The list shows both open and closed portfolios and projects. You can reorder them, move across portfolios, and filter by the parameters you specify. * **Gantt chart** tab. This is a roadmap for portfolio projects and issues included in them. The Gantt chart specifies the timeframes of the portfolios, projects, and issues and relationships between them. For more information, see [{#T}](../gantt/portfolio.md). diff --git a/en/tracker/manager/project-list.md b/en/tracker/manager/project-list.md index b5d903f9452..1812657b763 100644 --- a/en/tracker/manager/project-list.md +++ b/en/tracker/manager/project-list.md @@ -19,8 +19,8 @@ To open the list of project issues: To open the issue actions menu in the list of project issues, click ![](../../_assets/tracker/svg/actions.svg) **Actions** at the end of the line with an issue description. In the menu, you have the following actions available: -* ![](../../_assets/tracker/text-edit/link.svg) **{{ ui-key.startrek.ui_components_projects_hooks.copy-to-clipboard }}**. -* ![](../../_assets/tracker/svg/move-up.svg) **{{ ui-key.startrek.ui_components_projects_hooks.issue-actions--move-up }}** (for manual sorting only). -* ![](../../_assets/tracker/svg/move-down.svg) **{{ ui-key.startrek.ui_components_projects_hooks.issue-actions--move-down }}** (for manual sorting only). +* ![](../../_assets/tracker/text-edit/link.svg) **Copy link**. +* ![](../../_assets/tracker/svg/move-up.svg) **Move to top of list** (for manual sorting only). +* ![](../../_assets/tracker/svg/move-down.svg) **Move to bottom of list** (for manual sorting only). * ![](../../_assets/tracker/svg/convert.svg) **Convert to a [milestone](milestones.md) or issue**. -* ![](../../_assets/tracker/svg/icon-remove.svg) **{{ ui-key.startrek.ui_components_projects_hooks.delete-from-project }}**. +* ![](../../_assets/tracker/svg/icon-remove.svg) **Delete from project**. diff --git a/en/tracker/manager/queue-access-types.md b/en/tracker/manager/queue-access-types.md index 469d988e31b..5a2c1b7dc1d 100644 --- a/en/tracker/manager/queue-access-types.md +++ b/en/tracker/manager/queue-access-types.md @@ -10,7 +10,7 @@ Access can be restricted in the queue settings. To open settings: 1. In the left-hand panel, click **Queues** and select a queue from the list. -1. Click **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}** → **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-permissions }}**. If you do not see the **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}** button, it means you have no rights to configure the queue. If you need these rights, contact the queue owner. +1. Click **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}** → **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-permissions }}**. If you do not see the **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}** button, it means you have no rights to configure the queue. If you need these rights, contact the queue owner. Queue access is configured using the following permissions: diff --git a/en/tracker/manager/queue-access.md b/en/tracker/manager/queue-access.md index f5e4a2f907a..f9cf9f1a812 100644 --- a/en/tracker/manager/queue-access.md +++ b/en/tracker/manager/queue-access.md @@ -19,7 +19,7 @@ The queue access management page is available in the queue settings. To open set 1. In the left-hand panel, click **Queues** and select a queue from the list. -1. Click **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}** → **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-permissions }}**. If you do not see the **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}** button, it means you have no rights to configure the queue. If you need these rights, contact the queue owner. +1. Click **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}** → **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-permissions }}**. If you do not see the **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}** button, it means you have no rights to configure the queue. If you need these rights, contact the queue owner. The queue access rights setup page will open. To view all [access permissions](queue-access-types.md) for a user or group, use the search at the top of the screen or click the user or group. diff --git a/en/tracker/manager/queue-history.md b/en/tracker/manager/queue-history.md index cb497e2db7d..a1690761128 100644 --- a/en/tracker/manager/queue-history.md +++ b/en/tracker/manager/queue-history.md @@ -17,7 +17,7 @@ The log includes records about the changes in queue settings. Each record includ 1. Open the queue page. -1. In the top-right corner of the page, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner of the page, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. Go to the **Changelog** tab. diff --git a/en/tracker/manager/queue-spent-time.md b/en/tracker/manager/queue-spent-time.md index 5903c7e5ce7..b4c7a8874e7 100644 --- a/en/tracker/manager/queue-spent-time.md +++ b/en/tracker/manager/queue-spent-time.md @@ -4,26 +4,26 @@ To make [time tracking](../user/time-spent.md) more convenient, you can enable [ To do this: -1. In the queue settings, go to the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** tab. -1. Enable **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-track-time-in-issues }}**. -1. In **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-working-calendar }}**, choose one of the options. -1. Click **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.save }}**. +1. In the queue settings, go to the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** tab. +1. Enable **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-track-time-in-issues }}**. +1. In **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-working-calendar }}**, choose one of the options. +1. Click **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.save }}**. -As a result, a new section called **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** will appear in the queue issues. All data of the **Time spent** issue fields will be transferred to this section. +As a result, a new section called **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** will appear in the queue issues. All data of the **Time spent** issue fields will be transferred to this section. -If you disable the **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-track-time-in-issues }}** option, data from the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** section will be moved back to the fields of the **Time spent** category. +If you disable the **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-track-time-in-issues }}** option, data from the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** section will be moved back to the fields of the **Time spent** category. ## Granting the permission to edit time to the assignee {#assignee-edit} By default, the [logged time history](../user/time-spent.md#records-history) can only be edited through an [API request](../concepts/issues/patch-worklog.md). -To allow the author of a record to edit or delete it right in the history window, enable **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-can-assignee-update-time }}**. +To allow the author of a record to edit or delete it right in the history window, enable **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-can-assignee-update-time }}**. ## Automatically calculating the time spent on an issue when closing it {#calculate-time} -You can set up automatic calculation of the time spent on issues. If, when closing an issue, it has no time logged, the [transition screen](workflow-action-edit.md) will contain the **{{ ui-key.startrek.ui_components_FormField_TimeTrackingBlock.field-spent-title }}** field with a filled value. +You can set up automatic calculation of the time spent on issues. If, when closing an issue, it has no time logged, the [transition screen](workflow-action-edit.md) will contain the **{{ ui-key.startrek.ui_Common_smart-components_FormField_TimeTrackingBlock.field-spent-title }}** field with a filled value. -For this, enable the **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-show-time-field-on-close }}** option and [set up the transition screen](workflow-action-edit.md) to the final issue status. +For this, enable the **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-show-time-field-on-close }}** option and [set up the transition screen](workflow-action-edit.md) to the final issue status. {% cut "How the time is calculated" %} @@ -41,25 +41,25 @@ For example, on Friday, June 1, at 9 a.m., the issue status changed from **Open* ## Logging the time left and the total time spent on an issue {#overall-time} -You can add more fields to the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** section: +You can add more fields to the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** section: -* In the **{{ ui-key.startrek.ui_components_FormField_TimeTrackingBlock.field-remain-title }}** field, you can specify how much longer you plan to work on the issue. To add this field, enable **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-show-time-field-on-close }}**. -* In the **{{ ui-key.startrek.ui_components_FormField_TimeTrackingBlock.field-estimation-title }}** field, you can specify the total amount of time you plan to spend on the issue. To add this field, enable **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-use-remaining-time }}**. +* In the **{{ ui-key.startrek.ui_Common_smart-components_FormField_TimeTrackingBlock.field-remain-title }}** field, you can specify how much longer you plan to work on the issue. To add this field, enable **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-show-time-field-on-close }}**. +* In the **{{ ui-key.startrek.ui_Common_smart-components_FormField_TimeTrackingBlock.field-estimation-title }}** field, you can specify the total amount of time you plan to spend on the issue. To add this field, enable **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-use-remaining-time }}**. -If any of these fields is used, the issue page will show the issue progress bar in the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** field. +If any of these fields is used, the issue page will show the issue progress bar in the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** field. {% note info %} -The **{{ ui-key.startrek.ui_components_FormField_TimeTrackingBlock.field-remain-title }}** and **{{ ui-key.startrek.ui_components_FormField_TimeTrackingBlock.field-estimation-title }}** fields are related as follows: +The **{{ ui-key.startrek.ui_Common_smart-components_FormField_TimeTrackingBlock.field-remain-title }}** and **{{ ui-key.startrek.ui_Common_smart-components_FormField_TimeTrackingBlock.field-estimation-title }}** fields are related as follows: -**{{ ui-key.startrek.ui_components_FormField_TimeTrackingBlock.field-spent-title }}** + **{{ ui-key.startrek.ui_components_FormField_TimeTrackingBlock.field-remain-title }}** = **{{ ui-key.startrek.ui_components_FormField_TimeTrackingBlock.field-estimation-title }}** +**{{ ui-key.startrek.ui_Common_smart-components_FormField_TimeTrackingBlock.field-spent-title }}** + **{{ ui-key.startrek.ui_Common_smart-components_FormField_TimeTrackingBlock.field-remain-title }}** = **{{ ui-key.startrek.ui_Common_smart-components_FormField_TimeTrackingBlock.field-estimation-title }}** If both fields are used, when the value in one of them changes, the value in the other field will be set automatically. {% endnote %} ## Setting up work schedules {#work-schedule} -You can set up work schedules for the issue assignees in the current queue. This data is used when [automatically calculating the time spent](#calculate-time). To set a work schedule, select the appropriate option in the **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-working-calendar }}** field. +You can set up work schedules for the issue assignees in the current queue. This data is used when [automatically calculating the time spent](#calculate-time). To set a work schedule, select the appropriate option in the **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-working-calendar }}** field. If none of the schedule options suits you, you can [create a custom one](schedule.md). @@ -71,4 +71,4 @@ By default, time is displayed as **1w 2d 3h 4m 5s**: business weeks, business da In basic time tracking mode, you cannot just enter the time as a number and must always specify what exactly you are logging: weeks, days, minutes, or seconds. -In advanced time tracking mode, you can select the preferred time unit and enter it as a number without adding any letter. To enable this, select one of the options in the **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-use-summary-time }}** field. \ No newline at end of file +In advanced time tracking mode, you can select the preferred time unit and enter it as a number without adding any letter. To enable this, select one of the options in the **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-use-summary-time }}** field. \ No newline at end of file diff --git a/en/tracker/manager/queue-team.md b/en/tracker/manager/queue-team.md index ae2d869bc4a..871cde65930 100644 --- a/en/tracker/manager/queue-team.md +++ b/en/tracker/manager/queue-team.md @@ -30,19 +30,19 @@ Changing the queue owner: 1. Open the [queue page](../user/queue.md). -1. In the top-right corner of the page, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner of the page, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. Go to the **Access rights** tab. 1. Click the user picture next to the owner name. The window to change the queue owner will open. -1. Click **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminTabPermissions_ChangeOwnerForm.change-owner }}**. +1. Click **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminTabPermissions_ChangeOwnerForm.change-owner }}**. 1. Enter the name or username of the new owner. 1. Click **Save**. -1. If you want all new issues to be automatically assigned to the owner, enable the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminTabPermissions_ChangeOwnerForm.set-as-default }}** option. +1. If you want all new issues to be automatically assigned to the owner, enable the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminTabPermissions_ChangeOwnerForm.set-as-default }}** option. 1. Click **Save**. @@ -54,7 +54,7 @@ To change the list of team members: 1. Open the [queue page](../user/queue.md). -1. In the top-right corner of the page, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner of the page, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. Go to the **Queue team** tab. diff --git a/en/tracker/manager/quick-filters.md b/en/tracker/manager/quick-filters.md index 5d612e193d0..7c654cf23a7 100644 --- a/en/tracker/manager/quick-filters.md +++ b/en/tracker/manager/quick-filters.md @@ -17,7 +17,7 @@ If filtering by parameters does not provide enough filtering options for you, us 1. Go to the queue page. -1. Above the issue list, click ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_components_filter-pane_FieldsSelectButton.add-filter-field-button-title }}** and select a field. +1. Above the issue list, click ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_Common_smart-components_filter-pane_FieldsSelectButton.add-filter-field-button-title }}** and select a field. 1. Set the value for the parameter. @@ -27,7 +27,7 @@ Set up the fields visible to you in the issue list to see only those parameters 1. Go to the queue page. -1. Click ![](../../_assets/tracker/svg/list-settings.svg) **{{ ui-key.startrek.ui_components_PageAgileBoardSettings_Header.settings }}** above the issue list, on the right. +1. Click ![](../../_assets/tracker/svg/list-settings.svg) **Settings** above the issue list, on the right. 1. Select the parameters that you want to see in the issue list. @@ -50,7 +50,7 @@ To save your issue list to a file: 1. In the upper-right corner, click ![](../../_assets/tracker/svg/actions.svg) **Actions with queue**. -1. Then click ![](../../_assets/tracker/svg/icon-export-tasks.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.export }}**. +1. Then click ![](../../_assets/tracker/svg/icon-export-tasks.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.export }}**. 1. Select the format for saving the list. diff --git a/en/tracker/manager/schedule.md b/en/tracker/manager/schedule.md index a718441714b..a968fab2583 100644 --- a/en/tracker/manager/schedule.md +++ b/en/tracker/manager/schedule.md @@ -24,7 +24,7 @@ In the **Round the clock** system schedule, holidays are considered non-working 1. {% include [go to settings](../../_includes/tracker/transition-page.md) %} -1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. Select **SLA rules**. @@ -50,7 +50,7 @@ You can view the schedule you created in the **My schedules** section. Other use 1. {% include [go to settings](../../_includes/tracker/transition-page.md) %} -1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. Select **SLA rules**. diff --git a/en/tracker/manager/sla.md b/en/tracker/manager/sla.md index 6ffa68cbb31..07e39743222 100644 --- a/en/tracker/manager/sla.md +++ b/en/tracker/manager/sla.md @@ -19,7 +19,7 @@ To create a new SLA rule: 1. {% include [go to settings](../../_includes/tracker/transition-page.md) %} -1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. Go to the **SLA rules** tab. @@ -113,7 +113,7 @@ To view a list of SLA rules in the queue: 1. {% include [go to settings](../../_includes/tracker/transition-page.md) %} -1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. Go to the **SLA rules** tab. @@ -157,7 +157,7 @@ To edit the SLA rule: 1. {% include [go to settings](../../_includes/tracker/transition-page.md) %} -1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. Go to the **SLA rules** tab. diff --git a/en/tracker/manager/subscriptions.md b/en/tracker/manager/subscriptions.md index 1cf6f8ebf4d..fe7680cd359 100644 --- a/en/tracker/manager/subscriptions.md +++ b/en/tracker/manager/subscriptions.md @@ -12,7 +12,7 @@ To set up sending of notification about issue status changes in the queue: 1. Open the [queue page](../user/queue.md). -1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. Go to the **{{ ui-key.yacloud.component.navigation-menu.label_notifications }}** tab. diff --git a/en/tracker/manager/workflow-action-edit.md b/en/tracker/manager/workflow-action-edit.md index 2b48b4749cb..4f476475e54 100644 --- a/en/tracker/manager/workflow-action-edit.md +++ b/en/tracker/manager/workflow-action-edit.md @@ -10,9 +10,9 @@ You can set up transitions between statuses within a workflow using the workflow 1. Go to the queue page. -1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Go to the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab and click the name of the workflow whose status transitions you want to edit. +1. Go to the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab and click the name of the workflow whose status transitions you want to edit. The workflow visual editor will open. You can use it to edit existing transitions. To do this, just click the appropriate transition in the diagram to open its settings page. You can also [add new transitions](#add-action) to the diagram. @@ -22,21 +22,21 @@ You can configure automated actions to be performed by {{ tracker-name }} during To add an auto action: -1. In the transition settings, open the **Automation** section and click **{{ ui-key.startrek.ui_components_workflow-functions_WorkflowFunctionMenu.menu-title }}**. +1. In the transition settings, open the **Automation** section and click **{{ ui-key.startrek.ui_Queues_smart-components_workflow-functions_WorkflowFunctionMenu.menu-title }}**. 1. Select the automations you need from the list and configure them. If there is no suitable automation, set up a [trigger](../user/trigger.md). Possible auto actions at issue status change include: -* **{{ ui-key.startrek.ui_components_workflow-functions.type-SendEmailFunction }}**: Send emails to specific employees or users performing certain issue roles (for example, to the issue reporter or assignee). -* **{{ ui-key.startrek.ui_components_workflow-functions.type-AddCommentFunction }}**: Make a comment in the issue on behalf of a certain user (employee or robot). -* **{{ ui-key.startrek.ui_components_workflow-functions.type-SetActiveSprintFunction }}**: Add an issue to an active sprint on the selected board. -* **{{ ui-key.startrek.ui_components_workflow-functions.type-SetCurrentTimeFunction }}**: Write the transition time to the selected field. -* **{{ ui-key.startrek.ui_components_workflow-functions.type-CalculateFieldFunction }}**: Sum up the contents of multiple fields and write the resulting value to another field. -* **{{ ui-key.startrek.ui_components_workflow-functions.type-MoveUsersFunction }}**: Move or copy users from one field to another. -* **{{ ui-key.startrek.ui_components_workflow-functions.type-RemoveUsersFromCcFunction }}**: Remove a user from the list of issue followers, for example, if the required information was received from them and their participation in the issue is no longer required. -* **{{ ui-key.startrek.ui_components_workflow-functions.type-AddTextToFieldFunction }}**: Fill in an issue field. When setting up this type of automation, a filter by the type of field value will be helpful. -* **{{ ui-key.startrek.ui_components_workflow-functions.type-RemoveFieldValueFunction }}**: Remove the contents of any issue field. -* **{{ ui-key.startrek.ui_components_workflow-functions.type-UnsetResolutionFunction }}**: If the issue was completed with a certain resolution, this resolution will be canceled. +* **{{ ui-key.startrek.ui_Queues_smart-components_workflow-functions.type-SendEmailFunction }}**: Send emails to specific employees or users performing certain issue roles (for example, to the issue reporter or assignee). +* **{{ ui-key.startrek.ui_Queues_smart-components_workflow-functions.type-AddCommentFunction }}**: Make a comment in the issue on behalf of a certain user (employee or robot). +* **{{ ui-key.startrek.ui_Queues_smart-components_workflow-functions.type-SetActiveSprintFunction }}**: Add an issue to an active sprint on the selected board. +* **{{ ui-key.startrek.ui_Queues_smart-components_workflow-functions.type-SetCurrentTimeFunction }}**: Write the transition time to the selected field. +* **{{ ui-key.startrek.ui_Queues_smart-components_workflow-functions.type-CalculateFieldFunction }}**: Sum up the contents of multiple fields and write the resulting value to another field. +* **{{ ui-key.startrek.ui_Queues_smart-components_workflow-functions.type-MoveUsersFunction }}**: Move or copy users from one field to another. +* **{{ ui-key.startrek.ui_Queues_smart-components_workflow-functions.type-RemoveUsersFromCcFunction }}**: Remove a user from the list of issue followers, for example, if the required information was received from them and their participation in the issue is no longer required. +* **{{ ui-key.startrek.ui_Queues_smart-components_workflow-functions.type-AddTextToFieldFunction }}**: Fill in an issue field. When setting up this type of automation, a filter by the type of field value will be helpful. +* **{{ ui-key.startrek.ui_Queues_smart-components_workflow-functions.type-RemoveFieldValueFunction }}**: Remove the contents of any issue field. +* **{{ ui-key.startrek.ui_Queues_smart-components_workflow-functions.type-UnsetResolutionFunction }}**: If the issue was completed with a certain resolution, this resolution will be canceled. ### Transition conditions {#conditions} @@ -55,9 +55,9 @@ You can set up conditions under which a transition will be active: To add transition conditions: -1. In the transition settings, open the **Transition conditions** section and click **{{ ui-key.startrek.ui_components_workflow-conditions_ConditionsMenu.add-condition }}**. +1. In the transition settings, open the **Transition conditions** section and click **{{ ui-key.startrek.ui_Queues_smart-components_workflow-conditions_ConditionsMenu.add-condition }}**. -1. Select the appropriate conditions from the list and configure them. To set a group of conditions using **AND** and **OR** operators, click **{{ ui-key.startrek.ui_components_workflow-conditions_WorkflowGroupCondition.add-conditions-group }}**. +1. Select the appropriate conditions from the list and configure them. To set a group of conditions using **AND** and **OR** operators, click **{{ ui-key.startrek.ui_Queues_smart-components_workflow-conditions_WorkflowGroupCondition.add-conditions-group }}**. ### Transition screen {#screen} @@ -89,9 +89,9 @@ To add a transition between statuses added to a workflow: 1. Go to the queue page. -1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Go to the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab and click the name of the workflow you need. The workflow visual editor will open. +1. Go to the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab and click the name of the workflow you need. The workflow visual editor will open. 1. In the top panel of the workflow visual editor, click **Add transition**. Fill in the **Source status** and **New status** fields with the appropriate values from the lists. To add a transition for statuses that a workflow does not contain yet, [add them](./workflow-status-edit.md#add-status) first. diff --git a/en/tracker/manager/workflow-status-edit.md b/en/tracker/manager/workflow-status-edit.md index d556511aef0..cbc55a66691 100644 --- a/en/tracker/manager/workflow-status-edit.md +++ b/en/tracker/manager/workflow-status-edit.md @@ -12,9 +12,9 @@ You can set up statuses within a workflow using the workflow visual editor. To o 1. Go to the queue page. -1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Go to the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab and click the name of the workflow you want to edit statuses in. +1. Go to the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab and click the name of the workflow you want to edit statuses in. The workflow visual editor will open. You can use it to edit existing statuses. To do this, just click the appropriate status in the diagram to open its settings page. You can also [add new statuses](#add-status) to the diagram. @@ -116,9 +116,9 @@ You can also create a status on the workflows page. The created status will be i 1. Go to the queue page. -1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Go to the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab. It shows the list of workflows in the queue. Select the workflow to add the new status to and click its name. The workflow visual editor will open. +1. Go to the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab. It shows the list of workflows in the queue. Select the workflow to add the new status to and click its name. The workflow visual editor will open. 1. In the top panel of the workflow visual editor, click **Add status**. Start typing the name of the new status and click the **Create** button. @@ -137,9 +137,9 @@ To add a status to a workflow: 1. Go to the queue page. -1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Go to the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab and click the name of the workflow you need. The workflow visual editor will open. +1. Go to the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab and click the name of the workflow you need. The workflow visual editor will open. 1. In the top panel of the workflow visual editor, click **Add status**. Start typing the name of the new status and click the **Create** button. @@ -161,8 +161,8 @@ When a status is deleted, all the related status transitions are deleted, too. I To delete a status from a workflow: -1. In the top-right corner of the queue page, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner of the queue page, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Go to the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab. In the editor, open the workflow to delete the status from. +1. Go to the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab. In the editor, open the workflow to delete the status from. 1. Click the status to be deleted and then press **Delete** on the keyboard or go to the status settings and click ![](../../_assets/tracker/svg/actions.svg) → **Remove from workflow**. diff --git a/en/tracker/manager/workflow.md b/en/tracker/manager/workflow.md index 94d8d0ce6ec..8ff3cd5cf0f 100644 --- a/en/tracker/manager/workflow.md +++ b/en/tracker/manager/workflow.md @@ -23,9 +23,9 @@ To view the queue workflows: 1. In the {{ tracker-name }} panel on the left, click Queues and go to the queue page. -1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Go to the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab. +1. Go to the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab. It shows the list of all the queue workflows. diff --git a/en/tracker/mobile/attach-file.md b/en/tracker/mobile/attach-file.md index 8bc44c71879..d26fe9a22b0 100644 --- a/en/tracker/mobile/attach-file.md +++ b/en/tracker/mobile/attach-file.md @@ -11,9 +11,9 @@ To attach a file to an issue description: * To add a photo or video from your phone's camera, tap **Camera**. When everything is ready, tap **OK**. To take a new photo or video, tap **Repeat**. - * To attach files from your phone, tap **{{ ui-key.startrek.ui_components_attachments-manager.attachments-section-title }}** and select them. + * To attach files from your phone, tap **{{ ui-key.startrek.ui_Common_smart-components_attachments-manager.attachments-section-title }}** and select them. -1. Tap **{{ ui-key.startrek.ui_components_ModalTextEditor.save }}**. +1. Tap **Save**. You can similarly attach a file to a comment. diff --git a/en/tracker/mobile/checklist.md b/en/tracker/mobile/checklist.md index 9e9a04d5960..f929d282f8a 100644 --- a/en/tracker/mobile/checklist.md +++ b/en/tracker/mobile/checklist.md @@ -12,7 +12,7 @@ A checklist is a list of items that need to be completed to resolve the issue. H 1. To specify the assignee and deadline for this item, tap ![](../../_assets/horizontal-ellipsis.svg) and select the appropriate action. -1. To add another item, enter its description and press Enter on the phone keyboard. If you are adding a new item to a ready-made checklist, first tap **{{ ui-key.startrek.ui_components_entity-page_checklist_Footer.new-item-button-caption }}** at the bottom of the list. +1. To add another item, enter its description and press Enter on the phone keyboard. If you are adding a new item to a ready-made checklist, first tap **{{ ui-key.startrek.ui_Common_smart-components_entity-page_checklist_Footer.new-item-button-caption }}** at the bottom of the list. ## Managing a checklist {#checklist-operations} @@ -24,9 +24,9 @@ A checklist is a list of items that need to be completed to resolve the issue. H * To uncheck an item, tap the checkbox ![](../../_assets/tracker/checklist-checkmark.png). -* To add an item to the checklist, tap **{{ ui-key.startrek.ui_components_entity-page_checklist_Footer.new-item-button-caption }}** at the bottom of the list. +* To add an item to the checklist, tap **{{ ui-key.startrek.ui_Common_smart-components_entity-page_checklist_Footer.new-item-button-caption }}** at the bottom of the list. -* To delete a checklist item, tap ![](../../_assets/horizontal-ellipsis.svg) next to it and select **{{ ui-key.startrek.ui_components_entity-page_checklist_ChecklistItem.remove-item-title }}**. +* To delete a checklist item, tap ![](../../_assets/horizontal-ellipsis.svg) next to it and select **Delete item**. * To delete a checklist, tap ![](../../_assets/tracker/delete-checklist-mobile.png) at the top of the list. diff --git a/en/tracker/mobile/comments.md b/en/tracker/mobile/comments.md index c6c068b78d5..0ba75f4b1c8 100644 --- a/en/tracker/mobile/comments.md +++ b/en/tracker/mobile/comments.md @@ -10,7 +10,7 @@ If you only discuss an issue in the comments, you will always have access to a ## Leaving a comment {#leave-comment} -To comment on an issue, enter your text in the **{{ ui-key.startrek.ui_components_entity-page_comments_CommentEditor_mobile.write-comment }}** box at the bottom of the screen and tap ![](../../_assets/tracker/send.png). In the comments section, you can use [text markup](../user/markup.md) and [attach images and files](#sec_file). To expand the comment box to full screen, tap ![](../../_assets/tracker/open-text.png). +To comment on an issue, enter your text in the **Write a comment** box at the bottom of the screen and tap ![](../../_assets/tracker/send.png). In the comments section, you can use [text markup](../user/markup.md) and [attach images and files](#sec_file). To expand the comment box to full screen, tap ![](../../_assets/tracker/open-text.png). You can use the comments section to specify a key for a different issue so that {{ tracker-name }} automatically [links](ticket-links.md#add-link) the issue. @@ -32,9 +32,9 @@ Any changes to comments are saved in the [History](../user/history.md). To invite other users to discuss an issue: -1. Select **{{ ui-key.startrek.ui_components_entity-page_comments_CommentEditor_mobile.write-comment }}** at the bottom of the screen and tap ![](../../_assets/tracker/at.png). +1. Select **Write a comment** at the bottom of the screen and tap ![](../../_assets/tracker/at.png). -1. Enter the username or name of the user you want to invite to the comments and tap **{{ ui-key.startrek.ui_components_ModalTextEditor.save }}**. You can invite multiple users at once. +1. Enter the username or name of the user you want to invite to the comments and tap **Save**. You can invite multiple users at once. 1. Enter the comment and tap ![](../../_assets/tracker/send.png). @@ -50,11 +50,11 @@ If you add a user in the **{{ ui-key.startrek-backend.fields.issue.pendingReplyF To attach a file to a comment: -1. Select **{{ ui-key.startrek.ui_components_entity-page_comments_CommentEditor_mobile.write-comment }}** at the bottom of the screen and tap ![](../../_assets/tracker/pin.png). +1. Select **Write a comment** at the bottom of the screen and tap ![](../../_assets/tracker/pin.png). * To add a photo or video from your phone's camera, tap **Camera**. When everything is ready, tap **OK**. To take a new photo or video, tap **Repeat**. - * To attach files from your phone, tap **{{ ui-key.startrek.ui_components_attachments-manager.attachments-section-title }}** and select them. + * To attach files from your phone, tap **{{ ui-key.startrek.ui_Common_smart-components_attachments-manager.attachments-section-title }}** and select them. {% note info %} diff --git a/en/tracker/mobile/create-filter.md b/en/tracker/mobile/create-filter.md index cb57d2d602e..1506d0977d6 100644 --- a/en/tracker/mobile/create-filter.md +++ b/en/tracker/mobile/create-filter.md @@ -16,6 +16,6 @@ To create a filter: {% note info %} -To save the filter, use the {{ tracker-name }} web version: Your saved filters will be available in the **{{ ui-key.startrek.ui_components_agile_common_AgileFilters.all-issues-filter-title }}** checkbox under **{{ ui-key.startrek-backend.messages.user.named.request.folder.my }}**. +To save the filter, use the {{ tracker-name }} web version: Your saved filters will be available in the **All issues** checkbox under **{{ ui-key.startrek-backend.messages.user.named.request.folder.my }}**. {% endnote %} \ No newline at end of file diff --git a/en/tracker/mobile/create-ticket.md b/en/tracker/mobile/create-ticket.md index 492989101c4..4d7fa2a5310 100644 --- a/en/tracker/mobile/create-ticket.md +++ b/en/tracker/mobile/create-ticket.md @@ -24,11 +24,11 @@ To create an issue: 1. [Edit](edit-ticket.md) the issue details: - * Go to the **{{ ui-key.startrek.ui_components_IssueTabs.description-tab }}** tab and specify general parameters: add a description, select the issue type and priority, specify the assignee, and set the deadline. Use [YFM markup](../user/markup.md) to format text. + * Go to the **Description** tab and specify general parameters: add a description, select the issue type and priority, specify the assignee, and set the deadline. Use [YFM markup](../user/markup.md) to format text. - * In the **{{ ui-key.startrek.ui_components_IssueTabs.fields-tab }}** tab, specify [additional parameters](../user/create-param.md#default-fields) for the issue. + * In the **Parameters** tab, specify [additional parameters](../user/create-param.md#default-fields) for the issue. - * If your issue is related to other issues, go to the **{{ ui-key.startrek.ui_components_IssueTabs.links-tab }}** tab and [create sub-issues](#subtask). To change the issue [link type](../user/links.md), tap ![](../../_assets/tracker/dots.png) next to the sub-issue name and choose a new type. + * If your issue is related to other issues, go to the **Links** tab and [create sub-issues](#subtask). To change the issue [link type](../user/links.md), tap ![](../../_assets/tracker/dots.png) next to the sub-issue name and choose a new type. 1. To [attach files or images to the issue](attach-file.md), open the screen for editing the issue description ![](../../_assets/tracker/icon-edit.png ). Then click ![](../../_assets/tracker/pin.png) and select the apps. @@ -51,11 +51,11 @@ To create a sub-issue: 1. Open the issue to create a sub-issue for. -1. In the top-right corner, click ![](../../_assets/tracker/dots.png) and select **{{ ui-key.startrek.ui_components_IssueActionsButton.menu-item-create-subticket }}**. +1. In the top-right corner, click ![](../../_assets/tracker/dots.png) and select **Create sub-issue**. 1. Fill in the fields the same way as when [creating a new issue](#create-task). -1. Click **{{ ui-key.startrek.ui_components_IssueActionsButton.menu-item-create-subticket }}**. +1. Click **Create sub-issue**. diff --git a/en/tracker/mobile/default-filters.md b/en/tracker/mobile/default-filters.md index 7b01629006e..1930332cdda 100644 --- a/en/tracker/mobile/default-filters.md +++ b/en/tracker/mobile/default-filters.md @@ -6,7 +6,7 @@ To find the issues you're working on, use the _system filters_ preset. The filte Find your issues using preset system filters. -1. In the top-left corner, tap **{{ ui-key.startrek.ui_components_agile_common_AgileFilters.all-issues-filter-title }}** and select one of the options: +1. In the top-left corner, tap **All issues** and select one of the options: * **Favorite issues**: Issues you [added to Favorites](../user/favourites.md#task-fav). @@ -20,7 +20,7 @@ Find your issues using preset system filters. * **Waiting for response**: Issues you were [invited to comment](comments.md#call-comment) on. - * **{{ ui-key.startrek.ui_components_IssuesPresetSelect.preset_deadline }}**: Issues in which you are the reporter, assignee, or follower and where: + * **{{ ui-key.startrek.ui_Issues_smart-components_IssuesPresetSelect.preset_deadline }}**: Issues in which you are the reporter, assignee, or follower and where: * Issues that have exceeded their deadlines in the past two weeks ![](../../_assets/tracker/deadline-red.png). diff --git a/en/tracker/mobile/edit-ticket.md b/en/tracker/mobile/edit-ticket.md index 1aaeba87926..dfd5844ab62 100644 --- a/en/tracker/mobile/edit-ticket.md +++ b/en/tracker/mobile/edit-ticket.md @@ -10,20 +10,20 @@ The issue pages are updated in real time. If someone edits or comments on the is ## Changing issue names {#edit-name} -Tap the issue name. Edit the text and tap **{{ ui-key.startrek.ui_components_settings_IssueUpdatesSettings.save }}**. +Tap the issue name. Edit the text and tap **Save**. ## Editing issue descriptions {#edit-description} -To the right of the issue description, tap ![](../../_assets/tracker/icon-edit.png) and edit the text. Use [YFM markup](../user/markup.md) to format text. To save your changes, tap **{{ ui-key.startrek.ui_components_settings_IssueUpdatesSettings.save }}**. +To the right of the issue description, tap ![](../../_assets/tracker/icon-edit.png) and edit the text. Use [YFM markup](../user/markup.md) to format text. To save your changes, tap **Save**. -You can use the issue description to specify a key for a different issue so that {{ tracker-name }} automatically links the issues. You will see the linked issue in the **{{ ui-key.startrek.ui_components_IssueTabs.links-tab }}** tab. +You can use the issue description to specify a key for a different issue so that {{ tracker-name }} automatically links the issues. You will see the linked issue in the **Links** tab. You can also [attach images or files](attach-file.md) to issue descriptions. ## Editing issue fields {#edit-fields} -The [issue details](../user/create-param.md#default-fields) are shown in the **{{ ui-key.startrek.ui_components_IssueTabs.fields-tab }}** tab. To change a parameter value, tap ![](../../_assets/tracker/mobile-params-open.png). Enter a new value and click **{{ ui-key.startrek.ui_components_settings_IssueUpdatesSettings.save }}**. +The [issue details](../user/create-param.md#default-fields) are shown in the **Parameters** tab. To change a parameter value, tap ![](../../_assets/tracker/mobile-params-open.png). Enter a new value and click **Save**. {% note info %} @@ -31,7 +31,7 @@ If you do not see the required parameters, go to the web version and add them in {% endnote %} -The **{{ ui-key.startrek-backend.fields.issue.priority-key-value }}**, **{{ ui-key.startrek-backend.fields.issue.type-key-value }}**, **{{ ui-key.startrek-backend.fields.issue.assignee-key-value }}**, and **{{ ui-key.startrek-backend.fields.issue.dueDate-key-value }}** fields are also available in the **{{ ui-key.startrek.ui_components_IssueTabs.description-tab }}** tab. To edit their values, tap the parameter name, enter a new value, and tap **{{ ui-key.startrek.ui_components_settings_IssueUpdatesSettings.save }}**. +The **{{ ui-key.startrek-backend.fields.issue.priority-key-value }}**, **{{ ui-key.startrek-backend.fields.issue.type-key-value }}**, **{{ ui-key.startrek-backend.fields.issue.assignee-key-value }}**, and **{{ ui-key.startrek-backend.fields.issue.dueDate-key-value }}** fields are also available in the **Description** tab. To edit their values, tap the parameter name, enter a new value, and tap **Save**. ## Changing issue status {#edit-status} diff --git a/en/tracker/mobile/enable-tracker.md b/en/tracker/mobile/enable-tracker.md index 8020d189216..8f50a3f5da6 100644 --- a/en/tracker/mobile/enable-tracker.md +++ b/en/tracker/mobile/enable-tracker.md @@ -18,7 +18,7 @@ If the administrator of your organization already connected {{ tracker-name }}, 1. Log in to your [Yandex account]({{ link-passport }}). If you do not have an account, [create]({{ support-passport-create }}) one. - * If you don't have an organization in {{ yandex-cloud }}, the {{ tracker-full-name }} activation window opens. Accept the {{ yandex-cloud }} terms of use and tap **{{ ui-key.startrek.ui_components_PageHiThere.wrong-user-btn }}**. Your organization is automatically created and {{ tracker-full-name }} is activated. + * If you don't have an organization in {{ yandex-cloud }}, the {{ tracker-full-name }} activation window opens. Accept the {{ yandex-cloud }} terms of use and tap **Log in**. Your organization is automatically created and {{ tracker-full-name }} is activated. * If {{ tracker-name }} is not enabled for your organization yet, it will be activated automatically the first time you log in to the mobile app. diff --git a/en/tracker/mobile/login.md b/en/tracker/mobile/login.md index 742e8b41298..894708d03ec 100644 --- a/en/tracker/mobile/login.md +++ b/en/tracker/mobile/login.md @@ -26,7 +26,7 @@ To log in to {{ tracker-full-name }}: 1. When you launch the app for the first time, log in to the account you use to work with {{ tracker-name }}: - * To log in using your Yandex email address or the email address on your company's domain, tap **{{ ui-key.startrek.ui_components_PageHiThere.wrong-user-btn }}** and enter your username, such as `{{ example-account }}` or `login@example.com`. If you do not have an organization, one will be created automatically the [first time you log in](enable-tracker.md) to the app. + * To log in using your Yandex email address or the email address on your company's domain, tap **Log in** and enter your username, such as `{{ example-account }}` or `login@example.com`. If you do not have an organization, one will be created automatically the [first time you log in](enable-tracker.md) to the app. * If your organization uses the Single Sign-On authentication scheme with an [identity federation](../add-users.md#federation), click **Log in via SSO**, specify the federation ID, and log in to your corporate account. diff --git a/en/tracker/mobile/my-tickets.md b/en/tracker/mobile/my-tickets.md index 003ad07dc5b..486379facc7 100644 --- a/en/tracker/mobile/my-tickets.md +++ b/en/tracker/mobile/my-tickets.md @@ -22,7 +22,7 @@ To find issues you're working on: * **Assigned to me**. * **Followed by me**. * **Waiting for response**. - * **{{ ui-key.startrek.ui_components_IssuesPresetSelect.preset-deadline }}**. + * **{{ ui-key.startrek.ui_Issues_smart-components_IssuesPresetSelect.preset-deadline }}**. * To filter issues by their [resolution](../manager/create-resolution.md), tap **{{ ui-key.startrek-backend.fields.issue.resolution-key-value }}** and select relevant values from the list. diff --git a/en/tracker/mobile/search-task.md b/en/tracker/mobile/search-task.md index 36c5f098a45..2f2854015b2 100644 --- a/en/tracker/mobile/search-task.md +++ b/en/tracker/mobile/search-task.md @@ -2,4 +2,4 @@ If you know the name of an issue or its key, you can search for it using the search bar or query language. -At the top of the screen, enter the issue name or key in the **{{ ui-key.startrek.ui_components_PageIssues.search-title }}** field. As a result, you'll see a list with the issues that meet the query criteria. The list shows the first 20 entries. If you didn't find the issue you need, refine your query. +At the top of the screen, enter the issue name or key in the **Search by all tasks** field. As a result, you'll see a list with the issues that meet the query criteria. The list shows the first 20 entries. If you didn't find the issue you need, refine your query. diff --git a/en/tracker/mobile/sort-and-group.md b/en/tracker/mobile/sort-and-group.md index b759afa6331..4062dabe416 100644 --- a/en/tracker/mobile/sort-and-group.md +++ b/en/tracker/mobile/sort-and-group.md @@ -6,7 +6,7 @@ You can sort and group your issues using different parameters. 1. Open the issue list. -1. In the top-right corner, click ![](../../_assets/tracker/svg/gantt-settings-button.svg) → ![](../../_assets/tracker/svg/sorting.svg) **{{ ui-key.startrek.ui_components_dashboard_IssuesStatEditor.editor-sort-by-field-label }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/gantt-settings-button.svg) → ![](../../_assets/tracker/svg/sorting.svg) **Sorting**. 1. Select the sort parameter and the sort order: descending or ascending. @@ -16,7 +16,7 @@ You can sort and group your issues using different parameters. 1. Open the issue list. -1. In the top-right corner, click ![](../../_assets/tracker/svg/gantt-settings-button.svg) → ![](../../_assets/tracker/svg/group.svg) **{{ ui-key.startrek.ui_components_page-issues_touch_FilterSettingsMenu.item-group }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/gantt-settings-button.svg) → ![](../../_assets/tracker/svg/group.svg) **Grouping**. 1. Select the parameter to group your issues by. diff --git a/en/tracker/mobile/ticket-links.md b/en/tracker/mobile/ticket-links.md index 79ec4e554e4..3235f4d701f 100644 --- a/en/tracker/mobile/ticket-links.md +++ b/en/tracker/mobile/ticket-links.md @@ -16,7 +16,7 @@ Issue links are created automatically when an issue key is entered into the issu Create links with other issues: -1. Insert the issue key into the issue's description or comment body. You will see the linked issue in the **{{ ui-key.startrek.ui_components_IssueTabs.links-tab }}** tab. +1. Insert the issue key into the issue's description or comment body. You will see the linked issue in the **Links** tab. 1. If necessary, change the [link type](#change-link-type) to any of the ones available. @@ -32,7 +32,7 @@ To create a sub-issue: 1. Fill in the fields the same way as when [creating a new issue](./create-ticket.md). -1. Click **{{ ui-key.startrek.ui_components_CreateIssueForm.create-issue }}**. You will see a link to the parent issue next to the sub-issue name. +1. Click **Create issue**. You will see a link to the parent issue next to the sub-issue name. ## Changing the link type {#change-link-type} @@ -40,7 +40,7 @@ To change an issue's [link type](../user/links.md): 1. Open one of the two linked issues. -1. Click the **{{ ui-key.startrek.ui_components_IssueTabs.links-tab }}** tab. +1. Click the **Links** tab. 1. Next to the linked issue, tap ![](../../_assets/horizontal-ellipsis.svg) → **Change link type** and choose a new type. @@ -50,6 +50,6 @@ To remove an issue's link: 1. Open one of the two linked issues. -1. Click the **{{ ui-key.startrek.ui_components_IssueTabs.links-tab }}** tab. +1. Click the **Links** tab. 1. Next to the linked issue, click ![](../../_assets/horizontal-ellipsis.svg) and select **Remove link**. diff --git a/en/tracker/mobile/time-spent.md b/en/tracker/mobile/time-spent.md index 4808e97e96c..aef64365fc5 100644 --- a/en/tracker/mobile/time-spent.md +++ b/en/tracker/mobile/time-spent.md @@ -1,11 +1,11 @@ # View time spent -To view the amount of time you spent on an issue, go to the **{{ ui-key.startrek.ui_components_IssueTabs.fields-tab }}** tab on the issue page. The time spent is displayed under **{{ ui-key.startrek.ui_components_new-process_ProcessTypeStepRedesign.information-time-tracking-title }}**. +To view the amount of time you spent on an issue, go to the **Parameters** tab on the issue page. The time spent is displayed under **{{ ui-key.startrek.ui_Queues_smart-components_new-process_ProcessTypeStepRedesign.information-time-tracking-title }}**. -To edit your issue estimate, click ![](../../_assets/tracker/mobile-edit-param.png) to the right of the **{{ ui-key.startrek-backend.fields.issue.estimation-key-value }}** field. Enter a new value and click **{{ ui-key.startrek.ui_components_settings_IssueUpdatesSettings.save }}**. +To edit your issue estimate, click ![](../../_assets/tracker/mobile-edit-param.png) to the right of the **{{ ui-key.startrek-backend.fields.issue.estimation-key-value }}** field. Enter a new value and click **Save**. {% note info %} -If the **{{ ui-key.startrek.ui_components_new-process_ProcessTypeStepRedesign.information-time-tracking-title }}** section is missing, go to the web interface and add the **{{ ui-key.startrek-backend.fields.issue.spent-key-value }}** and **{{ ui-key.startrek-backend.fields.issue.estimation-key-value }}** fields in the right-hand panel by clicking ![](../../_assets/tracker/task-params-btn.png) **Choose fields**. +If the **{{ ui-key.startrek.ui_Queues_smart-components_new-process_ProcessTypeStepRedesign.information-time-tracking-title }}** section is missing, go to the web interface and add the **{{ ui-key.startrek-backend.fields.issue.spent-key-value }}** and **{{ ui-key.startrek-backend.fields.issue.estimation-key-value }}** fields in the right-hand panel by clicking ![](../../_assets/tracker/task-params-btn.png) **Choose fields**. {% endnote %} diff --git a/en/tracker/organizations.md b/en/tracker/organizations.md index 47ab7c14781..69cd1dacab6 100644 --- a/en/tracker/organizations.md +++ b/en/tracker/organizations.md @@ -6,7 +6,7 @@ Starting April 17, 2023, the free {{ ya-360 }} version will be running with cert The [changes]({{ link-ya-360-notfree }}) will affect all {{ tracker-name }} users with a free-of-charge organization in {{ ya-360 }}. -To see what organizations your {{ tracker-name }} is linked to, click ![](../_assets/tracker/svg/admin.svg) **Admin settings** → ![](../_assets/tracker/svg/organizations.svg) [**{{ ui-key.startrek.ui_components_page-admin_PageAdmin.menu-item-orgs }}**]({{ link-tracker }}admin/orgs) in the left-hand panel. To check if you pay for an organization in {{ ya-360 }}, click **{{ ui-key.startrek.ui_components_page-admin_OrgMainInfoPane.org-manage-button }}** in the section with the appropriate organization and go to **Payment and service plan**. +To see what organizations your {{ tracker-name }} is linked to, click ![](../_assets/tracker/svg/admin.svg) **Admin settings** → ![](../_assets/tracker/svg/organizations.svg) [**{{ ui-key.startrek.ui_Common_smart-components_page-admin_PageAdmin.menu-item-orgs }}**]({{ link-tracker }}admin/orgs) in the left-hand panel. To check if you pay for an organization in {{ ya-360 }}, click **Manage organization** in the section with the appropriate organization and go to **Payment and service plan**. {% cut "Why do I have an organization in {{ ya-360 }} if I only had {{ org-full-name }} set up?" %} diff --git a/en/tracker/pay-the-bill.md b/en/tracker/pay-the-bill.md index 516c87dcfac..41b296eeec7 100644 --- a/en/tracker/pay-the-bill.md +++ b/en/tracker/pay-the-bill.md @@ -60,9 +60,9 @@ To check your account balance: 1. Select your billing account on the **{{ ui-key.yacloud_billing.billing.switch_accounts }}** page. -1. Click **{{ ui-key.startrek.ui_components_page-admin_BillingAccountInfo.refill-balance }}** in the section with the account name. +1. Click **Top up balance** in the section with the account name. -1. Enter your payment amount and click **{{ ui-key.startrek.ui_components_page-admin_BillingAccountInfo.refill-balance }}** again. +1. Enter your payment amount and click **Top up balance** again. ## Top up your account via bank transfer {#transfer} @@ -70,9 +70,9 @@ To check your account balance: 1. Select your billing account on the **{{ ui-key.yacloud_billing.billing.accounts.label_title }}** page. -1. Click **{{ ui-key.startrek.ui_components_page-admin_BillingAccountInfo.refill-balance }}** in the section with the account name. +1. Click **Top up balance** in the section with the account name. -1. Enter the payment amount and click **{{ ui-key.startrek.ui_components_page-admin_BillingAccountInfo.refill-dialog-ok-issue }}**. The system will generate a payment invoice. +1. Enter the payment amount and click **Issue an invoice**. The system will generate a payment invoice. 1. Print the invoice and use it to make a payment in a bank or using a banking client system. diff --git a/en/tracker/quick-start.md b/en/tracker/quick-start.md index fddcbe7a105..8b387094e01 100644 --- a/en/tracker/quick-start.md +++ b/en/tracker/quick-start.md @@ -9,13 +9,13 @@ To get started with {{ tracker-name }}, create a queue: this is a shared space w In {{ tracker-name }}, you can [create](manager/create-queue.md) and [set up](manager/edit-queue-general.md) a queue manually, or use [automation tools](automation.md). To create a queue preconfigured for a specific workflow, we recommend using [workflow templates](manager/create-work-process.md). -1. On the [**My page**](https://tracker.yandex.ru/pages/my) home page, click **{{ ui-key.startrek.ui_components_dashboard_InfoPresetsWidget.choose-template-button }}** in the **{{ ui-key.startrek.ui_components_dashboard_InfoPresetsWidget.widget-title }}** widget. -1. Select **{{ ui-key.startrek.ui_components_new-process_ProcessTypeStepRedesign.process-type-standard }}** and click **{{ ui-key.startrek.ui_components_new-process_QueueSetupForm.next-button }}**. +1. On the [**My page**](https://tracker.yandex.ru/pages/my) home page, click **{{ ui-key.startrek.ui_Dashboards_smart-components_InfoPresetsWidget.choose-template-button }}** in the **{{ ui-key.startrek.ui_Dashboards_smart-components_InfoPresetsWidget.widget-title }}** widget. +1. Select **{{ ui-key.startrek.ui_Queues_smart-components_new-process_ProcessTypeStepRedesign.process-type-standard }}** and click **{{ ui-key.startrek.ui_Queues_smart-components_new-process_QueueSetupForm.next-button }}**. 1. Specify the queue parameters: * Issue queue name * [Queue key](manager/create-queue.md#key) * Permissions -1. Click **{{ ui-key.startrek.ui_components_new-process_QueueSetupForm.next-button }}**. +1. Click **{{ ui-key.startrek.ui_Queues_smart-components_new-process_QueueSetupForm.next-button }}**. This will create a queue with a basic set of issue [types and statuses](manager/workflow.md) and a [simple issue board](manager/agile.md#sec_boards). @@ -56,17 +56,17 @@ Use the full form to set up all the issue attributes you need right from the sta 1. Enter a name for the issue in the **Issue name** field. Make sure the name is explicative so that the issue is easy to find in the list, e.g.: _Find the answer to the ultimate question of life, the Universe, and everything else_. - 1. Enter a description of the issue if needed. To do so, click the `{{ ui-key.startrek.ui_components_PageCreateIssue.description-placeholder }}` placeholder and describe the issue in the text editor that opens. + 1. Enter a description of the issue if needed. To do so, click the `{{ ui-key.startrek.ui_Issues_pages_PageCreateIssue.description-placeholder }}` placeholder and describe the issue in the text editor that opens. - 1. If you need to upload files, click **{{ ui-key.startrek.ui_components_attachments-manager.attach }}**. + 1. If you need to upload files, click **{{ ui-key.startrek.ui_Common_smart-components_attachments-manager.attach }}**. - 1. You can also add checkpoints to the **Checklist**. For this, click **{{ ui-key.startrek.ui_components_entity-page_checklist_Footer.new-item-button-caption }}** and fill out the form that opens. + 1. You can also add checkpoints to the **Checklist**. For this, click **{{ ui-key.startrek.ui_Common_smart-components_entity-page_checklist_Footer.new-item-button-caption }}** and fill out the form that opens. 1. On the left-hand panel, enter the relevant issue details, for example: * In the **{{ ui-key.startrek-backend.fields.issue.assignee-key-value }}** field, assign the issue to yourself by clicking **Assign to me**. * In the **{{ ui-key.startrek-backend.fields.issue.dueDate-key-value }}** field, enter an arbitrary deadline. - 1. Edit the list of the issue's displayed fields if needed. To do this, click **{{ ui-key.startrek.ui_components_entity-page_sidebar_SidebarFieldsSelect.add-sidebar-field }}** and set the relevant parameters. + 1. Edit the list of the issue's displayed fields if needed. To do this, click **{{ ui-key.startrek.ui_Common_smart-components_entity-page_sidebar_SidebarFieldsSelect.add-sidebar-field }}** and set the relevant parameters. 1. Click **{{ ui-key.startrek-backend.types.types.trigger.action.create.issue }}**. diff --git a/en/tracker/release-notes/2308.md b/en/tracker/release-notes/2308.md index a2c9f52c5e9..acaacb68966 100644 --- a/en/tracker/release-notes/2308.md +++ b/en/tracker/release-notes/2308.md @@ -23,8 +23,8 @@ Added a new page, **Integrations (beta)**, to the queue settings. You can use it You can now use the organizations page to change the organization that {{ tracker-name }} is enabled for. To do this: 1. Go to the [organizations page]({{ link-tracker }}admin/orgs). -1. Click **{{ ui-key.startrek.ui_components_page-admin_ChangeOrganizationModal.add-button }}**. -1. In the window that opens, select an available organization and click **{{ ui-key.startrek.ui_components_page-admin_ChangeOrganizationModal.add-button }}**. +1. Click **Change organization**. +1. In the window that opens, select an available organization and click **Change organization**. You can change both {{ yandex-cloud }} and {{ ya-360 }} organizations. @@ -40,10 +40,10 @@ You can now [connect a repository](../user/add-repository.md) hosted on your own To connect a custom repository: 1. Go to the [connect repositories page]({{ link-tracker }}admin/repositories). -1. In the top-right corner, click **{{ ui-key.startrek.ui_components_admin-repositories_ConnectRepositoryDialog.connect }}**. +1. In the top-right corner, click **{{ ui-key.startrek.ui_Common_smart-components_admin-repositories_ConnectRepositoryDialog.connect }}**. 1. In the **Platform** field, select the platform your server is connected to. -1. In the **{{ ui-key.startrek.ui_components_admin-repositories_ConnectRepositoryDialog_fields_UrlField.server-url-label }}** field, specify your server address to any repository that can be accessed using a token. -1. In the **{{ ui-key.startrek.ui_components_admin-repositories_ConnectRepositoryDialog.token-label }}** field, enter the token for connecting to your server. +1. In the **Link to repository** field, specify your server address to any repository that can be accessed using a token. +1. In the **{{ ui-key.startrek.ui_Common_smart-components_admin-repositories_ConnectRepositoryDialog.token-label }}** field, enter the token for connecting to your server. 1. Click **Connect**. 1. Make sure that the repository status in {{ tracker-name }} is **Connected**. diff --git a/en/tracker/release-notes/2309.md b/en/tracker/release-notes/2309.md index 69229b458c9..7897095e17c 100644 --- a/en/tracker/release-notes/2309.md +++ b/en/tracker/release-notes/2309.md @@ -11,7 +11,7 @@ The new access rights allow you to flexibly manage your team's queue permissions You still can override access rights in tasks using components and assign rights depending on roles in the task. Now these settings can be accessed from the new interface and are easier to use. -To manage access, go to the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-permissions }}** tab in queue settings. On this page, you can also view queue access rights for any user or user group. +To manage access, go to the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-permissions }}** tab in queue settings. On this page, you can also view queue access rights for any user or user group. For more details on setting up access rights, see [{#T}](../manager/queue-access.md). @@ -33,9 +33,9 @@ In the queue integration settings, you can now create and integrate [{{ forms-fu 1. In the settings for the queue that you want to create or integrate a form for, select **Integrations (beta)**. -1. In the **{{ ui-key.startrek.ui_components_queue-admin-tab-integrations_IntegrationForms.title }}** section, click **Setting up forms**. On this page, you can work with forms: +1. In the **Forms** section, click **Setting up forms**. On this page, you can work with forms: - * Create new forms and connect existing ones. To do this, click **{{ ui-key.startrek.ui_components_page-queue-admin_queue-admin-tab-integrations-forms_components_FormsMenu.add-form }}** in the upper-right corner and select **{{ ui-key.startrek.ui_components_page-queue-admin_queue-admin-tab-integrations-forms_components_FormsMenu.add-form }}** or **{{ ui-key.startrek.ui_components_page-queue-admin_queue-admin-tab-integrations-forms_components_FormsMenu.create-new }}**. + * Create new forms and connect existing ones. To do this, click **Add form** in the upper-right corner and select **Add form** or **Create new**. * Edit and delete previously added forms. To do this, in the list of forms, click ![](../../_assets/tracker/svg/actions.svg) to the right of the record and select an action. @@ -49,7 +49,7 @@ For more information on portfolios, see [{#T}](../manager/portfolio.md). ### Project milestones {#milestones} -Added a new [issue type](../manager/add-ticket-type.md): ![](../../_assets/tracker/svg/milestone.svg) **{{ ui-key.startrek.ui_components_issues_create-issue-popup_NewIssueForm.milestone-type }}**. You can use it to track important project development stages. Please note that milestones have no **Start date** and **End date** fields. They only have the **Deadline** field. +Added a new [issue type](../manager/add-ticket-type.md): ![](../../_assets/tracker/svg/milestone.svg) **Milestone**. You can use it to track important project development stages. Please note that milestones have no **Start date** and **End date** fields. They only have the **Deadline** field. Project milestones in {{ tracker-name }} are displayed in the **About the project** tab under the project description. On the [project Gantt chart](../gantt/project.md), milestones are shown as a diamond. Now you can add milestones to your project on these pages. @@ -62,17 +62,17 @@ For more information on milestones, see [{#T}](../manager/milestones.md). The new [queue workflow](../manager/add-workflow.md) editor has left beta and is now available by default. Because of this, we have now removed the **Task Types** section from queue settings: all these options are now available under **Workflows**. To open workflows: 1. Navigate to the required queue's settings. -1. Select the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab. +1. Select the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab. ### Copying workflows from other queues {#copy-workflow} In the workflow editor, you can now copy workflows from one queue and use them in another queue. To do this: 1. Navigate to the settings of the queue for which you want to set up a workflow. -1. Select the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab. +1. Select the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** tab. 1. In the top-right corner, click ![](../../_assets/tracker/svg/copy-workflow.svg). 1. In the pop-up window, select the queue and its workflow you want to copy, and enter the name for the new workflow. -1. Click **{{ ui-key.startrek.ui_components_queue-admin-tab-workflows_CopyWorkflowDialog.action-copy }}**. +1. Click **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-workflows_CopyWorkflowDialog.action-copy }}**. ## Fixes and improvements {#fixes} diff --git a/en/tracker/support-process-send-mail.md b/en/tracker/support-process-send-mail.md index 604e2656735..62cd85d97be 100644 --- a/en/tracker/support-process-send-mail.md +++ b/en/tracker/support-process-send-mail.md @@ -6,7 +6,7 @@ To send emails from the issue page: ### Step 1. Set up email integration in the queue -1. Go to **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-aliases }}** in the queue settings and [add queue address](manager/queue-mail.md). +1. Go to **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-aliases }}** in the queue settings and [add queue address](manager/queue-mail.md). If you want to send issues from the issue page, you need a shared queue address. The user responses sent to the queue address will be added as issue comments. diff --git a/en/tracker/user/agile.md b/en/tracker/user/agile.md index 31a2992563b..604d56b7c45 100644 --- a/en/tracker/user/agile.md +++ b/en/tracker/user/agile.md @@ -32,7 +32,7 @@ Make sure that the queue for creating issues in is specified in the [board setti 1. Open issues boards. -1. In the bottom-right corner, click **{{ ui-key.startrek.ui_components_agile_common_AddIssueButton.add-issue-button }}**. +1. In the bottom-right corner, click **Add issue**. 1. Enter the issuer name and select its type. @@ -100,13 +100,13 @@ To add multiple issues to the board at once, use the [bulk change](../manager/bu 1. Choose the issues you want to add to the board and click **Edit fields**. -1. To add an issue to a backlog, start typing the backlog name in the **{{ ui-key.startrek.ui_components_agile_common_AgileTabs.board }}** field and pick the option you need from the list that appears. If you do not see the **{{ ui-key.startrek.ui_components_agile_common_AgileTabs.board }}** field, add it by clicking **Choose fields**. +1. To add an issue to a backlog, start typing the backlog name in the **Board** field and pick the option you need from the list that appears. If you do not see the **Board** field, add it by clicking **Choose fields**. 1. To add an issue to a sprint, start typing the sprint name in the **{{ ui-key.startrek-backend.fields.issue.sprint }}** field and pick the option you need from the list that appears. The board field is populated automatically. If you do not see the **{{ ui-key.startrek-backend.fields.issue.sprint }}** field, add it by clicking **Choose fields**. -1. Click **{{ ui-key.startrek.ui_components_TransitionScreen.screen-next-button }}** and wait until your issues are processed. +1. Click **Continue** and wait until your issues are processed. ## Remove an issue from the board {#remove-tasks} @@ -153,7 +153,7 @@ If there are too many issues on the board, you can always hide some of them usin * The issue's key or name. Start typing the text in the field on the top panel. Only the issues whose key or name includes this text will remain on the board. -* Quick filters. By default, the board has only two quick filters: **{{ ui-key.startrek.ui_components_agile_common_QuickFiltersItem.quick-filter--assignee-me }}** and **{{ ui-key.startrek.ui_components_agile_common_QuickFiltersItem.quick-filter--author-me }}**. To add new filters, click![](../../_assets/tracker/edit-agile.png) in the filter panel. +* Quick filters. By default, the board has only two quick filters: **Assigned to me** and **Created by me**. To add new filters, click![](../../_assets/tracker/edit-agile.png) in the filter panel. ## Fullscreen mode {#fullscreen} diff --git a/en/tracker/user/attach-file.md b/en/tracker/user/attach-file.md index 36577ce47f5..bed90020a69 100644 --- a/en/tracker/user/attach-file.md +++ b/en/tracker/user/attach-file.md @@ -5,7 +5,7 @@ The files that you add in {{ tracker-name }} don't consume space on Yandex  To attach a file to an issue description, use one of the methods: -* Click ![](../../_assets/tracker/svg/icon-file.svg) **{{ ui-key.startrek.ui_components_attachments-manager.attach }}** next to the issue description. +* Click ![](../../_assets/tracker/svg/icon-file.svg) **{{ ui-key.startrek.ui_Common_smart-components_attachments-manager.attach }}** next to the issue description. * Drag files to the issue description. diff --git a/en/tracker/user/checklist.md b/en/tracker/user/checklist.md index 5b0241ea355..b68c47eba56 100644 --- a/en/tracker/user/checklist.md +++ b/en/tracker/user/checklist.md @@ -12,9 +12,9 @@ A checklist is a list of items that need to be completed to resolve the issue. H 1. If necessary, specify the assignee and deadline for this checklist item. -1. To add the item, click **{{ ui-key.startrek.ui_components_entity-page_checklist_ChecklistItem.button-submit }}**. If you want to cancel this action, click **{{ ui-key.startrek.ui_components_entity-page_checklist_ChecklistItem.button-cancel }}**. +1. To add the item, click **Save**. If you want to cancel this action, click **Cancel**. -1. To add another item, click **{{ ui-key.startrek.ui_components_entity-page_checklist_Footer.new-item-button-caption }}**. +1. To add another item, click **{{ ui-key.startrek.ui_Common_smart-components_entity-page_checklist_Footer.new-item-button-caption }}**. ## Managing a checklist {#checklist-operations} @@ -32,8 +32,8 @@ The checklist operations include: * To move an item up or down the list, click ![](../../_assets/tracker/svg/range.svg) and drag the item to the desired location in the list. -* To hide or show all the items, click **{{ ui-key.startrek.ui_components_entity-page_checklist_Header.header-title }}** at the top of the list. +* To hide or show all the items, click **{{ ui-key.startrek.ui_Common_smart-components_entity-page_checklist_Header.header-title }}** at the top of the list. -* To add an item to the checklist, click **{{ ui-key.startrek.ui_components_entity-page_checklist_Footer.new-item-button-caption }}** at the bottom of the list. +* To add an item to the checklist, click **{{ ui-key.startrek.ui_Common_smart-components_entity-page_checklist_Footer.new-item-button-caption }}** at the bottom of the list. -* To delete the checklist, click ![](../../_assets/horizontal-ellipsis.svg) and select ![](../../_assets/tracker/svg/icon-remove.svg) **{{ ui-key.startrek.ui_components_entity-page_checklist_ChecklistActionsMenu.remove-title }}** at the top of the list. +* To delete the checklist, click ![](../../_assets/horizontal-ellipsis.svg) and select ![](../../_assets/tracker/svg/icon-remove.svg) **{{ ui-key.startrek.ui_Common_smart-components_entity-page_checklist_ChecklistActionsMenu.remove-title }}** at the top of the list. diff --git a/en/tracker/user/clone.md b/en/tracker/user/clone.md index 154e4665662..7392ed45876 100644 --- a/en/tracker/user/clone.md +++ b/en/tracker/user/clone.md @@ -12,7 +12,7 @@ To clone an issue: 1. Open the issue page. -1. In the top-right corner, select **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.clone-issue-action-title }}**. +1. In the top-right corner, select **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.clone-issue-action-title }}**. 1. Select the queue to create your cloned issue in. diff --git a/en/tracker/user/create-autoaction.md b/en/tracker/user/create-autoaction.md index 1f0b86fe2cf..7c1e26c7378 100644 --- a/en/tracker/user/create-autoaction.md +++ b/en/tracker/user/create-autoaction.md @@ -12,7 +12,7 @@ When an auto action is triggered, only the first 100 issues that meet the specif 1. {% include [go to settings](../../_includes/tracker/transition-page.md) %} -1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. On the left-hand panel, select **Automation** → **Auto actions** and click **Create auto action**. diff --git a/en/tracker/user/create-filter.md b/en/tracker/user/create-filter.md index 33d9e00c639..bd03a493e9d 100644 --- a/en/tracker/user/create-filter.md +++ b/en/tracker/user/create-filter.md @@ -26,7 +26,7 @@ There are several ways to set the filter conditions: Add the issue parameters and specify their possible values: - 1. Click ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_components_filter-pane_FieldsSelectButton.add-filter-field-button-title }}** above the issue list. + 1. Click ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_Common_smart-components_filter-pane_FieldsSelectButton.add-filter-field-button-title }}** above the issue list. 1. Select an issue parameter and then set its value. @@ -46,11 +46,11 @@ There are several ways to set the filter conditions: {% endnote %} -- **{{ ui-key.startrek.ui_components_dashboard_FilterEditor.editor-source-radio-query }}** +- **Query language** You can use the query language to set special conditions that are not accessible via regular parameters. For instance, you can find issues that have been opened within the last week. For more information about the query language, see [{#T}](query-filter.md). - 1. In the top-right corner of the page, click ![](../../_assets/tracker/svg/query-language.svg) **{{ ui-key.startrek.ui_components_dashboard_FilterEditor.editor-source-radio-query }}**. All the search parameters that you set by quick filters and conditions, will be shown in the search bar. + 1. In the top-right corner of the page, click ![](../../_assets/tracker/svg/query-language.svg) **Query language**. All the search parameters that you set by quick filters and conditions, will be shown in the search bar. 1. Use the [query language](query-filter.md) to add parameters. @@ -58,7 +58,7 @@ There are several ways to set the filter conditions: ### Step 3. Set up the layout for the issue list -- If you want to hide or display certain issue parameters, on the right above the list, click ![](../../_assets/tracker/svg/list-settings.svg) **{{ ui-key.startrek.ui_components_PageAgileBoard_PageAgileBoardHeader.settings }}**, select the parameters, and click **Apply**. +- If you want to hide or display certain issue parameters, on the right above the list, click ![](../../_assets/tracker/svg/list-settings.svg) **{{ ui-key.startrek.ui_Boards_pages_PageAgileBoard_PageAgileBoardHeader.settings }}**, select the parameters, and click **Apply**. - To group issues by a certain parameter, click ![](../../_assets/tracker/svg/group.svg) **Not grouped** above the list and select the parameter. @@ -66,7 +66,7 @@ There are several ways to set the filter conditions: ### Step 4. Save filters -If you often use a filter, save it. Your saved filters will be available in the **{{ ui-key.startrek.ui_components_filter-pane.all-issues-filter-title }}** checkbox under **{{ ui-key.startrek-backend.messages.user.named.request.folder.my }}**. +If you often use a filter, save it. Your saved filters will be available in the **{{ ui-key.startrek.ui_Common_smart-components_filter-pane.all-issues-filter-title }}** checkbox under **{{ ui-key.startrek-backend.messages.user.named.request.folder.my }}**. 1. Click **Save** above the issue list. @@ -74,29 +74,29 @@ If you often use a filter, save it. Your saved filters will be available in the 1. Click **Save**. -To save a filtered issue list, in the top-right corner, click ![](../../_assets/tracker/svg/icon-export-tasks.svg) **{{ ui-key.startrek.ui_components_FilterExportMenu.menu-item-export }}** and select the download file format or simply copy the list to the clipboard. +To save a filtered issue list, in the top-right corner, click ![](../../_assets/tracker/svg/icon-export-tasks.svg) **Export** and select the download file format or simply copy the list to the clipboard. ## Editing a filter {#edit} #### Changing filter parameters -1. In the **{{ ui-key.startrek.ui_components_page-issues_touch.all-issues-filter-title }}** field at the top of the window, select your filter. +1. In the **{{ ui-key.startrek.ui_Issues_pages_page-issues_touch.all-issues-filter-title }}** field at the top of the window, select your filter. 1. [Change the issue search criteria](#set-conditions) using quick filters, parameters, or the query language. 1. Click **Save** above the issue list: - * To save the filter with the current name, click **{{ ui-key.startrek.ui_components_filter-pane.action-title-save }}**. + * To save the filter with the current name, click **{{ ui-key.startrek.ui_Common_smart-components_filter-pane.action-title-save }}**. - * To save the filter under a different name, click **{{ ui-key.startrek.ui_components_filter-pane.action-title-save-as }}**. Then enter the filter name, select the category, and click **Save**. + * To save the filter under a different name, click **{{ ui-key.startrek.ui_Common_smart-components_filter-pane.action-title-save-as }}**. Then enter the filter name, select the category, and click **Save**. #### Removing filters -1. In the **{{ ui-key.startrek.ui_components_page-issues_touch.all-issues-filter-title }}** field at the top of the window, select your filter. +1. In the **{{ ui-key.startrek.ui_Issues_pages_page-issues_touch.all-issues-filter-title }}** field at the top of the window, select your filter. 1. Delete your filter using one of the methods: * To the right of the filter name, click ![](../../_assets/tracker/svg/icon-filter-delete.svg) **Delete**. - * In the top-right corner of the page, click ![](../../_assets/tracker/svg/actions.svg) **{{ ui-key.startrek.ui_components_FilterExportMenu.title }}**, then select ![](../../_assets/tracker/svg/icon-filter-delete.svg) **Delete**. \ No newline at end of file + * In the top-right corner of the page, click ![](../../_assets/tracker/svg/actions.svg) **Filter actions**, then select ![](../../_assets/tracker/svg/icon-filter-delete.svg) **Delete**. \ No newline at end of file diff --git a/en/tracker/user/create-ticket-with-forms.md b/en/tracker/user/create-ticket-with-forms.md index e0c9f232b03..fc9b8281576 100644 --- a/en/tracker/user/create-ticket-with-forms.md +++ b/en/tracker/user/create-ticket-with-forms.md @@ -12,6 +12,6 @@ You can use a form to create issues as follows: - The form is [added to a queue in {{ tracker-name }}](../manager/attach-form.md) as a template for quick creation of standard issues. - In the case of this form publication method, go to the issue page, then click **{{ ui-key.startrek.ui_components_CreateIssueForm.create-issue }}**, select the form, and fill out its fields. An issue will be created based on the entered data. + In the case of this form publication method, go to the issue page, then click **Create issue**, select the form, and fill out its fields. An issue will be created based on the entered data. To learn more about integration with {{ forms-full-name }}, see [{#T}](../manager/forms-integration.md). diff --git a/en/tracker/user/create-ticket.md b/en/tracker/user/create-ticket.md index 21b8237a793..058aec8ee03 100644 --- a/en/tracker/user/create-ticket.md +++ b/en/tracker/user/create-ticket.md @@ -15,7 +15,7 @@ To create an issue: 1. Add an issue description. Use [YFM markup](markup.md) to format text. -1. To add files or images to the issue, click **{{ ui-key.startrek.ui_components_attachments-manager.attach }}**. +1. To add files or images to the issue, click **{{ ui-key.startrek.ui_Common_smart-components_attachments-manager.attach }}**. 1. To add a list of steps for issue resolution, click **Add checklist**. @@ -27,7 +27,7 @@ To create an issue: You can also leave the values at defaults to come back to them later. -1. If necessary, configure [additional parameters](create-param.md#default-fields): To do this, add fields by clicking ![](../../_assets/tracker/task-params-btn.png) **{{ ui-key.startrek.ui_components_entity-page_sidebar_SidebarFieldsSelect.add-sidebar-field }}** and fill them out. +1. If necessary, configure [additional parameters](create-param.md#default-fields): To do this, add fields by clicking ![](../../_assets/tracker/task-params-btn.png) **{{ ui-key.startrek.ui_Common_smart-components_entity-page_sidebar_SidebarFieldsSelect.add-sidebar-field }}** and fill them out. {% note info %} @@ -35,7 +35,7 @@ To create an issue: {% endnote %} -1. Click **{{ ui-key.startrek.ui_components_CreateIssueForm.create-issue }}**. +1. Click **Create issue**. ## Automation features {#avto} @@ -49,7 +49,7 @@ If no simplified form was added to the queue, a standard issue creation form wil If you need to create a lot of similar issues, make a [template](ticket-template.md) for them. -To create an issue using a template, click ![](../../_assets/tracker/svg/icon-note.svg) **{{ ui-key.startrek.ui_components_issue-templates_Select.select-template }}** in the top-right corner. Select a suitable template or click `{{ ui-key.startrek.ui_components_issue-templates_Select.manage-templates }}` to create a new one. +To create an issue using a template, click ![](../../_assets/tracker/svg/icon-note.svg) **{{ ui-key.startrek.ui_Issues_smart-components_issue-templates_Select.select-template }}** in the top-right corner. Select a suitable template or click `{{ ui-key.startrek.ui_Issues_smart-components_issue-templates_Select.manage-templates }}` to create a new one. If you apply a template, the issue fields will be set to template values that you can edit. @@ -71,11 +71,11 @@ To create a sub-issue: 1. Open the issue page to create a sub-issue for. -1. In the top-right corner, select **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.create-subissue }}**. +1. In the top-right corner, select **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.create-subissue }}**. 1. Fill in the fields the same way as when [creating a new issue](#create-task). -1. Click **{{ ui-key.startrek.ui_components_CreateIssueForm.create-issue }}**. +1. Click **Create issue**. #### The next step diff --git a/en/tracker/user/create-trigger.md b/en/tracker/user/create-trigger.md index f4560f6c39a..ec4e2ccfc8e 100644 --- a/en/tracker/user/create-trigger.md +++ b/en/tracker/user/create-trigger.md @@ -13,7 +13,7 @@ Only [queue owners](../manager/queue-access.md) can create, edit, and delete tri 1. {% include [go to settings](../../_includes/tracker/transition-page.md) %} -1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. On the left-hand panel, select **Automation** → **Triggers** and click **Create trigger**. diff --git a/en/tracker/user/default-filters.md b/en/tracker/user/default-filters.md index ba67cbba6ef..1e5f4e0fffa 100644 --- a/en/tracker/user/default-filters.md +++ b/en/tracker/user/default-filters.md @@ -22,7 +22,7 @@ Find your issues using preset system filters. * **Waiting for response**: Issues you were [invited to comment](comments.md#call-comment) on. - * **{{ ui-key.startrek.ui_components_IssuesPresetSelect.preset_deadline }}**: Issues in which you are reporter, assignee, or follower and where: + * **{{ ui-key.startrek.ui_Issues_smart-components_IssuesPresetSelect.preset_deadline }}**: Issues in which you are reporter, assignee, or follower and where: * Issues that have exceeded their deadlines in the past two weeks. @@ -36,7 +36,7 @@ Find your issues using preset system filters. * To group issues by a certain parameter, click ![](../../_assets/tracker/svg/group.svg) **Not grouped** to the right of the search bar and select the desired parameter. - * To save an issue list, in the top-right corner, click ![](../../_assets/tracker/svg/icon-export-tasks.svg) **{{ ui-key.startrek.ui_components_FilterExportMenu.menu-item-export }}** and select the download file format or simply copy the list to the clipboard. + * To save an issue list, in the top-right corner, click ![](../../_assets/tracker/svg/icon-export-tasks.svg) **Export** and select the download file format or simply copy the list to the clipboard. * To collapse the panel with the filter list, in the top-right corner of the page, click ![](../../_assets/tracker/svg/icon-parameters.svg) **Parameters**. @@ -52,7 +52,7 @@ Use filtering by parameters to narrow down your issue list and display only thos * To filter issues by their [resolution](../manager/create-resolution.md), click **{{ ui-key.startrek-backend.fields.issue.resolution-key-value }}** and select relevant values from the list. -* To use [advanced search parameters](#add-condition), click ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_components_filter-pane_FieldsSelectButton.add-filter-field-button-title }}** and select a field. +* To use [advanced search parameters](#add-condition), click ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_Common_smart-components_filter-pane_FieldsSelectButton.add-filter-field-button-title }}** and select a field. As a result, only the issues that meet the selected filter criteria are shown in the list. @@ -62,18 +62,18 @@ As a result, only the issues that meet the selected filter criteria are shown in To find issues by the parameters that cannot be set using the system filters, add search conditions. -1. In the top-right corner of the page, click ![](../../_assets/tracker/svg/icon-parameters.svg) **{{ ui-key.startrek.ui_components_dashboard_IssuesStatEditor.editor-source-radio-parameters }}**. A panel with the specified filtering parameters will be shown under the search bar. +1. In the top-right corner of the page, click ![](../../_assets/tracker/svg/icon-parameters.svg) **Parameters**. A panel with the specified filtering parameters will be shown under the search bar. -1. Click ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_components_filter-pane_FieldsSelectButton.add-filter-field-button-title }}**. +1. Click ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_Common_smart-components_filter-pane_FieldsSelectButton.add-filter-field-button-title }}**. -1. Select an issue parameter, set its value, and click **{{ ui-key.startrek.ui_components_filter-field.save-button }}**. +1. Select an issue parameter, set its value, and click **Save**. Any issues that do not meet your criteria are filtered out of the list. 1. If you need to refine the search conditions, add more parameters. -1. You can reset the search parameters by clicking **{{ ui-key.startrek.ui_components_filter-pane.reset-button }}** above the issue list. +1. You can reset the search parameters by clicking **{{ ui-key.startrek.ui_Common_smart-components_filter-pane.reset-button }}** above the issue list. For example, you can search issues by their name or description: @@ -92,7 +92,7 @@ If you set multiple search conditions, only those issues that meet all the condi If you cannot set search conditions using the issue parameters, use the request: -1. Click ![](../../_assets/tracker/svg/query-language.svg) **{{ ui-key.startrek.ui_components_dashboard_FilterEditor.editor-source-radio-query }}** in the top-right corner. All the search parameters that you set by quick filters and conditions, will be shown in the search bar. +1. Click ![](../../_assets/tracker/svg/query-language.svg) **Query language** in the top-right corner. All the search parameters that you set by quick filters and conditions, will be shown in the search bar. 1. Use the [query language](query-filter.md) to add parameters. diff --git a/en/tracker/user/edit-ticket.md b/en/tracker/user/edit-ticket.md index 7cbe35fe29a..b0dbd79c075 100644 --- a/en/tracker/user/edit-ticket.md +++ b/en/tracker/user/edit-ticket.md @@ -26,7 +26,7 @@ You can also [attach images or files](attach-file.md) to issue descriptions. The [issue details](create-param.md##default-fields) are shown in the panel on the right. To edit the parameter's value, click its name and select a new value. -If you do not see the desired parameters in the right-hand panel, add them by clicking **{{ ui-key.startrek.ui_components_entity-page_sidebar_SidebarFieldsSelect.add-sidebar-field }}**. +If you do not see the desired parameters in the right-hand panel, add them by clicking **{{ ui-key.startrek.ui_Common_smart-components_entity-page_sidebar_SidebarFieldsSelect.add-sidebar-field }}**. To edit the parameters of multiple issues at once, use [bulk operations](../manager/bulk-change.md#change-parameters). diff --git a/en/tracker/user/forms-template.md b/en/tracker/user/forms-template.md index 20c78c973f7..cf7568a731d 100644 --- a/en/tracker/user/forms-template.md +++ b/en/tracker/user/forms-template.md @@ -26,9 +26,9 @@ To create a form for your issues: 1. Select a queue in the field located at the top of the page. -1. If there are no forms in the queue, select **{{ ui-key.startrek.ui_components_PageCreateIssue.create-new }}**. If you already have forms, click **{{ ui-key.startrek.ui_components_PageCreateIssue.create-new-template }}**. +1. If there are no forms in the queue, select **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssue.create-new }}**. If you already have forms, click **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssue.create-new-template }}**. -1. Enter a name and description for the form and click **{{ ui-key.startrek.ui_components_PageCreateIssueForm.continue }}**. +1. Enter a name and description for the form and click **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssueForm.continue }}**. 1. Add fields to the form. @@ -87,10 +87,10 @@ To go to the queue forms, in the left panel, click ![](../../_assets/tracker/sv To change the form order on the issue creation page, click ![](../../_assets/tracker/svg/range.svg) and drag the form. -You can set up your issues to be created without a form or only with a form. To do this, select **{{ ui-key.startrek.ui_components_QueueAdminTemplateOptions.allow-empty-template }}** in the top-right corner. -* **{{ ui-key.startrek.ui_components_QueueAdminTemplateOptions.always }}**: All users will be able to create issues without a form. -* **{{ ui-key.startrek.ui_components_QueueAdminTemplateOptions.never }}**: Users will only be able to create issues using a form. -* **{{ ui-key.startrek.ui_components_QueueAdminTemplateOptions.team }}**: Only the members of the [queue team](../manager/queue-team.md) will be able to create issues without a form. +You can set up your issues to be created without a form or only with a form. To do this, select **{{ ui-key.startrek.ui_Queues_smart-components_QueueAdminTemplateOptions.allow-empty-template }}** in the top-right corner. +* **{{ ui-key.startrek.ui_Queues_smart-components_QueueAdminTemplateOptions.always }}**: All users will be able to create issues without a form. +* **{{ ui-key.startrek.ui_Queues_smart-components_QueueAdminTemplateOptions.never }}**: Users will only be able to create issues using a form. +* **{{ ui-key.startrek.ui_Queues_smart-components_QueueAdminTemplateOptions.team }}**: Only the members of the [queue team](../manager/queue-team.md) will be able to create issues without a form. ### Changing form parameters {#edit-template-name} @@ -98,9 +98,9 @@ To change the name or description of a form: 1. Select the form and click ![](../../_assets/horizontal-ellipsis.svg). -1. Select **{{ ui-key.startrek.ui_components_PageCreateIssue.change-title-and-description }}**. +1. Select **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssue.change-title-and-description }}**. -1. Enter a new name and description for the form and click **{{ ui-key.startrek.ui_components_queue-admin-tab-main_QueueAdminTabMain.save }}**. +1. Enter a new name and description for the form and click **Save**. ### Change the form {#edit-template} @@ -108,7 +108,7 @@ To change the form: 1. Select the form and click ![](../../_assets/horizontal-ellipsis.svg). -1. Select **{{ ui-key.startrek.ui_components_PageCreateIssue.change-template }}**. +1. Select **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssue.change-template }}**. 1. Edit the form's questions in the embedded {{ forms-full-name }} builder and set up integrations with {{ tracker-name }}, same as when [creating a form](#create-template). @@ -118,6 +118,6 @@ To delete a form: 1. Select the form and click ![](../../_assets/horizontal-ellipsis.svg). -1. Select **{{ ui-key.startrek.ui_components_PageCreateIssue.switch-to-admin-panel }}**. +1. Select **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssue.switch-to-admin-panel }}**. 1. In the queue settings next to the form, click ![](../../_assets/tracker/icon-delete.png). diff --git a/en/tracker/user/gitlab.md b/en/tracker/user/gitlab.md index cb0283385b3..f4edd7e3441 100644 --- a/en/tracker/user/gitlab.md +++ b/en/tracker/user/gitlab.md @@ -8,7 +8,7 @@ description: In this tutorial, you will learn how links work between between {{ ## Setting up a link {#relation} -In [{{ tracker-name }} issues](../about-tracker.md#zadacha), you can automatically add links to [merge requests]({{ gl.docs }}/ee/user/project/merge_requests/) from {{ GL }}. To do this, specify the appropriate issue's [key](../glossary.md#key) in the name or description of a new merge request. The links will be placed in [{{ ui-key.startrek.ui_components_issue-links_ExternalLinksCollapse.external-relations}}](../external-links.md). +In [{{ tracker-name }} issues](../about-tracker.md#zadacha), you can automatically add links to [merge requests]({{ gl.docs }}/ee/user/project/merge_requests/) from {{ GL }}. To do this, specify the appropriate issue's [key](../glossary.md#key) in the name or description of a new merge request. The links will be placed in [{{ ui-key.startrek.ui_Issues_smart-components_issue-links_ExternalLinksCollapse.external-relations}}](../external-links.md). You can also enable automatic creation of issue comments with information about merge requests. Auto comments are only available for [{{ mgl-name }}](../../managed-gitlab/). diff --git a/en/tracker/user/issues-stat.md b/en/tracker/user/issues-stat.md index 0a317777ffb..7766c64748a 100644 --- a/en/tracker/user/issues-stat.md +++ b/en/tracker/user/issues-stat.md @@ -16,7 +16,7 @@ To configure a widget, set the following: - **Issue source**: Filter on the basis of which the list of issues is formed. You can select a [system](default-filters.md) filter or a [previously created](create-filter.md) filter from the list or specify a filter using the [query language](query-filter.md) or parameters. -- **Number of rows on page**: Maximum number of chart rows to display in the widget. If there are more rows than the maximum, you can see them by clicking **{{ ui-key.startrek.ui_components_dashboard_TableWidget.show-all }}** at the bottom of the widget. +- **Number of rows on page**: Maximum number of chart rows to display in the widget. If there are more rows than the maximum, you can see them by clicking **Show All** at the bottom of the widget. - **Key parameter**: Issue field to gather statistics for. diff --git a/en/tracker/user/login.md b/en/tracker/user/login.md index 424e184a8b0..c8227755441 100644 --- a/en/tracker/user/login.md +++ b/en/tracker/user/login.md @@ -22,7 +22,7 @@ To create and edit issues, you will need [full access](../access.md) to {{ track To log in to {{ tracker-full-name }}: -1. Go to the [{{ tracker-name }}]({{ link-tracker }}). Click **{{ ui-key.startrek.ui_components_promo_Page.login-button-label }}**. +1. Go to the [{{ tracker-name }}]({{ link-tracker }}). Click **{{ ui-key.startrek.ui_Common_pages_promo_Page.login-button-label }}**. 1. Select an account you use to work in {{ tracker-name }}: diff --git a/en/tracker/user/manage-autoaction.md b/en/tracker/user/manage-autoaction.md index a11bf0a8e10..2524ed271be 100644 --- a/en/tracker/user/manage-autoaction.md +++ b/en/tracker/user/manage-autoaction.md @@ -2,7 +2,7 @@ 1. {% include [go to settings](../../_includes/tracker/transition-page.md) %} -1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. On the left-hand panel, select **Automation** → **Auto actions**. diff --git a/en/tracker/user/manage-trigger.md b/en/tracker/user/manage-trigger.md index fd21c07acaa..b341392bda2 100644 --- a/en/tracker/user/manage-trigger.md +++ b/en/tracker/user/manage-trigger.md @@ -13,7 +13,7 @@ Only [queue owners](../manager/queue-access.md) can create, edit, and delete tri 1. {% include [go to settings](../../_includes/tracker/transition-page.md) %} -1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. On the left-hand panel, select **Automation** → **Triggers**. diff --git a/en/tracker/user/move-ticket.md b/en/tracker/user/move-ticket.md index e36f756e73f..264a9fc78a2 100644 --- a/en/tracker/user/move-ticket.md +++ b/en/tracker/user/move-ticket.md @@ -17,7 +17,7 @@ To move a issue: 1. Open the issue that you want to move. -1. In the top-right corner, select **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.move-issue }}**. +1. In the top-right corner, select **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.move-issue }}**. 1. Specify the queue to which you want to move the issue, then click **Save**. diff --git a/en/tracker/user/my-tickets.md b/en/tracker/user/my-tickets.md index bc3720bd0be..a65cfa20d0a 100644 --- a/en/tracker/user/my-tickets.md +++ b/en/tracker/user/my-tickets.md @@ -30,11 +30,11 @@ Use filters to narrow down your issue list and display only those issues that ma * **Assigned to me**. * **Followed by me**. * **Waiting for response**. - * **{{ ui-key.startrek.ui_components_IssuesPresetSelect.preset-deadline }}**. + * **{{ ui-key.startrek.ui_Issues_smart-components_IssuesPresetSelect.preset-deadline }}**. * To filter issues by their [resolution](../manager/create-resolution.md), click **Resolution** and select relevant values from the list. -* To use [advanced search parameters](./default-filters.md#add-condition), click ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_components_filter-pane_FieldsSelectButton.add-filter-field-button-title }}** and select a field. +* To use [advanced search parameters](./default-filters.md#add-condition), click ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_Common_smart-components_filter-pane_FieldsSelectButton.add-filter-field-button-title }}** and select a field. ## Searching for issues by name {#search-name} @@ -42,7 +42,7 @@ If you want to find an issue using its name: 1. In the left-hand panel, open ![](../../_assets/tracker/svg/tasks.svg) **Issues** or follow the [link]({{ link-tracker }}issues/). -1. In the **{{ ui-key.startrek.ui_components_filter-pane.search-placeholder }}** field, enter the text to search for. +1. In the **{{ ui-key.startrek.ui_Common_smart-components_filter-pane.search-placeholder }}** field, enter the text to search for. The system will search for issues that match all the selected filters. diff --git a/en/tracker/user/notifications-projects-portfolios.md b/en/tracker/user/notifications-projects-portfolios.md index 9be67971c57..8e52d3c8119 100644 --- a/en/tracker/user/notifications-projects-portfolios.md +++ b/en/tracker/user/notifications-projects-portfolios.md @@ -39,7 +39,7 @@ If you are the customer for a project, you will receive notifications about the * You are assigned a customer. * Description changed. -* The following fields updated: **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--startDate }}**, **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--endDate }}**, **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--lead }}**, and **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--teamUsers }}**. +* The following fields updated: **Start date**, **Deadline**, **Responsible**, and **Participants**. * Changing the start and end dates changed the quarters that the project was scheduled for. * Comment added. * Reaction to a comment added. @@ -51,7 +51,7 @@ If you are the customer for a project, you will receive notifications about the If you are the customer for a portfolio, you will receive notifications about the following changes to it: * You are assigned a customer. -* The following fields updated: **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--startDate }}**, **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--endDate }}**, **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--status }}**, **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--lead }}**, and **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--teamUsers }}**. +* The following fields updated: **Start date**, **Deadline**, **Status**, **Responsible**, and **Participants**. * Changing the start and end dates changed the quarters that the portfolio was scheduled for. * Comment added. * Reaction to a comment added. @@ -62,9 +62,9 @@ If you are the customer for a portfolio, you will receive notifications about th If you are a participant of a portfolio or a project, you will receive notifications about the following changes to them: * You are assigned a participant. -* The following fields updated: **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--startDate }}**, **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--endDate }}**, **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--lead }}**, and **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--teamUsers }}**. +* The following fields updated: **Start date**, **Deadline**, **Responsible**, and **Participants**. * Changing the start and end dates changed the quarters that the project or portfolio was scheduled for. * Description changed. * Comment added. * Reaction to a comment added. -* For portfolios: **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--status }}** field updated. \ No newline at end of file +* For portfolios: **Status** field updated. \ No newline at end of file diff --git a/en/tracker/user/personal.md b/en/tracker/user/personal.md index 4c3dbf96b15..96e9774e27d 100644 --- a/en/tracker/user/personal.md +++ b/en/tracker/user/personal.md @@ -6,7 +6,7 @@ You can manage your issues more easily by customizing the {{ tracker-name }} int You can set up your [start page](startpage.md) in the old interface to show one of the selected options: -* [**{{ ui-key.startrek.ui_components_page-my_PageMy.page-title }}**](startpage.md#my-page) +* [**{{ ui-key.startrek.ui_Common_pages_page-my_PageMy.page-title }}**](startpage.md#my-page) * [Filter](create-filter.md) * [Dashboard](dashboard.md) * [Issue board](../manager/create-agile-board.md) diff --git a/en/tracker/user/query-filter.md b/en/tracker/user/query-filter.md index 031cd598013..c5c1ea991ab 100644 --- a/en/tracker/user/query-filter.md +++ b/en/tracker/user/query-filter.md @@ -25,7 +25,7 @@ To set up a filter using a query language: 1. Open the [**Issues** page]({{ link-tracker }}issues). -1. Click ![](../../_assets/tracker/svg/query-language.svg) **{{ ui-key.startrek.ui_components_dashboard_FilterEditor.editor-source-radio-query }}** in the top-right corner of the page. +1. Click ![](../../_assets/tracker/svg/query-language.svg) **Query language** in the top-right corner of the page. 1. Enter a query and click **Apply**. diff --git a/en/tracker/user/queue.md b/en/tracker/user/queue.md index 94ac36bcc18..e7ebe63744e 100644 --- a/en/tracker/user/queue.md +++ b/en/tracker/user/queue.md @@ -4,7 +4,7 @@ Each issue in {{ tracker-name }} belongs to a [queue](../queue-intro.md). Queues To view all issues in the queue, open its page: -1. In the left-hand panel, select ![](../../_assets/tracker/svg/queues.svg) **{{ ui-key.startrek.ui_components_TrackerSearch.queues }}**. +1. In the left-hand panel, select ![](../../_assets/tracker/svg/queues.svg) **{{ ui-key.startrek.ui_Common_smart-components_TrackerSearch.queues }}**. 1. Select a filter to show the list of queues: * **My queues** @@ -20,7 +20,7 @@ To view all issues in the queue, open its page: 1. Click the name of the relevant queue. -By default, the queue page only displays active issues (**{{ ui-key.startrek.ui_components_projects_utils.field-name-resolution }}: {{ ui-key.startrek.ui_components_projects_utils.filter-macro-empty_ }}** option). You can customize which issues to display by using the [filter by parameters](../manager/quick-filters.md) buttons above the issue list. +By default, the queue page only displays active issues (**{{ ui-key.startrek.ui_Portfolios_smart-components_project-list_utils.field-name-resolution }}: {{ ui-key.startrek.ui_Portfolios_smart-components_project-list_utils.filter-macro-empty_ }}** option). You can customize which issues to display by using the [filter by parameters](../manager/quick-filters.md) buttons above the issue list. ## Adding a queue to Favorites {#queue-fav} @@ -28,11 +28,11 @@ If you need quick access to a particular queue, add it to your Favorites: 1. Open the queue page. -1. At the top of the page, under the queue name, click ![](../../_assets/tracker/svg/favourites.svg) **{{ ui-key.startrek.ui_components_entity-page_macros_FavoriteButton.button-tooltip-add }}**. +1. At the top of the page, under the queue name, click ![](../../_assets/tracker/svg/favourites.svg) **{{ ui-key.startrek.ui_Common_smart-components_entity-page_macros_FavoriteButton.button-tooltip-add }}**. To open the list of your favorite queues: -1. In the left-hand panel, select ![](../../_assets/tracker/svg/queues.svg) **{{ ui-key.startrek.ui_components_TrackerSearch.queues }}**. +1. In the left-hand panel, select ![](../../_assets/tracker/svg/queues.svg) **{{ ui-key.startrek.ui_Common_smart-components_TrackerSearch.queues }}**. 1. In the list on the right, select the **Favorites** filter. @@ -49,7 +49,7 @@ The issue list is saved with all the filters and field settings applied. To save your issue list to a file: -1. In the top-right corner of the page, click ![](../../_assets/horizontal-ellipsis.svg) → ![](../../_assets/tracker/svg/export.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.export }}**. +1. In the top-right corner of the page, click ![](../../_assets/horizontal-ellipsis.svg) → ![](../../_assets/tracker/svg/export.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.export }}**. 1. Select the format for saving the list. diff --git a/en/tracker/user/reminder.md b/en/tracker/user/reminder.md index be9f817a705..10ca1534065 100644 --- a/en/tracker/user/reminder.md +++ b/en/tracker/user/reminder.md @@ -14,7 +14,7 @@ To set up reminder: {% endnote %} -1. In the top-right corner, select **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.add-notification }}**. +1. In the top-right corner, select **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.add-notification }}**. 1. Specify the date and time of the reminder. @@ -46,6 +46,6 @@ To add an entry about working on the issue or arrange a meeting with issue par 1. Open the issue page. -1. In the top-right corner, select **{{ ui-key.startrek.ui_components_actions-panel_ActionsPanel.action-menu-title }}** → **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.create-calendar-event }}** → **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.calendar-event-me }}**. +1. In the top-right corner, select **{{ ui-key.startrek.ui_Common_smart-components_actions-panel_ActionsPanel.action-menu-title }}** → **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.create-calendar-event }}** → **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.calendar-event-me }}**. 1. Enter information about the calendar event. If needed, add the meeting participants, then click **Create**. diff --git a/en/tracker/user/share-template.md b/en/tracker/user/share-template.md index ea25ec7da23..d0bc5678617 100644 --- a/en/tracker/user/share-template.md +++ b/en/tracker/user/share-template.md @@ -40,7 +40,7 @@ To share a template with a colleague, send them a link to the template: 1. {% include [go to settings](../../_includes/tracker/transition-page.md) %} -1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. In the {{ tracker-name }} top panel, click ![](../../_assets/tracker/tracker-settings.png) → **Manage templates**. @@ -66,7 +66,7 @@ If you have [read access](#section_nmn_prs_zz) to the desired template, you can 1. {% include [go to settings](../../_includes/tracker/transition-page.md) %} -1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. In the {{ tracker-name }} top panel, click ![](../../_assets/tracker/tracker-settings.png) → **Manage templates**. diff --git a/en/tracker/user/startpage-dashboard.md b/en/tracker/user/startpage-dashboard.md index 0a3d873e688..21419919ead 100644 --- a/en/tracker/user/startpage-dashboard.md +++ b/en/tracker/user/startpage-dashboard.md @@ -1,3 +1,3 @@ # Making a dashboard your start page -You can set any dashboard you have access to as your [start page](startpage.md). To do this, click ![](../../_assets/tracker/svg/actions.svg) → **{{ ui-key.startrek.ui_components_dashboard_DashboardActionsMenu.set-start-page-action }}** in the top-right corner of the dashboard page. +You can set any dashboard you have access to as your [start page](startpage.md). To do this, click ![](../../_assets/tracker/svg/actions.svg) → **Set as start page** in the top-right corner of the dashboard page. diff --git a/en/tracker/user/startpage.md b/en/tracker/user/startpage.md index 216ee863174..64a94c7b8cc 100644 --- a/en/tracker/user/startpage.md +++ b/en/tracker/user/startpage.md @@ -6,7 +6,7 @@ description: Learn how to customize the {{ tracker-name }} homepage for your nee # Start page -The home page opens on clicking the {{ tracker-name }} logo. You can [select](#change-start-page) which page to use as a homepage. By default, [**{{ ui-key.startrek.ui_components_page-my_PageMy.page-title }}**](https://tracker.yandex.ru/pages/my) is selected as the homepage: this is the user's personal page that includes the following widgets: +The home page opens on clicking the {{ tracker-name }} logo. You can [select](#change-start-page) which page to use as a homepage. By default, [**{{ ui-key.startrek.ui_Common_pages_page-my_PageMy.page-title }}**](https://tracker.yandex.ru/pages/my) is selected as the homepage: this is the user's personal page that includes the following widgets: * [Information for employees](#staff-widget): This widget is set up by the administrator for every employee in the organization. * [Useful information about {{ tracker-name }}](#tracker-info). @@ -31,8 +31,8 @@ The widget is positioned in the upper part of the page and the shown similarly f The widget with information for employees is published by the organization administrator, and only the administrator can edit or delete it. To publish a widget: -1. On the **{{ ui-key.startrek.ui_components_page-my_PageMy.page-title }}** page, click **{{ ui-key.startrek.ui_components_dashboard_DashboardHeader.dashboard-header-settings-button }}** → **{{ ui-key.startrek.ui_components_dashboard_DashboardHeader.dashboard-header-add-button }}** → **{{ ui-key.startrek.ui_components_dashboard_DashboardHeader.dashboard-header-add-orgAdmin }}**. -1. Enable **{{ ui-key.startrek.ui_components_dashboard_OrgAdminEditor.editor-published-field-label }}**. +1. On the **{{ ui-key.startrek.ui_Common_pages_page-my_PageMy.page-title }}** page, click **{{ ui-key.startrek.ui_Dashboards_smart-components_DashboardHeader.dashboard-header-settings-button }}** → **{{ ui-key.startrek.ui_Dashboards_smart-components_DashboardHeader.dashboard-header-add-button }}** → **{{ ui-key.startrek.ui_Dashboards_smart-components_DashboardHeader.dashboard-header-add-orgAdmin }}**. +1. Enable **{{ ui-key.startrek.ui_Dashboards_smart-components_OrgAdminEditor.editor-published-field-label }}**. {% note tip %} @@ -41,7 +41,7 @@ To publish a widget: {% endnote %} 1. Fill out the contents of the widget. -1. Click **{{ ui-key.startrek.ui_components_dashboard_OrgAdminEditor.editor-save-button }}**. +1. Click **{{ ui-key.startrek.ui_Dashboards_smart-components_OrgAdminEditor.editor-save-button }}**. ### Widgets with useful information about {{ tracker-name }} {#tracker-info} @@ -76,7 +76,7 @@ By editing or adding a new widget with issues, you can set up: -As a home page, you can use any [filter](create-filter.md), [dashboard](dashboard.md), or [issue board](../manager/create-agile-board.md).If you do so, you can still access **{{ ui-key.startrek.ui_components_page-my_PageMy.page-title }}** at the direct link: [https://tracker.yandex.ru/pages/my](https://tracker.yandex.ru/pages/my) or by clicking the home icon in the {{ tracker-name }} header. +As a home page, you can use any [filter](create-filter.md), [dashboard](dashboard.md), or [issue board](../manager/create-agile-board.md).If you do so, you can still access **{{ ui-key.startrek.ui_Common_pages_page-my_PageMy.page-title }}** at the direct link: [https://tracker.yandex.ru/pages/my](https://tracker.yandex.ru/pages/my) or by clicking the home icon in the {{ tracker-name }} header. For now, you can only change the home page in the old interface: 1. {% include [open-personal-settings](../../_includes/tracker/open-personal-settings.md) %} diff --git a/en/tracker/user/subscribe.md b/en/tracker/user/subscribe.md index 09f09166e37..1d07d44f333 100644 --- a/en/tracker/user/subscribe.md +++ b/en/tracker/user/subscribe.md @@ -18,7 +18,7 @@ If you want to get notified about changes in a specific issue, subscribe to it. 1. Open the issue page. -1. In the **{{ ui-key.startrek-backend.fields.issue.followers }}** field on the right-hand panel, click **Add me**. If you do not see the **{{ ui-key.startrek-backend.fields.issue.followers }}** field, add it by clicking ![](../../_assets/tracker/svg/add-task.svg) **{{ ui-key.startrek.ui_components_entity-page_sidebar_SidebarFieldsSelect.add-sidebar-field }}**. +1. In the **{{ ui-key.startrek-backend.fields.issue.followers }}** field on the right-hand panel, click **Add me**. If you do not see the **{{ ui-key.startrek-backend.fields.issue.followers }}** field, add it by clicking ![](../../_assets/tracker/svg/add-task.svg) **{{ ui-key.startrek.ui_Common_smart-components_entity-page_sidebar_SidebarFieldsSelect.add-sidebar-field }}**. If you followed the steps correctly, your name will be added to the Followers field. Now you will get emails with notifications about any changes in this issue. @@ -35,9 +35,9 @@ Subscribe to changes in the queue to track changes to all its issues. 1. Open the [queue page](queue.md). -1. In the upper-right corner, click ![](../../_assets/tracker/svg/actions.svg). Then click ![](../../_assets/tracker/svg/subscribe.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.subscribe }}** and select a value: - - Select **{{ ui-key.startrek.ui_components_PageQueue_header.subscribe-new-tickets }}** to get notifications on new issues created in the queue. You will also subscribe to notifications on all events specified in the [notification settings](user-notifications.md#sec_add_role) for the **{{ ui-key.startrek-backend.roles.role.name.queue-follower-key-value }}** role. - - Select **{{ ui-key.startrek.ui_components_PageQueue_header.subscribe-all }}** to get notifications on all changes to issues in the queue. +1. In the upper-right corner, click ![](../../_assets/tracker/svg/actions.svg). Then click ![](../../_assets/tracker/svg/subscribe.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.subscribe }}** and select a value: + - Select **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.subscribe-new-tickets }}** to get notifications on new issues created in the queue. You will also subscribe to notifications on all events specified in the [notification settings](user-notifications.md#sec_add_role) for the **{{ ui-key.startrek-backend.roles.role.name.queue-follower-key-value }}** role. + - Select **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.subscribe-all }}** to get notifications on all changes to issues in the queue. You can also [select events](user-subscriptions.md) you want to get notified about. diff --git a/en/tracker/user/summary-table-with-totals.md b/en/tracker/user/summary-table-with-totals.md index f6772c9be77..8a32313423b 100644 --- a/en/tracker/user/summary-table-with-totals.md +++ b/en/tracker/user/summary-table-with-totals.md @@ -16,7 +16,7 @@ To configure a widget, set the following: - **Cells**: Parameter whose totals are displayed at intersections. -- **Number of rows on page**: Maximum number of table rows to display in the widget. If there are more rows than the maximum, you can see them by clicking **{{ ui-key.startrek.ui_components_dashboard_TableWidget.show-all }}** at the bottom of the widget. +- **Number of rows on page**: Maximum number of table rows to display in the widget. If there are more rows than the maximum, you can see them by clicking **Show All** at the bottom of the widget. - **Sort rows**: Sorting order for table rows. diff --git a/en/tracker/user/summary-table.md b/en/tracker/user/summary-table.md index c1c5e442409..3ab015865bd 100644 --- a/en/tracker/user/summary-table.md +++ b/en/tracker/user/summary-table.md @@ -14,7 +14,7 @@ To configure a widget, set the following: - **Rows**: Parameter to use for table rows. -- **Number of rows on page**: Maximum number of table rows to display in the widget. If there are more rows than the maximum, you can see them by clicking **{{ ui-key.startrek.ui_components_dashboard_TableWidget.show-all }}** at the bottom of the widget. +- **Number of rows on page**: Maximum number of table rows to display in the widget. If there are more rows than the maximum, you can see them by clicking **Show All** at the bottom of the widget. - **Sort by**: Sorting order for table rows. diff --git a/en/tracker/user/ticket-links.md b/en/tracker/user/ticket-links.md index c134f92ca67..051a7753ba5 100644 --- a/en/tracker/user/ticket-links.md +++ b/en/tracker/user/ticket-links.md @@ -34,11 +34,11 @@ To create a sub-issue: 1. Open the issue page to create a sub-issue for. -1. In the top-right corner, select **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.create-subissue }}**. +1. In the top-right corner, select **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.create-subissue }}**. 1. Fill in the fields the same way as when [creating a new issue](./create-ticket.md). -1. Click **{{ ui-key.startrek.ui_components_CreateIssueForm.create-issue }}**. You will see a link to the parent issue at the top of the page above the sub-issue name. +1. Click **Create issue**. You will see a link to the parent issue at the top of the page above the sub-issue name. ## Changing the link type {#change-link-type} @@ -64,7 +64,7 @@ To remove an issue's link: You can make your issue a part of a larger (parent) issue: -1. In the top-right corner, select **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.to-subissue }}**. +1. In the top-right corner, select **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.to-subissue }}**. 1. Specify the key or name of the parent issue, then select it from the list. You can find the key on the issue page, under the title (for example, `TEST-1234`). @@ -74,7 +74,7 @@ You can make your issue a part of a larger (parent) issue: 1. Open the sub-issue page. -1. In the top-right corner, select **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.to-subissue }}**. +1. In the top-right corner, select **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.to-subissue }}**. 1. Specify the key or name of the new parent issue, then select it from the list. You can find the key on the issue page, under the title (for example, `TEST-1234`). diff --git a/en/tracker/user/ticket-schedule.md b/en/tracker/user/ticket-schedule.md index 0e36963dbbc..cf0c80ed18b 100644 --- a/en/tracker/user/ticket-schedule.md +++ b/en/tracker/user/ticket-schedule.md @@ -14,7 +14,7 @@ To schedule creation of issues: 1. {% include [go to settings](../../_includes/tracker/transition-page.md) %} -1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. In the left-hand panel, select **Auto actions**. @@ -46,7 +46,7 @@ To schedule creation of issues: 1. Under **Action**, click **Create issue**. -1. Fill in the fields of the automatic issue creation template in the **Create issue** window and click **{{ ui-key.startrek.ui_components_FieldEdit.form-submit }}**. +1. Fill in the fields of the automatic issue creation template in the **Create issue** window and click **Save**. 1. If you want to include multiple issues in one auto action, click **Create issue** again and fill in the fields for the new issue. diff --git a/en/tracker/user/time-spent.md b/en/tracker/user/time-spent.md index d9f6d659fd0..b58f989fafb 100644 --- a/en/tracker/user/time-spent.md +++ b/en/tracker/user/time-spent.md @@ -9,7 +9,7 @@ The time spent is counted in work weeks (five work days), work days (eight hours There are two ways to manage time tracking: * [Basic method](#limited-spent-time): Use the **Add time spent** action in the list of actions. -* [Advanced method](#extended-spent-time): Use the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** section in the right-hand panel. +* [Advanced method](#extended-spent-time): Use the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** section in the right-hand panel. We recommend using the advanced method for tracking time, as it has more flexible configuration options and is easy to use. @@ -36,15 +36,15 @@ To log spent time: 1. Open the issue page. -1. In the top-right corner, select **{{ ui-key.startrek.ui_components_actions-panel_ActionsPanel.action-menu-title }}** → **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.add-worklog }}**. +1. In the top-right corner, select **{{ ui-key.startrek.ui_Common_smart-components_actions-panel_ActionsPanel.action-menu-title }}** → **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.add-worklog }}**. -1. Fill in the **{{ ui-key.startrek.ui_components_issue-actions_worklog_AddWorklogDialog.duration-label }}** field. +1. Fill in the **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_worklog_AddWorklogDialog.duration-label }}** field. Here is an example: * 1 week and 3 days: `1w 3d`. * 3 hours, 20 minutes, and 30 seconds: `3h 20m 30s`. -1. Fill in the **{{ ui-key.startrek.ui_components_issue-actions_worklog_AddWorklogDialog.date-label }}** field with the date and time in the current time zone. +1. Fill in the **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_worklog_AddWorklogDialog.date-label }}** field with the date and time in the current time zone. {% note info %} @@ -56,7 +56,7 @@ To log spent time: 1. Leave a comment, if needed. The comment will not be visible in the issue but will be saved in the [Time spent report](../manager/statistics.md#section_uxt_3ft_xz) and the [History of issue changes](#records-history). -1. Click **{{ ui-key.startrek.ui_components_issue-actions_worklog_AddWorklogDialog.apply-button }}**. +1. Click **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_worklog_AddWorklogDialog.apply-button }}**. {% note info %} @@ -74,7 +74,7 @@ You can view the time spent on an issue under **Time tracking** in the right-han If the issue does not show the **Time tracking** section, add it: -1. Click ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_components_entity-page_sidebar_SidebarFieldsSelect.add-sidebar-field }}** in the right-hand panel. +1. Click ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_Common_smart-components_entity-page_sidebar_SidebarFieldsSelect.add-sidebar-field }}** in the right-hand panel. 1. In the **{{ ui-key.startrek-backend.fields.issue.fields.timetracking }}** group, enable **{{ ui-key.startrek-backend.fields.issue.spent-key-value }}** and **{{ ui-key.startrek-backend.fields.issue.estimation-key-value }}**. @@ -92,24 +92,24 @@ With advanced time tracking, you can: To enable advanced time tracking for queue issues: 1. Open the [queue page](queue.md). -1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. -1. Go to the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** tab. -1. Enable **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-track-time-in-issues }}**. -1. In **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-working-calendar }}**, choose one of the options. -1. Click **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.save }}**. +1. In the top-right corner, click ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. +1. Go to the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** tab. +1. Enable **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-track-time-in-issues }}**. +1. In **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-working-calendar }}**, choose one of the options. +1. Click **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.save }}**. -As a result, a new section called **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** will appear in the queue issues. All data of the **Time tracking** issue fields will be transferred to this section. +As a result, a new section called **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** will appear in the queue issues. All data of the **Time tracking** issue fields will be transferred to this section. -To switch back to basic time tracking, disable **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-track-time-in-issues }}** in the queue settings. Data from the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** section will be transferred to the fields of the **Time tracking** category. +To switch back to basic time tracking, disable **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-track-time-in-issues }}** in the queue settings. Data from the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** section will be transferred to the fields of the **Time tracking** category. ### Logging spent time {#add-extended-time-spent} To log spent time: -1. Make sure the **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-track-time-in-issues }}** option is enabled in the queue settings. +1. Make sure the **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-track-time-in-issues }}** option is enabled in the queue settings. 1. Open the issue page. -1. In the right-hand panel, click **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}**. -1. Fill in the **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.save }}** field. +1. In the right-hand panel, click **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}**. +1. Fill in the **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.save }}** field. Here is an example: @@ -117,24 +117,24 @@ To log spent time: * 3 hours, 20 minutes, and 30 seconds: `3h 20m 30s`. * Four [preferred time units](../manager/queue-spent-time.md#displayed-time): `4`. -1. In the **{{ ui-key.startrek.ui_components_FormField_TimeTrackingBlock.field-datetime-title }}** field, enter the date and time to display in the logged time record. -1. You can optionally add a comment on the record in the **{{ ui-key.startrek.ui_components_FormField_TimeTrackingBlock.field-comment-title }}** field. -1. Click **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.save }}**. +1. In the **{{ ui-key.startrek.ui_Common_smart-components_FormField_TimeTrackingBlock.field-datetime-title }}** field, enter the date and time to display in the logged time record. +1. You can optionally add a comment on the record in the **{{ ui-key.startrek.ui_Common_smart-components_FormField_TimeTrackingBlock.field-comment-title }}** field. +1. Click **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.save }}**. You can also log the time you spent using the [basic time tracking method](#add-limited-time-spent). ### Viewing and editing the record history {#records-history} -To open the logged time history for an issue, click ![](../../_assets/tracker/svg/history.svg) in the right-hand panel on the right side of the **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** field. This will open the **{{ ui-key.startrek.ui_components_FormField_TimeTrackingBlock.field-comment-title }}** window. +To open the logged time history for an issue, click ![](../../_assets/tracker/svg/history.svg) in the right-hand panel on the right side of the **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** field. This will open the **{{ ui-key.startrek.ui_Common_smart-components_FormField_TimeTrackingBlock.field-comment-title }}** window. {% note alert %} -You can edit the record history only if the [time tracking settings](../manager/queue-spent-time.md) have the **{{ ui-key.startrek.ui_components_timetracking-history-dialog_TimeTrackingHistoryDialog.title }}** option enabled. +You can edit the record history only if the [time tracking settings](../manager/queue-spent-time.md) have the **{{ ui-key.startrek.ui_Common_smart-components_timetracking-history-dialog_TimeTrackingHistoryDialog.title }}** option enabled. {% endnote %} -The author of a record can update the record **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-can-assignee-update-time }}** and **{{ ui-key.startrek.ui_components_timetracking-history-dialog_TimeTrackingDialogBody.column-date }}** fields. To do this, click ![](../../_assets/tracker/svg/icon-edit2.svg) to the right of the appropriate field value and enter a new one. You cannot edit the **{{ ui-key.startrek.ui_components_timetracking-history-dialog_TimeTrackingDialogBody.column-spent }}** field. +The author of a record can update the record **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-can-assignee-update-time }}** and **{{ ui-key.startrek.ui_Common_smart-components_timetracking-history-dialog_TimeTrackingDialogBody.column-date }}** fields. To do this, click ![](../../_assets/tracker/svg/icon-edit2.svg) to the right of the appropriate field value and enter a new one. You cannot edit the **{{ ui-key.startrek.ui_Common_smart-components_timetracking-history-dialog_TimeTrackingDialogBody.column-spent }}** field. -If a record was edited, you will see the ![](../../_assets/tracker/svg/history.svg) icon to the right of the **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-can-assignee-update-time }}** field value. If you hover over it, a pop-up window with the record change history will appear. +If a record was edited, you will see the ![](../../_assets/tracker/svg/history.svg) icon to the right of the **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-can-assignee-update-time }}** field value. If you hover over it, a pop-up window with the record change history will appear. -The author of a record can also delete it. To do that, click ![](../../_assets/tracker/svg/actions.svg) → **{{ ui-key.startrek.ui_components_timetracking-history-dialog_TimeTrackingDialogBody.column-comment }}** on the right side of the record. \ No newline at end of file +The author of a record can also delete it. To do that, click ![](../../_assets/tracker/svg/actions.svg) → **{{ ui-key.startrek.ui_Common_smart-components_timetracking-history-dialog_TimeTrackingDialogBody.column-comment }}** on the right side of the record. \ No newline at end of file diff --git a/en/tracker/user/votes.md b/en/tracker/user/votes.md index 3cead01a864..f22db96e52f 100644 --- a/en/tracker/user/votes.md +++ b/en/tracker/user/votes.md @@ -19,9 +19,9 @@ To vote for an issue, click ![](../../_assets/tracker/svg/vote.svg) in the top-r To find issues that you have voted for, use the [query language](query-filter.md): -1. On the left panel, select ![](../../_assets/tracker/svg/tasks.svg) **Issues**, then at the bottom of the window, click **{{ ui-key.startrek.ui_components_page-issues_touch.all-issues-filter-title }}**. +1. On the left panel, select ![](../../_assets/tracker/svg/tasks.svg) **Issues**, then at the bottom of the window, click **{{ ui-key.startrek.ui_Issues_pages_page-issues_touch.all-issues-filter-title }}**. -1. Click **{{ ui-key.startrek.ui_components_page-issues_touch.query-language }}** in the top-right corner of the page. +1. Click **{{ ui-key.startrek.ui_Issues_pages_page-issues_touch.query-language }}** in the top-right corner of the page. 1. Enter your query in the bar: diff --git a/en/troubleshooting/billing/how-to/analyzing-charges-chart.md b/en/troubleshooting/billing/how-to/analyzing-charges-chart.md index b1c8a5e729f..f6099c61b38 100644 --- a/en/troubleshooting/billing/how-to/analyzing-charges-chart.md +++ b/en/troubleshooting/billing/how-to/analyzing-charges-chart.md @@ -7,7 +7,7 @@ You need to avoid debiting your billing account for unused resources. ## Solution {#case-resolution} -To understand which cloud products continue to consume your resources and balance, review the usage details in the **{{ ui-key.yacloud.billing.account.detail.tab_product }}** tab on your account page. +To understand which cloud products continue to consume your resources and balance, review the usage details in the **{{ ui-key.yacloud_billing.billing.account.detail.tab_product }}** tab on your account page. If you stop your VM, you are no longer charged only for its computing resources: vCPU and RAM. However, you will continue paying for VM-attached disks, generated snapshots and images. diff --git a/en/troubleshooting/billing/how-to/getting-invoices-when-paying-by-card.md b/en/troubleshooting/billing/how-to/getting-invoices-when-paying-by-card.md index 68d61f7a6a8..a77451f0557 100644 --- a/en/troubleshooting/billing/how-to/getting-invoices-when-paying-by-card.md +++ b/en/troubleshooting/billing/how-to/getting-invoices-when-paying-by-card.md @@ -20,7 +20,6 @@ The option to get a receipt depends on the country of residence of your billing We recommend that you keep all your payment receipts, as this will help you if any problems with payments occur. The payment receipt amount is equal to the amount debited from the bank card linked to your account. - More details [here](../../../billing/concepts/individual-bill). - Non-residents of Russia and Kazakhstan diff --git a/en/troubleshooting/billing/how-to/getting-reconcillation-report.md b/en/troubleshooting/billing/how-to/getting-reconcillation-report.md index 881a95da34b..142f5f71500 100644 --- a/en/troubleshooting/billing/how-to/getting-reconcillation-report.md +++ b/en/troubleshooting/billing/how-to/getting-reconcillation-report.md @@ -19,7 +19,7 @@ Select your billing account type on the tab below: To request a reconciliation report: 1. In the top-left corner of the management console, click ![image](../../../_assets/main-menu.svg) **{{ ui-key.yacloud.iam.folder.dashboard.label_products }}** and select [**{{ billing-name }}**]({{ link-console-billing }}). - 2. On the **{{ ui-key.yacloud.billing.label_accounts }}** page, select a billing account. + 2. On the **{{ ui-key.yacloud_billing.billing.title_accounts }}** page, select a billing account. 3. Go to **{{ ui-key.yacloud_billing.billing.account.switch_acts }}**. 4. Open the **{{ ui-key.yacloud_billing.billing.account.tab_reconciliation-reports-title }}** tab: 5. Click **{{ ui-key.yacloud_billing.billing.account.reconciliation-reports.action_request-report }}**. In the window that opens, select the period to generate the reconciliation report for and click **{{ ui-key.yacloud_billing.billing.account.reconciliation-reports.action_request-report-short }}**. diff --git a/en/troubleshooting/datalens/how-to/marketplace-connector-support.md b/en/troubleshooting/datalens/how-to/marketplace-connector-support.md index 2c20bc10be8..96af7ec5172 100644 --- a/en/troubleshooting/datalens/how-to/marketplace-connector-support.md +++ b/en/troubleshooting/datalens/how-to/marketplace-connector-support.md @@ -11,5 +11,5 @@ Check that you have entered a valid token, then establish a connection following ## If nothing helped {#if-issue-still-persists} -If these actions did not help you solve the task, write an [email](datalens@htmls.ru)to the MyWarehouse connector technical support. +If these actions did not help you solve the task, write an [email](mailto:datalens@htmls.ru)to the MyWarehouse connector technical support. diff --git a/en/troubleshooting/storage/known-issues/error-429.md b/en/troubleshooting/storage/known-issues/error-429.md index a168ea05c18..99e03fd2aae 100644 --- a/en/troubleshooting/storage/known-issues/error-429.md +++ b/en/troubleshooting/storage/known-issues/error-429.md @@ -29,4 +29,4 @@ You can also recursively delete all files with an identical prefix. The followin aws s3 --endpoint-url=https://storage.yandexcloud.net rm s3://my-bucket/my-folder/ --recursive ``` -A guide for installing and configuring the AWS CLI is also available in our [documentation](../../../docs/storage/tools/aws-cli). +A guide for installing and configuring the AWS CLI is also available in our [documentation](../../../storage/tools/aws-cli.md). diff --git a/en/tutorials/archive/single-node-file-server/console.md b/en/tutorials/archive/single-node-file-server/console.md index e3e0b4bef6c..f692fdbb965 100644 --- a/en/tutorials/archive/single-node-file-server/console.md +++ b/en/tutorials/archive/single-node-file-server/console.md @@ -1,3 +1,8 @@ +--- +title: Creating a single-node file server using the management console +description: In this tutorial, you will create a single-node NFS file server using the Samba software suite and the {{ vpc-full-name }} network infrastructure. The server will be hosted on a VM running Ubuntu. You will be able to connect to the server from Linux, macOS, and Windows computers. +--- + # Creating a single-node file server using the management console To create an infrastructure for a [single-node file server](index.md) using the {{ yandex-cloud }} management console: diff --git a/en/tutorials/archive/single-node-file-server/index.md b/en/tutorials/archive/single-node-file-server/index.md index 6e368430c74..0d83783b5d4 100644 --- a/en/tutorials/archive/single-node-file-server/index.md +++ b/en/tutorials/archive/single-node-file-server/index.md @@ -1 +1,9 @@ +--- +title: Single-node file server Overview +description: In this tutorial, you will create a single-node NFS file server using the Samba software suite and the {{ vpc-full-name }} network infrastructure. The server will be hosted on a VM running Ubuntu. You will be able to connect to the server from Linux, macOS, and Windows computers. +--- + {% include [single-node-file-server](../../../_tutorials/archive/single-node-file-server.md) %} + +* [Management console](console.md): Create your infrastructure step by step from the {{ yandex-cloud }} management console. +* [{{ TF }}](terraform.md): Streamline creating and managing your resources using the _infrastructure as code_ (IaC) approach. Download a {{ TF }} configuration example and then deploy the infrastructure using the [{{ yandex-cloud }} {{ TF }} provider]({{ tf-docs-link }}). \ No newline at end of file diff --git a/en/tutorials/archive/single-node-file-server/terraform.md b/en/tutorials/archive/single-node-file-server/terraform.md index 0497c0e1a26..a05c53fbfff 100644 --- a/en/tutorials/archive/single-node-file-server/terraform.md +++ b/en/tutorials/archive/single-node-file-server/terraform.md @@ -1,3 +1,8 @@ +--- +title: Creating a single-node file server using {{ TF }} +description: In this tutorial, you will create a single-node NFS file server using the Samba software suite and the {{ vpc-full-name }} network infrastructure. The server will be hosted on a VM running Ubuntu. You will be able to connect to the server from Linux, macOS, and Windows computers. +--- + # Creating a single-node file server using {{ TF }} To create an infrastructure for a [single-node file server](index.md) using {{ TF }}: diff --git a/en/tutorials/dataplatform/index.md b/en/tutorials/dataplatform/index.md index 66304452c37..f9fc84fd4e7 100644 --- a/en/tutorials/dataplatform/index.md +++ b/en/tutorials/dataplatform/index.md @@ -106,13 +106,14 @@ description: This page provides a list of tutorials for building a data platform * [{#T}](opensearch-to-ydb.md) * [{#T}](opensearch-to-clickhouse.md) * [{#T}](postgresql-to-opensearch.md) +* [{#T}](opensearch-saml-keycloak.md) ## {{ PG }} {#postgresql} * [Creating a {{ PG }} cluster for 1C:Enterprise](1c-postgresql.md) -* [{{ mpg-name }} performance analysis and tuning](mpg-profiling.md) -* [Migrating databases from {{ mpg-name }}](outbound-replication.md) +* [{{ mpg-name }} performance analysis and tuning](mpg-profiling.md +* [Migrating a database from {{ mpg-name }}](outbound-replication.md) * [Migrating a database from a third-party {{ PG }} cluster to {{ mpg-name }}](postgresql-data-migration.md) * [{#T}](rdbms-to-clickhouse.md) * [{#T}](mkf-to-mpg.md) diff --git a/en/tutorials/dataplatform/opensearch-saml-keycloak.md b/en/tutorials/dataplatform/opensearch-saml-keycloak.md new file mode 100644 index 00000000000..0c7278b9c0d --- /dev/null +++ b/en/tutorials/dataplatform/opensearch-saml-keycloak.md @@ -0,0 +1,8 @@ +--- +title: Authenticating a {{ mos-full-name }} cluster in {{ OS }} Dashboards using {{ keycloak }} +description: How to configure SAML SSO in a {{ mos-full-name }} cluster for authentication in {{ OS }} Dashboards using {{ keycloak }}. +--- + +# Authenticating a {{ mos-full-name }} cluster in {{ OS }} Dashboards using {{ keycloak }} + +{% include [opensearch-saml-keycloak](../../_tutorials/dataplatform/opensearch-saml-keycloak.md) %} diff --git a/en/tutorials/infrastructure-management/vm-autoscale/index.md b/en/tutorials/infrastructure-management/vm-autoscale/index.md index eae3be3d14d..28db913aef6 100644 --- a/en/tutorials/infrastructure-management/vm-autoscale/index.md +++ b/en/tutorials/infrastructure-management/vm-autoscale/index.md @@ -1,5 +1,5 @@ --- -title: Running a VM group with autoscaling if the load limit is exceeded. +title: Running a VM group with autoscaling if the load limit is exceeded description: In this tutorial, you will deploy an instance group with an autoscaling policy to apply if the load limit is exceeded. The VM loading will be balanced using a network load balancer. --- diff --git a/en/tutorials/infrastructure-management/vm-autoscale/terraform.md b/en/tutorials/infrastructure-management/vm-autoscale/terraform.md index c519d02efb9..35a77a3a9f7 100644 --- a/en/tutorials/infrastructure-management/vm-autoscale/terraform.md +++ b/en/tutorials/infrastructure-management/vm-autoscale/terraform.md @@ -1,12 +1,12 @@ --- -title: Running a VM group with autoscaling if the load limit is exceeded via {{ TF }}. +title: Running a VM group with autoscaling if the load limit is exceeded via {{ TF }} description: In this tutorial, you will deploy an instance group with an autoscaling policy to apply if the load limit is exceeded. The VM loading will be balanced using a network load balancer. --- # Running a VM group with autoscaling using {{ TF }} -To create an infrastructure for a [VM group with an autoscaling policy](index.md) using {{ TF }}: +To create an infrastructure for an [instance group with an autoscaling policy](index.md) using {{ TF }}: {% include [vm-autoscale-terraform](../../../_tutorials/infrastructure/vm-autoscale-terraform.md) %} diff --git a/en/tutorials/routing/high-accessible-dmz.md b/en/tutorials/routing/high-accessible-dmz.md index 563290fecf2..59f09f7aef5 100644 --- a/en/tutorials/routing/high-accessible-dmz.md +++ b/en/tutorials/routing/high-accessible-dmz.md @@ -14,7 +14,7 @@ The solution has the following basic segments (folders): * The **dmz** folder enables you to publish applications with public access from the internet. * The **app** and **database** folders can be used to host the business logic of applications (in this tutorial, no VMs are placed there). -For more information, see the [project repository](https://github.com/yandex-cloud-examples/yc-dmz-with-high-available-ngfw/blob/main/README.md). +For more information, see the [project repository](https://github.com/yandex-cloud-examples/yc-dmz-with-high-available-ngfw/blob/main/README.md). To deploy a secure high-availability network infrastructure with a dedicated DMZ based on the Next-Generation Firewall: @@ -26,7 +26,7 @@ To deploy a secure high-availability network infrastructure with a dedicated DMZ 1. [Test the solution for performance and fault tolerance](#test-accessibility). If you no longer need the resources you created, [delete them](#clear-out). - + ## Prepare your cloud {#prepare-cloud} {% include [before-you-begin](../../_tutorials/_tutorials_includes/before-you-begin.md) %} @@ -60,7 +60,7 @@ Make sure your cloud has sufficient [quotas](../../overview/concepts/quotas-limi | ----------- | ----------- | | Folders | 7 | | Instance groups | 1 | - | VM instances | 6 | + | Virtual machines | 6 | | VM instance vCPUs | 18 | | VM instance RAM | 30 GB | | Disks | 6 | @@ -88,18 +88,18 @@ Make sure your cloud has sufficient [quotas](../../overview/concepts/quotas-limi ## Prepare the environment {#prepare-environment} The tutorial uses Windows software and the [Windows Subsystem for Linux](https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux) (WSL). -The infrastructure is deployed using [{{ TF }}](https://www.terraform.io/). +The infrastructure is deployed using [{{ TF }}](https://www.terraform.io/). ### Configure WSL {#setup-wsl} 1. Check if WSL is installed on your PC. To do this, run the following command in the CLI terminal: - + ```bash wsl -l ``` If WSL is installed, the terminal will display a list of available distributions, for example: - + ```bash Windows Subsystem for Linux Distributions: docker-desktop (Default) @@ -111,7 +111,7 @@ The infrastructure is deployed using [{{ TF }}](https://www.terraform.io/). 1. In addition, you can install on WSL a familiar Linux distribution, e.g., [Ubuntu](https://ubuntu.com/tutorials/install-ubuntu-on-wsl2-on-windows-11-with-gui-support#1-overview). 1. To make the installed distribution the default system, run: - + ```bash wsl --setdefault ubuntu ``` @@ -129,7 +129,7 @@ All the steps described below are completed in the Linux terminal. {% endnote %} ### Create a service account with the admin privileges for the cloud {#create-account} - + {% list tabs %} - Management console @@ -147,10 +147,10 @@ All the steps described below are completed in the Linux terminal. 1. Assign the account the admin [role](../../iam/concepts/access-control/roles.md): 1. On the management console [home page]({{ link-console-main }}), select the cloud. - 1. Click the **Access bindings** tab. + 1. Click the **Access permissions** tab. 1. Find the `sa-terraform` account in the list and click ![image](../../_assets/options.svg). 1. Click **Edit roles**. - 1. Click **Add role** in the dialog box that opens and select the `admin` role. + 1. Click **Add role** in the dialog box that opens and select the `admin` role. - CLI @@ -209,14 +209,14 @@ All the steps described below are completed in the Linux terminal. 1. Install {{ TF }}: - 1. Go to the root directory: + 1. Go to the root folder: ```bash cd ~ ``` 1. Create a folder named `terraform` and open it: - + ```bash mkdir terraform cd terraform @@ -229,20 +229,20 @@ All the steps described below are completed in the Linux terminal. ``` 1. Install the `zip` utility and unpack the ZIP archive: - + ```bash apt install zip unzip terraform_1.3.9_linux_amd64.zip ``` - 1. Add the path to the folder containing the executable file to the `PATH` variable: - + 1. Add the path to the folder with the executable file to the `PATH` variable: + ```bash export PATH=$PATH:~/terraform ``` 1. Make sure that {{ TF }} is installed by running this command: - + ```bash terraform -help ``` @@ -274,8 +274,8 @@ All the steps described below are completed in the Linux terminal. ## Deploy your resources {#create-resources} -1. Clone the GitHub `yandex-cloud-examples/yc-dmz-with-high-available-ngfw` repository and go to the `yc-dmz-with-high-available-ngfw` folder: - +1. Clone the `yandex-cloud-examples/yc-dmz-with-high-available-ngfw` GitHub repository and go to the `yc-dmz-with-high-available-ngfw` folder: + ```bash git clone https://github.com/yandex-cloud-examples/yc-dmz-with-high-available-ngfw.git cd yc-dmz-with-high-available-ngfw @@ -292,7 +292,7 @@ All the steps described below are completed in the Linux terminal. {% include [default-catalogue](../../_includes/default-catalogue.md) %} 1. Create an [authorized key](../../iam/concepts/authorization/key.md) for your service account and save the file: - + ```bash yc iam key create \ --service-account-id \ @@ -301,13 +301,13 @@ All the steps described below are completed in the Linux terminal. ``` Where: - + * `service-account-id`: Service account ID. * `folder-id`: ID of the folder in which the service account was created. * `output`: Name of the file with the authorized key. Result: - + ```text id: aje8nn871qo4a8bbopvb service_account_id: ajehr0to1g8bh0la8c8r @@ -316,23 +316,23 @@ All the steps described below are completed in the Linux terminal. ``` 1. Create a CLI profile to run operations on behalf of the service account: - + ```bash yc config profile create sa-terraform ``` Result: - + ```text Profile 'sa-terraform' created and activated ``` 1. Set the profile configuration: - + ```bash yc config set service-account-key key.json yc config set cloud-id - yc config set folder-id + yc config set folder-id ``` Where: @@ -342,7 +342,7 @@ All the steps described below are completed in the Linux terminal. * `folder-id`: [Folder ID](../../resource-manager/operations/folder/get-id.md). 1. Add the credentials to the environment variables: - + ```bash export YC_TOKEN=$(yc iam create-token) export YC_CLOUD_ID=$(yc config get cloud-id) @@ -352,13 +352,13 @@ All the steps described below are completed in the Linux terminal. {% endlist %} 1. Get your PC's IP address: - + ```bash curl 2ip.ru ``` Result: - + ```text 192.240.24.87 ``` @@ -366,13 +366,13 @@ All the steps described below are completed in the Linux terminal. 1. Open the `terraform.tfvars` file in the `nano` editor to edit as follows: 1. The line with the cloud ID: - + ```text cloud_id = "" ``` 1. The line with a list of allowed public IP addresses for `jump-vm` access: - + ```text trusted_ip_for_access_jump-vm = ["/32"] ``` @@ -380,25 +380,25 @@ All the steps described below are completed in the Linux terminal. 1. Deploy the resources in the cloud using {{ TF }}: 1. Initialize {{ TF }}: - + ```bash terraform init ``` 1. Check the {{ TF }} file configuration: - + ```bash terraform validate ``` 1. Check the list of cloud resources you are about to create: - + ```bash terraform plan ``` 1. Create resources: - + ```bash terraform apply ``` @@ -409,7 +409,7 @@ As an example, this tutorial describes steps for configuring firewalls named FW- ### Connect to the control segment via a VPN {#connect-via-vpn} -After deploying the infrastructure, the `mgmt` folder will contain a VM named `jump-vm` based on an Ubuntu image with the [WireGuard VPN](https://www.wireguard.com/) configured for a secure connection. Set up a VPN tunnel to `jump-vm` on your PC to access the `mgmt`, `dmz`, `app`, and `database` segment subnets. +After deploying the infrastructure, the `mgmt` folder will contain a VM named `jump-vm` based on an Ubuntu image with the [WireGuard VPN](https://www.wireguard.com/) configured for a secure connection. Set up a VPN tunnel to `jump-vm` on your PC to access the `mgmt`, `dmz`, `app`, and `database` segment subnets. To set up the VPN tunnel: @@ -432,7 +432,7 @@ To set up the VPN tunnel: 1. Click **Activate** to activate the tunnel. 1. Check network connectivity with the management server via the WireGuard VPN tunnel by running the following command in the terminal: - + ```bash ping 192.168.1.100 ``` @@ -448,12 +448,12 @@ To set up the VPN tunnel: To manage and set up the [Check Point](https://en.wikipedia.org/wiki/Check_Point) solution, install and run the SmartConsole GUI client: -1. Connect to the NGFW management server by opening `https://192.168.1.100` in your browser. -1. Sign in using the `admin` username and the `admin` password. +1. Connect to the NGFW management server by opening `https://192.168.1.100` in your browser. +1. Sign in using the `admin` username and the `admin` password. 1. In the Gaia Portal interface that opens, download the SmartConsole GUI client. To do this, click **Manage Software Blades using SmartConsole. Download Now!**. 1. Install SmartConsole on your PC. 1. Get the SmartConsole access password: - + ```bash terraform output fw_smartconsole_mgmt-server_password ``` @@ -467,12 +467,12 @@ Add the FW-A firewall gateway to the management server using the Wizard: 1. In the **Objects** drop-down list at the top left, select **More object types → Network Object → Gateways and Servers → New Gateway...**. 1. Click **Wizard Mode**. 1. In the dialog box that opens, enter the following: - * **Gateway name:** `FW-A` - * **Gateway platform:** `CloudGuard IaaS` - * **IPv4:** `192.168.1.10` + * **Gateway name**: `FW-A` + * **Gateway platform**: `CloudGuard IaaS` + * **IPv4**: `192.168.1.10` 1. Click **Next**. 1. Get the firewall access password: - + ```bash terraform output fw_sic-password ``` @@ -481,8 +481,8 @@ Add the FW-A firewall gateway to the management server using the Wizard: 1. Click **Next** and **Finish**. In the same way, add the FW-B firewall gateway to the management server using the following values: - * **Gateway name:** `FW-B` - * **IPv4:** `192.168.2.10` + * **Gateway name**: `FW-B` + * **IPv4**: `192.168.2.10` ### Configure the FW-A gateway network interfaces {#setup-gateways-fw-a} @@ -598,7 +598,7 @@ In the same way, set up the static NAT table for the FW-B gateway based on the t | 1 | public | FW-a-public-IP | TCP_8080 | FW-a-dmz-IP (Hide) | dmz-web-server | Original | FW-a | | 2 | public | FW-b-public-IP | TCP_8080 | FW-b-dmz-IP (Hide) | dmz-web-server | Original | FW-b | -### Apply the security policy rules {#apply-policies} +### Apply the security policy rules {#apply-policies} 1. Click **Install Policy** at the top left of the screen. 1. In the dialog box that opens, click **Push & Install**. @@ -628,21 +628,21 @@ Within 5 minutes, the route-switcher module starts providing fault tolerance of ``` 1. Make sure the network infrastructure can be accessed from the outside by opening the following address in the browser: - + ```bash - http:// + http:// ``` If the system is accessible from the outside, you will see the `Welcome to nginx!` page. 1. Make sure the firewall security policy rules that allow traffic are active. To do this, go to the `yc-dmz-with-high-available-ngfw` folder on your PC and connect to a VM in the DMZ segment over SSH: - + ```bash cd ~/yc-dmz-with-high-available-ngfw - ssh -i pt_key.pem admin@ + ssh -i pt_key.pem admin@ ``` -1. To check that there is access from the VM in the DMZ segment to a public resource on the internet, run this command: - +1. To check that there is access from the VM in the DMZ segment to a public resource on the internet, run this command: + ```bash ping ya.ru ``` @@ -650,7 +650,7 @@ Within 5 minutes, the route-switcher module starts providing fault tolerance of The command must run according to the `ping from dmz to internet` rule that allows traffic. 1. Make sure the security policy rules that prohibit traffic are applied. - To check that `Jump VM` in the `mgmt` segment cannot be accessed from the `dmz` segment, run this command: + To check that `Jump VM` in the `mgmt` segment cannot be accessed from the `dmz` segment, run this command: ```bash ping 192.168.1.101 @@ -674,13 +674,13 @@ Within 5 minutes, the route-switcher module starts providing fault tolerance of 1. Enable incoming traffic to the application published in the DMZ segment by making the following request to the ALB public IP: ```bash - httping http:// + httping http:// ``` 1. Open another terminal and connect to a VM in the DMZ segment over SSH: - + ```bash - ssh -i pt_key.pem admin@ + ssh -i pt_key.pem admin@ ``` 1. Set a password for the `admin` user: @@ -693,12 +693,12 @@ Within 5 minutes, the route-switcher module starts providing fault tolerance of 1. In the list of services, select **{{ compute-name }}**. 1. In the list of VMs, choose the one you need, click ![options](../../_assets/options.svg), and select **Edit**. - 1. In the **Additional** column, select **Grant access to serial console**. - + 1. In the **Additional** column, select **Grant access to serial console**. + 1. Connect to the VM serial console, enter the `admin` username and the password you set earlier. 1. Enable outgoing traffic from the VM in the DMZ segment to a resource on the internet using `ping`: - + ```bash ping ya.ru ``` @@ -707,7 +707,7 @@ Within 5 minutes, the route-switcher module starts providing fault tolerance of 1. Monitor the loss of packets sent by `httping` and `ping`. After FW-A fails, there may be a traffic loss for 1 minute on average with subsequent traffic recovery. 1. Check that the FW-B address is used in the `dmz-rt` route table, the `dmz` folder, for the next hop. -1. In the {{ yandex-cloud }} [management console]({{ link-console-main }}), [run](../../compute/operations/vm-control/vm-stop-and-start.md#start) the `fw-a` VM by emulating the recovery of the main firewall. +1. In the {{ yandex-cloud }} [management console]({{ link-console-main }}), [run](../../compute/operations/vm-control/vm-stop-and-start.md#start) the `fw-a` VM by emulating the recovery of the main firewall. 1. Monitor the loss of packets sent by `httping` and `ping`. After FW-A recovers, there may be a traffic loss for 1 minute on average with subsequent traffic recovery. 1. Check that the FW-A address is used in the `dmz-rt` route table, the `dmz` folder, for the next hop. diff --git a/en/tutorials/toc.yaml b/en/tutorials/toc.yaml index 3b5114ea50f..27ef123dc09 100644 --- a/en/tutorials/toc.yaml +++ b/en/tutorials/toc.yaml @@ -53,7 +53,7 @@ items: href: archive/single-node-file-server/terraform.md - name: Configuring an SFTP server based on CentOS 7 href: archive/backup-and-archive-to-sftp.md - - name: Creating a VM backup with Hystax Acura Backup + - name: Backing up a VM with Hystax Acura Backup href: infrastructure-management/hystax-backup.md - name: >- Backup to {{ objstorage-name }} using MSP360 Backup (CloudBerry @@ -325,8 +325,8 @@ items: - name: '{{ TF }}' href: internet-store/bitrix-shop/terraform.md - name: >- - Creating a cluster of 1C:Enterprise Linux servers with {{ mpg-name - }} + Creating a cluster of 1C:Enterprise Linux servers with a {{ + mpg-name }} cluster href: infrastructure-management/1c-postgresql-linux.md - name: Internet of Things (IoT) items: @@ -353,8 +353,8 @@ items: - name: Deploying the UI for {{ KF }} href: dataplatform/deploy-kafka-ui.md - name: >- - Migrating databases from a third-party {{ KF }} cluster to {{ mkf-name - }} + Migrating a database from a third-party {{ KF }} cluster to {{ + mkf-name }} href: dataplatform/kafka-connector.md - name: >- Moving data between {{ mkf-name }} clusters using {{ @@ -514,7 +514,7 @@ items: - name: '{{ MG }} performance analysis and tuning' href: dataplatform/mongodb-profiling.md - name: >- - Migrating databases from a third-party {{ MY }} cluster to a {{ + Migrating a database from a third-party {{ MY }} cluster to a {{ mmy-name }} cluster href: dataplatform/mysql-data-migration.md - name: '{{ mmy-name }} performance analysis and tuning' @@ -524,12 +524,12 @@ items: using {{ data-transfer-name }} href: dataplatform/sync-mysql.md - name: >- - Migrating databases from {{ mmy-name }} to a third-party {{ MY }} + Migrating a database from {{ mmy-name }} to a third-party {{ MY }} cluster href: dataplatform/mmy-to-mysql-migration.md - name: >- - Migrating databases from {{ mmy-name }} to {{ objstorage-name }} using - {{ data-transfer-name }} + Migrating a database from {{ mmy-name }} to {{ objstorage-name }} + using {{ data-transfer-name }} href: dataplatform/mmy-objs-migration.md - name: >- Migrating data from {{ objstorage-name }} to {{ mmy-name }} using {{ @@ -545,7 +545,7 @@ items: - name: Delivering data from {{ mmy-name }} to {{ mkf-name }} using Debezium href: dataplatform/./debezium-mmy.md - name: >- - Migrating databases from {{ mmy-name }} to {{ ydb-name }} using {{ + Migrating a database from {{ mmy-name }} to {{ ydb-name }} using {{ data-transfer-name }} href: dataplatform/mmy-ydb-migration.md - name: '{{ MY }} change data capture and delivery to {{ DS }}' @@ -582,15 +582,19 @@ items: Migrating data from {{ mpg-full-name }} to {{ mos-full-name }} using {{ data-transfer-full-name }} href: dataplatform/postgresql-to-opensearch.md + - name: >- + Authenticating a {{ mos-full-name }} cluster in {{ OS }} Dashboards + using {{ keycloak }} + href: dataplatform/opensearch-saml-keycloak.md - name: Creating a {{ PG }} cluster for 1C:Enterprise href: dataplatform/1c-postgresql.md - name: '{{ mpg-name }} performance analysis and tuning' href: dataplatform/mpg-profiling.md - - name: Migrating databases from {{ mpg-name }} + - name: Migrating a database from {{ mpg-name }} href: dataplatform/outbound-replication.md - name: >- - Migrating databases from a third-party {{ PG }} cluster to {{ mpg-name - }} + Migrating a database from a third-party {{ PG }} cluster to {{ + mpg-name }} href: dataplatform/postgresql-data-migration.md - name: Asynchronously replicating data from {{ PG }} to {{ CH }} href: dataplatform/rdbms-to-clickhouse.md @@ -608,7 +612,7 @@ items: Delivering data from {{ mpg-name }} to {{ ydb-name }} using {{ data-transfer-name }} href: dataplatform/mpg-ydb-replication.md - - name: Migrating databases from {{ mpg-name }} to {{ objstorage-name }} + - name: Migrating a database from {{ mpg-name }} to {{ objstorage-name }} href: dataplatform/mpg-to-objstorage.md - name: >- Migrating data from {{ objstorage-full-name }} to {{ mpg-full-name }} @@ -624,9 +628,9 @@ items: Migrating data from {{ mpg-full-name }} to {{ mos-full-name }} using {{ data-transfer-full-name }} href: dataplatform/postgresql-to-opensearch.md - - name: Migrating databases from {{ GP }} to {{ CH }} + - name: Migrating a database from {{ GP }} to {{ CH }} href: dataplatform/greenplum-to-clickhouse.md - - name: Migrating databases from {{ GP }} to {{ PG }} + - name: Migrating a database from {{ GP }} to {{ PG }} href: dataplatform/greenplum-to-postgresql.md - name: Exporting {{ GP }} data to a cold storage in {{ objstorage-name }} href: dataplatform/greenplum-yezzey.md @@ -635,8 +639,8 @@ items: using {{ data-transfer-full-name }} href: dataplatform/object-storage-to-greenplum.md - name: >- - Migrating databases from a third-party {{ RD }} cluster to {{ mrd-name - }} + Migrating a database from a third-party {{ RD }} cluster to {{ + mrd-name }} href: dataplatform/redis-data-migration.md - name: Using {{ mrd-name }} clusters as PHP session storage href: dataplatform/redis-as-php-sessions-storage.md @@ -651,7 +655,7 @@ items: href: dataplatform/mkf-ydb-stream.md hidden: true - name: >- - Migrating databases from {{ mmy-name }} to {{ ydb-name }} using {{ + Migrating a database from {{ mmy-name }} to {{ ydb-name }} using {{ data-transfer-name }} href: dataplatform/mmy-ydb-migration.md hidden: true @@ -710,7 +714,7 @@ items: href: routing/network-segmentation-checkpoint.md - name: Configuring a secure GRE tunnel over IPsec href: routing/gre-over-ipsec.md - - name: Configuring networks for {{ dataproc-name }} + - name: Configuring a network for {{ dataproc-name }} href: routing/dataproc-nat-instance.md - name: Connecting to {{ objstorage-name }} from {{ vpc-short-name }} href: routing/storage-vpc-access.md @@ -756,7 +760,7 @@ items: href: datalens/data-from-tracker.md - name: Analyzing {{ objstorage-name }} logs in {{ datalens-name }} href: datalens/storage-logs-analysis.md - - name: 'Yandex Music podcasts: statistics' + - name: 'Yandex Music podcasts: Statistics' href: datalens/data-from-podcasts.md - name: Visualizing {{ yq-full-name }} data href: datalens/data-from-yandex-query-visualization.md @@ -810,13 +814,13 @@ items: href: serverless/serverless-live-debug.md - name: Running a containerized app in {{ serverless-containers-full-name }} href: serverless/deploy-app-container.md + - name: >- + Streaming {{ postbox-full-name }} events to {{ yds-full-name }} and + analyzing them using {{ datalens-full-name }} + href: serverless/events-from-postbox-to-yds.md - name: >- Using {{ api-gw-full-name }} to set up speech synthesis in {{ speechkit-full-name }} href: serverless/speechkit-integrarion-via-agi-gw.md - - name: >- - Streaming {{ postbox-full-name }} events to {{ yds-full-name }} and - analyzing them with {{ datalens-full-name }} - href: serverless/events-from-postbox-to-yds.md base: en/tutorials deepBase: 2 diff --git a/en/video/concepts/videos.md b/en/video/concepts/videos.md index 8ee04a49f8c..814fb38d862 100644 --- a/en/video/concepts/videos.md +++ b/en/video/concepts/videos.md @@ -59,6 +59,10 @@ The following viewing statistics are currently available: On the heat map, the fact of video fragment playback is counted as a view regardless of playback duration. For example, if you start a video and stop it right away, a view will be counted for the first fragment of the video. +## Subtitles {#subtitles} + +Supported subtitle formats: SRT and VTT. The maximum subtitle file size is 500 MB. You can load several subtitle files in one or more languages for one video. View the list of supported languages in [{{ video-name }} interface]({{ link-video-main }}). + ## See also {#see-also} * [Getting started with video hosting](../hosting.md) diff --git a/en/video/hosting.md b/en/video/hosting.md index 9ef8833e748..d1144f2b4c3 100644 --- a/en/video/hosting.md +++ b/en/video/hosting.md @@ -43,6 +43,7 @@ To upload a [video](./concepts/index.md#videos) to a service [channel](./concept {% include [image-characteristic](../_includes/video/image-characteristic.md) %} +1. {% include [add-subtitles-optional](../_includes/video/add-subtitles-optional.md) %} 1. Click **{{ ui-key.yacloud_video.common.action_accept }}**. [Learn more about videos](./concepts/videos.md) diff --git a/en/video/operations/channels/create.md b/en/video/operations/channels/create.md index d9738791a67..231f26e429b 100644 --- a/en/video/operations/channels/create.md +++ b/en/video/operations/channels/create.md @@ -9,10 +9,12 @@ description: Follow this guide to create a {{ video-full-name }} channel. - {{ video-name }} interface {#console} - {% include [create-channel](../../../_includes/video/create-channel.md) %} + {% include [create-channel](../../../_includes/video/create-channel.md) %} - API {#api} - Use the [ChannelService/Create](../../api-ref/grpc/Channel/create.md) gRPC API call. + Use the [create](../../api-ref/Channel/create.md) REST API method for the [Channel](../../api-ref/Channel/index.md) resource or the [ChannelService/Create](../../api-ref/grpc/Channel/create.md) gRPC API call. + + For more information about creating a channel, see [Getting started with the {{ video-full-name }} API](../../api-ref/quickstart.md#create-channel). {% endlist %} \ No newline at end of file diff --git a/en/video/operations/channels/delete.md b/en/video/operations/channels/delete.md index 50f55f18898..a5625b0dc83 100644 --- a/en/video/operations/channels/delete.md +++ b/en/video/operations/channels/delete.md @@ -9,12 +9,12 @@ description: Follow this guide to delete a {{ video-full-name }} channel. - {{ video-name }} interface {#console} - 1. Open the {{ video-name }} [home page]({{ link-video-main }}). - 1. In the line of the proper channel, click ![image](../../../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud_video.common.action_delete }}**. - 1. Click **{{ ui-key.yacloud_video.common.action_delete }}**. + 1. Open the {{ video-name }} [home page]({{ link-video-main }}). + 1. In the row with the channel you need, click ![image](../../../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud_video.common.action_delete }}**. + 1. Click **{{ ui-key.yacloud_video.common.action_delete }}**. - API {#api} - Use the [ChannelService/Delete](../../api-ref/grpc/Channel/delete.md) gRPC API call. + Use the [delete](../../api-ref/Channel/delete.md) REST API method for the [Channel](../../api-ref/Channel/index.md) resource or the [ChannelService/Delete](../../api-ref/grpc/Channel/delete.md) gRPC API call. {% endlist %} \ No newline at end of file diff --git a/en/video/operations/channels/update.md b/en/video/operations/channels/update.md index feb60a0289e..ff1a91afb1c 100644 --- a/en/video/operations/channels/update.md +++ b/en/video/operations/channels/update.md @@ -9,14 +9,14 @@ description: Follow this guide to edit a {{ video-full-name }} channel. - {{ video-name }} interface {#console} - 1. Open the {{ video-name }} [home page]({{ link-video-main }}). - 1. In the line of the proper channel, click ![image](../../../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud_video.common.action_edit }}**. - 1. Edit the channel name and description. - 1. Click **{{ ui-key.yacloud_video.common.action_accept }}**. + 1. Open the {{ video-name }} [home page]({{ link-video-main }}). + 1. In the row with the channel you need, click ![image](../../../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud_video.common.action_edit }}**. + 1. Edit the channel name and description. + 1. Click **{{ ui-key.yacloud_video.common.action_accept }}**. - API {#api} - Use the [ChannelService/Update](../../api-ref/grpc/Channel/update.md) gRPC API call. + Use the [update](../../api-ref/Channel/update.md) REST API method for the [Channel](../../api-ref/Channel/index.md) resource or the [ChannelService/Update](../../api-ref/grpc/Channel/update.md) gRPC API call. {% endlist %} diff --git a/en/video/operations/index.md b/en/video/operations/index.md index 76577522bc0..bc679a6507c 100644 --- a/en/video/operations/index.md +++ b/en/video/operations/index.md @@ -1,5 +1,5 @@ --- -title: How to work with {{ video-full-name }}. Step-by-step guides +title: Working with {{ video-full-name }}. Step-by-step guides description: Step-by-step guides on how to use the streaming and video hosting service in {{ yandex-cloud }}. In this tutorial, you will learn how to manage channels and videos in {{ video-full-name }}. --- @@ -15,6 +15,7 @@ description: Step-by-step guides on how to use the streaming and video hosting s * [{#T}](video/upload.md) * [{#T}](video/update.md) +* [{#T}](video/subtitles.md) * [{#T}](video/download.md) * [{#T}](video/publish.md) * [{#T}](video/unpublish.md) diff --git a/en/video/operations/lines/create.md b/en/video/operations/lines/create.md index 254be220147..d925238fa9c 100644 --- a/en/video/operations/lines/create.md +++ b/en/video/operations/lines/create.md @@ -9,24 +9,24 @@ description: Follow this guide to create a {{ video-full-name }} line. - {{ video-name }} interface {#console} - 1. Open the {{ video-name }} [home page]({{ link-video-main }}). - 1. Select a channel. - 1. In the ![image](../../../_assets/console-icons/branches-right-arrow-right.svg) **{{ ui-key.yacloud_video.stream-lines.title_lines }}** tab, click **{{ ui-key.yacloud_video.stream-lines.action_create-line }}**. - 1. Enter a name for the line. - 1. In the **{{ ui-key.yacloud_video.stream-lines.label_input-stream-protocol }}** field, select the [required protocol](../../concepts/streams.md#lines): `RTMP` or `SRT`. - 1. In the **{{ ui-key.yacloud_video.stream-lines.label_input-stream-type }}** field, select: + 1. Open the {{ video-name }} [home page]({{ link-video-main }}). + 1. Select a channel. + 1. In the ![image](../../../_assets/console-icons/branches-right-arrow-right.svg) **{{ ui-key.yacloud_video.stream-lines.title_lines }}** tab, click **{{ ui-key.yacloud_video.stream-lines.action_create-line }}**. + 1. Enter a name for the line. + 1. In the **{{ ui-key.yacloud_video.stream-lines.label_input-stream-protocol }}** field, select the [required protocol](../../concepts/streams.md#lines), `RTMP` or `SRT`. + 1. In the **{{ ui-key.yacloud_video.stream-lines.label_input-stream-type }}** field, select: {% include [push-pull](../../../_includes/video/push-pull.md) %} - 1. If you selected the `Pull` stream type, enter the address of your broadcast server in the **{{ ui-key.yacloud_video.stream-lines.label_url }}** field. - 1. In the **{{ ui-key.yacloud_video.thumbnails.label_thumbnail }}** field, click ![image](../../../_assets/console-icons/cloud-arrow-up-in.svg) **Select file** and select an image for the cover. + 1. If you selected the `Pull` stream type, enter the address of your broadcast server in the **{{ ui-key.yacloud_video.stream-lines.label_url }}** field. + 1. In the **{{ ui-key.yacloud_video.thumbnails.label_thumbnail }}** field, click ![image](../../../_assets/console-icons/cloud-arrow-up-in.svg) **Select file** and choose a cover image. {% include [image-characteristic](../../../_includes/video/image-characteristic.md) %} - 1. Click **{{ ui-key.yacloud_video.common.action_create }}**. + 1. Click **{{ ui-key.yacloud_video.common.action_create }}**. - API {#api} - Use the [StreamLineService/Create](../../api-ref/grpc/StreamLine/create.md) gRPC API call. + Use the [create](../../api-ref/StreamLine/create.md) REST API method for the [StreamLine](../../api-ref/StreamLine/index.md) resource or the [StreamLineService/Create](../../api-ref/grpc/StreamLine/create.md) gRPC API call. {% endlist %} \ No newline at end of file diff --git a/en/video/operations/lines/delete.md b/en/video/operations/lines/delete.md index d2d1662b17d..f7e188edf53 100644 --- a/en/video/operations/lines/delete.md +++ b/en/video/operations/lines/delete.md @@ -9,13 +9,13 @@ description: Follow this guide to delete a {{ video-full-name }} line. - {{ video-name }} interface {#console} - 1. Open the {{ video-name }} [home page]({{ link-video-main }}). - 1. Select a channel. - 1. On the ![image](../../../_assets/console-icons/branches-right-arrow-right.svg) **{{ ui-key.yacloud_video.stream-lines.title_lines }}** tab, in the line with the required line, click the ![image](../../../_assets/console-icons/ellipsis.svg) icon and select **{{ ui-key.yacloud_video.common.action_delete }}**. - 1. Click **{{ ui-key.yacloud_video.common.action_delete }}**. + 1. Open the {{ video-name }} [home page]({{ link-video-main }}). + 1. Select a channel. + 1. In the ![image](../../../_assets/console-icons/branches-right-arrow-right.svg) **{{ ui-key.yacloud_video.stream-lines.title_lines }}** tab, in the row with the line you need, click ![image](../../../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud_video.common.action_delete }}**. + 1. Click **{{ ui-key.yacloud_video.common.action_delete }}**. - API {#api} - Use the [StreamLineService/Delete](../../api-ref/grpc/StreamLine/delete.md) gRPC API call. + Use the [delete](../../api-ref/StreamLine/delete.md) REST API method for the [StreamLine](../../api-ref/StreamLine/index.md) resource or the [StreamLineService/Delete](../../api-ref/grpc/StreamLine/delete.md) gRPC API call. {% endlist %} \ No newline at end of file diff --git a/en/video/operations/lines/update.md b/en/video/operations/lines/update.md index dffc3f6b462..6a2bb1d2dad 100644 --- a/en/video/operations/lines/update.md +++ b/en/video/operations/lines/update.md @@ -9,27 +9,27 @@ description: Follow this guide to edit a {{ video-full-name }} line. - {{ video-name }} interface {#console} - 1. Open the {{ video-name }} [home page]({{ link-video-main }}). - 1. Select a channel. - 1. On the ![image](../../../_assets/console-icons/branches-right-arrow-right.svg) **{{ ui-key.yacloud_video.stream-lines.title_lines }}** tab, in the line with the required line, click the ![image](../../../_assets/console-icons/ellipsis.svg) icon and select **{{ ui-key.yacloud_video.common.action_edit }}**. - 1. Change the line name. - 1. In the **{{ ui-key.yacloud_video.stream-lines.label_input-stream-protocol }}** field, select the [required protocol](../../concepts/streams.md#lines): `RTMP` or `SRT`. - 1. In the **{{ ui-key.yacloud_video.stream-lines.label_input-stream-type }}** field, select: + 1. Open the {{ video-name }} [home page]({{ link-video-main }}). + 1. Select a channel. + 1. In the ![image](../../../_assets/console-icons/branches-right-arrow-right.svg) **{{ ui-key.yacloud_video.stream-lines.title_lines }}** tab, in the row with the line you need, click ![image](../../../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud_video.common.action_edit }}**. + 1. Change the line name. + 1. In the **{{ ui-key.yacloud_video.stream-lines.label_input-stream-protocol }}** field, select the [required protocol](../../concepts/streams.md#lines), `RTMP` or `SRT`. + 1. In the **{{ ui-key.yacloud_video.stream-lines.label_input-stream-type }}** field, select: {% include [push-pull](../../../_includes/video/push-pull.md) %} - 1. If you selected the `Pull` stream type, enter the address of your broadcast server in the **{{ ui-key.yacloud_video.stream-lines.label_url }}** field. - 1. To change the cover: + 1. If you selected the `Pull` stream type, enter the address of your broadcast server in the **{{ ui-key.yacloud_video.stream-lines.label_url }}** field. + 1. To change the cover: - 1. If the line already has a cover, hover over the cover preview and click the ![image](../../../_assets/console-icons/circle-xmark.svg) icon. - 1. Click ![image](../../../_assets/console-icons/cloud-arrow-up-in.svg) **Select file** and select a new image for the cover. + 1. If the line already has a cover, hover over the cover preview and click ![image](../../../_assets/console-icons/circle-xmark.svg). + 1. Click ![image](../../../_assets/console-icons/cloud-arrow-up-in.svg) **Select file** and select a new cover image. - {% include [image-characteristic](../../../_includes/video/image-characteristic.md) %} + {% include [image-characteristic](../../../_includes/video/image-characteristic.md) %} - 1. Click **{{ ui-key.yacloud_video.common.action_accept }}**. + 1. Click **{{ ui-key.yacloud_video.common.action_accept }}**. - API {#api} - Use the [StreamLineService/Update](../../api-ref/grpc/StreamLine/update.md) gRPC API call. + Use the [update](../../api-ref/StreamLine/update.md) REST API method for the [StreamLine](../../api-ref/StreamLine/index.md) resource or the [StreamLineService/Update](../../api-ref/grpc/StreamLine/update.md) gRPC API call. {% endlist %} \ No newline at end of file diff --git a/en/video/operations/streams/create.md b/en/video/operations/streams/create.md index c4e129428dd..9bc5c7f90bd 100644 --- a/en/video/operations/streams/create.md +++ b/en/video/operations/streams/create.md @@ -9,36 +9,36 @@ description: Follow this guide to create a {{ video-full-name }} broadcast. - {{ video-name }} interface {#console} - 1. Open the {{ video-name }} [home page]({{ link-video-main }}). - 1. Select a channel. - 1. In the ![image](../../../_assets/console-icons/antenna-signal.svg) **{{ ui-key.yacloud_video.streams.title_streams }}** tab, click **{{ ui-key.yacloud_video.streams.action_create-stream }}**. - 1. Enter a name and description for the broadcast. - 1. Select or [create](../lines/create.md) a new line. - 1. In the **{{ ui-key.yacloud_video.thumbnails.label_thumbnail }}** field, click ![image](../../../_assets/console-icons/cloud-arrow-up-in.svg) **Select file** and select an image for the cover. + 1. Open the {{ video-name }} [home page]({{ link-video-main }}). + 1. Select a channel. + 1. In the ![image](../../../_assets/console-icons/antenna-signal.svg) **{{ ui-key.yacloud_video.streams.title_streams }}** tab, click **{{ ui-key.yacloud_video.streams.action_create-stream }}**. + 1. Enter a name and description for the broadcast. + 1. Select or [create](../lines/create.md) a new line. + 1. In the **{{ ui-key.yacloud_video.thumbnails.label_thumbnail }}** field, click ![image](../../../_assets/console-icons/cloud-arrow-up-in.svg) **Select file** and choose a cover image. {% include [image-characteristic](../../../_includes/video/image-characteristic.md) %} - 1. Select the preferred [broadcast](../../concepts/streams.md#streams) stream type: - + 1. Select the preferred [broadcast](../../concepts/streams.md#streams) stream type: + * `{{ ui-key.yacloud_video.streams.label_type-on-demand }}`: Start and end the broadcast manually from the {{ video-name }} interface. * `{{ ui-key.yacloud_video.streams.label_type-schedule }}`: Start and end the broadcast automatically at the specified time. - 1. If you selected the `{{ ui-key.yacloud_video.streams.label_type-schedule }}` stream type, specify the start and end date and time of the broadcast. - 1. (Optional) To place part of the broadcast on the website, select it as a separate episode: + 1. If you selected the `{{ ui-key.yacloud_video.streams.label_type-schedule }}` stream type, specify the start and end date and time of the broadcast. + 1. (Optional) To place part of the broadcast on the website, select it as a separate episode: 1. Click ![image](../../../_assets/console-icons/plus.svg) **{{ ui-key.yacloud_video.streams.action_add-stream-episode }}**. 1. Enter a name and description for the episode. 1. Specify the start and end date and time of the episode. - 1. In the **{{ ui-key.yacloud_video.thumbnails.label_thumbnail }}** field, click ![image](../../../_assets/console-icons/cloud-arrow-up-in.svg) **Select file** and select an image for the cover. + 1. In the **{{ ui-key.yacloud_video.thumbnails.label_thumbnail }}** field, click ![image](../../../_assets/console-icons/cloud-arrow-up-in.svg) **Select file** and choose a cover image. - {% include [image-characteristic](../../../_includes/video/image-characteristic.md) %} + {% include [image-characteristic](../../../_includes/video/image-characteristic.md) %} You can add any number of episodes. To delete an episode you do not need, click ![image](../../../_assets/console-icons/trash-bin.svg). - 1. Click **{{ ui-key.yacloud_video.common.action_create }}**. + 1. Click **{{ ui-key.yacloud_video.common.action_create }}**. - API {#api} - Use the [StreamService/Create](../../api-ref/grpc/Stream/create.md) gRPC API call. + Use the [create](../../api-ref/Stream/create.md) REST API method for the [Stream](../../api-ref/Stream/index.md) resource or the [StreamService/Create](../../api-ref/grpc/Stream/create.md) gRPC API call. {% endlist %} \ No newline at end of file diff --git a/en/video/operations/streams/delete.md b/en/video/operations/streams/delete.md index 2956ee0d058..d7a62c010a6 100644 --- a/en/video/operations/streams/delete.md +++ b/en/video/operations/streams/delete.md @@ -9,13 +9,13 @@ description: Follow this guide to delete a {{ video-full-name }} broadcast. - {{ video-name }} interface {#console} - 1. Open the {{ video-name }} [home page]({{ link-video-main }}). - 1. Select a channel. - 1. On the ![image](../../../_assets/console-icons/antenna-signal.svg) **{{ ui-key.yacloud_video.streams.title_streams }}** tab, in the line with the required broadcast, click the ![image](../../../_assets/console-icons/ellipsis.svg) icon and select **{{ ui-key.yacloud_video.common.action_delete }}**. - 1. Click **{{ ui-key.yacloud_video.common.action_delete }}**. + 1. Open the {{ video-name }} [home page]({{ link-video-main }}). + 1. Select a channel. + 1. In the ![image](../../../_assets/console-icons/antenna-signal.svg) **{{ ui-key.yacloud_video.streams.title_streams }}** tab, in the row with the broadcast you need, click ![image](../../../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud_video.common.action_delete }}**. + 1. Click **{{ ui-key.yacloud_video.common.action_delete }}**. - API {#api} - Use the [StreamService/Delete](../../api-ref/grpc/Stream/delete.md) gRPC API call. + Use the [delete](../../api-ref/Stream/delete.md) REST API method for the [Stream](../../api-ref/Stream/index.md) resource or the [StreamService/Delete](../../api-ref/grpc/Stream/delete.md) gRPC API call. {% endlist %} \ No newline at end of file diff --git a/en/video/operations/streams/get-link.md b/en/video/operations/streams/get-link.md index 7ad509b11ba..d3622333e25 100644 --- a/en/video/operations/streams/get-link.md +++ b/en/video/operations/streams/get-link.md @@ -1,6 +1,6 @@ --- -title: How to get an embed code or link to a broadcast in {{ video-full-name }} -description: Follow this guide to get a {{ video-full-name }} embed code or link to a broadcast. +title: How to get an embed code or broadcast link in {{ video-full-name }} +description: Follow this guide to get a {{ video-full-name }} embed code or broadcast link. --- # Getting an embed code or link to a broadcast @@ -16,8 +16,8 @@ description: Follow this guide to get a {{ video-full-name }} embed code or link 1. Set the required playback parameters for the broadcast: - 1. `{{ ui-key.yacloud_video.streams.label_episode-mute }}`. - 1. `{{ ui-key.yacloud_video.streams.label_episode-autoplay }}`. + 1. `{{ ui-key.yacloud_video.streams.label_episode-mute }}` + 1. `{{ ui-key.yacloud_video.streams.label_episode-autoplay }}` 1. `Display controls in the player`. {% include [iframe-settings](../../../_includes/video/iframe-settings.md) %} @@ -31,6 +31,6 @@ description: Follow this guide to get a {{ video-full-name }} embed code or link - API {#api} - Use the [EpisodeService/GetPlayerURL](../../api-ref/grpc/Episode/getPlayerURL.md) gRPC API call or the [getPlayerURL](../../api-ref/Episode/getPlayerURL.md) REST API method for the [Episode](../../api-ref/Video/index.md) resource. + Use the [getPlayerURL](../../api-ref/Episode/getPlayerURL.md) REST API method for the [Episode](../../api-ref/Episode/index.md) resource or the [EpisodeService/GetPlayerURL](../../api-ref/grpc/Episode/getPlayerURL.md) gRPC API call. {% endlist %} \ No newline at end of file diff --git a/en/video/operations/streams/start.md b/en/video/operations/streams/start.md index 1dba452cab5..203599ca8f5 100644 --- a/en/video/operations/streams/start.md +++ b/en/video/operations/streams/start.md @@ -28,29 +28,29 @@ In the program, specify {{ ui-key.yacloud_video.stream-lines.label_stream-key }} 1. Under **Controls**, click **Settings**. 1. In the **Stream** tab, set up the broadcast server: - * In the **Service** field, select **Custom...** - * In the **Server** field, enter the {{ ui-key.yacloud_video.stream-lines.label_server-address }} you got earlier. - * In the **Stream Key** field, enter the {{ ui-key.yacloud_video.stream-lines.label_stream-key }} you got earlier. + * In the **Service** field, select **Custom...** + * In the **Server** field, enter the {{ ui-key.yacloud_video.stream-lines.label_server-address }} you got earlier. + * In the **Stream Key** field, enter the {{ ui-key.yacloud_video.stream-lines.label_stream-key }} you got earlier. 1. Click **OK**. -1. Under **Sources**, click ![image](../../../_assets/console-icons/plus.svg), select what you want to broadcast, e.g., **Video Capture Device**, and click **OK**. +1. Under **Sources**, click ![image](../../../_assets/console-icons/plus.svg), choose what you want to stream (e.g., **Video Capture Device**), and click **OK**. 1. Select the video stream's source device, e.g., a webcam, and click **OK**. 1. Under **Controls**, click **Start Streaming**. -## Start your broadcast {#start-stream} +## Start streaming {#start-stream} {% list tabs group=instructions %} - {{ video-name }} interface {#console} - 1. Open the {{ video-name }} [home page]({{ link-video-main }}). - 1. Select a channel. - 1. In the ![image](../../../_assets/console-icons/antenna-signal.svg) **{{ ui-key.yacloud_video.streams.title_streams }}** tab, select a stream. - 1. Click ![image](../../../_assets/console-icons/circle-play.svg) **{{ ui-key.yacloud_video.streams.action_start-stream }}**. + 1. Open the {{ video-name }} [home page]({{ link-video-main }}). + 1. Select a channel. + 1. In the ![image](../../../_assets/console-icons/antenna-signal.svg) **{{ ui-key.yacloud_video.streams.title_streams }}** tab, select the broadcast you need. + 1. Click ![image](../../../_assets/console-icons/circle-play.svg) **{{ ui-key.yacloud_video.streams.action_start-stream }}**. - API {#api} - Use the [StreamService/Create](../../api-ref/grpc/Stream/create.md) gRPC API call. + Use the [performAction](../../api-ref/Stream/performAction.md) REST API method for the [Stream](../../api-ref/Stream/index.md) resource or the [StreamService/PerformAction](../../api-ref/grpc/Stream/performAction.md) gRPC API call. {% endlist %} @@ -62,16 +62,16 @@ In the program, specify {{ ui-key.yacloud_video.stream-lines.label_stream-key }} - {{ video-name }} interface {#console} - 1. Open the {{ video-name }} [home page]({{ link-video-main }}). - 1. Select a channel. - 1. In the ![image](../../../_assets/console-icons/antenna-signal.svg) **{{ ui-key.yacloud_video.streams.title_streams }}** tab, select a stream. - 1. Under **{{ ui-key.yacloud_video.streams.title_stream-episodes }}**, click ** {{ ui-key.yacloud_video.streams.title_past-code }}** and select the `link` tab. - 1. Click ![image](../../../_assets/console-icons/copy.svg) **{{ ui-key.yacloud_video.streams.action_copy-code }}**. - 1. Open a new browser page and paste the obtained URL to the address bar. - 1. Click the play button to make sure the broadcast is available. + 1. Open the {{ video-name }} [home page]({{ link-video-main }}). + 1. Select a channel. + 1. In the ![image](../../../_assets/console-icons/antenna-signal.svg) **{{ ui-key.yacloud_video.streams.title_streams }}** tab, select the broadcast you need. + 1. Under **{{ ui-key.yacloud_video.streams.title_stream-episodes }}**, click ** {{ ui-key.yacloud_video.streams.title_past-code }}** and select the `link` tab. + 1. Click ![image](../../../_assets/console-icons/copy.svg) **{{ ui-key.yacloud_video.streams.action_copy-code }}**. + 1. Open a new browser page and paste the obtained URL to the address bar. + 1. Click the play button to make sure the broadcast is available. - API {#api} - Use the [EpisodeService/GetPlayerURL](../../api-ref/grpc/Episode/getPlayerURL.md) gRPC API call. + Use the [getPlayerURL](../../api-ref/Episode/getPlayerURL.md) REST API method for the [Episode](../../api-ref/Episode/index.md) resource or the [EpisodeService/GetPlayerURL](../../api-ref/grpc/Episode/getPlayerURL.md) gRPC API call. {% endlist %} \ No newline at end of file diff --git a/en/video/operations/streams/update.md b/en/video/operations/streams/update.md index bbef40d76a8..1ec39ff14ff 100644 --- a/en/video/operations/streams/update.md +++ b/en/video/operations/streams/update.md @@ -9,39 +9,39 @@ description: Follow this guide to edit a {{ video-full-name }} broadcast. - {{ video-name }} interface {#console} - 1. Open the {{ video-name }} [home page]({{ link-video-main }}). - 1. Select a channel. - 1. On the ![image](../../../_assets/console-icons/antenna-signal.svg) **{{ ui-key.yacloud_video.streams.title_streams }}** tab, in the line with the required broadcast, click the ![image](../../../_assets/console-icons/ellipsis.svg) icon and select **{{ ui-key.yacloud_video.common.action_edit }}**. - 1. Edit the broadcast name and description. - 1. Select or [create](../lines/create.md) a new line. - 1. To change the cover: + 1. Open the {{ video-name }} [home page]({{ link-video-main }}). + 1. Select a channel. + 1. In the ![image](../../../_assets/console-icons/antenna-signal.svg) **{{ ui-key.yacloud_video.streams.title_streams }}** tab, in the row with the broadcast you need, click ![image](../../../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud_video.common.action_edit }}**. + 1. Edit the broadcast name and description. + 1. Select or [create](../lines/create.md) a new line. + 1. To change the cover: - 1. If the line broadcast has a cover, hover over the cover preview and click ![image](../../../_assets/console-icons/circle-xmark.svg). - 1. Click ![image](../../../_assets/console-icons/cloud-arrow-up-in.svg) **Select file** and select a new image for the cover. + 1. If the broadcast already has a cover, hover over the cover preview and click ![image](../../../_assets/console-icons/circle-xmark.svg). + 1. Click ![image](../../../_assets/console-icons/cloud-arrow-up-in.svg) **Select file** and select a new cover image. - {% include [image-characteristic](../../../_includes/video/image-characteristic.md) %} - - 1. Select the preferred [broadcast](../../concepts/streams.md#streams) stream type: + {% include [image-characteristic](../../../_includes/video/image-characteristic.md) %} + 1. Select the preferred [broadcast](../../concepts/streams.md#streams) stream type: + * `{{ ui-key.yacloud_video.streams.label_type-on-demand }}`: Start and end the broadcast manually from the {{ video-name }} interface. * `{{ ui-key.yacloud_video.streams.label_type-schedule }}`: Start and end the broadcast automatically at the specified time. - 1. If you selected the `{{ ui-key.yacloud_video.streams.label_type-schedule }}` stream type, specify the start and end date and time of the broadcast. - 1. (Optional) To place part of the broadcast on the website, select it as a separate episode: + 1. If you selected the `{{ ui-key.yacloud_video.streams.label_type-schedule }}` stream type, specify the start and end date and time of the broadcast. + 1. (Optional) To place part of the broadcast on the website, select it as a separate episode: 1. Click ![image](../../../_assets/console-icons/plus.svg) **{{ ui-key.yacloud_video.streams.action_add-stream-episode }}**. 1. Enter a name and description for the episode. 1. Specify the start and end date and time of the episode. - 1. In the **{{ ui-key.yacloud_video.thumbnails.label_thumbnail }}** field, click ![image](../../../_assets/console-icons/cloud-arrow-up-in.svg) **Select file** and select an image for the cover. + 1. In the **{{ ui-key.yacloud_video.thumbnails.label_thumbnail }}** field, click ![image](../../../_assets/console-icons/cloud-arrow-up-in.svg) **Select file** and choose a cover image. - {% include [image-characteristic](../../../_includes/video/image-characteristic.md) %} + {% include [image-characteristic](../../../_includes/video/image-characteristic.md) %} You can add any number of episodes. To delete an episode you do not need, click ![image](../../../_assets/console-icons/trash-bin.svg). - 1. Click **{{ ui-key.yacloud_video.common.action_accept }}**. + 1. Click **{{ ui-key.yacloud_video.common.action_accept }}**. - API {#api} - Use the [StreamService/Update](../../api-ref/grpc/Stream/update.md) gRPC API call. + Use the [update](../../api-ref/Stream/update.md) REST API method for the [Stream](../../api-ref/Stream/index.md) resource or the [StreamService/Update](../../api-ref/grpc/Stream/update.md) gRPC API call. {% endlist %} \ No newline at end of file diff --git a/en/video/operations/video/delete.md b/en/video/operations/video/delete.md index 26d382667d6..7233a83ad0d 100644 --- a/en/video/operations/video/delete.md +++ b/en/video/operations/video/delete.md @@ -9,13 +9,14 @@ description: Follow this guide to delete a {{ video-full-name }} video. - {{ video-name }} interface {#console} - 1. Open the {{ video-name }} [home page]({{ link-video-main }}). - 1. Select a channel. - 1. On the ![image](../../../_assets/console-icons/circle-play.svg) **{{ ui-key.yacloud_video.videos.title_videos }}** tab, in the line with the video, click ![image](../../../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud_video.common.action_delete }}**. - 1. Click **{{ ui-key.yacloud_video.common.action_delete }}**. + 1. Open the {{ video-name }} [home page]({{ link-video-main }}). + 1. Select a channel. + 1. On the ![image](../../../_assets/console-icons/circle-play.svg) **{{ ui-key.yacloud_video.videos.title_videos }}** tab, in the row with the video you need, click ![image](../../../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud_video.common.action_delete }}**. + 1. Click **{{ ui-key.yacloud_video.common.action_delete }}**. - API {#api} - Use the [VideoService/Delete](../../api-ref/grpc/Video/delete.md) gRPC API call. + Use the [delete](../../api-ref/Video/delete.md) REST API method for the [Video](../../api-ref/Video/index.md) resource or the [VideoService/Delete](../../api-ref/grpc/Video/delete.md) gRPC API call. + {% endlist %} \ No newline at end of file diff --git a/en/video/operations/video/download.md b/en/video/operations/video/download.md index 5ea887f48aa..87e306eb63e 100644 --- a/en/video/operations/video/download.md +++ b/en/video/operations/video/download.md @@ -1,6 +1,6 @@ --- title: How to download a video in {{ video-full-name }} -description: Follow this guide to download videos from {{ video-full-name }}. +description: Follow this guide to download a video from {{ video-full-name }}. --- # Downloading a video @@ -9,12 +9,8 @@ description: Follow this guide to download videos from {{ video-full-name }}. - {{ video-name }} interface {#console} - 1. Open the {{ video-name }} [home page]({{ link-video-main }}). - 1. Select a channel. - 1. On the ![image](../../../_assets/console-icons/circle-play.svg) **{{ ui-key.yacloud_video.videos.title_videos }}** tab, in the line with the video, click ![image](../../../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud_video.common.action_download }}**. - -- API {#api} - - Use the [VideoService/Get](../../api-ref/grpc/Video/get.md) gRPC API call. + 1. Open the {{ video-name }} [home page]({{ link-video-main }}). + 1. Select a channel. + 1. On the ![image](../../../_assets/console-icons/circle-play.svg) **{{ ui-key.yacloud_video.videos.title_videos }}** tab, in the row with the video you need, click ![image](../../../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud_video.common.action_download }}**. {% endlist %} \ No newline at end of file diff --git a/en/video/operations/video/get-link.md b/en/video/operations/video/get-link.md index 3356343cbba..1e7c86bcd11 100644 --- a/en/video/operations/video/get-link.md +++ b/en/video/operations/video/get-link.md @@ -16,8 +16,8 @@ description: Follow this guide to get an embed code or link to a video in {{ vid 1. Set the required playback parameters for the video: - 1. `{{ ui-key.yacloud_video.streams.label_episode-mute }}`. - 1. `{{ ui-key.yacloud_video.streams.label_episode-autoplay }}`. + 1. `{{ ui-key.yacloud_video.streams.label_episode-mute }}` + 1. `{{ ui-key.yacloud_video.streams.label_episode-autoplay }}` 1. `Display controls in the player`. {% include [iframe-settings](../../../_includes/video/iframe-settings.md) %} @@ -31,6 +31,8 @@ description: Follow this guide to get an embed code or link to a video in {{ vid - API {#api} - Use the [VideoService/GetPlayerURL](../../api-ref/grpc/Video/getPlayerURL.md) gRPC API call or the [getPlayerURL](../../api-ref/Video/getPlayerURL.md) REST API method for the [Video](../../api-ref/Video/index.md) resource. + Use the [getPlayerURL](../../api-ref/Video/getPlayerURL.md) REST API method for the [Video](../../api-ref/Video/index.md) resource or the [VideoService/GetPlayerURL](../../api-ref/grpc/Video/getPlayerURL.md) gRPC API call. + + For details on how to get a link to your video, see [Getting started with the {{ video-full-name }} API](../../api-ref/quickstart.md#get-link) {% endlist %} \ No newline at end of file diff --git a/en/video/operations/video/publish.md b/en/video/operations/video/publish.md index 3af612ee084..398987d987a 100644 --- a/en/video/operations/video/publish.md +++ b/en/video/operations/video/publish.md @@ -20,7 +20,7 @@ You can publish a video and check its availability. - API {#api} - Use the [VideoService/Create](../../api-ref/grpc/Video/create.md) gRPC API call. + Use the [performAction](../../api-ref/Video/create.md) REST API method for the [Video](../../api-ref/Video/index.md) resource or the [VideoService/PerformAction](../../api-ref/grpc/Video/performAction.md) gRPC API call. {% endlist %} @@ -40,7 +40,7 @@ You can publish a video and check its availability. - API {#api} - Use the [VideoService/GetPlayerURL](../../api-ref/grpc/Video/getPlayerURL.md) gRPC API call. + Use the [getPlayerURL](../../api-ref/Video/getPlayerURL.md) REST API method for the [Video](../../api-ref/Video/index.md) resource or the [VideoService/GetPlayerURL](../../api-ref/grpc/Video/getPlayerURL.md) gRPC API call. {% endlist %} diff --git a/en/video/operations/video/subtitles.md b/en/video/operations/video/subtitles.md new file mode 100644 index 00000000000..21466748fa8 --- /dev/null +++ b/en/video/operations/video/subtitles.md @@ -0,0 +1,80 @@ +--- +title: How to manage subtitles in {{ video-full-name }} +description: Follow this guide to manage subtitles in {{ video-full-name }}. +--- + +# Managing subtitles + +You can [add](#add) and [delete](#delete) subtitles while uploading or editing a video. After a video is uploaded, you will also be able to [download](#download) [subtitle](../../concepts/videos.md#subtitles) files. + + +## Adding subtitles {#add} + +{% list tabs group=instructions %} + +- {{ video-name }} interface {#console} + + 1. Open the {{ video-name }} [home page]({{ link-video-main }}). + 1. Select a channel. + 1. On the ![image](../../../_assets/console-icons/circle-play.svg) **{{ ui-key.yacloud_video.videos.title_videos }}** tab, in the line with the video, click ![image](../../../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud_video.common.action_edit }}**. + 1. In the **{{ ui-key.yacloud_video.videos.label_subtitles }}** field, click **{{ ui-key.yacloud_video.common.action_add }}**. + 1. In the window that opens, select the subtitle language. + 1. Click **Select file** and select a subtitle file. + 1. Click **{{ ui-key.yacloud_video.common.action_create }}**. + + Wait for the file to upload. + + 1. Click **{{ ui-key.yacloud_video.common.action_accept }}**. + +{% endlist %} + + +## Updating subtitles {#update} + +{% list tabs group=instructions %} + +- {{ video-name }} interface {#console} + + 1. Open the {{ video-name }} [home page]({{ link-video-main }}). + 1. Select a channel. + 1. On the ![image](../../../_assets/console-icons/circle-play.svg) **{{ ui-key.yacloud_video.videos.title_videos }}** tab, in the line with the video, click ![image](../../../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud_video.common.action_edit }}**. + 1. Click ![image](../../../_assets/console-icons/xmark.svg) to the right of the name of the subtitle file you want to replace. + 1. In the **{{ ui-key.yacloud_video.videos.label_subtitles }}** field, click **{{ ui-key.yacloud_video.common.action_add }}**. + 1. In the window that opens, select the subtitle language. + 1. Click **Select file** and select a subtitle file. + 1. Click **{{ ui-key.yacloud_video.common.action_create }}**. + + Wait for the file to upload. + + 1. Click **{{ ui-key.yacloud_video.common.action_accept }}**. + +{% endlist %} + + +## Downloading subtitles {#download} + +{% list tabs group=instructions %} + +- {{ video-name }} interface {#console} + + 1. Open the {{ video-name }} [home page]({{ link-video-main }}). + 1. Select a channel. + 1. In the ![video](../../../_assets/console-icons/circle-play.svg) **{{ ui-key.yacloud_video.videos.title_videos }}** tab, select the video. + 1. Under **{{ ui-key.yacloud_video.videos.label_subtitles }}**, click ![image](../../../_assets/console-icons/arrow-down-to-line.svg) to the right of the name of the subtitle file to download. + +{% endlist %} + + +## Deleting subtitles {#add} + +{% list tabs group=instructions %} + +- {{ video-name }} interface {#console} + + 1. Open the {{ video-name }} [home page]({{ link-video-main }}). + 1. Select a channel. + 1. On the ![image](../../../_assets/console-icons/circle-play.svg) **{{ ui-key.yacloud_video.videos.title_videos }}** tab, in the line with the video, click ![image](../../../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud_video.common.action_edit }}**. + 1. Click ![image](../../../_assets/console-icons/xmark.svg) to the right of the name of the subtitle file you want to delete. + 1. Click **{{ ui-key.yacloud_video.common.action_accept }}**. + +{% endlist %} \ No newline at end of file diff --git a/en/video/operations/video/unpublish.md b/en/video/operations/video/unpublish.md index a82d8ac56ce..0e7def5a025 100644 --- a/en/video/operations/video/unpublish.md +++ b/en/video/operations/video/unpublish.md @@ -18,7 +18,7 @@ description: Follow this guide to unpublish a video in {{ video-full-name }}. - API {#api} - Use the [VideoService/Update](../../api-ref/grpc/Video/update.md) gRPC API call. + Use the [performAction](../../api-ref/Video/create.md) REST API method for the [Video](../../api-ref/Video/index.md) resource or the [VideoService/PerformAction](../../api-ref/grpc/Video/performAction.md) gRPC API call. {% endlist %} diff --git a/en/video/operations/video/update.md b/en/video/operations/video/update.md index c645b02f528..767cbada8c4 100644 --- a/en/video/operations/video/update.md +++ b/en/video/operations/video/update.md @@ -9,22 +9,32 @@ description: Follow this guide to edit a video in {{ video-full-name }}. - {{ video-name }} interface {#console} - 1. Open the {{ video-name }} [home page]({{ link-video-main }}). - 1. Select a channel. - 1. On the ![image](../../../_assets/console-icons/circle-play.svg) **{{ ui-key.yacloud_video.videos.title_videos }}** tab, in the line with the video, click ![image](../../../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud_video.common.action_edit }}**. - 1. Edit the video title and description. - 1. To change the cover: + 1. Open the {{ video-name }} [home page]({{ link-video-main }}). + 1. Select a channel. + 1. On the ![image](../../../_assets/console-icons/circle-play.svg) **{{ ui-key.yacloud_video.videos.title_videos }}** tab, in the line with the video, click ![image](../../../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud_video.common.action_edit }}**. + 1. Edit the video title and description. + 1. To change the cover: 1. If the video has a cover, hover over the cover preview and click ![image](../../../_assets/console-icons/circle-xmark.svg). - 1. Click ![image](../../../_assets/console-icons/cloud-arrow-up-in.svg) **Select file** and select a new image for the cover. + 1. Click ![image](../../../_assets/console-icons/cloud-arrow-up-in.svg) **Select file** and select a new cover image. - {% include [image-characteristic](../../../_includes/video/image-characteristic.md) %} + {% include [image-characteristic](../../../_includes/video/image-characteristic.md) %} - 1. Click **{{ ui-key.yacloud_video.common.action_accept }}**. + 1. To edit [subtitles](../../concepts/videos.md#subtitles), delete and add them as needed: + + 1. Click ![image](../../../_assets/console-icons/xmark.svg) to the right of the name of the subtitle file you want to update. + 1. In the **{{ ui-key.yacloud_video.videos.label_subtitles }}** field, click **{{ ui-key.yacloud_video.common.action_add }}**. + 1. In the window that opens, select a subtitle language. + 1. Click **Select file** and select a subtitle file. + 1. Click **{{ ui-key.yacloud_video.common.action_create }}**. + + Wait for the file to upload. + + 1. Click **{{ ui-key.yacloud_video.common.action_accept }}**. - API {#api} - Use the [VideoService/Update](../../api-ref/grpc/Video/update.md) gRPC API call. + Use the [update](../../api-ref/Video/update.md) REST API method for the [Video](../../api-ref/Video/index.md) resource or the [VideoService/Update](../../api-ref/grpc/Video/update.md) gRPC API call. {% endlist %} diff --git a/en/video/operations/video/upload.md b/en/video/operations/video/upload.md index b858dac3381..6c9449ea5a3 100644 --- a/en/video/operations/video/upload.md +++ b/en/video/operations/video/upload.md @@ -30,6 +30,7 @@ description: Follow this guide to upload a video to {{ video-full-name }}. {% include [image-characteristic](../../../_includes/video/image-characteristic.md) %} + 1. {% include [add-subtitles-optional](../../../_includes/video/add-subtitles-optional.md) %} 1. Click **{{ ui-key.yacloud_video.common.action_accept }}**. This will open the video management page. After processing is complete, the video will be available for viewing. @@ -43,7 +44,11 @@ description: Follow this guide to upload a video to {{ video-full-name }}. - API {#api} - Use the [VideoService/Create](../../api-ref/grpc/Video/create.md) gRPC API call. + Use the [create](../../api-ref/Video/create.md) REST API method for the [Video](../../api-ref/Video/index.md) resource or the [VideoService/Create](../../api-ref/grpc/Video/create.md) gRPC API call. + + The request will register the video in the channel. After that, upload your video file over the [tus](https://tus.io/protocols/resumable-upload) protocol. You can either code the upload yourself in any programming language or use [ready-made](https://tus.io/implementations) libraries for this purpose. + + For more information about uploading videos, see [Getting started with the {{ video-full-name }} API](../../api-ref/quickstart.md#create-video). {% endlist %} @@ -65,10 +70,11 @@ description: Follow this guide to upload a video to {{ video-full-name }}. As soon as they are processed, the videos will be available for viewing. - If you need to, [edit](./update.md) the title and cover separately for each video you uploaded. + If required, [add](./update.md) subtitles and [edit](./update.md) the title and the cover separately for each video you uploaded. {% endlist %} + #### See also {#see-also} [{#T}](./update.md) \ No newline at end of file diff --git a/en/video/release-notes.md b/en/video/release-notes.md index 0385e769538..a9c7935b2da 100644 --- a/en/video/release-notes.md +++ b/en/video/release-notes.md @@ -7,9 +7,9 @@ description: This section contains {{ video-name }} release notes. ## September 2024 {#sep-2024} -* Added support for [video](./concepts/videos.md) subtitle uploading. -* Published [video player SDK for JavaScript](./sdk/javascript/index.md) -* Added support for [REST API methods](https://github.com/yandex-cloud/cloudapi/tree/master/yandex/cloud/video) for the service; published a [reference](./api-ref/). +* Added support for [video](./concepts/videos.md#subtitles) [subtitle](./concepts/videos.md) uploading. +* Published [Video player SDK for JavaScript](./sdk/javascript/index.md) +* Added support for [REST API methods](https://github.com/yandex-cloud/cloudapi/tree/master/yandex/cloud/video) for {{ video-name }}; published a [reference](./api-ref/). ## August 2024 {#aug-2024} diff --git a/en/video/sdk/javascript/index.md b/en/video/sdk/javascript/index.md index ca8f5f7ba5b..c9603e6a19e 100644 --- a/en/video/sdk/javascript/index.md +++ b/en/video/sdk/javascript/index.md @@ -12,7 +12,7 @@ You can integrate a [video player](../../concepts/player.md) with content from C To connect a player to a page, add the following code to it: ```html - + ``` ## Initializing a player {#initialize-player} diff --git a/en/video/sdk/javascript/initialization.md b/en/video/sdk/javascript/initialization.md index 13838b1c8f0..1b5ad33c4fc 100644 --- a/en/video/sdk/javascript/initialization.md +++ b/en/video/sdk/javascript/initialization.md @@ -9,7 +9,7 @@ You can provide initial parameters to [Cloud Video Player](./index.md#initialize #### element {#element} -Embed element. This is a required parameter. This can be either an `HTMLElement` pointer or an ID selector. +Embed element. This is a required parameter. This can be either a pointer to a certain `HTMLElement` or an ID selector. Player creation examples: @@ -32,7 +32,7 @@ Playable content link. Player creation examples: ```javascript -var player = Ya.playerApi.init({ ..., source: 'https://runtime.video.cloud.yandex.net/player/...', ...}); +var player = Ya.playerSdk.init({ ..., source: 'https://runtime.video.cloud.yandex.net/player/...', ...}); ``` {% include [video-content-id-desc](../../../_includes/video/video-content-id-desc.md) %} @@ -48,7 +48,7 @@ Autoplay is disabled by default. Player creation examples with disabled autoplay: ```javascript -var player = Ya.playerApi.init({ ..., autoplay: false, ...}); +var player = Ya.playerSdk.init({ ..., autoplay: false, ...}); ``` #### muted {#muted} @@ -60,7 +60,7 @@ If the sound is on, autoplay may [fail](https://developer.chrome.com/blog/autopl Player creation examples with enabled sound: ```javascript -var player = Ya.playerApi.init({ ..., muted: false, ...}); +var player = Ya.playerSdk.init({ ..., muted: false, ...}); ``` #### volume {#volume} @@ -72,7 +72,7 @@ The default value is `1`. Player creation example with the `0.5` volume: ```javascript -var player = Ya.playerApi.init({ ..., volume: 0.5, ...}); +var player = Ya.playerSdk.init({ ..., volume: 0.5, ...}); ``` #### startPosition {#startposition} @@ -87,7 +87,7 @@ The default values are: Player creation example with the `10` starting position: ```javascript -var player = Ya.playerApi.init({ ..., startPosition: 10, ...}); +var player = Ya.playerSdk.init({ ..., startPosition: 10, ...}); ``` #### hiddenControls {#hiddencontrols} @@ -103,31 +103,31 @@ Examples: * Hide the play/pause and settings buttons by providing `hiddenControls` as a string: ```javascript - var player = Ya.playerApi.init({ ..., hiddenControls: 'play,settings', ...}); + var player = Ya.playerSdk.init({ ..., hiddenControls: 'play,settings', ...}); ``` -* Hiding the play/pause and settings buttons by providing `hiddenControls` as an array: +* Hide the play/pause and settings buttons by providing `hiddenControls` as an array: ```javascript - var player = Ya.playerApi.init({ ..., hiddenControls: ['play','settings'], ...}); + var player = Ya.playerSdk.init({ ..., hiddenControls: ['play','settings'], ...}); ``` * You can hide all interface elements using the `*` meta element: ```javascript - var player = Ya.playerApi.init({ ..., hiddenControls: '*', ...}); + var player = Ya.playerSdk.init({ ..., hiddenControls: '*', ...}); ``` -* To hide all interface elements except the specified one, you can use the `!` operator. For example, the following code will hide all controls except the play/pause button: +* You can hide all interface elements except a specific one using the `!` operator. For example, the following code will hide all controls except the play/pause button: ```javascript - var player = Ya.playerApi.init({ ..., hiddenControls: '*,!play', ...}); + var player = Ya.playerSdk.init({ ..., hiddenControls: '*,!play', ...}); ``` Interface elements you can hide: * `*`: All interface elements. -* `play`: Interface element displaying the **Play**, **Pause**, and **Repeat** buttons. It turns off play/pause when clicking on the player. +* `play`: Interface element displaying the **Play**, **Pause**, and **Repeat** buttons. It turns off play or pause when clicking the player. * `contextMenu`: Context menu. * `fullscreen`: Full screen toggle button. * `live`: **Go back to live** button. @@ -139,7 +139,7 @@ Interface elements you can hide: * `settings`: Settings button. * `startScreen`: Start screen. * `startScreenPlay`: Play button on the start screen. -* `subtitlesToggle`: Subtitles toggle button. +* `subtitlesToggle`: Button to toggle subtitles. * `timeline`: Timeline. It turns off rewinding and fast forwarding from the keyboard or by touching the sensor screen. * `timelinePreview`: Preview on the timeline. * `time`: Current playback time. diff --git a/en/video/toc.yaml b/en/video/toc.yaml index 3d4d984d3a7..aa67d84c965 100644 --- a/en/video/toc.yaml +++ b/en/video/toc.yaml @@ -28,6 +28,8 @@ items: href: operations/video/upload.md - name: Editing a video href: operations/video/update.md + - name: Managing subtitles + href: operations/video/subtitles.md - name: Downloading a video href: operations/video/download.md - name: Publishing a video diff --git a/en/vision/operations/classification/moderation.md b/en/vision/operations/classification/moderation.md index 0bad9cabcee..86d979c5110 100644 --- a/en/vision/operations/classification/moderation.md +++ b/en/vision/operations/classification/moderation.md @@ -103,7 +103,7 @@ To do this, set the `type` property to `Classification` in the [batchAnalyze](.. ```bash vision_moderation() { - curl -H "Authorization: Bearer `yc iam create-token`" \ + curl --header "Authorization: Bearer `yc iam create-token`" \ "https://vision.{{ api-host }}/vision/v1/batchAnalyze" \ -d @<(cat << EOF { diff --git a/en/vision/operations/classification/quality.md b/en/vision/operations/classification/quality.md index 539d1c1d8ef..8000fa262e6 100644 --- a/en/vision/operations/classification/quality.md +++ b/en/vision/operations/classification/quality.md @@ -1,5 +1,5 @@ --- -description: "To evaluate image quality, you can use the quality model offered by {{ vision-full-name }}. The service compares similar images\_and selects the best quality ones or filters out lower quality images, e.g., to exclude them from search results. Supported file formats for quality evaluation: JPEG, PNG, PDF." +description: "To evaluate image quality, you can use the _quality_ model offered by {{ vision-full-name }}. The service compares similar images\_and selects the best quality ones or filters out lower quality images, e.g., to exclude them from search results. Supported file formats for quality evaluation: JPEG, PNG, PDF." noIndex: true keywords: - image quality @@ -12,7 +12,7 @@ keywords: To evaluate the quality of an image, use [Image classification](../../concepts/classification/index.md). -In the [batchAnalyze](../../vision/api-ref/Vision/batchAnalyze.md) method, set the `type` property to `Classification`, and specify the [quality](../../concepts/classification/supported-models.md#quality) model in the configuration. +To do this, set the `type` property to `Classification` in the [batchAnalyze](../../vision/api-ref/Vision/batchAnalyze.md) method and specify the [quality](../../concepts/classification/supported-models.md#quality) model in the configuration. ## Examples {#examples} @@ -34,7 +34,7 @@ In the [batchAnalyze](../../vision/api-ref/Vision/batchAnalyze.md) method, set t {% endnote %} -1. Encode the file as Base64: +1. Encode the file into Base64: {% include [base64-encode-command](../../../_includes/vision/base64-encode-command.md) %} @@ -60,13 +60,13 @@ In the [batchAnalyze](../../vision/api-ref/Vision/batchAnalyze.md) method, set t Where: * `folderId`: [ID of any folder](../../../resource-manager/operations/folder/get-id.md) for which your account has the `{{ roles-vision-user }}` role or higher. - * `analyze_specs: content`: [Base64 encoded](../base64-encode.md) image. + * `analyze_specs: content`: [Base64-encoded](../base64-encode.md) image. 1. {% include [send-request](../../../_includes/vision/send-request.md) %} Where `IAM_TOKEN` is the IAM token you got [before you started](#before-you-begin). - The response will contain the properties and the probability of matching them. You can use these properties to moderate the image: + The response will contain the properties and the probability of matches. You can use these properties to moderate the image: {% include [classification-quality-response](../../../_includes/vision/classification-quality-response.md) %} @@ -80,7 +80,7 @@ In the [batchAnalyze](../../vision/api-ref/Vision/batchAnalyze.md) method, set t ```bash vision_quality() { - curl -H "Authorization: Bearer `yc iam create-token`" \ + curl --header "Authorization: Bearer `yc iam create-token`" \ "https://vision.{{ api-host }}/vision/v1/batchAnalyze" \ -d @<(cat << EOF { diff --git a/en/vision/operations/face-detection/index.md b/en/vision/operations/face-detection/index.md index 018a1c4ffda..8aa6d62e0b2 100644 --- a/en/vision/operations/face-detection/index.md +++ b/en/vision/operations/face-detection/index.md @@ -8,7 +8,7 @@ noIndex: true To detect faces in a photo, use the [Face Detection](../../concepts/face-detection/index.md) feature. -To do this, in the [batchAnalyze](../../vision/api-ref/Vision/batchAnalyze.md) method, specify `FACE_DETECTION` in the `type` property. +To do this, in the [batchAnalyze](../../vision/api-ref/Vision/batchAnalyze.md) method, set the `type` property to `FACE_DETECTION`. ## Examples {#examples} @@ -29,7 +29,7 @@ To do this, in the [batchAnalyze](../../vision/api-ref/Vision/batchAnalyze.md) m Need an image? [Download a sample](https://{{ s3-storage-host }}/vision/face-detection-sample.jpg). {% endnote %} -1. Encode the file as Base64: +1. Encode the file into Base64: {% include [base64-encode-command](../../../_includes/vision/base64-encode-command.md) %} 1. Create a file with the request body, e.g., `body.json`: @@ -65,7 +65,7 @@ To do this, in the [batchAnalyze](../../vision/api-ref/Vision/batchAnalyze.md) m ```bash vision_face_detection() { - curl -H "Authorization: Bearer `yc iam create-token`" \ + curl --header "Authorization: Bearer `yc iam create-token`" \ "https://vision.{{ api-host }}/vision/v1/batchAnalyze" \ -d @<(cat << EOF { @@ -88,4 +88,4 @@ To do this, in the [batchAnalyze](../../vision/api-ref/Vision/batchAnalyze.md) m ```bash vision_face_detection path/to/image.jpg - ``` + ``` \ No newline at end of file diff --git a/en/vision/operations/ocr/text-detection-image.md b/en/vision/operations/ocr/text-detection-image.md index c0136f5844a..c063349ecff 100644 --- a/en/vision/operations/ocr/text-detection-image.md +++ b/en/vision/operations/ocr/text-detection-image.md @@ -34,13 +34,13 @@ Image text recognition is implemented in the [recognize](../../ocr/api-ref/TextR "mimeType": "JPEG", "languageCodes": ["*"], "model": "page", - "content": "" + "content": "" } ``` In the `content` property, specify the image file contents [encoded](../base64-encode.md) as Base64. - For the service to automatically detect the text language, specify the `"languageCodes": ["*"]` property in the configuration. + To automatically detect the text language, indicate the `"languageCodes": ["*"]` property in the configuration. 1. {% include [send-request](../../../_includes/vision/send-request_ocr.md) %} @@ -49,7 +49,7 @@ Image text recognition is implemented in the [recognize](../../ocr/api-ref/TextR {% include [text-detection](../../../_includes/vision/text-detection-example.md) %} -1. To get all the recognized words in an image, find all the values with the `text` property. +1. To get all the words recognized in the image, find all values with the `text` property. {% include [coordinate-definition-issue-note](../../../_includes/vision/coordinate-definition-issue-note.md) %} diff --git a/en/vision/operations/ocr/text-detection-pdf.md b/en/vision/operations/ocr/text-detection-pdf.md index c88ef3f2ab1..8da3211d4d1 100644 --- a/en/vision/operations/ocr/text-detection-pdf.md +++ b/en/vision/operations/ocr/text-detection-pdf.md @@ -16,29 +16,29 @@ Text recognition from a PDF file is implemented through OCR API methods, such as 1. Encode the PDF file as Base64: - {% include [base64-encode-command](../../../_includes/vision/base64-encode-command-pdf.md) %} + {% include [base64-encode-command](../../../_includes/vision/base64-encode-command-pdf.md) %} 1. Create a file with the request body, e.g., `body.json`. - **body.json:** - ```json - { - "mimeType": "application/pdf", - "languageCodes": ["*"], - "model": "page", - "content": "" - } - ``` + **body.json:** + ```json + { + "mimeType": "application/pdf", + "languageCodes": ["*"], + "model": "page", + "content": "" + } + ``` - In the `content` property, specify the PDF file contents [encoded](../base64-encode.md) as Base64. + In the `content` property, specify the PDF file contents [encoded](../base64-encode.md) as Base64. - For the service to automatically detect the text language, specify the `"languageCodes": ["*"]` property in the configuration. + To automatically detect the text language, specify the `"languageCodes": ["*"]` property in the configuration. 1. Send your request: - {% list tabs %} + {% list tabs %} - - Single-page PDF file + - Single-page PDF file {% include [send-request](../../../_includes/vision/send-request_ocr.md) %} @@ -342,639 +342,640 @@ Text recognition from a PDF file is implemented through OCR API methods, such as {% endcut %} - - Multi-page PDF file + - Multi-page PDF file * {% include [send-request](../../../_includes/vision/send-request_ocr-async.md) %} - Result: + Result: - ```json - { - "id": "cfrtr5q0hdhl********", - "description": "OCR async recognition", - "created_at": "2023-10-24T09:12:48Z", - "created_by": "ajeol2afu1js********", - "modified_at": "2023-10-24T09:12:48Z", - "done": false, - "metadata": null - } - ``` + ```json + { + "id": "cfrtr5q0hdhl********", + "description": "OCR async recognition", + "created_at": "2023-10-24T09:12:48Z", + "created_by": "ajeol2afu1js********", + "modified_at": "2023-10-24T09:12:48Z", + "done": false, + "metadata": null + } + ``` - Save the recognition operation `id` that you received in the response. + Save the recognition operation `id` you get in the response. * Send a recognition request using the [getRecognition](../../ocr/api-ref/TextRecognitionAsync/getRecognition.md) method: - ```bash - export IAM_TOKEN= - curl -X GET \ - -H "Content-Type: application/json" \ - -H "Authorization: Bearer ${IAM_TOKEN}" \ - -H "x-folder-id: " \ - -H "x-data-logging-enabled: true" \ - https://ocr.{{ api-host }}/ocr/v1/getRecognition?operationId= \ - -o output.json - ``` - - Where: - * ``: Previously obtained IAM token. - * ``: Previously obtained folder ID. - * ``: Previously obtained recognition operation ID. - - The result will consist of recognized blocks of text, lines, and words with their positions on the PDF file's page. The result of recognizing each page is given in a separate `result` section. - - - {% cut "Result" %} - - ```json - { - "result": { - "text_annotation": { - "width": "3312", - "height": "4683", - "blocks": [ - { - "bounding_box": { - "vertices": [ - { - "x": "373", - "y": "371" - }, - { - "x": "373", - "y": "580" - }, - { - "x": "1836", - "y": "580" - }, - { - "x": "1836", - "y": "371" - } - ] - }, - "lines": [ - { - "bounding_box": { - "vertices": [ - { - "x": "373", - "y": "371" - }, - { - "x": "373", - "y": "430" - }, - { - "x": "1836", - "y": "430" - }, - { - "x": "1836", - "y": "371" - } - ] - }, - "alternatives": [ - { - "text": "Page №1, line 1", - "words": [ - { - "bounding_box": { - "vertices": [ - { - "x": "373", - "y": "358" - }, - { - "x": "373", - "y": "444" - }, - { - "x": "967", - "y": "444" - }, - { - "x": "967", - "y": "358" - } - ] - }, - "text": "Page", - "entity_index": "-1" - }, - { - "bounding_box": { - "vertices": [ - { - "x": "1014", - "y": "358" - }, - { - "x": "1014", - "y": "444" - }, - { - "x": "1278", - "y": "444" - }, - { - "x": "1278", - "y": "358" - } - ] - }, - "text": "№1,", - "entity_index": "-1" - }, - { - "bounding_box": { - "vertices": [ - { - "x": "1303", - "y": "358" - }, - { - "x": "1303", - "y": "444" - }, - { - "x": "1718", - "y": "444" - }, - { - "x": "1718", - "y": "358" - } - ] - }, - "text": "line", - "entity_index": "-1" - }, - { - "bounding_box": { - "vertices": [ - { - "x": "1765", - "y": "358" - }, - { - "x": "1765", - "y": "444" - }, - { - "x": "1836", - "y": "444" - }, - { - "x": "1836", - "y": "358" - } - ] - }, - "text": "1", - "entity_index": "-1" - } - ] - } - ] - }, - { - "bounding_box": { - "vertices": [ - { - "x": "373", - "y": "520" - }, - { - "x": "373", - "y": "580" - }, - { - "x": "1836", - "y": "580" - }, - { - "x": "1836", - "y": "520" - } - ] - }, - "alternatives": [ - { - "text": "Page №1, line 2", - "words": [ - { - "bounding_box": { - "vertices": [ - { - "x": "373", - "y": "508" - }, - { - "x": "373", - "y": "594" - }, - { - "x": "967", - "y": "594" - }, - { - "x": "967", - "y": "508" - } - ] - }, - "text": "Page", - "entity_index": "-1" - }, - { - "bounding_box": { - "vertices": [ - { - "x": "1014", - "y": "507" - }, - { - "x": "1014", - "y": "593" - }, - { - "x": "1277", - "y": "593" - }, - { - "x": "1277", - "y": "507" - } - ] - }, - "text": "№1,", - "entity_index": "-1" - }, - { - "bounding_box": { - "vertices": [ - { - "x": "1302", - "y": "507" - }, - { - "x": "1302", - "y": "593" - }, - { - "x": "1718", - "y": "593" - }, - { - "x": "1718", - "y": "507" - } - ] - }, - "text": "line", - "entity_index": "-1" - }, - { - "bounding_box": { - "vertices": [ - { - "x": "1765", - "y": "507" - }, - { - "x": "1765", - "y": "593" - }, - { - "x": "1836", - "y": "593" - }, - { - "x": "1836", - "y": "507" - } - ] - }, - "text": "2", - "entity_index": "-1" - } - ] - } - ] - } - ], - "languages": [ - { - "language_code": "ru" - } - ] - } - ], - "entities": [] - }, - "page": "0" - } - } - { - "result": { - "text_annotation": { - "width": "3312", - "height": "4683", - "blocks": [ - { - "bounding_box": { - "vertices": [ - { - "x": "371", - "y": "371" - }, - { - "x": "371", - "y": "580" - }, - { - "x": "1836", - "y": "580" - }, - { - "x": "1836", - "y": "371" - } - ] - }, - "lines": [ - { - "bounding_box": { - "vertices": [ - { - "x": "371", - "y": "371" - }, - { - "x": "371", - "y": "430" - }, - { - "x": "1820", - "y": "430" - }, - { - "x": "1820", - "y": "371" - } - ] - }, - "alternatives": [ - { - "text": "Page №2, line 1", - "words": [ - { - "bounding_box": { - "vertices": [ - { - "x": "371", - "y": "357" - }, - { - "x": "371", - "y": "444" - }, - { - "x": "964", - "y": "444" - }, - { - "x": "964", - "y": "357" - } - ] - }, - "text": "Page", - "entity_index": "-1" - }, - { - "bounding_box": { - "vertices": [ - { - "x": "993", - "y": "357" - }, - { - "x": "993", - "y": "444" - }, - { - "x": "1292", - "y": "444" - }, - { - "x": "1292", - "y": "357" - } - ] - }, - "text": "№2,", - "entity_index": "-1" - }, - { - "bounding_box": { - "vertices": [ - { - "x": "1317", - "y": "357" - }, - { - "x": "1317", - "y": "444" - }, - { - "x": "1701", - "y": "444" - }, - { - "x": "1701", - "y": "357" - } - ] - }, - "text": "line", - "entity_index": "-1" - }, - { - "bounding_box": { - "vertices": [ - { - "x": "1748", - "y": "357" - }, - { - "x": "1748", - "y": "444" - }, - { - "x": "1820", - "y": "444" - }, - { - "x": "1820", - "y": "357" - } - ] - }, - "text": "1", - "entity_index": "-1" - } - ] - } - ] - }, - { - "bounding_box": { - "vertices": [ - { - "x": "373", - "y": "520" - }, - { - "x": "373", - "y": "580" - }, - { - "x": "1836", - "y": "580" - }, - { - "x": "1836", - "y": "520" - } - ] - }, - "alternatives": [ - { - "text": "Page №2, line 2", - "words": [ - { - "bounding_box": { - "vertices": [ - { - "x": "373", - "y": "507" - }, - { - "x": "373", - "y": "594" - }, - { - "x": "967", - "y": "594" - }, - { - "x": "967", - "y": "507" - } - ] - }, - "text": "Page", - "entity_index": "-1" - }, - { - "bounding_box": { - "vertices": [ - { - "x": "1014", - "y": "507" - }, - { - "x": "1014", - "y": "594" - }, - { - "x": "1277", - "y": "594" - }, - { - "x": "1277", - "y": "507" - } - ] - }, - "text": "№2,", - "entity_index": "-1" - }, - { - "bounding_box": { - "vertices": [ - { - "x": "1302", - "y": "507" - }, - { - "x": "1302", - "y": "594" - }, - { - "x": "1718", - "y": "594" - }, - { - "x": "1718", - "y": "507" - } - ] - }, - "text": "line", - "entity_index": "-1" - }, - { - "bounding_box": { - "vertices": [ - { - "x": "1765", - "y": "506" - }, - { - "x": "1765", - "y": "593" - }, - { - "x": "1836", - "y": "593" - }, - { - "x": "1836", - "y": "506" - } - ] - }, - "text": "2", - "entity_index": "-1" - } - ] - } - ] - } - ], - "languages": [ - { - "language_code": "ru" - } - ] - } - ], - "entities": [] - }, - "page": "1" - } - } - ``` - - {% endcut %} - - {% endlist %} - -1. To get the recognized words from the PDF file, find all the values with the `text` property. + ```bash + export IAM_TOKEN= + curl \ + --request GET \ + --header "Content-Type: application/json" \ + --header "Authorization: Bearer ${IAM_TOKEN}" \ + --header "x-folder-id: " \ + --header "x-data-logging-enabled: true" \ + https://ocr.{{ api-host }}/ocr/v1/getRecognition?operationId= \ + --output output.json + ``` + + Where: + * ``: IAM token you got earlier. + * ``: Folder ID you got earlier. + * ``: Recognition operation ID you got earlier. + + The result will consist of recognized blocks of text, lines, and words with their positions on the PDF file page. The recognition result for each page is presented in a separate `result` section. + + + {% cut "Result" %} + + ```json + { + "result": { + "text_annotation": { + "width": "3312", + "height": "4683", + "blocks": [ + { + "bounding_box": { + "vertices": [ + { + "x": "373", + "y": "371" + }, + { + "x": "373", + "y": "580" + }, + { + "x": "1836", + "y": "580" + }, + { + "x": "1836", + "y": "371" + } + ] + }, + "lines": [ + { + "bounding_box": { + "vertices": [ + { + "x": "373", + "y": "371" + }, + { + "x": "373", + "y": "430" + }, + { + "x": "1836", + "y": "430" + }, + { + "x": "1836", + "y": "371" + } + ] + }, + "alternatives": [ + { + "text": "Page 1, line 1", + "words": [ + { + "bounding_box": { + "vertices": [ + { + "x": "373", + "y": "358" + }, + { + "x": "373", + "y": "444" + }, + { + "x": "967", + "y": "444" + }, + { + "x": "967", + "y": "358" + } + ] + }, + "text": "Page", + "entity_index": "-1" + }, + { + "bounding_box": { + "vertices": [ + { + "x": "1014", + "y": "358" + }, + { + "x": "1014", + "y": "444" + }, + { + "x": "1278", + "y": "444" + }, + { + "x": "1278", + "y": "358" + } + ] + }, + "text": "№1,", + "entity_index": "-1" + }, + { + "bounding_box": { + "vertices": [ + { + "x": "1303", + "y": "358" + }, + { + "x": "1303", + "y": "444" + }, + { + "x": "1718", + "y": "444" + }, + { + "x": "1718", + "y": "358" + } + ] + }, + "text": "line", + "entity_index": "-1" + }, + { + "bounding_box": { + "vertices": [ + { + "x": "1765", + "y": "358" + }, + { + "x": "1765", + "y": "444" + }, + { + "x": "1836", + "y": "444" + }, + { + "x": "1836", + "y": "358" + } + ] + }, + "text": "1", + "entity_index": "-1" + } + ] + } + ] + }, + { + "bounding_box": { + "vertices": [ + { + "x": "373", + "y": "520" + }, + { + "x": "373", + "y": "580" + }, + { + "x": "1836", + "y": "580" + }, + { + "x": "1836", + "y": "520" + } + ] + }, + "alternatives": [ + { + "text": "Page 1, line 2", + "words": [ + { + "bounding_box": { + "vertices": [ + { + "x": "373", + "y": "508" + }, + { + "x": "373", + "y": "594" + }, + { + "x": "967", + "y": "594" + }, + { + "x": "967", + "y": "508" + } + ] + }, + "text": "Page", + "entity_index": "-1" + }, + { + "bounding_box": { + "vertices": [ + { + "x": "1014", + "y": "507" + }, + { + "x": "1014", + "y": "593" + }, + { + "x": "1277", + "y": "593" + }, + { + "x": "1277", + "y": "507" + } + ] + }, + "text": "№1,", + "entity_index": "-1" + }, + { + "bounding_box": { + "vertices": [ + { + "x": "1302", + "y": "507" + }, + { + "x": "1302", + "y": "593" + }, + { + "x": "1718", + "y": "593" + }, + { + "x": "1718", + "y": "507" + } + ] + }, + "text": "line", + "entity_index": "-1" + }, + { + "bounding_box": { + "vertices": [ + { + "x": "1765", + "y": "507" + }, + { + "x": "1765", + "y": "593" + }, + { + "x": "1836", + "y": "593" + }, + { + "x": "1836", + "y": "507" + } + ] + }, + "text": "2", + "entity_index": "-1" + } + ] + } + ] + } + ], + "languages": [ + { + "language_code": "ru" + } + ] + } + ], + "entities": [] + }, + "page": "0" + } + } + { + "result": { + "text_annotation": { + "width": "3312", + "height": "4683", + "blocks": [ + { + "bounding_box": { + "vertices": [ + { + "x": "371", + "y": "371" + }, + { + "x": "371", + "y": "580" + }, + { + "x": "1836", + "y": "580" + }, + { + "x": "1836", + "y": "371" + } + ] + }, + "lines": [ + { + "bounding_box": { + "vertices": [ + { + "x": "371", + "y": "371" + }, + { + "x": "371", + "y": "430" + }, + { + "x": "1820", + "y": "430" + }, + { + "x": "1820", + "y": "371" + } + ] + }, + "alternatives": [ + { + "text": "Page №2, line 1", + "words": [ + { + "bounding_box": { + "vertices": [ + { + "x": "371", + "y": "357" + }, + { + "x": "371", + "y": "444" + }, + { + "x": "964", + "y": "444" + }, + { + "x": "964", + "y": "357" + } + ] + }, + "text": "Page", + "entity_index": "-1" + }, + { + "bounding_box": { + "vertices": [ + { + "x": "993", + "y": "357" + }, + { + "x": "993", + "y": "444" + }, + { + "x": "1292", + "y": "444" + }, + { + "x": "1292", + "y": "357" + } + ] + }, + "text": "№2,", + "entity_index": "-1" + }, + { + "bounding_box": { + "vertices": [ + { + "x": "1317", + "y": "357" + }, + { + "x": "1317", + "y": "444" + }, + { + "x": "1701", + "y": "444" + }, + { + "x": "1701", + "y": "357" + } + ] + }, + "text": "line", + "entity_index": "-1" + }, + { + "bounding_box": { + "vertices": [ + { + "x": "1748", + "y": "357" + }, + { + "x": "1748", + "y": "444" + }, + { + "x": "1820", + "y": "444" + }, + { + "x": "1820", + "y": "357" + } + ] + }, + "text": "1", + "entity_index": "-1" + } + ] + } + ] + }, + { + "bounding_box": { + "vertices": [ + { + "x": "373", + "y": "520" + }, + { + "x": "373", + "y": "580" + }, + { + "x": "1836", + "y": "580" + }, + { + "x": "1836", + "y": "520" + } + ] + }, + "alternatives": [ + { + "text": "Page №2, line 2", + "words": [ + { + "bounding_box": { + "vertices": [ + { + "x": "373", + "y": "507" + }, + { + "x": "373", + "y": "594" + }, + { + "x": "967", + "y": "594" + }, + { + "x": "967", + "y": "507" + } + ] + }, + "text": "Page", + "entity_index": "-1" + }, + { + "bounding_box": { + "vertices": [ + { + "x": "1014", + "y": "507" + }, + { + "x": "1014", + "y": "594" + }, + { + "x": "1277", + "y": "594" + }, + { + "x": "1277", + "y": "507" + } + ] + }, + "text": "№2,", + "entity_index": "-1" + }, + { + "bounding_box": { + "vertices": [ + { + "x": "1302", + "y": "507" + }, + { + "x": "1302", + "y": "594" + }, + { + "x": "1718", + "y": "594" + }, + { + "x": "1718", + "y": "507" + } + ] + }, + "text": "line", + "entity_index": "-1" + }, + { + "bounding_box": { + "vertices": [ + { + "x": "1765", + "y": "506" + }, + { + "x": "1765", + "y": "593" + }, + { + "x": "1836", + "y": "593" + }, + { + "x": "1836", + "y": "506" + } + ] + }, + "text": "2", + "entity_index": "-1" + } + ] + } + ] + } + ], + "languages": [ + { + "language_code": "ru" + } + ] + } + ], + "entities": [] + }, + "page": "1" + } + } + ``` + + {% endcut %} + + {% endlist %} + +1. To get the recognized words from the PDF file, find all values with the `text` property. {% include [coordinate-definition-issue-note](../../../_includes/vision/coordinate-definition-issue-note.md) %} diff --git a/en/vpc/api-ref/SecurityGroup/delete.md b/en/vpc/api-ref/SecurityGroup/delete.md index 845f809de1a..49debf68b06 100644 --- a/en/vpc/api-ref/SecurityGroup/delete.md +++ b/en/vpc/api-ref/SecurityGroup/delete.md @@ -21,7 +21,7 @@ DELETE https://vpc.{{ api-host }}/vpc/v1/securityGroups/{securityGroupId} Required field. ID of the security group to delete. -To get a address ID make a [SecurityGroup.List](/docs/vpc/api-ref/Address/list#List) request. || +To get a address ID make a [SecurityGroup.List] request. || |# ## Response {#yandex.cloud.operation.Operation} diff --git a/en/vpc/api-ref/SecurityGroup/get.md b/en/vpc/api-ref/SecurityGroup/get.md index b7e09c248a5..130af54e1b8 100644 --- a/en/vpc/api-ref/SecurityGroup/get.md +++ b/en/vpc/api-ref/SecurityGroup/get.md @@ -22,7 +22,7 @@ GET https://vpc.{{ api-host }}/vpc/v1/securityGroups/{securityGroupId} || securityGroupId | **string** Required field. ID of the Security Group resource to return. -To get the security group ID, use a [SecurityGroup.List](/docs/vpc/api-ref/Address/list#List) request. || +To get the security group ID, use a [SecurityGroup.List] request. || |# ## Response {#yandex.cloud.vpc.v1.SecurityGroup} diff --git a/en/vpc/api-ref/SecurityGroup/listOperations.md b/en/vpc/api-ref/SecurityGroup/listOperations.md index 704b44548e6..43df0eb7898 100644 --- a/en/vpc/api-ref/SecurityGroup/listOperations.md +++ b/en/vpc/api-ref/SecurityGroup/listOperations.md @@ -21,7 +21,7 @@ GET https://vpc.{{ api-host }}/vpc/v1/securityGroups/{securityGroupId}/operation Required field. ID of the address to list operations for. -To get a address ID make a [SecurityGroup.List](/docs/vpc/api-ref/Address/list#List) request. || +To get a address ID make a [SecurityGroup.List] request. || |# ## Query parameters {#yandex.cloud.vpc.v1.ListSecurityGroupOperationsRequest} diff --git a/en/vpc/api-ref/grpc/SecurityGroup/delete.md b/en/vpc/api-ref/grpc/SecurityGroup/delete.md index 364dbb1ab07..2400fc58248 100644 --- a/en/vpc/api-ref/grpc/SecurityGroup/delete.md +++ b/en/vpc/api-ref/grpc/SecurityGroup/delete.md @@ -25,7 +25,7 @@ Deletes the specified security group. Required field. ID of the security group to delete. -To get a address ID make a [SecurityGroup.List](/docs/vpc/api-ref/grpc/Address/list#List) request. || +To get a address ID make a [SecurityGroup.List] request. || |# ## operation.Operation {#yandex.cloud.operation.Operation} diff --git a/en/vpc/api-ref/grpc/SecurityGroup/get.md b/en/vpc/api-ref/grpc/SecurityGroup/get.md index d21f9d84e7d..41c5d5c1f9f 100644 --- a/en/vpc/api-ref/grpc/SecurityGroup/get.md +++ b/en/vpc/api-ref/grpc/SecurityGroup/get.md @@ -26,7 +26,7 @@ To get the list of all available SecurityGroup resources, make a [List](/docs/vp || securityGroupId | **string** Required field. ID of the Security Group resource to return. -To get the security group ID, use a [SecurityGroup.List](/docs/vpc/api-ref/grpc/Address/list#List) request. || +To get the security group ID, use a [SecurityGroup.List] request. || |# ## SecurityGroup {#yandex.cloud.vpc.v1.SecurityGroup} diff --git a/en/vpc/api-ref/grpc/SecurityGroup/listOperations.md b/en/vpc/api-ref/grpc/SecurityGroup/listOperations.md index 6cc1eab6673..3871f9249d5 100644 --- a/en/vpc/api-ref/grpc/SecurityGroup/listOperations.md +++ b/en/vpc/api-ref/grpc/SecurityGroup/listOperations.md @@ -27,7 +27,7 @@ Lists operations for the specified security groups. Required field. ID of the address to list operations for. -To get a address ID make a [SecurityGroup.List](/docs/vpc/api-ref/grpc/Address/list#List) request. || +To get a address ID make a [SecurityGroup.List] request. || || pageSize | **int64** The maximum number of results per page to return. If the number of available diff --git a/en/vpc/concepts/security-groups.md b/en/vpc/concepts/security-groups.md index 794eabfcc06..8721c73f4bd 100644 --- a/en/vpc/concepts/security-groups.md +++ b/en/vpc/concepts/security-groups.md @@ -13,9 +13,9 @@ Currently, you can only use IPv4 in {{ yandex-cloud }} networks. IPv6 is not sup {% endnote %} -A security group (SG) is a resource that is created at the [cloud network](./network.md#network) level. Once created, a security group can be used in {{ yandex-cloud }} services to control network access to an object it applies to. +A *security group* (SG) is a resource created at the [cloud network](./network.md#network) level. Once created, a security group can be used in {{ yandex-cloud }} services to control network access to an object it applies to. -A default security group (DSG) is created automatically while creating a [new cloud network](./network.md#network). The default security group has the following properties: +A *default security group* (DSG) is created automatically while creating a [new cloud network](./network.md#network). The default security group has the following properties: * It will allow any network traffic, both egress and ingress, in the new cloud network. * It applies to traffic passing through all subnets in the network where the DSG is created. @@ -56,7 +56,7 @@ Security groups can be used in the following {{ yandex-cloud }} service objects: {% note info %} -For more information about using security groups in a specific {{ yandex-cloud }} service, see the documentation for the service. +For more information about using security groups in a specific {{ yandex-cloud }} service, see the relevant documentation. {% endnote %} @@ -77,8 +77,8 @@ Each rule in a security group has a fixed set of fields: | **Description** | Brief description of the rule. You can also describe metadata in this field. | **Protocol** | Specifies the [network protocol](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml#protocol-numbers-1) to be used for this rule.
You can use the following protocols for security group rules:
  • `TCP`
  • `UDP`
  • `ICMP`
  • `AH` (for IPsec connections)
  • `ESP` (for IPsec connections)
  • `GRE` (for tunnel connections)
  • `Any`: [Any network protocol](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml#protocol-numbers-1)
| **Port range** | Range of ports for the network protocol selected in the rule.
You can only specify a continuous port range. You cannot list arbitrary comma-separated ports. -| **Source**
For incoming traffic only | Traffic source IP addresses.
You can specify traffic source IP addresses in one of the following ways:
  • `CIDR`: List of traffic source IPv4 prefixes. You can set [up to 50 CIDR blocks](./limits.md#vpc-limits) per rule.
  • `Security group`: Name of an existing security group.
  • `Load balancer health checks`: Special rule that defines how to interact with the [{{ network-load-balancer-name }} health check nodes](../../network-load-balancer/concepts/health-check.md#target-statuses).
-| **Destination**
For outgoing traffic only | Traffic target IP addresses.
You can specify traffic target IP addresses in one of the following ways:
  • `CIDR`: List of traffic target IPv4 prefixes. You can set [up to 50 CIDR blocks](./limits.md#vpc-limits) per rule.
  • `Security group`: Name of an existing SG.
  • `Load balancer health checks`: Special rule that defines how to interact with the [{{ network-load-balancer-name }} health check nodes](../../network-load-balancer/concepts/health-check.md#target-statuses).
+| **Source**
For incoming traffic only | Traffic source IP addresses.
You can use the following methods to specify traffic source IP adresses:
  • `CIDR`: List of traffic source IPv4 prefixes. You can set [up to 50 CIDR blocks](./limits.md#vpc-limits) per rule.
  • `Security group`: Name of an existing security group.
  • `Load balancer health checks`: Special rule that defines how to interact with [{{ network-load-balancer-name }} health check nodes](../../network-load-balancer/concepts/health-check.md#target-statuses).
+| **Target**
For outgoing traffic only | Traffic target IP addresses.
You can use the following methods to specify traffic target IP addresses:
  • `CIDR`: List of traffic target IPv4 prefixes. You can set [up to 50 CIDR blocks](./limits.md#vpc-limits) per rule.
  • `Security group`: Name of an existing security group.
  • `Load balancer health checks`: Special rule that defines how to interact with [{{ network-load-balancer-name }} health check nodes](../../network-load-balancer/concepts/health-check.md#target-statuses).
### Self rule {#self-rule} diff --git a/en/vpc/operations/address-delete.md b/en/vpc/operations/address-delete.md index da26c7db457..41dab2be346 100644 --- a/en/vpc/operations/address-delete.md +++ b/en/vpc/operations/address-delete.md @@ -20,9 +20,9 @@ You cannot restore an address after it is deleted. 1. In the [management console]({{ link-console-main }}), go to the folder you need to delete a static address from. 1. In the list of services, select **{{ ui-key.yacloud.iam.folder.dashboard.label_vpc }}**. 1. In the left-hand panel, select ![image](../../_assets/console-icons/map-pin.svg) **{{ ui-key.yacloud.vpc.switch_addresses }}**. - 1. Click ![image](../../_assets/console-icons/ellipsis.svg) in the row with the IP address: + 1. Click ![image](../../_assets/console-icons/ellipsis.svg) in the row with the address: * Select ![image](../../_assets/console-icons/trash-bin.svg) **{{ ui-key.yacloud.common.delete }}**. - * (Optional) Select ![image](../../_assets/console-icons/lock-open.svg) **{{ ui-key.yacloud.vpc.addresses.button_action-disable-protection }}** if protection is enabled, and click **{{ ui-key.yacloud.vpc.addresses.popup-confirm_button_disable-protection }}**. + * (Optional) Select ![image](../../_assets/console-icons/lock-open.svg) **{{ ui-key.yacloud.vpc.addresses.button_action-disable-protection }}** if protection is enabled and click **{{ ui-key.yacloud.vpc.addresses.popup-confirm_button_disable-protection }}**. 1. In the window that opens, confirm by clicking **{{ ui-key.yacloud.common.delete }}**. - CLI {#cli} diff --git a/en/vpc/operations/delete-route-table.md b/en/vpc/operations/delete-route-table.md index 139a2d7a328..0737cd8021c 100644 --- a/en/vpc/operations/delete-route-table.md +++ b/en/vpc/operations/delete-route-table.md @@ -14,14 +14,14 @@ If you no longer need a route table, you can [delete](#delete-route-table) it. B {% note info %} - If you do not know which network the route table belongs to, select ![image](../../_assets/console-icons/route.svg) **{{ ui-key.yacloud.vpc.network.switch_route-table }}** on the left-hand panel. This will open a list of route tables. Find the network you need in the **Network** column next to the route table name. To view the cloud network, click its name. + If you do not know which network the route table belongs to, in the left-hand panel, select ![image](../../_assets/console-icons/route.svg) **{{ ui-key.yacloud.vpc.network.switch_route-table }}**. This will open a list of route tables. Find the network you need in the **Network** column next to the route table name. To view the cloud network, click its name. {% endnote %} 1. In the list of subnets, find the subnet associated with the route table. 1. Disassociate the route table from the subnet using any of these methods: - * In the line with subnet information, click ![image](../../_assets/console-icons/xmark.svg) next to the route table name. - * In the line with subnet information, click ![image](../../_assets/console-icons/ellipsis.svg) and select **Edit**. In the window that opens, click ![image](../../_assets/console-icons/xmark.svg) in the row with the route table name and save the changes. + * In the row with subnet information, click ![image](../../_assets/console-icons/xmark.svg) next to the route table name. + * In the row with subnet information, click ![image](../../_assets/console-icons/ellipsis.svg) and select **Edit**. In the window that opens, click ![image](../../_assets/console-icons/xmark.svg) in the row with the route table name and save the changes. * Open the subnet information and click ![image](../../_assets/console-icons/xmark.svg) next to the route table name. * Open the subnet information and click **Edit** in the top right corner. In the window that opens, click ![image](../../_assets/console-icons/xmark.svg) in the row with the route table name and save the changes. diff --git a/en/vpc/operations/enable-software-accelerated-network.md b/en/vpc/operations/enable-software-accelerated-network.md index ff00f986630..371c572eb79 100644 --- a/en/vpc/operations/enable-software-accelerated-network.md +++ b/en/vpc/operations/enable-software-accelerated-network.md @@ -1,4 +1,4 @@ -# Enable a software-accelerated network +# Enabling a software-accelerated network You can enable a [software-accelerated network](../concepts/software-accelerated-network.md) when creating or updating a VM. @@ -14,80 +14,80 @@ To enable a software-accelerated network on an existing VM: - Management console {#console} - 1. In the [management console]({{ link-console-main }}), select the folder the VM belongs to. - 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. - 1. In the line with the appropriate VM, click ![image](../../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud.common.stop }} **. - 1. In the window that opens, click **{{ ui-key.yacloud.compute.instances.popup-confirm_button_stop }}**. - 1. Wait for the VM status to change to `Stopped`, click ![image](../../_assets/console-icons/ellipsis.svg), and select **{{ ui-key.yacloud.common.edit }}**. - 1. Under **{{ ui-key.yacloud.compute.instances.create.section_platform }}**, select **{{ ui-key.yacloud.component.compute.resources.label_sw-accelerated-net }}**. - 1. Click **{{ ui-key.yacloud.compute.instance.edit.button_update }}**. - 1. Click **{{ ui-key.yacloud.common.start }}** in the top-right corner. - 1. In the window that opens, click **{{ ui-key.yacloud.compute.instances.popup-confirm_button_start }}**. + 1. In the [management console]({{ link-console-main }}), select the folder the VM belongs to. + 1. Select **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. + 1. In the line with the appropriate VM, click ![image](../../_assets/console-icons/ellipsis.svg) and select **{{ ui-key.yacloud.common.stop }}**. + 1. In the window that opens, click **{{ ui-key.yacloud.compute.instances.popup-confirm_button_stop }}**. + 1. Wait for the VM status to change to `Stopped`, click ![image](../../_assets/console-icons/ellipsis.svg), and select **{{ ui-key.yacloud.common.edit }}**. + 1. Under **{{ ui-key.yacloud.compute.instances.create.section_platform }}**, select **{{ ui-key.yacloud.component.compute.resources.field_sw-accelerated-net }}**. + 1. Click **{{ ui-key.yacloud.compute.instance.edit.button_update }}**. + 1. Click **{{ ui-key.yacloud.common.start }}** in the top-right corner. + 1. In the window that opens, click **{{ ui-key.yacloud.compute.instances.popup-confirm_button_start }}**. - CLI {#cli} - {% include [cli-install](../../_includes/cli-install.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - 1. View a description of the CLI command for updating VM parameters: + 1. View a description of the CLI command for updating VM parameters: ```bash yc compute instance update --help ``` - 1. Get a list of VMs in the default folder: + 1. Get a list of VMs in the default folder: {% include [compute-instance-list](../../compute/_includes_service/compute-instance-list.md) %} - 1. Select the `ID` or `NAME` of the relevant VM instance and stop it. For example, to stop a VM named `first-instance`, run the command: + 1. Select the `ID` or `NAME` of the relevant VM and stop it. For example, to stop a VM named `first-instance`, run this command: ```bash yc compute instance stop first-instance ``` - 1. Enable a software-accelerated network: + 1. Enable a software-accelerated network: 1. Run this command: - ```bash - yc compute instance update first-instance \ - --network-settings type=software-accelerated - ``` - - Here `--network-settings` is the option that switches over the network type. - - Result: - - ```text - id: fhm0b28lgfp4******** - folder_id: b1gbnv36zqf5******** - created_at: "2023-05-24T09:28:11Z" - name: first-instance - zone_id: {{ region-id }}-a - platform_id: standard-v3 - resources: - memory: "2147483648" - cores: "2" - core_fraction: "100" - status: STOPPED - ... - network_settings: - type: SOFTWARE_ACCELERATED - placement_policy: {} - ``` + ```bash + yc compute instance update first-instance \ + --network-settings type=software-accelerated + ``` + + Where `--network-settings` is the flag that switches the network type. + + Result: + + ```text + id: fhm0b28lgfp4******** + folder_id: b1gbnv36zqf5******** + created_at: "2023-05-24T09:28:11Z" + name: first-instance + zone_id: {{ region-id }}-a + platform_id: standard-v3 + resources: + memory: "2147483648" + cores: "2" + core_fraction: "100" + status: STOPPED + ... + network_settings: + type: SOFTWARE_ACCELERATED + placement_policy: {} + ``` 1. Run the VM: - ```bash - yc compute instance start first-instance - ``` + ```bash + yc compute instance start first-instance + ``` - To disable a software accelerated network, stop the VM and run the command: + To disable a software accelerated network, stop the VM and run the command: - ```bash - yc compute instance update first-instance \ - --network-settings type=standard - ``` + ```bash + yc compute instance update first-instance \ + --network-settings type=standard + ``` {% endlist %} diff --git a/en/vpc/operations/subnet-relocate.md b/en/vpc/operations/subnet-relocate.md index 74f351706dc..d8e76c985bd 100644 --- a/en/vpc/operations/subnet-relocate.md +++ b/en/vpc/operations/subnet-relocate.md @@ -7,7 +7,7 @@ description: Follow this guide to move a subnet to a different availability zone # Moving a subnet to a different availability zone -[Subnets](../concepts/network.md) can be moved to a different [availability zone](../../overview/concepts/geo-scope.md). You can only migrate empty subnets not hosting any VM instances or other resources. +[Subnets](../concepts/network.md) can be moved to a different [availability zone](../../overview/concepts/geo-scope.md). You can only migrate empty subnets not hosting any VMs or other resources. Make sure the subnet does not include addresses of target load balancer groups either. They prevent migration. Remove unused [target groups](../../network-load-balancer/operations/target-group-delete.md) or individual addresses. @@ -57,14 +57,14 @@ To move a subnet to a different availability zone: Where: * `--id`: ID of the subnet you need to move. - * `--destination-zone-id`: ID of the availability zone to move the subnet to. Possible values: + * `--destination-zone-id`: ID of the availability zone to move the subnet to. The possible values are: * `{{ region-id }}-a` * `{{ region-id }}-b` * `{{ region-id }}-c` * `{{ region-id }}-d` - Example: + Examples: ```bash yc vpc subnet relocate \ @@ -101,7 +101,7 @@ To move a subnet to a different availability zone: 1. Save the token to a variable. ```bash - export IAM_TOKEN= + export IAM_TOKEN= ``` 1. Prepare a `body.json` file with the request body, specifying the ID of the [availability zone](../../overview/concepts/geo-scope.md) to move the subnet to: diff --git a/en/vpc/toc.yaml b/en/vpc/toc.yaml index 9d11eba9b2d..2dda8b8d222 100644 --- a/en/vpc/toc.yaml +++ b/en/vpc/toc.yaml @@ -100,7 +100,7 @@ items: href: operations/security-group-delete.md - name: Enabling a software-accelerated network href: operations/enable-software-accelerated-network.md - - name: Protection against DDoS attacks + - name: DDoS protection items: - name: Enabling DDoS protection href: operations/enable-ddos-protection.md diff --git a/en/websql/concepts/index.md b/en/websql/concepts/index.md index 7a0b6cd536b..cc752d9dcdc 100644 --- a/en/websql/concepts/index.md +++ b/en/websql/concepts/index.md @@ -8,10 +8,10 @@ You can connect to managed database clusters from clouds and folders that belong {{ websql-full-name }} supports the following DB versions: -* {{ PG }}: 12, 13, 14, 15, 16 -* {{ MY }}: 5, 8 -* {{ CH }}: 23, 24 -* {{ RD }} (non-sharded clusters only): 6.2, 7 +* {{ PG }}: 12 and higher +* {{ MY }}: 5 and higher +* {{ CH }}: 23 and higher +* {{ RD }} (non-sharded clusters only): 6 and higher ## GUI {#user-interface} diff --git a/en/websql/index.yaml b/en/websql/index.yaml index bf0d96be9c4..b9b71efe63a 100644 --- a/en/websql/index.yaml +++ b/en/websql/index.yaml @@ -12,8 +12,8 @@ description: Hub Connection Manager and vice versa. - >- Yandex WebSQL supports the following database versions:
  • PostgreSQL: - 12, 13, 14, 15, 16.
  • MySQL: 5, 8.
  • ClickHouse®: 23, 24.
    • -
+ 12 and higher.
  • MySQL: 5 and higher.
  • ClickHouse®: 23 and + higher.
  • Redis (non-sharded clusters only): 6 and higher.
    • meta: title: Yandex WebSQL links: diff --git a/en/websql/quickstart.md b/en/websql/quickstart.md index d39dc0e86cd..8cca2648756 100644 --- a/en/websql/quickstart.md +++ b/en/websql/quickstart.md @@ -6,10 +6,10 @@ Once connected to a database, you will be able to view DB schemas, tables, and v {{ websql-full-name }} supports the following DB versions: -* {{ PG }}: 12, 13, 14, 15, 16 -* {{ MY }}: 5, 8 -* {{ CH }}: 23, 24 -* {{ RD }} (non-sharded clusters only): 6.2, 7 +* {{ PG }}: 12 and higher +* {{ MY }}: 5 and higher +* {{ CH }}: 23 and higher +* {{ RD }} (non-sharded clusters only): 6 and higher In this section, you will learn how to connect to: diff --git a/en/websql/release-notes/index.md b/en/websql/release-notes/index.md index 40cdaba637f..86cd7998942 100644 --- a/en/websql/release-notes/index.md +++ b/en/websql/release-notes/index.md @@ -5,6 +5,26 @@ description: This section contains {{ websql-name }} release notes. # {{ websql-full-name }} release notes: 2024 +## September {#september} + +### New features {#new-features-september} + +1. Now you can [connect](../quickstart.md) to unsharded {{ RD }} clusters. + +1. Added the [`websql.auditor`](../security/index.md#websql-auditor), [`websql.executedQueries.auditor`](../security/index.md#websql-executedqueries-auditor), and [`websql.savedQueries.auditor`](../security/index.md#websql-savedqueries-auditor) roles for viewing metadata requests and permissions to access them. + +### Improvements {#improvements-september} + +1. Added the experiment of displaying connections as database users. + +1. {{ PG }} tables are now displayed as database objects even if the user does not have access to these tables. + +1. Added the display of empty {{ PG }} schemas to the list of database objects. + +### Fixed issues {#fixes-september} + +Configured the backend request timeout as 25 seconds. + ## August {#august} ### Improvements {#improvements-august} diff --git a/en/yandexgpt/pricing.md b/en/yandexgpt/pricing.md index c11d91df4a0..7907d6b6178 100644 --- a/en/yandexgpt/pricing.md +++ b/en/yandexgpt/pricing.md @@ -8,7 +8,7 @@ editable: false {% include [link-to-price-list](../_includes/pricing/link-to-price-list.md) %} -{{ yagpt-full-name }} is at the [Preview stage](../overview/concepts/launch-stages.md) and is part of {{ foundation-models-full-name }}. The service is billed according to the [Special Terms of Use](https://yandex.ru/legal/cloud_specialterms/?lang=en#index__section_fk5_d4c_cgb). You can find {{ yagpt-full-name }} usage details in {{ billing-name }} as {{ foundation-models-full-name }} resource usage. +{{ yagpt-full-name }} is at the [Preview stage](../overview/concepts/launch-stages.md) and is part of {{ foundation-models-full-name }}. The service is billed as per the [Special Terms of Use](https://yandex.ru/legal/cloud_specialterms/?lang=en#index__section_fk5_d4c_cgb). You can find {{ yagpt-full-name }} usage details in {{ billing-name }} as {{ foundation-models-full-name }} resource usage. In the [management console]({{ link-console-main }}/link/yandexgpt), {{ gpt-freetier }} free prompts per hour are available to new users without a [billing account](../billing/concepts/billing-account.md). diff --git a/en/yandexgpt/text-generation/api-ref/TextGeneration/completion.md b/en/yandexgpt/text-generation/api-ref/TextGeneration/completion.md index 1719f3b1d5b..ae0b2d5b77e 100644 --- a/en/yandexgpt/text-generation/api-ref/TextGeneration/completion.md +++ b/en/yandexgpt/text-generation/api-ref/TextGeneration/completion.md @@ -26,8 +26,45 @@ POST https://llm.{{ api-host }}/foundationModels/v1/completion "messages": [ { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "object" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } + // end of the list of possible fields + } + ], + "tools": [ + { + // Includes only one of the fields `function` + "function": { + "name": "string", + "description": "string", + "parameters": "object" + } // end of the list of possible fields } ] @@ -47,6 +84,10 @@ Configuration options for completion generation. || || messages[] | **[Message](#yandex.cloud.ai.foundation_models.v1.Message)** A list of messages representing the context for the completion model. || +|| tools[] | **[Tool](#yandex.cloud.ai.foundation_models.v1.Tool)** + +List of tools that are available for the model to invoke during the completion generation. +Note: This parameter is not yet supported and will be ignored if provided. || |# ## CompletionOptions {#yandex.cloud.ai.foundation_models.v1.CompletionOptions} @@ -85,9 +126,134 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **object** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + +## Tool {#yandex.cloud.ai.foundation_models.v1.Tool} + +Represents a tool that can be invoked during completion generation. + +#| +||Field | Description || +|| function | **[FunctionTool](#yandex.cloud.ai.foundation_models.v1.FunctionTool)** + +Represents a function that can be called. + +Includes only one of the fields `function`. || +|# + +## FunctionTool {#yandex.cloud.ai.foundation_models.v1.FunctionTool} + +Represents a function tool that can be invoked during completion generation. + +#| +||Field | Description || +|| name | **string** + +The name of the function. || +|| description | **string** + +A description of the function's purpose or behavior. || +|| parameters | **object** + +A JSON Schema that defines the expected parameters for the function. +The schema should describe the required fields, their types, and any constraints or default values. || |# ## Response {#yandex.cloud.ai.foundation_models.v1.CompletionResponse} @@ -100,8 +266,34 @@ Message content. || { "message": { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "object" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } // end of the list of possible fields }, "status": "string" @@ -149,7 +341,8 @@ The generation status of the alternative - `ALTERNATIVE_STATUS_TRUNCATED_FINAL`: Incomplete final alternative resulting from reaching the maximum allowed number of tokens. - `ALTERNATIVE_STATUS_FINAL`: Final alternative generated without running into any limits. - `ALTERNATIVE_STATUS_CONTENT_FILTER`: Generation was stopped due to the discovery of potentially sensitive content in the prompt or generated response. -To fix, modify the prompt and restart generation. || +To fix, modify the prompt and restart generation. +- `ALTERNATIVE_STATUS_TOOL_CALLS`: Tools were invoked during the completion generation. || |# ## Message {#yandex.cloud.ai.foundation_models.v1.Message2} @@ -168,9 +361,103 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList2)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList2)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList2} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall2)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall2} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall2)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall2} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **object** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList2} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult2)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult2} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult2)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult2} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || |# ## ContentUsage {#yandex.cloud.ai.foundation_models.v1.ContentUsage} diff --git a/en/yandexgpt/text-generation/api-ref/TextGenerationAsync/completion.md b/en/yandexgpt/text-generation/api-ref/TextGenerationAsync/completion.md index 88c5d34ebec..f6f4fa61b0e 100644 --- a/en/yandexgpt/text-generation/api-ref/TextGenerationAsync/completion.md +++ b/en/yandexgpt/text-generation/api-ref/TextGenerationAsync/completion.md @@ -26,8 +26,45 @@ POST https://llm.{{ api-host }}/foundationModels/v1/completionAsync "messages": [ { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "object" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } + // end of the list of possible fields + } + ], + "tools": [ + { + // Includes only one of the fields `function` + "function": { + "name": "string", + "description": "string", + "parameters": "object" + } // end of the list of possible fields } ] @@ -47,6 +84,10 @@ Configuration options for completion generation. || || messages[] | **[Message](#yandex.cloud.ai.foundation_models.v1.Message)** A list of messages representing the context for the completion model. || +|| tools[] | **[Tool](#yandex.cloud.ai.foundation_models.v1.Tool)** + +List of tools that are available for the model to invoke during the completion generation. +Note: This parameter is not yet supported and will be ignored if provided. || |# ## CompletionOptions {#yandex.cloud.ai.foundation_models.v1.CompletionOptions} @@ -85,9 +126,134 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **object** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + +## Tool {#yandex.cloud.ai.foundation_models.v1.Tool} + +Represents a tool that can be invoked during completion generation. + +#| +||Field | Description || +|| function | **[FunctionTool](#yandex.cloud.ai.foundation_models.v1.FunctionTool)** + +Represents a function that can be called. + +Includes only one of the fields `function`. || +|# + +## FunctionTool {#yandex.cloud.ai.foundation_models.v1.FunctionTool} + +Represents a function tool that can be invoked during completion generation. + +#| +||Field | Description || +|| name | **string** + +The name of the function. || +|| description | **string** + +A description of the function's purpose or behavior. || +|| parameters | **object** + +A JSON Schema that defines the expected parameters for the function. +The schema should describe the required fields, their types, and any constraints or default values. || |# ## Response {#yandex.cloud.operation.Operation} @@ -116,8 +282,34 @@ Message content. || { "message": { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "object" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } // end of the list of possible fields }, "status": "string" @@ -255,7 +447,8 @@ The generation status of the alternative - `ALTERNATIVE_STATUS_TRUNCATED_FINAL`: Incomplete final alternative resulting from reaching the maximum allowed number of tokens. - `ALTERNATIVE_STATUS_FINAL`: Final alternative generated without running into any limits. - `ALTERNATIVE_STATUS_CONTENT_FILTER`: Generation was stopped due to the discovery of potentially sensitive content in the prompt or generated response. -To fix, modify the prompt and restart generation. || +To fix, modify the prompt and restart generation. +- `ALTERNATIVE_STATUS_TOOL_CALLS`: Tools were invoked during the completion generation. || |# ## Message {#yandex.cloud.ai.foundation_models.v1.Message2} @@ -274,11 +467,105 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList2)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList2)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || |# +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList2} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall2)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall2} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall2)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall2} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **object** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList2} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult2)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult2} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult2)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult2} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + ## ContentUsage {#yandex.cloud.ai.foundation_models.v1.ContentUsage} An object representing the number of content [tokens](/docs/foundation-models/concepts/yandexgpt/tokens) used by the completion model. diff --git a/en/yandexgpt/text-generation/api-ref/Tokenizer/tokenizeCompletion.md b/en/yandexgpt/text-generation/api-ref/Tokenizer/tokenizeCompletion.md index a1e1261d98f..73a37220d12 100644 --- a/en/yandexgpt/text-generation/api-ref/Tokenizer/tokenizeCompletion.md +++ b/en/yandexgpt/text-generation/api-ref/Tokenizer/tokenizeCompletion.md @@ -26,8 +26,45 @@ POST https://llm.{{ api-host }}/foundationModels/v1/tokenizeCompletion "messages": [ { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "object" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } + // end of the list of possible fields + } + ], + "tools": [ + { + // Includes only one of the fields `function` + "function": { + "name": "string", + "description": "string", + "parameters": "object" + } // end of the list of possible fields } ] @@ -47,6 +84,10 @@ Configuration options for completion generation. || || messages[] | **[Message](#yandex.cloud.ai.foundation_models.v1.Message)** A list of messages representing the context for the completion model. || +|| tools[] | **[Tool](#yandex.cloud.ai.foundation_models.v1.Tool)** + +List of tools that are available for the model to invoke during the completion generation. +Note: This parameter is not yet supported and will be ignored if provided. || |# ## CompletionOptions {#yandex.cloud.ai.foundation_models.v1.CompletionOptions} @@ -85,9 +126,134 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **object** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + +## Tool {#yandex.cloud.ai.foundation_models.v1.Tool} + +Represents a tool that can be invoked during completion generation. + +#| +||Field | Description || +|| function | **[FunctionTool](#yandex.cloud.ai.foundation_models.v1.FunctionTool)** + +Represents a function that can be called. + +Includes only one of the fields `function`. || +|# + +## FunctionTool {#yandex.cloud.ai.foundation_models.v1.FunctionTool} + +Represents a function tool that can be invoked during completion generation. + +#| +||Field | Description || +|| name | **string** + +The name of the function. || +|| description | **string** + +A description of the function's purpose or behavior. || +|| parameters | **object** + +A JSON Schema that defines the expected parameters for the function. +The schema should describe the required fields, their types, and any constraints or default values. || |# ## Response {#yandex.cloud.ai.foundation_models.v1.TokenizeResponse} diff --git a/en/yandexgpt/text-generation/api-ref/grpc/TextGeneration/completion.md b/en/yandexgpt/text-generation/api-ref/grpc/TextGeneration/completion.md index d75fb715107..028f8fdfa46 100644 --- a/en/yandexgpt/text-generation/api-ref/grpc/TextGeneration/completion.md +++ b/en/yandexgpt/text-generation/api-ref/grpc/TextGeneration/completion.md @@ -24,8 +24,45 @@ A method for generating text completions in [synchronous mode](/docs/foundation- "messages": [ { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "google.protobuf.Struct" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } + // end of the list of possible fields + } + ], + "tools": [ + { + // Includes only one of the fields `function` + "function": { + "name": "string", + "description": "string", + "parameters": "google.protobuf.Struct" + } // end of the list of possible fields } ] @@ -45,6 +82,10 @@ Configuration options for completion generation. || || messages[] | **[Message](#yandex.cloud.ai.foundation_models.v1.Message)** A list of messages representing the context for the completion model. || +|| tools[] | **[Tool](#yandex.cloud.ai.foundation_models.v1.Tool)** + +List of tools that are available for the model to invoke during the completion generation. +Note: This parameter is not yet supported and will be ignored if provided. || |# ## CompletionOptions {#yandex.cloud.ai.foundation_models.v1.CompletionOptions} @@ -83,9 +124,134 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + +## Tool {#yandex.cloud.ai.foundation_models.v1.Tool} + +Represents a tool that can be invoked during completion generation. + +#| +||Field | Description || +|| function | **[FunctionTool](#yandex.cloud.ai.foundation_models.v1.FunctionTool)** + +Represents a function that can be called. + +Includes only one of the fields `function`. || +|# + +## FunctionTool {#yandex.cloud.ai.foundation_models.v1.FunctionTool} + +Represents a function tool that can be invoked during completion generation. + +#| +||Field | Description || +|| name | **string** + +The name of the function. || +|| description | **string** + +A description of the function's purpose or behavior. || +|| parameters | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +A JSON Schema that defines the expected parameters for the function. +The schema should describe the required fields, their types, and any constraints or default values. || |# ## CompletionResponse {#yandex.cloud.ai.foundation_models.v1.CompletionResponse} @@ -96,8 +262,34 @@ Message content. || { "message": { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "google.protobuf.Struct" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } // end of the list of possible fields }, "status": "AlternativeStatus" @@ -145,7 +337,8 @@ The generation status of the alternative - `ALTERNATIVE_STATUS_TRUNCATED_FINAL`: Incomplete final alternative resulting from reaching the maximum allowed number of tokens. - `ALTERNATIVE_STATUS_FINAL`: Final alternative generated without running into any limits. - `ALTERNATIVE_STATUS_CONTENT_FILTER`: Generation was stopped due to the discovery of potentially sensitive content in the prompt or generated response. -To fix, modify the prompt and restart generation. || +To fix, modify the prompt and restart generation. +- `ALTERNATIVE_STATUS_TOOL_CALLS`: Tools were invoked during the completion generation. || |# ## Message {#yandex.cloud.ai.foundation_models.v1.Message2} @@ -164,9 +357,103 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList2)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList2)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList2} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall2)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall2} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall2)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall2} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList2} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult2)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult2} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult2)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult2} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || |# ## ContentUsage {#yandex.cloud.ai.foundation_models.v1.ContentUsage} diff --git a/en/yandexgpt/text-generation/api-ref/grpc/TextGenerationAsync/completion.md b/en/yandexgpt/text-generation/api-ref/grpc/TextGenerationAsync/completion.md index 5c0b9687bfd..37d669b9f21 100644 --- a/en/yandexgpt/text-generation/api-ref/grpc/TextGenerationAsync/completion.md +++ b/en/yandexgpt/text-generation/api-ref/grpc/TextGenerationAsync/completion.md @@ -24,8 +24,45 @@ A method for generating text completions in [asynchronous mode](/docs/foundation "messages": [ { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "google.protobuf.Struct" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } + // end of the list of possible fields + } + ], + "tools": [ + { + // Includes only one of the fields `function` + "function": { + "name": "string", + "description": "string", + "parameters": "google.protobuf.Struct" + } // end of the list of possible fields } ] @@ -45,6 +82,10 @@ Configuration options for completion generation. || || messages[] | **[Message](#yandex.cloud.ai.foundation_models.v1.Message)** A list of messages representing the context for the completion model. || +|| tools[] | **[Tool](#yandex.cloud.ai.foundation_models.v1.Tool)** + +List of tools that are available for the model to invoke during the completion generation. +Note: This parameter is not yet supported and will be ignored if provided. || |# ## CompletionOptions {#yandex.cloud.ai.foundation_models.v1.CompletionOptions} @@ -83,9 +124,134 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + +## Tool {#yandex.cloud.ai.foundation_models.v1.Tool} + +Represents a tool that can be invoked during completion generation. + +#| +||Field | Description || +|| function | **[FunctionTool](#yandex.cloud.ai.foundation_models.v1.FunctionTool)** + +Represents a function that can be called. + +Includes only one of the fields `function`. || +|# + +## FunctionTool {#yandex.cloud.ai.foundation_models.v1.FunctionTool} + +Represents a function tool that can be invoked during completion generation. + +#| +||Field | Description || +|| name | **string** + +The name of the function. || +|| description | **string** + +A description of the function's purpose or behavior. || +|| parameters | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +A JSON Schema that defines the expected parameters for the function. +The schema should describe the required fields, their types, and any constraints or default values. || |# ## operation.Operation {#yandex.cloud.operation.Operation} @@ -106,8 +272,34 @@ Message content. || { "message": { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "google.protobuf.Struct" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } // end of the list of possible fields }, "status": "AlternativeStatus" @@ -214,7 +406,8 @@ The generation status of the alternative - `ALTERNATIVE_STATUS_TRUNCATED_FINAL`: Incomplete final alternative resulting from reaching the maximum allowed number of tokens. - `ALTERNATIVE_STATUS_FINAL`: Final alternative generated without running into any limits. - `ALTERNATIVE_STATUS_CONTENT_FILTER`: Generation was stopped due to the discovery of potentially sensitive content in the prompt or generated response. -To fix, modify the prompt and restart generation. || +To fix, modify the prompt and restart generation. +- `ALTERNATIVE_STATUS_TOOL_CALLS`: Tools were invoked during the completion generation. || |# ## Message {#yandex.cloud.ai.foundation_models.v1.Message2} @@ -233,11 +426,105 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList2)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList2)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || |# +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList2} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall2)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall2} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall2)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall2} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList2} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult2)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult2} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult2)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult2} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + ## ContentUsage {#yandex.cloud.ai.foundation_models.v1.ContentUsage} An object representing the number of content [tokens](/docs/foundation-models/concepts/yandexgpt/tokens) used by the completion model. diff --git a/en/yandexgpt/text-generation/api-ref/grpc/Tokenizer/tokenizeCompletion.md b/en/yandexgpt/text-generation/api-ref/grpc/Tokenizer/tokenizeCompletion.md index f7155869ab0..d72df7fd1c9 100644 --- a/en/yandexgpt/text-generation/api-ref/grpc/Tokenizer/tokenizeCompletion.md +++ b/en/yandexgpt/text-generation/api-ref/grpc/Tokenizer/tokenizeCompletion.md @@ -24,8 +24,45 @@ RPC method for tokenizing content of CompletionRequest "messages": [ { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "google.protobuf.Struct" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } + // end of the list of possible fields + } + ], + "tools": [ + { + // Includes only one of the fields `function` + "function": { + "name": "string", + "description": "string", + "parameters": "google.protobuf.Struct" + } // end of the list of possible fields } ] @@ -45,6 +82,10 @@ Configuration options for completion generation. || || messages[] | **[Message](#yandex.cloud.ai.foundation_models.v1.Message)** A list of messages representing the context for the completion model. || +|| tools[] | **[Tool](#yandex.cloud.ai.foundation_models.v1.Tool)** + +List of tools that are available for the model to invoke during the completion generation. +Note: This parameter is not yet supported and will be ignored if provided. || |# ## CompletionOptions {#yandex.cloud.ai.foundation_models.v1.CompletionOptions} @@ -83,9 +124,134 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + +## Tool {#yandex.cloud.ai.foundation_models.v1.Tool} + +Represents a tool that can be invoked during completion generation. + +#| +||Field | Description || +|| function | **[FunctionTool](#yandex.cloud.ai.foundation_models.v1.FunctionTool)** + +Represents a function that can be called. + +Includes only one of the fields `function`. || +|# + +## FunctionTool {#yandex.cloud.ai.foundation_models.v1.FunctionTool} + +Represents a function tool that can be invoked during completion generation. + +#| +||Field | Description || +|| name | **string** + +The name of the function. || +|| description | **string** + +A description of the function's purpose or behavior. || +|| parameters | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +A JSON Schema that defines the expected parameters for the function. +The schema should describe the required fields, their types, and any constraints or default values. || |# ## TokenizeResponse {#yandex.cloud.ai.foundation_models.v1.TokenizeResponse} diff --git a/en/ydb/docapi/tools/aws-http.md b/en/ydb/docapi/tools/aws-http.md index b78d861c753..6a77e198264 100644 --- a/en/ydb/docapi/tools/aws-http.md +++ b/en/ydb/docapi/tools/aws-http.md @@ -14,29 +14,29 @@ For HTTP queries, the examples in the section use the [cURL](https://curl.se/) u 1. If you do not have the {{ yandex-cloud }} command line interface yet, [install and initialize it](../../../cli/quickstart.md#install). 1. Prepare the Document API endpoint of the [created database](../../operations/manage-databases.md). - {% cut "How do I find out the Document API endpoint of a database?" %} + {% cut "How do I find out the Document API endpoint of a database?" %} - 1. Go to the [management console]({{ link-console-main }}). - 1. Select the folder and go to **{{ ui-key.yacloud.iam.folder.dashboard.label_ydb }}**. - 1. Select the database you want to query. - 1. In the menu on the left, go to the **{{ ui-key.yacloud.ydb.database.switch_overview }}** section. - 1. The endpoint value is in the **{{ ui-key.yacloud.ydb.overview.label_document-endpoint }}** line. + 1. Go to the [management console]({{ link-console-main }}). + 1. Select the folder and go to **{{ ui-key.yacloud.iam.folder.dashboard.label_ydb }}**. + 1. Select the database you want to query. + 1. In the menu on the left, go to the **{{ ui-key.yacloud.ydb.database.switch_overview }}** section. + 1. The endpoint value is in the **{{ ui-key.yacloud.ydb.overview.label_document-endpoint }}** line. - Example of an `{{ ydb.aws-ep }}` endpoint value. + Example of an `{{ ydb.aws-ep }}` endpoint value. - {% endcut %} + {% endcut %} - {% note info %} + {% note info %} - For the Amazon DynamoDB-compatible mode, use a serverless database configuration. + For the Amazon DynamoDB-compatible mode, use a serverless database configuration. - {% endnote %} + {% endnote %} 1. Set the `ENDPOINT` environment variable to the prepared value: - ```bash - export ENDPOINT= - ``` + ```bash + export ENDPOINT= + ``` ## Creating a table {#create-table} @@ -44,47 +44,47 @@ For HTTP queries, the examples in the section use the [cURL](https://curl.se/) u - HTTP interface - Set the table configuration in the `create.json` file: - - ```json - { - "TableName": "test/pets", - "AttributeDefinitions": - [ - { - "AttributeName": "species", - "AttributeType": "S" - }, - { - "AttributeName": "name", - "AttributeType": "S" - } - ], - "KeySchema": - [ - { - "AttributeName": "species", - "KeyType": "HASH" - }, - { - "AttributeName": "name", - "KeyType": "RANGE" - } - ] - } - ``` - - Create a document table in the database using the command: - - ```bash - curl \ - -H 'X-Amz-Target: DynamoDB_20120810.CreateTable' \ - -H "Authorization: Bearer $(yc iam create-token)" \ - -H "Content-Type: application.json" \ - -d @create.json $ENDPOINT - ``` - - For more information about the `CreateTable` method, see the [Document API reference](../../docapi/api-ref/actions/createTable.md). + Set the table configuration in the `create.json` file: + + ```json + { + "TableName": "test/pets", + "AttributeDefinitions": + [ + { + "AttributeName": "species", + "AttributeType": "S" + }, + { + "AttributeName": "name", + "AttributeType": "S" + } + ], + "KeySchema": + [ + { + "AttributeName": "species", + "KeyType": "HASH" + }, + { + "AttributeName": "name", + "KeyType": "RANGE" + } + ] + } + ``` + + Create a document table in the database using the command: + + ```bash + curl \ + --header 'X-Amz-Target: DynamoDB_20120810.CreateTable' \ + --header "Authorization: Bearer $(yc iam create-token)" \ + --header "Content-Type: application.json" \ + --data @create.json $ENDPOINT + ``` + + For more information about the `CreateTable` method, see the [Document API reference](../../docapi/api-ref/actions/createTable.md). {% endlist %} @@ -94,32 +94,32 @@ For HTTP queries, the examples in the section use the [cURL](https://curl.se/) u - HTTP interface - Prepare data to save to the document table by creating a file named `put.json`: - - ```json - { - "TableName": "test/pets", - "Item": - { - "species": {"S": "cat"}, - "name": {"S": "Tom"}, - "color": {"S": "black"}, - "price": {"N": "10.5"} - } - } - ``` - - Add the data to the table using the command: - - ```bash - curl \ - -H 'X-Amz-Target: DynamoDB_20120810.PutItem' \ - -H "Authorization: Bearer $(yc iam create-token)" \ - -H "Content-Type: application.json" \ - -d @put.json $ENDPOINT - ``` - - For more information about the `PutItem` method, see the [Document API reference](../../docapi/api-ref/actions/putItem.md). + Prepare data to save to the document table by creating a file named `put.json`: + + ```json + { + "TableName": "test/pets", + "Item": + { + "species": {"S": "cat"}, + "name": {"S": "Tom"}, + "color": {"S": "black"}, + "price": {"N": "10.5"} + } + } + ``` + + Add the data to the table using the command: + + ```bash + curl \ + --header 'X-Amz-Target: DynamoDB_20120810.PutItem' \ + --header "Authorization: Bearer $(yc iam create-token)" \ + --header "Content-Type: application.json" \ + --data @put.json $ENDPOINT + ``` + + For more information about the `PutItem` method, see the [Document API reference](../../docapi/api-ref/actions/putItem.md). {% endlist %} @@ -129,23 +129,23 @@ For HTTP queries, the examples in the section use the [cURL](https://curl.se/) u - HTTP interface - To read the data from the document table, run the command: + To read the data from the document table, run the command: - ```bash - curl \ - -H 'X-Amz-Target: DynamoDB_20120810.GetItem' \ - -H "Authorization: Bearer $(yc iam create-token)" \ - -H "Content-Type: application.json" \ - -d '{"TableName": "test/pets", "Key": {"species":{"S":"cat"}, "name":{"S":"Tom"}}}' \ - $ENDPOINT - ``` + ```bash + curl \ + --header 'X-Amz-Target: DynamoDB_20120810.GetItem' \ + --header "Authorization: Bearer $(yc iam create-token)" \ + --header "Content-Type: application.json" \ + --data '{"TableName": "test/pets", "Key": {"species":{"S":"cat"}, "name":{"S":"Tom"}}}' \ + $ENDPOINT + ``` - Result: + Result: - ```text - {"Item":{"name":{"S":"Tom"},"species":{"S":"cat"},"color":{"S":"black"},"price":{"N":"10.5"}}} - ``` + ```text + {"Item":{"name":{"S":"Tom"},"species":{"S":"cat"},"color":{"S":"black"},"price":{"N":"10.5"}}} + ``` - For more information about the `GetItem` method, see the [Document API reference](../../docapi/api-ref/actions/getItem.md). + For more information about the `GetItem` method, see the [Document API reference](../../docapi/api-ref/actions/getItem.md). {% endlist %} diff --git a/ru/_assets/console-icons/magnifier.svg b/ru/_assets/console-icons/magnifier.svg new file mode 100644 index 00000000000..4ed25354290 --- /dev/null +++ b/ru/_assets/console-icons/magnifier.svg @@ -0,0 +1,3 @@ + + + diff --git a/ru/_assets/create.png b/ru/_assets/create.png deleted file mode 100644 index 7b9c82d0cfb..00000000000 Binary files a/ru/_assets/create.png and /dev/null differ diff --git a/ru/_assets/datalens/concepts/widget.png b/ru/_assets/datalens/concepts/widget.png index 1aececb5e3c..dbbbae92145 100644 Binary files a/ru/_assets/datalens/concepts/widget.png and b/ru/_assets/datalens/concepts/widget.png differ diff --git a/ru/_assets/datalens/operations/connection/analytics-detailed-dash-1.png b/ru/_assets/datalens/operations/connection/analytics-detailed-dash-1.png new file mode 100644 index 00000000000..acba196b684 Binary files /dev/null and b/ru/_assets/datalens/operations/connection/analytics-detailed-dash-1.png differ diff --git a/ru/_assets/datalens/operations/connection/analytics-detailed-dash-2.png b/ru/_assets/datalens/operations/connection/analytics-detailed-dash-2.png new file mode 100644 index 00000000000..99186e550f5 Binary files /dev/null and b/ru/_assets/datalens/operations/connection/analytics-detailed-dash-2.png differ diff --git a/ru/_assets/datalens/operations/connection/analytics-detailed-dash-3.png b/ru/_assets/datalens/operations/connection/analytics-detailed-dash-3.png new file mode 100644 index 00000000000..a6ee2622e69 Binary files /dev/null and b/ru/_assets/datalens/operations/connection/analytics-detailed-dash-3.png differ diff --git a/ru/_assets/datalens/operations/connection/analytics-light-dash-1.png b/ru/_assets/datalens/operations/connection/analytics-light-dash-1.png new file mode 100644 index 00000000000..39de09d13ff Binary files /dev/null and b/ru/_assets/datalens/operations/connection/analytics-light-dash-1.png differ diff --git a/ru/_assets/datalens/operations/connection/analytics-light-dash-2.png b/ru/_assets/datalens/operations/connection/analytics-light-dash-2.png new file mode 100644 index 00000000000..9442c4bce4c Binary files /dev/null and b/ru/_assets/datalens/operations/connection/analytics-light-dash-2.png differ diff --git a/ru/_assets/datalens/solution-03/01-metrica-list.png b/ru/_assets/datalens/solution-03/01-metrica-list.png index fcaa99e8a2a..ea6a4a587a2 100755 Binary files a/ru/_assets/datalens/solution-03/01-metrica-list.png and b/ru/_assets/datalens/solution-03/01-metrica-list.png differ diff --git a/ru/_assets/datalens/solution-03/03-choose-metrica.png b/ru/_assets/datalens/solution-03/03-choose-metrica.png deleted file mode 100755 index d448a2a8162..00000000000 Binary files a/ru/_assets/datalens/solution-03/03-choose-metrica.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-03/03-create-metrica-coonection.png b/ru/_assets/datalens/solution-03/03-create-metrica-coonection.png new file mode 100644 index 00000000000..c4fb5eafc9d Binary files /dev/null and b/ru/_assets/datalens/solution-03/03-create-metrica-coonection.png differ diff --git a/ru/_assets/datalens/solution-03/04-metrica-creation1.png b/ru/_assets/datalens/solution-03/04-metrica-creation1.png deleted file mode 100755 index 4e44f91c19c..00000000000 Binary files a/ru/_assets/datalens/solution-03/04-metrica-creation1.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-03/04-metrica-objects-list.png b/ru/_assets/datalens/solution-03/04-metrica-objects-list.png new file mode 100644 index 00000000000..e12f78458c2 Binary files /dev/null and b/ru/_assets/datalens/solution-03/04-metrica-objects-list.png differ diff --git a/ru/_assets/datalens/solution-03/05-metrica-creation2.png b/ru/_assets/datalens/solution-03/05-metrica-creation2.png deleted file mode 100755 index d7b1b095088..00000000000 Binary files a/ru/_assets/datalens/solution-03/05-metrica-creation2.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-03/06-01-metrica-creation-accuracy.png b/ru/_assets/datalens/solution-03/06-01-metrica-creation-accuracy.png deleted file mode 100644 index 925a88f9044..00000000000 Binary files a/ru/_assets/datalens/solution-03/06-01-metrica-creation-accuracy.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-03/06-metrica-creation3.png b/ru/_assets/datalens/solution-03/06-metrica-creation3.png deleted file mode 100755 index 488348efac9..00000000000 Binary files a/ru/_assets/datalens/solution-03/06-metrica-creation3.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-03/07-open-dashboard.png b/ru/_assets/datalens/solution-03/07-open-dashboard.png deleted file mode 100755 index 2877b8638f3..00000000000 Binary files a/ru/_assets/datalens/solution-03/07-open-dashboard.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-03/09-edit-dashboard.png b/ru/_assets/datalens/solution-03/09-edit-dashboard.png deleted file mode 100755 index 48994271eee..00000000000 Binary files a/ru/_assets/datalens/solution-03/09-edit-dashboard.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-03/10-delete-charts1.png b/ru/_assets/datalens/solution-03/10-delete-charts1.png index acaaef32e05..90d61500572 100755 Binary files a/ru/_assets/datalens/solution-03/10-delete-charts1.png and b/ru/_assets/datalens/solution-03/10-delete-charts1.png differ diff --git a/ru/_assets/datalens/solution-03/11-replace-charts.png b/ru/_assets/datalens/solution-03/11-replace-charts.png index 070d4f6db42..33f11407c40 100755 Binary files a/ru/_assets/datalens/solution-03/11-replace-charts.png and b/ru/_assets/datalens/solution-03/11-replace-charts.png differ diff --git a/ru/_assets/datalens/solution-03/12-delete-charts2.png b/ru/_assets/datalens/solution-03/12-delete-charts2.png deleted file mode 100755 index 92e74ff2b68..00000000000 Binary files a/ru/_assets/datalens/solution-03/12-delete-charts2.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-03/13-save-dashboard.png b/ru/_assets/datalens/solution-03/13-save-dashboard.png deleted file mode 100755 index 121195e129e..00000000000 Binary files a/ru/_assets/datalens/solution-03/13-save-dashboard.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-03/14-edit-chart.png b/ru/_assets/datalens/solution-03/14-edit-chart.png index ce7c4c396e1..a75dc17d6a8 100644 Binary files a/ru/_assets/datalens/solution-03/14-edit-chart.png and b/ru/_assets/datalens/solution-03/14-edit-chart.png differ diff --git a/ru/_assets/datalens/solution-03/15-choose-pie.png b/ru/_assets/datalens/solution-03/15-choose-pie.png index e75dd89a458..693cacd98f9 100755 Binary files a/ru/_assets/datalens/solution-03/15-choose-pie.png and b/ru/_assets/datalens/solution-03/15-choose-pie.png differ diff --git a/ru/_assets/datalens/solution-03/16-save-chart.png b/ru/_assets/datalens/solution-03/16-save-chart.png deleted file mode 100755 index f77582adef7..00000000000 Binary files a/ru/_assets/datalens/solution-03/16-save-chart.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-03/17-refresh-dashboard.png b/ru/_assets/datalens/solution-03/17-refresh-dashboard.png index 4c431221227..27333dbc6fa 100755 Binary files a/ru/_assets/datalens/solution-03/17-refresh-dashboard.png and b/ru/_assets/datalens/solution-03/17-refresh-dashboard.png differ diff --git a/ru/_assets/datalens/solution-09/00-organization-list.png b/ru/_assets/datalens/solution-09/00-organization-list.png deleted file mode 100644 index 2c5690296ac..00000000000 Binary files a/ru/_assets/datalens/solution-09/00-organization-list.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/01-add-field.png b/ru/_assets/datalens/solution-09/01-add-field.png deleted file mode 100644 index aa473cb60f8..00000000000 Binary files a/ru/_assets/datalens/solution-09/01-add-field.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/01-workbook-choose.png b/ru/_assets/datalens/solution-09/01-workbook-choose.png new file mode 100644 index 00000000000..7e6344779d1 Binary files /dev/null and b/ru/_assets/datalens/solution-09/01-workbook-choose.png differ diff --git a/ru/_assets/datalens/solution-09/02-add-measure-selector.png b/ru/_assets/datalens/solution-09/02-add-measure-selector.png deleted file mode 100644 index 6a4b32eb67a..00000000000 Binary files a/ru/_assets/datalens/solution-09/02-add-measure-selector.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/03-2-bread-crumbs.png b/ru/_assets/datalens/solution-09/03-2-bread-crumbs.png new file mode 100644 index 00000000000..e667143ec9f Binary files /dev/null and b/ru/_assets/datalens/solution-09/03-2-bread-crumbs.png differ diff --git a/ru/_assets/datalens/solution-09/03-bar-chart.png b/ru/_assets/datalens/solution-09/03-bar-chart.png deleted file mode 100644 index 1da563c8d63..00000000000 Binary files a/ru/_assets/datalens/solution-09/03-bar-chart.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/03-dashboard-90.png b/ru/_assets/datalens/solution-09/03-dashboard-90.png new file mode 100644 index 00000000000..5772765e8d9 Binary files /dev/null and b/ru/_assets/datalens/solution-09/03-dashboard-90.png differ diff --git a/ru/_assets/datalens/solution-09/04-bar-chart-1.png b/ru/_assets/datalens/solution-09/04-bar-chart-1.png deleted file mode 100644 index fdc19febe8d..00000000000 Binary files a/ru/_assets/datalens/solution-09/04-bar-chart-1.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/04-create-connection.png b/ru/_assets/datalens/solution-09/04-create-connection.png new file mode 100644 index 00000000000..c9653d5a4be Binary files /dev/null and b/ru/_assets/datalens/solution-09/04-create-connection.png differ diff --git a/ru/_assets/datalens/solution-09/05-chart-tab.png b/ru/_assets/datalens/solution-09/05-chart-tab.png deleted file mode 100644 index 9ab84939350..00000000000 Binary files a/ru/_assets/datalens/solution-09/05-chart-tab.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/05-drag-table.png b/ru/_assets/datalens/solution-09/05-drag-table.png new file mode 100644 index 00000000000..55a26130c25 Binary files /dev/null and b/ru/_assets/datalens/solution-09/05-drag-table.png differ diff --git a/ru/_assets/datalens/solution-09/06-colour-settings.png b/ru/_assets/datalens/solution-09/06-colour-settings.png deleted file mode 100644 index 8dbbca452a9..00000000000 Binary files a/ru/_assets/datalens/solution-09/06-colour-settings.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/06-field-changes.png b/ru/_assets/datalens/solution-09/06-field-changes.png new file mode 100644 index 00000000000..3002f439cc3 Binary files /dev/null and b/ru/_assets/datalens/solution-09/06-field-changes.png differ diff --git a/ru/_assets/datalens/solution-09/07-create-chart.png b/ru/_assets/datalens/solution-09/07-create-chart.png deleted file mode 100644 index 59d5d361438..00000000000 Binary files a/ru/_assets/datalens/solution-09/07-create-chart.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/07-dublicate-field.png b/ru/_assets/datalens/solution-09/07-dublicate-field.png new file mode 100644 index 00000000000..436832b277e Binary files /dev/null and b/ru/_assets/datalens/solution-09/07-dublicate-field.png differ diff --git a/ru/_assets/datalens/solution-09/08-add-rank-field.png b/ru/_assets/datalens/solution-09/08-add-rank-field.png new file mode 100644 index 00000000000..942197f05bc Binary files /dev/null and b/ru/_assets/datalens/solution-09/08-add-rank-field.png differ diff --git a/ru/_assets/datalens/solution-09/08-create-connection.png b/ru/_assets/datalens/solution-09/08-create-connection.png deleted file mode 100644 index 9fd32631eb5..00000000000 Binary files a/ru/_assets/datalens/solution-09/08-create-connection.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/09-create-column-chart.png b/ru/_assets/datalens/solution-09/09-create-column-chart.png new file mode 100644 index 00000000000..541c8eb7afb Binary files /dev/null and b/ru/_assets/datalens/solution-09/09-create-column-chart.png differ diff --git a/ru/_assets/datalens/solution-09/09-dashboard-pizza-moscow.png b/ru/_assets/datalens/solution-09/09-dashboard-pizza-moscow.png deleted file mode 100644 index 4e630e8e5e0..00000000000 Binary files a/ru/_assets/datalens/solution-09/09-dashboard-pizza-moscow.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/10-dashboard-spb.png b/ru/_assets/datalens/solution-09/10-dashboard-spb.png deleted file mode 100644 index 39cc4a7016a..00000000000 Binary files a/ru/_assets/datalens/solution-09/10-dashboard-spb.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/10-date-to-month.png b/ru/_assets/datalens/solution-09/10-date-to-month.png new file mode 100644 index 00000000000..0d706efa67c Binary files /dev/null and b/ru/_assets/datalens/solution-09/10-date-to-month.png differ diff --git a/ru/_assets/datalens/solution-09/11-delete-filters.png b/ru/_assets/datalens/solution-09/11-delete-filters.png deleted file mode 100644 index cca07e1c915..00000000000 Binary files a/ru/_assets/datalens/solution-09/11-delete-filters.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/11-save-column-chart.png b/ru/_assets/datalens/solution-09/11-save-column-chart.png new file mode 100644 index 00000000000..2f6c68a4188 Binary files /dev/null and b/ru/_assets/datalens/solution-09/11-save-column-chart.png differ diff --git a/ru/_assets/datalens/solution-09/12-drag-table.png b/ru/_assets/datalens/solution-09/12-drag-table.png deleted file mode 100644 index 9ef130dc691..00000000000 Binary files a/ru/_assets/datalens/solution-09/12-drag-table.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/12-save-chart-as-copy.png b/ru/_assets/datalens/solution-09/12-save-chart-as-copy.png new file mode 100644 index 00000000000..e2f9ef5a621 Binary files /dev/null and b/ru/_assets/datalens/solution-09/12-save-chart-as-copy.png differ diff --git a/ru/_assets/datalens/solution-09/13-choose-bar-chart.png b/ru/_assets/datalens/solution-09/13-choose-bar-chart.png new file mode 100644 index 00000000000..3b736025417 Binary files /dev/null and b/ru/_assets/datalens/solution-09/13-choose-bar-chart.png differ diff --git a/ru/_assets/datalens/solution-09/13-dublicate-field.png b/ru/_assets/datalens/solution-09/13-dublicate-field.png deleted file mode 100644 index 204c819d9b4..00000000000 Binary files a/ru/_assets/datalens/solution-09/13-dublicate-field.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/14-add-chart-filter.png b/ru/_assets/datalens/solution-09/14-add-chart-filter.png new file mode 100644 index 00000000000..ec70ca45da1 Binary files /dev/null and b/ru/_assets/datalens/solution-09/14-add-chart-filter.png differ diff --git a/ru/_assets/datalens/solution-09/14-geopolygon.png b/ru/_assets/datalens/solution-09/14-geopolygon.png deleted file mode 100644 index 587c3494e61..00000000000 Binary files a/ru/_assets/datalens/solution-09/14-geopolygon.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/15-bar-chart-section.png b/ru/_assets/datalens/solution-09/15-bar-chart-section.png new file mode 100644 index 00000000000..573cd157375 Binary files /dev/null and b/ru/_assets/datalens/solution-09/15-bar-chart-section.png differ diff --git a/ru/_assets/datalens/solution-09/15-indicator.png b/ru/_assets/datalens/solution-09/15-indicator.png deleted file mode 100644 index 486bbdb48f7..00000000000 Binary files a/ru/_assets/datalens/solution-09/15-indicator.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/16-2-title-hide.png b/ru/_assets/datalens/solution-09/16-2-title-hide.png new file mode 100644 index 00000000000..fe58fc4df41 Binary files /dev/null and b/ru/_assets/datalens/solution-09/16-2-title-hide.png differ diff --git a/ru/_assets/datalens/solution-09/16-choose-indicator.png b/ru/_assets/datalens/solution-09/16-choose-indicator.png new file mode 100644 index 00000000000..724ae84eed0 Binary files /dev/null and b/ru/_assets/datalens/solution-09/16-choose-indicator.png differ diff --git a/ru/_assets/datalens/solution-09/16-indicator-metric.png b/ru/_assets/datalens/solution-09/16-indicator-metric.png deleted file mode 100644 index d7f4462a1cf..00000000000 Binary files a/ru/_assets/datalens/solution-09/16-indicator-metric.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/17-links.png b/ru/_assets/datalens/solution-09/17-links.png deleted file mode 100644 index bbd716b57f2..00000000000 Binary files a/ru/_assets/datalens/solution-09/17-links.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/17-save-indicator.png b/ru/_assets/datalens/solution-09/17-save-indicator.png new file mode 100644 index 00000000000..29e0881a8d7 Binary files /dev/null and b/ru/_assets/datalens/solution-09/17-save-indicator.png differ diff --git a/ru/_assets/datalens/solution-09/18-indicator-metric.png b/ru/_assets/datalens/solution-09/18-indicator-metric.png new file mode 100644 index 00000000000..42eae622551 Binary files /dev/null and b/ru/_assets/datalens/solution-09/18-indicator-metric.png differ diff --git a/ru/_assets/datalens/solution-09/18-map-chart.png b/ru/_assets/datalens/solution-09/18-map-chart.png deleted file mode 100644 index 923cf3e1c29..00000000000 Binary files a/ru/_assets/datalens/solution-09/18-map-chart.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/19-choose-map.png b/ru/_assets/datalens/solution-09/19-choose-map.png new file mode 100644 index 00000000000..e33fbb6c970 Binary files /dev/null and b/ru/_assets/datalens/solution-09/19-choose-map.png differ diff --git a/ru/_assets/datalens/solution-09/19-map-colour.png b/ru/_assets/datalens/solution-09/19-map-colour.png deleted file mode 100644 index f5fe6fc3b71..00000000000 Binary files a/ru/_assets/datalens/solution-09/19-map-colour.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/20-map-editor.png b/ru/_assets/datalens/solution-09/20-map-editor.png deleted file mode 100644 index 30fed6ed6eb..00000000000 Binary files a/ru/_assets/datalens/solution-09/20-map-editor.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/20-map-sections-90.png b/ru/_assets/datalens/solution-09/20-map-sections-90.png new file mode 100644 index 00000000000..49288a95ad9 Binary files /dev/null and b/ru/_assets/datalens/solution-09/20-map-sections-90.png differ diff --git a/ru/_assets/datalens/solution-09/21-map-colour-90.png b/ru/_assets/datalens/solution-09/21-map-colour-90.png new file mode 100644 index 00000000000..b45fc0a6679 Binary files /dev/null and b/ru/_assets/datalens/solution-09/21-map-colour-90.png differ diff --git a/ru/_assets/datalens/solution-09/21-map-measure.png b/ru/_assets/datalens/solution-09/21-map-measure.png deleted file mode 100644 index f1707ee17ec..00000000000 Binary files a/ru/_assets/datalens/solution-09/21-map-measure.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/22-off-option.png b/ru/_assets/datalens/solution-09/22-off-option.png deleted file mode 100644 index 621bd1e1969..00000000000 Binary files a/ru/_assets/datalens/solution-09/22-off-option.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/22-pizzerias-on-the-map-90.png b/ru/_assets/datalens/solution-09/22-pizzerias-on-the-map-90.png new file mode 100644 index 00000000000..88d2b99c6ca Binary files /dev/null and b/ru/_assets/datalens/solution-09/22-pizzerias-on-the-map-90.png differ diff --git a/ru/_assets/datalens/solution-09/23-add-chart.png b/ru/_assets/datalens/solution-09/23-add-chart.png new file mode 100644 index 00000000000..5669ead7d93 Binary files /dev/null and b/ru/_assets/datalens/solution-09/23-add-chart.png differ diff --git a/ru/_assets/datalens/solution-09/23-organizations.png b/ru/_assets/datalens/solution-09/23-organizations.png deleted file mode 100644 index d98aa5ad3bf..00000000000 Binary files a/ru/_assets/datalens/solution-09/23-organizations.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/24-add-chart-window.png b/ru/_assets/datalens/solution-09/24-add-chart-window.png new file mode 100644 index 00000000000..c2615a425db Binary files /dev/null and b/ru/_assets/datalens/solution-09/24-add-chart-window.png differ diff --git a/ru/_assets/datalens/solution-09/24-organizations-dataset.png b/ru/_assets/datalens/solution-09/24-organizations-dataset.png deleted file mode 100644 index 783045d765d..00000000000 Binary files a/ru/_assets/datalens/solution-09/24-organizations-dataset.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/25-pizzerias-on-the-map.png b/ru/_assets/datalens/solution-09/25-pizzerias-on-the-map.png deleted file mode 100644 index 8fc80176232..00000000000 Binary files a/ru/_assets/datalens/solution-09/25-pizzerias-on-the-map.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/26-dashboard1.png b/ru/_assets/datalens/solution-09/26-dashboard1.png new file mode 100644 index 00000000000..fa2e5986f2f Binary files /dev/null and b/ru/_assets/datalens/solution-09/26-dashboard1.png differ diff --git a/ru/_assets/datalens/solution-09/27-add-selector.png b/ru/_assets/datalens/solution-09/27-add-selector.png new file mode 100644 index 00000000000..8ec4d9fe0a7 Binary files /dev/null and b/ru/_assets/datalens/solution-09/27-add-selector.png differ diff --git a/ru/_assets/datalens/solution-09/27-rank-field.png b/ru/_assets/datalens/solution-09/27-rank-field.png deleted file mode 100644 index d991dd25f8f..00000000000 Binary files a/ru/_assets/datalens/solution-09/27-rank-field.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/28-round-month.png b/ru/_assets/datalens/solution-09/28-round-month.png deleted file mode 100644 index 051a75970f9..00000000000 Binary files a/ru/_assets/datalens/solution-09/28-round-month.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/28-selector1.png b/ru/_assets/datalens/solution-09/28-selector1.png new file mode 100644 index 00000000000..1f9766f89f3 Binary files /dev/null and b/ru/_assets/datalens/solution-09/28-selector1.png differ diff --git a/ru/_assets/datalens/solution-09/29-saved-dashboard.png b/ru/_assets/datalens/solution-09/29-saved-dashboard.png new file mode 100644 index 00000000000..b7adbef1b47 Binary files /dev/null and b/ru/_assets/datalens/solution-09/29-saved-dashboard.png differ diff --git a/ru/_assets/datalens/solution-09/30-dashboard-pizza-moscow.png b/ru/_assets/datalens/solution-09/30-dashboard-pizza-moscow.png new file mode 100644 index 00000000000..9accd42b0c7 Binary files /dev/null and b/ru/_assets/datalens/solution-09/30-dashboard-pizza-moscow.png differ diff --git a/ru/_assets/datalens/solution-09/30-select-layer.png b/ru/_assets/datalens/solution-09/30-select-layer.png deleted file mode 100644 index 42564ac1e49..00000000000 Binary files a/ru/_assets/datalens/solution-09/30-select-layer.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/31-map-edit.png b/ru/_assets/datalens/solution-09/31-map-edit.png new file mode 100644 index 00000000000..95d0f58bbd4 Binary files /dev/null and b/ru/_assets/datalens/solution-09/31-map-edit.png differ diff --git a/ru/_assets/datalens/solution-09/31-selector-settings.png b/ru/_assets/datalens/solution-09/31-selector-settings.png deleted file mode 100644 index 3836f874ba5..00000000000 Binary files a/ru/_assets/datalens/solution-09/31-selector-settings.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/32-add-dataset.png b/ru/_assets/datalens/solution-09/32-add-dataset.png new file mode 100644 index 00000000000..5a4cfe2114e Binary files /dev/null and b/ru/_assets/datalens/solution-09/32-add-dataset.png differ diff --git a/ru/_assets/datalens/solution-09/33-add-links.png b/ru/_assets/datalens/solution-09/33-add-links.png new file mode 100644 index 00000000000..d12810af267 Binary files /dev/null and b/ru/_assets/datalens/solution-09/33-add-links.png differ diff --git a/ru/_assets/datalens/solution-09/33-sort-rank.png b/ru/_assets/datalens/solution-09/33-sort-rank.png deleted file mode 100644 index ed746c7c330..00000000000 Binary files a/ru/_assets/datalens/solution-09/33-sort-rank.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/34-map-geolayers.png b/ru/_assets/datalens/solution-09/34-map-geolayers.png deleted file mode 100644 index d2bf36ab228..00000000000 Binary files a/ru/_assets/datalens/solution-09/34-map-geolayers.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/34-select-layer.png b/ru/_assets/datalens/solution-09/34-select-layer.png new file mode 100644 index 00000000000..d6000f7c78e Binary files /dev/null and b/ru/_assets/datalens/solution-09/34-select-layer.png differ diff --git a/ru/_assets/datalens/solution-09/35-geopolygon.png b/ru/_assets/datalens/solution-09/35-geopolygon.png new file mode 100644 index 00000000000..85228a7923a Binary files /dev/null and b/ru/_assets/datalens/solution-09/35-geopolygon.png differ diff --git a/ru/_assets/datalens/solution-09/35-organization-dash.png b/ru/_assets/datalens/solution-09/35-organization-dash.png deleted file mode 100644 index 8316292a274..00000000000 Binary files a/ru/_assets/datalens/solution-09/35-organization-dash.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/36-organizations-dataset.png b/ru/_assets/datalens/solution-09/36-organizations-dataset.png new file mode 100644 index 00000000000..c684b79c6da Binary files /dev/null and b/ru/_assets/datalens/solution-09/36-organizations-dataset.png differ diff --git a/ru/_assets/datalens/solution-09/36-transparency.png b/ru/_assets/datalens/solution-09/36-transparency.png deleted file mode 100644 index 683426dda30..00000000000 Binary files a/ru/_assets/datalens/solution-09/36-transparency.png and /dev/null differ diff --git a/ru/_assets/datalens/solution-09/37-colour-settings.png b/ru/_assets/datalens/solution-09/37-colour-settings.png new file mode 100644 index 00000000000..f0344be562d Binary files /dev/null and b/ru/_assets/datalens/solution-09/37-colour-settings.png differ diff --git a/ru/_assets/datalens/solution-09/38-transparency.png b/ru/_assets/datalens/solution-09/38-transparency.png new file mode 100644 index 00000000000..c42e3cf1a5b Binary files /dev/null and b/ru/_assets/datalens/solution-09/38-transparency.png differ diff --git a/ru/_assets/datalens/solution-09/39-map-geolayers.png b/ru/_assets/datalens/solution-09/39-map-geolayers.png new file mode 100644 index 00000000000..a2b333f2d01 Binary files /dev/null and b/ru/_assets/datalens/solution-09/39-map-geolayers.png differ diff --git a/ru/_assets/datalens/solution-09/40-dashboard-spb.png b/ru/_assets/datalens/solution-09/40-dashboard-spb.png new file mode 100644 index 00000000000..4ffe1cd3cc2 Binary files /dev/null and b/ru/_assets/datalens/solution-09/40-dashboard-spb.png differ diff --git a/ru/_includes/billing/billing-account-create-individual.md b/ru/_includes/billing/billing-account-create-individual.md index fe1b85ffc01..9472dc82c51 100644 --- a/ru/_includes/billing/billing-account-create-individual.md +++ b/ru/_includes/billing/billing-account-create-individual.md @@ -14,7 +14,7 @@ 1. Если в блоке **{{ ui-key.yacloud_billing_account.create-account-wizard.field_person-id }}** показан список доступных плательщиков, вы можете выбрать одного из них или добавить нового. Чтобы добавить плательщика: - * Выберите тип плательщика: **{{ ui-key.startrek.ui_components_page-admin_BillingAccountInfo.person-type-invididual }}** и нажмите кнопку **{{ ui-key.yacloud_billing_account.cloud-billing-account.label_wizard-next }}**. + * Выберите тип плательщика: **Физическое лицо** и нажмите кнопку **{{ ui-key.yacloud_billing_account.cloud-billing-account.label_wizard-next }}**. * Укажите ваше имя и фамилию. * (Опционально) Укажите отчество и почтовый адрес. * Нажмите кнопку **{{ ui-key.yacloud_billing_account.cloud-billing-account.label_wizard-next }}**. diff --git a/ru/_includes/billing/billing-account-create-legal-entities.md b/ru/_includes/billing/billing-account-create-legal-entities.md index be8034dc128..0e4cfc0ef79 100644 --- a/ru/_includes/billing/billing-account-create-legal-entities.md +++ b/ru/_includes/billing/billing-account-create-legal-entities.md @@ -14,13 +14,12 @@ 1. Если в блоке **{{ ui-key.yacloud_billing_account.create-account-wizard.field_person-id }}** показан список доступных плательщиков, вы можете выбрать одного из них или добавить нового. -1. Выберите тип плательщика: **{{ ui-key.startrek.ui_components_page-admin_BillingAccountInfo.person-type-company }}**. +1. Выберите тип плательщика: **Юридическое лицо или ИП**. 1. Выберите способ оплаты **{{ ui-key.yacloud_billing.billing.account.create-new.payment-type_label_card }}** или **{{ ui-key.yacloud_billing.billing.account.create-new.payment-type_label_invoice }}**. В любой момент после создания платежного аккаунта вы можете [изменить способ оплаты](../../billing/operations/change-payment-method.md). 1. Нажмите кнопку **{{ ui-key.yacloud_billing_account.cloud-billing-account.label_wizard-next }}** - 1. Если вы выбрали способ оплаты **{{ ui-key.yacloud_billing.billing.account.create-new.payment-type_label_card }}**: 1. Укажите юридическую информацию о вашей организации и ваши контактные данные. @@ -47,15 +46,12 @@ 1. Укажите актуальные почту и телефон. Контактные данные нужны не только для связи с вами, но и для выставления счетов и финансовых документов. Если вы уже зарегистрированы в {{ yandex-cloud }}, проверьте правильность контактных данных. - 1. Если это ваш первый платежный аккаунт в {{ yandex-cloud }}, вам доступно подключение [пробного периода](../../billing/concepts/trial-period.md). После его завершения доступ к вашим ресурсам будет приостановлен. Для возобновления работы потребуется перейти на [платную версию](../../billing/operations/activate-commercial.md). 1. Нажмите кнопку **{{ ui-key.yacloud.common.create }}**. - Если вы выбрали способ оплаты **{{ ui-key.yacloud_billing.billing.account.create-new.payment-type_label_invoice }}** или если плательщик — нерезидент РФ и РК, вы получите письмо с описанием дальнейших действий на почту, указанную в аккаунте Яндекса или Яндекс 360. После проверки документов ваш платежный аккаунт может быть активирован, и вы сможете начать пользоваться {{ yandex-cloud }}. - Отправьте на электронную почту [{{ billing-docs-email }}](mailto:{{ billing-docs-email }}) следующие документы: * Копию протокола или решения о назначении генерального директора. * Идентификатор [платежного аккаунта](../../billing/concepts/billing-account.md#billing-account-id) (billing account ID). diff --git a/ru/_includes/billing/card-business-nonresidents.md b/ru/_includes/billing/card-business-nonresidents.md deleted file mode 100644 index 6af2e2285b9..00000000000 --- a/ru/_includes/billing/card-business-nonresidents.md +++ /dev/null @@ -1,5 +0,0 @@ -{% note info %} - -Оплата банковскими картами недоступна для нерезидентов Российской Федерации и Республики Казахстан. - -{% endnote %} \ No newline at end of file diff --git a/ru/_includes/billing/contract.md b/ru/_includes/billing/contract.md index d48453a0a68..f3ce83872d6 100644 --- a/ru/_includes/billing/contract.md +++ b/ru/_includes/billing/contract.md @@ -1 +1 @@ -В {{ yandex-cloud }} все услуги предоставляются по договору, который заключается путем принятия [оферты]({{ billing-oferta-url }}?lang=ru) при создании [платежного аккаунта](../../billing/concepts/billing-account.md). Такой договор не требует двустороннего подписания. +В {{ yandex-cloud }} все услуги предоставляются по договору, который заключается путем принятия оферты при создании [платежного аккаунта](../../billing/concepts/billing-account.md). Такой договор не требует двустороннего подписания. diff --git a/ru/_includes/billing/legal-entity-nonresidents.md b/ru/_includes/billing/legal-entity-nonresidents.md new file mode 100644 index 00000000000..6356811ddf6 --- /dev/null +++ b/ru/_includes/billing/legal-entity-nonresidents.md @@ -0,0 +1,5 @@ +{% note info %} + +Нерезидентам РФ и РК необходимо указать банковские реквизиты юридического лица, с которым был заключен [договор](../../billing/concepts/contract.md) при [создании платежного аккаунта](../../billing/operations/create-new-account.md). + +{% endnote %} \ No newline at end of file diff --git a/ru/_includes/billing/payment-card-types.md b/ru/_includes/billing/payment-card-types.md index 054e7e5c8e4..5502006c517 100644 --- a/ru/_includes/billing/payment-card-types.md +++ b/ru/_includes/billing/payment-card-types.md @@ -1,4 +1,5 @@ Принимаются банковские карты Мир, Visa и MasterCard. * Резиденты Российской Федерации ведут расчеты в RUB и могут использовать для оплаты карты, выпущенные только российскими банками. -* Резиденты Республики Казахстан ведут расчеты в KZT и могут использовать для оплаты карты, выпущенные только нероссийскими банками. \ No newline at end of file +* Резиденты Республики Казахстан ведут расчеты в KZT и могут использовать для оплаты карты, выпущенные только нероссийскими банками. +* Нерезиденты Российской Федерации и Республики Казахстан ведут расчеты в USD и могут использовать для оплаты карты, выпущенные только нероссийскими банками. \ No newline at end of file diff --git a/ru/_includes/compute/create/access-ssh-key.md b/ru/_includes/compute/create/access-ssh-key.md index 0cf42767e35..e933320d342 100644 --- a/ru/_includes/compute/create/access-ssh-key.md +++ b/ru/_includes/compute/create/access-ssh-key.md @@ -1,4 +1,11 @@ -В поле **{{ ui-key.yacloud.compute.instances.create.field_key }}** вставьте содержимое файла [публичного ключа](../../../compute/operations/vm-connect/ssh.md#creating-ssh-keys). +В поле **{{ ui-key.yacloud.compute.instances.create.field_key }}** выберите SSH-ключ, сохраненный в вашем профиле [пользователя организации](../../../organization/concepts/membership.md). -Пару ключей для подключения по SSH необходимо создать самостоятельно, см. [раздел о подключении к ВМ по SSH](../../../compute/operations/vm-connect/ssh.md). +Если в вашем профиле нет сохраненных SSH-ключей или вы хотите добавить новый ключ: +* Нажмите кнопку **Добавить ключ**. +* Задайте имя SSH-ключа. +* Загрузите или вставьте содержимое открытого SSH-ключа. Пару SSH-ключей для подключения к ВМ по [SSH](../../../glossary/ssh-keygen.md) необходимо [создать](../../../compute/operations/vm-connect/ssh.md#creating-ssh-keys) самостоятельно. +* Нажмите кнопку **{{ ui-key.yacloud.common.add }}**. +SSH-ключ будет добавлен в ваш профиль пользователя организации. + +Если в организации отключена возможность добавления пользователями SSH-ключей в свои профили, добавленный открытый SSH-ключ будет сохранен только в профиле пользователя создаваемой виртуальной машины. \ No newline at end of file diff --git a/ru/_includes/compute/create/section-access.md b/ru/_includes/compute/create/section-access.md index d085750b33d..78d2e66a312 100644 --- a/ru/_includes/compute/create/section-access.md +++ b/ru/_includes/compute/create/section-access.md @@ -1,17 +1,21 @@ -В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** укажите данные для доступа на ВМ: +В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}**: -* (Опционально) [Включите доступ к ВМ по OS Login](../../../compute/operations/vm-connect/os-login.md). Опция доступна для образов Linux из [{{ marketplace-name }}](/marketplace), которые содержат `OS Login` в названии. -* В поле **{{ ui-key.yacloud.compute.instances.create.field_user }}** введите имя пользователя. +* Выберите **Доступ по OS Login**, чтобы [подключаться](../../../compute/operations/vm-connect/os-login.md) к создаваемой ВМ и управлять доступом к ней с помощью [OS Login](../../../organization/concepts/os-login.md) в {{ org-full-name }}. - {% note alert %} + Используя OS Login, вы сможете подключаться к ВМ по SSH-ключам и SSH-сертификатам с помощью стандартного SSH-клиента или [интерфейса командной строки {{ yandex-cloud }}](../../../cli/quickstart.md). OS Login позволяет ротировать SSH-ключи, используемые для доступа к ВМ, и является наиболее [безопасным](../../../security/domains/iaas-checklist.md#vm-security) вариантом доступа. - Не используйте логин `root` или другие имена, зарезервированные ОС. Для выполнения операций, требующих прав суперпользователя, используйте команду `sudo`. +* Если доступ по OS Login вам не подходит, выберите вариант **{{ ui-key.yacloud.compute.instance.access-method.label_oslogin-control-ssh-option-title }}** и укажите данные для доступа к ВМ: - {% endnote %} + * В поле **{{ ui-key.yacloud.compute.instances.create.field_user }}** введите имя пользователя. -* В поле **{{ ui-key.yacloud.compute.instances.create.field_key }}** вставьте содержимое файла [публичного ключа](../../../compute/operations/vm-connect/ssh.md#creating-ssh-keys). Пару ключей для подключения по SSH необходимо создать самостоятельно, см. [раздел о подключении к ВМ по SSH](../../../compute/operations/vm-connect/ssh.md). + {% note alert %} -Если вы хотите добавить на ВМ одновременно нескольких пользователей с SSH-ключами, [задайте](../../../compute/concepts/vm-metadata.md#how-to-send-metadata) данные этих пользователей в блоке **{{ ui-key.yacloud.common.metadata }}**. С помощью метаданных вы также можете [установить дополнительное ПО](../../../compute/operations/vm-create/create-with-cloud-init-scripts.md) на ВМ при ее создании. + Не используйте логин `root` или другие имена, зарезервированные ОС. Для выполнения операций, требующих прав суперпользователя, используйте команду `sudo`. + + {% endnote %} -{% include [vm-connect-linux](../../vm-connect-linux.md) %} + * {% include [access-ssh-key](./access-ssh-key.md) %} + +Если вы хотите добавить на ВМ одновременно нескольких пользователей с SSH-ключами, [задайте](../../../compute/concepts/vm-metadata.md#how-to-send-metadata) данные этих пользователей в блоке **{{ ui-key.yacloud.common.metadata }}**. С помощью метаданных вы также можете [установить дополнительное ПО](../../../compute/operations/vm-create/create-with-cloud-init-scripts.md) на ВМ при ее создании. +{% include [vm-connect-linux](../../vm-connect-linux.md) %} \ No newline at end of file diff --git a/ru/_includes/compute/create/section-storages-filesystem.md b/ru/_includes/compute/create/section-storages-filesystem.md index 439a0883103..a3c1be47690 100644 --- a/ru/_includes/compute/create/section-storages-filesystem.md +++ b/ru/_includes/compute/create/section-storages-filesystem.md @@ -4,6 +4,4 @@ * В открывшемся окне выберите **Файловое хранилище** и в появившемся списке выберите хранилище, которое требуется подключить. - Если файловых хранилищ пока нет, нажмите кнопку **{{ ui-key.yacloud.compute.nfs.button_create-filesystem }}**, чтобы создать новое. - * Нажмите кнопку **Добавить файловое хранилище**. \ No newline at end of file diff --git a/ru/_includes/compute/independent-resources.md b/ru/_includes/compute/independent-resources.md new file mode 100644 index 00000000000..2b85f4474e5 --- /dev/null +++ b/ru/_includes/compute/independent-resources.md @@ -0,0 +1,5 @@ +{% note info %} + +[Диски](../../compute/concepts/disk.md), [снимки дисков](../../compute/concepts/snapshot.md) и [образы](../../compute/concepts/image.md) — это отдельные ресурсы, которые работают независимо друг от друга в {{ compute-name }}. Вы можете создавать, удалять и управлять ими по отдельности. Ваши действия с диском не влияют на снимок этого диска или на образ, по которому был создан диск. Даже если вы удалите диск или ВМ с диском, снимок диска и образ останутся. + +{% endnote %} \ No newline at end of file diff --git a/ru/_includes/compute/os-login-enablement-notice.md b/ru/_includes/compute/os-login-enablement-notice.md new file mode 100644 index 00000000000..82905c815a2 --- /dev/null +++ b/ru/_includes/compute/os-login-enablement-notice.md @@ -0,0 +1,5 @@ +{% note tip %} + +Чтобы иметь возможность создавать виртуальные машины с доступом по {{ oslogin }} и [подключаться](../../compute/operations/vm-connect/os-login.md) к таким ВМ, [включите](../../organization/operations/os-login-access.md) {{ oslogin }} на уровне [организации](../../organization/quickstart.md) {{ yandex-cloud }}. + +{% endnote %} \ No newline at end of file diff --git a/ru/_includes/data-transfer/fields/postgresql/ui/connection-manager.md b/ru/_includes/data-transfer/fields/postgresql/ui/connection-manager.md index 724e94c5601..2d3b35b752d 100644 --- a/ru/_includes/data-transfer/fields/postgresql/ui/connection-manager.md +++ b/ru/_includes/data-transfer/fields/postgresql/ui/connection-manager.md @@ -1,6 +1,6 @@ **{{ ui-key.yc-data-transfer.data-transfer.console.form.common.console.form.common.Connection.authorization_connman.title }}** — позволяет использовать подключение к базе данных через [{{ connection-manager-full-name }}](../../../../../metadata-hub/quickstart/connection-manager.md): -* **{{ ui-key.yc-data-transfer.data-transfer.console.form.postgres.console.form.postgres.ConnmanConnection.connection_id.title }}** — укажите идентификатор подключения из {{ connection-manager-name }}. +* **{{ ui-key.yc-data-transfer.data-transfer.console.form.common.console.form.common.ConnmanConnection.connection_id.title }}** — укажите идентификатор подключения из {{ connection-manager-name }}. * {% include [database](../../../fields/postgresql/ui/database.md) %} diff --git a/ru/_includes/default-cloud.md b/ru/_includes/default-cloud.md new file mode 100644 index 00000000000..f88f3a3d51a --- /dev/null +++ b/ru/_includes/default-cloud.md @@ -0,0 +1 @@ +По умолчанию используется облако, заданное в профиле CLI. Вы можете задать другое облако в параметре `--cloud-id`. \ No newline at end of file diff --git a/ru/_includes/iam/service-control-access.md b/ru/_includes/iam/service-control-access.md new file mode 100644 index 00000000000..9b1ee075b97 --- /dev/null +++ b/ru/_includes/iam/service-control-access.md @@ -0,0 +1 @@ +Управлять доступом сервисов к ресурсам могут пользователи с ролью [администратора](../../resource-manager/security/index.md#resource-manager-admin) или [владельца](../../resource-manager/security/index.md#resource-manager-clouds-owner) облака. \ No newline at end of file diff --git a/ru/_includes/mdb/api/backup-window-start-common.md b/ru/_includes/mdb/api/backup-window-start-common.md new file mode 100644 index 00000000000..5746a21f814 --- /dev/null +++ b/ru/_includes/mdb/api/backup-window-start-common.md @@ -0,0 +1,4 @@ +* `hours` — часы в 24-часовом формате. +* `minutes` — минуты. +* `seconds` — секунды. +* `nanos` — наносекунды. diff --git a/ru/_includes/mdb/api/backup-windows-start-grpc.md b/ru/_includes/mdb/api/backup-windows-start-grpc.md new file mode 100644 index 00000000000..06e54cb73b8 --- /dev/null +++ b/ru/_includes/mdb/api/backup-windows-start-grpc.md @@ -0,0 +1,3 @@ +`config_spec.backup_window_start` — время начала резервного копирования (UTC): + +{% include [backup-window-start-common](./backup-window-start-common.md) %} diff --git a/ru/_includes/mdb/api/backup-windows-start-rest.md b/ru/_includes/mdb/api/backup-windows-start-rest.md new file mode 100644 index 00000000000..6b4da4b4c68 --- /dev/null +++ b/ru/_includes/mdb/api/backup-windows-start-rest.md @@ -0,0 +1,3 @@ +`configSpec.backupWindowStart` — время начала резервного копирования (UTC): + +{% include [backup-window-start-common](./backup-window-start-common.md) %} diff --git a/ru/_includes/mdb/api/column-filter-grpc.md b/ru/_includes/mdb/api/column-filter-grpc.md new file mode 100644 index 00000000000..c2e773aa283 --- /dev/null +++ b/ru/_includes/mdb/api/column-filter-grpc.md @@ -0,0 +1 @@ +В параметре `column_filter` можно указать несколько колонок, если нужно отфильтровать логи по нескольким колонкам. diff --git a/ru/_includes/mdb/api/column-filter-list.md b/ru/_includes/mdb/api/column-filter-list.md new file mode 100644 index 00000000000..75df6e88e2b --- /dev/null +++ b/ru/_includes/mdb/api/column-filter-list.md @@ -0,0 +1,6 @@ +* `hostname` — имя хоста. +* `component` — тип компонента, который попадет в лог. Например, `HTTP-Session`. +* `message` — сообщение, которое выводит компонент. +* `query_id` — идентификатор запроса. +* `severity` — уровень логирования, например, `Debug`. +* `thread` — идентификатор потока, участвующего в обработке запросов. diff --git a/ru/_includes/mdb/api/column-filter-rest.md b/ru/_includes/mdb/api/column-filter-rest.md new file mode 100644 index 00000000000..b2c9b93f210 --- /dev/null +++ b/ru/_includes/mdb/api/column-filter-rest.md @@ -0,0 +1 @@ +В одном параметре `columnFilter` можно указать только одну колонку. Если необходимо отфильтровать логи по нескольким колонкам, передайте перечень нужных колонок в нескольких параметрах. diff --git a/ru/_includes/mdb/api/from-time-grpc.md b/ru/_includes/mdb/api/from-time-grpc.md new file mode 100644 index 00000000000..b19963cd1a5 --- /dev/null +++ b/ru/_includes/mdb/api/from-time-grpc.md @@ -0,0 +1 @@ +* `from_time` — левая граница временного диапазона в формате [RFC-3339](https://www.ietf.org/rfc/rfc3339.html). Пример: `{{ sample-rfc3339-timestamp }}`. diff --git a/ru/_includes/mdb/api/from-time-rest.md b/ru/_includes/mdb/api/from-time-rest.md new file mode 100644 index 00000000000..d6b0da6374a --- /dev/null +++ b/ru/_includes/mdb/api/from-time-rest.md @@ -0,0 +1 @@ +* `fromTime` — левая граница временного диапазона в формате [RFC-3339](https://www.ietf.org/rfc/rfc3339.html). Пример: `{{ sample-rfc3339-timestamp }}`. diff --git a/ru/_includes/mdb/api/stream-logs-filter.md b/ru/_includes/mdb/api/stream-logs-filter.md new file mode 100644 index 00000000000..7ac5f20d869 --- /dev/null +++ b/ru/_includes/mdb/api/stream-logs-filter.md @@ -0,0 +1,10 @@ +{% note tip %} + +Фильтр может содержать в себе кавычки и другие символы. Экранируйте их, если это необходимо. + +{% endnote %} + +Поддерживаемые фильтры: + +* `message.hostname` — фильтрация по имени хоста. +* `message.severity` — фильтрация по уровню логирования. diff --git a/ru/_includes/mdb/api/tail-f-semantics.md b/ru/_includes/mdb/api/tail-f-semantics.md new file mode 100644 index 00000000000..15892c14894 --- /dev/null +++ b/ru/_includes/mdb/api/tail-f-semantics.md @@ -0,0 +1 @@ +Если не указывать этот параметр, то в поток логов будут отсылаться новые логи по мере их появления. Это поведение семантически эквивалентно `tail -f`. diff --git a/ru/_includes/mdb/mch/api/grpc-access-settings.md b/ru/_includes/mdb/mch/api/grpc-access-settings.md new file mode 100644 index 00000000000..d0d99e4993d --- /dev/null +++ b/ru/_includes/mdb/mch/api/grpc-access-settings.md @@ -0,0 +1,15 @@ +* `data_lens` — разрешить доступ из {{ datalens-name }}: `true` или `false`. Значение по умолчанию — `false`. Подробнее о настройке подключения см. в разделе [Подключение из {{ datalens-name }}](../../../../managed-clickhouse/operations/datalens-connect.md). + +* `web_sql` — разрешить [выполнять SQL-запросы](../../../../managed-clickhouse/operations/web-sql-query.md) к базам данных кластера из консоли управления {{ yandex-cloud }} с помощью сервиса {{ websql-full-name }}: `true` или `false`. Значение по умолчанию — `false`. + + +* `metrika` — разрешить [импорт данных из AppMetrika в кластер](https://appmetrica.yandex.ru/docs/common/cloud/about.html): `true` или `false`. Значение по умолчанию — `false`. + +* `serverless` — разрешить доступ к кластеру из сервиса [{{ sf-full-name }}](../../../../functions/concepts/index.md): `true` или `false`. Значение по умолчанию — `false`. Подробнее о настройке доступа см. в документации [{{ sf-name }}](../../../../functions/operations/database-connection.md). + +* `data_transfer` — разрешить доступ к кластеру из сервиса [{{ data-transfer-full-name }}](../../../../data-transfer/concepts/index.md) в Serverless-режиме: `true` или `false`. Значение по умолчанию — `false`. + + Это позволит через специальную сеть подключаться к {{ data-transfer-full-name }}, запущенному в {{ k8s }}. В результате будут быстрее выполняться, например, запуск и деактивация трансфера. + + +* `yandex_query` — разрешить доступ к кластеру из сервиса [{{ yq-full-name }}](../../../../query/concepts/index.md): `true` или `false`. Функциональность находится на стадии [Preview](../../../../overview/concepts/launch-stages.md). Значение по умолчанию — `false`. diff --git a/ru/_includes/mdb/mch/api/grpc-cloud-storage-settings.md b/ru/_includes/mdb/mch/api/grpc-cloud-storage-settings.md new file mode 100644 index 00000000000..4488c66b742 --- /dev/null +++ b/ru/_includes/mdb/mch/api/grpc-cloud-storage-settings.md @@ -0,0 +1,19 @@ +* `enabled` — включить гибридное хранилище в кластере, если оно выключено: `true` или `false`. Значение по умолчанию — `false` (выключено). + + {% include [Hybrid Storage cannot be switched off](../hybrid-storage-cannot-be-switched-off.md) %} + +* `move_factor` — минимальная доля свободного места в кластерном хранилище. Если доля свободного места меньше этого значения, данные переносятся в {{ objstorage-full-name }}. + + Минимальное значение — `0`, максимальное — `1`, по умолчанию — `0.01`. + +* `data_cache_enabled` — разрешить временное хранение файлов в кластерном хранилище: `true` или `false`. + + По умолчанию — `true` (разрешено). + +* `data_cache_max_size` — максимальный объем памяти (в байтах), выделяемый в кластерном хранилище для временного хранения файлов. + + По умолчанию — `1073741824` (1 ГБ). + +* `prefer_not_to_merge` — отключить [слияние кусков данных]({{ ch.docs }}/engines/table-engines/mergetree-family/custom-partitioning-key/) в кластерном и объектном хранилищах: `true` или `false`. + + Чтобы отключить слияние, укажите значение `true`. Чтобы оставить слияние включенным, укажите значение `false`. diff --git a/ru/_includes/mdb/mch/api/grpc-user-specs.md b/ru/_includes/mdb/mch/api/grpc-user-specs.md new file mode 100644 index 00000000000..25034763376 --- /dev/null +++ b/ru/_includes/mdb/mch/api/grpc-user-specs.md @@ -0,0 +1,5 @@ +* `name` — имя пользователя. Оно может содержать латинские буквы, цифры, дефис и подчеркивание, но должно начинаться с буквы или подчеркивания. +* `password` — пароль пользователя. Длина пароля от 8 до 128 символов. +* `permissions` — список БД, к которым пользователь должен иметь доступ. + + Список организован в виде массива параметров `database_name`. Один параметр содержит имя отдельной БД. diff --git a/ru/_includes/mdb/mch/api/replication-management-details.md b/ru/_includes/mdb/mch/api/replication-management-details.md new file mode 100644 index 00000000000..236d16e4c3b --- /dev/null +++ b/ru/_includes/mdb/mch/api/replication-management-details.md @@ -0,0 +1,7 @@ +Эта настройка определяет, как будет происходить управление репликацией в кластере из нескольких хостов {{ CH }}: + +* Если указано значение `true`, то для управления репликацией будет использоваться {{ CK }}. + + {% include [ClickHouse Keeper can't turn off](../note-ck-no-turn-off.md) %} + +* Если значение не задано или равно `false`, то для управления репликацией и распределением запросов будет использоваться {{ ZK }}. diff --git a/ru/_includes/mdb/mch/api/rest-access-settings.md b/ru/_includes/mdb/mch/api/rest-access-settings.md new file mode 100644 index 00000000000..cda924c83ce --- /dev/null +++ b/ru/_includes/mdb/mch/api/rest-access-settings.md @@ -0,0 +1,15 @@ +* `dataLens` — разрешить доступ из {{ datalens-name }}: `true` или `false`. Значение по умолчанию — `false`. Подробнее о настройке подключения см. в разделе [Подключение из {{ datalens-name }}](../../../../managed-clickhouse/operations/datalens-connect.md). + +* `webSql` — разрешить [выполнять SQL-запросы](../../../../managed-clickhouse/operations/web-sql-query.md) к базам данных кластера из консоли управления {{ yandex-cloud }} с помощью сервиса {{ websql-full-name }}: `true` или `false`. Значение по умолчанию — `false`. + + +* `metrika` — разрешить [импорт данных из AppMetrika в кластер](https://appmetrica.yandex.ru/docs/common/cloud/about.html): `true` или `false`. Значение по умолчанию — `false`. + +* `serverless` — разрешить доступ к кластеру из сервиса [{{ sf-full-name }}](../../../../functions/concepts/index.md): `true` или `false`. Значение по умолчанию — `false`. Подробнее о настройке доступа см. в документации [{{ sf-name }}](../../../../functions/operations/database-connection.md). + +* `dataTransfer` — разрешить доступ к кластеру из сервиса [{{ data-transfer-full-name }}](../../../../data-transfer/concepts/index.md) в Serverless-режиме: `true` или `false`. Значение по умолчанию — `false`. + + Это позволит через специальную сеть подключаться к {{ data-transfer-full-name }}, запущенному в {{ k8s }}. В результате будут быстрее выполняться, например, запуск и деактивация трансфера. + + +* `yandexQuery` — разрешить доступ к кластеру из сервиса [{{ yq-full-name }}](../../../../query/concepts/index.md): `true` или `false`. Функциональность находится на стадии [Preview](../../../../overview/concepts/launch-stages.md). Значение по умолчанию — `false`. diff --git a/ru/_includes/mdb/mch/api/rest-cloud-storage-settings.md b/ru/_includes/mdb/mch/api/rest-cloud-storage-settings.md new file mode 100644 index 00000000000..735200e2234 --- /dev/null +++ b/ru/_includes/mdb/mch/api/rest-cloud-storage-settings.md @@ -0,0 +1,19 @@ +* `enabled` — включить гибридное хранилище в кластере, если оно выключено: `true` или `false`. Значение по умолчанию — `false` (выключено). + + {% include [Hybrid Storage cannot be switched off](../hybrid-storage-cannot-be-switched-off.md) %} + +* `moveFactor` — минимальная доля свободного места в кластерном хранилище. Если доля свободного места меньше этого значения, данные переносятся в {{ objstorage-full-name }}. + + Минимальное значение — `0`, максимальное — `1`, по умолчанию — `0.01`. + +* `dataCacheEnabled` — разрешить временное хранение файлов в кластерном хранилище: `true` или `false`. + + По умолчанию — `true` (разрешено). + +* `dataCacheMaxSize` — максимальный объем памяти (в байтах), выделяемый в кластерном хранилище для временного хранения файлов. + + По умолчанию — `1073741824` (1 ГБ). + +* `preferNotToMerge` — отключить [слияние кусков данных]({{ ch.docs }}/engines/table-engines/mergetree-family/custom-partitioning-key/) в кластерном и объектном хранилищах: `true` или `false`. + + Чтобы отключить слияние, укажите значение `true`. Чтобы оставить слияние включенным, укажите значение `false`. diff --git a/ru/_includes/mdb/mch/api/rest-user-specs.md b/ru/_includes/mdb/mch/api/rest-user-specs.md new file mode 100644 index 00000000000..4d55d4a0e11 --- /dev/null +++ b/ru/_includes/mdb/mch/api/rest-user-specs.md @@ -0,0 +1,5 @@ +* `name` — имя пользователя. Оно может содержать латинские буквы, цифры, дефис и подчеркивание, но должно начинаться с буквы или подчеркивания. +* `password` — пароль пользователя. Длина пароля от 8 до 128 символов. +* `permissions` — список БД, к которым пользователь должен иметь доступ. + + Список организован в виде массива параметров `databaseName`. Один параметр содержит имя отдельной БД. diff --git a/ru/_includes/mdb/mch/api/zk-hosts-details.md b/ru/_includes/mdb/mch/api/zk-hosts-details.md new file mode 100644 index 00000000000..7877fc0d64b --- /dev/null +++ b/ru/_includes/mdb/mch/api/zk-hosts-details.md @@ -0,0 +1,5 @@ +Если вы создаете кластер из нескольких хостов и не используете [{{ CK }}](../../../../managed-clickhouse/concepts/replication.md#ck), то для хостов {{ ZK }} действуют следующие правила: + +* Если в [облачной сети](../../../../vpc/concepts/network.md) кластера есть подсети в каждой из [зон доступности](../../../../overview/concepts/geo-scope.md), а настройки хостов {{ ZK }} не заданы, то в каждую подсеть будет автоматически добавлено по одному такому хосту. + +* Если подсети в сети кластера есть только в некоторых зонах доступности, то необходимо указать настройки хостов {{ ZK }} явно. diff --git a/ru/_includes/mdb/mch/extra-settings-web-console.md b/ru/_includes/mdb/mch/extra-settings-web-console.md index e8d027534be..c169f50255f 100644 --- a/ru/_includes/mdb/mch/extra-settings-web-console.md +++ b/ru/_includes/mdb/mch/extra-settings-web-console.md @@ -22,3 +22,4 @@ * {% include [Deletion protection](../console/deletion-protection.md) %} {% include [Ограничения защиты от удаления](../deletion-protection-limits-db.md) %} + diff --git a/ru/_includes/mdb/mch/hybrid-storage-settings-api.md b/ru/_includes/mdb/mch/hybrid-storage-settings-api.md deleted file mode 100644 index 36d466612ed..00000000000 --- a/ru/_includes/mdb/mch/hybrid-storage-settings-api.md +++ /dev/null @@ -1,4 +0,0 @@ -* `configSpec.cloudStorage.dataCacheEnabled` — разрешает временное хранение файлов в кластерном хранилище. По умолчанию — `true` (разрешено). -* `configSpec.cloudStorage.dataCacheMaxSize` — определяет максимальный объем памяти (в байтах), выделяемый в кластерном хранилище для временного хранения файлов. По умолчанию — `1073741824` (1 ГБ). -* `configSpec.cloudStorage.moveFactor` — устанавливает минимальную долю свободного места в кластерном хранилище. Если доля свободного места меньше этого значения, данные переносятся в {{ objstorage-full-name }}. Минимальное значение — `0`, максимальное — `1`, по умолчанию — `0.01`. -* `configSpec.cloudStorage.preferNotToMerge` — отключает [слияние кусков данных]({{ ch.docs }}/engines/table-engines/mergetree-family/custom-partitioning-key/) в кластерном и объектном хранилищах. Чтобы отключить слияние, укажите значение `true`. Чтобы оставить слияние включенным, укажите значение `false` или не передавайте параметр в запросе API при создании кластера. diff --git a/ru/_includes/mdb/mgp/cloud-storage-preview.md b/ru/_includes/mdb/mgp/cloud-storage-preview.md new file mode 100644 index 00000000000..5c313409be1 --- /dev/null +++ b/ru/_includes/mdb/mgp/cloud-storage-preview.md @@ -0,0 +1,5 @@ +{% note info %} + +Функциональность находится на стадии [Preview](../../../overview/concepts/launch-stages.md) и не тарифицируется. + +{% endnote %} diff --git a/ru/_includes/mdb/mgp/dbms-settings.md b/ru/_includes/mdb/mgp/dbms-settings.md index 52778736962..415054adf87 100644 --- a/ru/_includes/mdb/mgp/dbms-settings.md +++ b/ru/_includes/mdb/mgp/dbms-settings.md @@ -1,4 +1,4 @@ -* **Gp add column inherits table setting**{#setting-gp-add-column-inherits-table-setting} {{ tag-con }} {{ tag-api }} +* **Gp add column inherits table setting**{#setting-gp-add-column-inherits-table-setting} {{ tag-con }} {{ tag-tf }} {{ tag-api }} Определяет, применяются ли параметры сжатия данных (`compresstype`, `compresslevel` и `blocksize`), указанные для [AOCO-таблицы](../../../managed-greenplum/concepts/tables.md), при добавлении столбца. @@ -6,7 +6,7 @@ Подробнее см. в [документации {{ GP }}]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_add_column_inherits_table_setting). -* **Gp workfile compression**{#setting-gp-workfile-compression} {{ tag-con }} {{ tag-api }} +* **Gp workfile compression**{#setting-gp-workfile-compression} {{ tag-con }} {{ tag-tf }} {{ tag-api }} Определяет, будут ли сжаты временные файлы, созданные на диске в процессе хеш-соединения или агрегации хеша. @@ -14,7 +14,7 @@ Подробнее см. в [документации {{ GP }}]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_compression). -* **Gp workfile limits per query**{#setting-gp-workfile-limits} {{ tag-con }} {{ tag-api }} +* **Gp workfile limits per query**{#setting-gp-workfile-limits} {{ tag-con }} {{ tag-tf }} {{ tag-api }} Максимальный объем дискового пространства (в байтах), который могут занимать временные файлы активного запроса в каждом сегменте. @@ -22,7 +22,7 @@ Подробнее см. в [документации {{ GP }}]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_query). -* **Gp workfile limit files per query**{#setting-gp-workfile-limit-files} {{ tag-con }} {{ tag-api }} +* **Gp workfile limit files per query**{#setting-gp-workfile-limit-files} {{ tag-con }} {{ tag-tf }} {{ tag-api }} Максимальное количество временных файлов, которые сервис создает в сегменте для обработки одного запроса. Если этот предел превышен, запрос будет отменен. @@ -30,7 +30,7 @@ Подробнее см. в [документации {{ GP }}]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_files_per_query). -* **Gp workfile limit per segment**{#setting-gp-workfile-limit-per-segment} {{ tag-con }} {{ tag-api }} +* **Gp workfile limit per segment**{#setting-gp-workfile-limit-per-segment} {{ tag-con }} {{ tag-tf }} {{ tag-api }} Максимальный объем дискового пространства (в байтах), который могут занимать временные файлы всех активных запросов в каждом сегменте. @@ -96,7 +96,7 @@ Подробнее см. в [документации {{ GP }}]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#log_min_messages). -* **Log statement**{#setting-log-statement} {{ tag-con }} {{ tag-api }} +* **Log statement**{#setting-log-statement} {{ tag-con }} {{ tag-tf }} {{ tag-api }} Фильтр команд SQL, которые будут записаны в лог {{ GP }}: @@ -139,7 +139,7 @@ {% endnote %} -* **Max connections**{#setting-max-connections} {{ tag-con }} {{ tag-api }} +* **Max connections**{#setting-max-connections} {{ tag-con }} {{ tag-tf }} {{ tag-api }} Максимальное количество одновременных подключений к хосту-мастеру. @@ -149,7 +149,7 @@ Подробнее см. в [документации {{ GP }}]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#max_connections). -* **Max prepared transactions**{#setting-max-prepared-transactions} {{ tag-con }} {{ tag-api }} +* **Max prepared transactions**{#setting-max-prepared-transactions} {{ tag-con }} {{ tag-tf }} {{ tag-api }} Максимальное количество транзакций, которые могут одновременно находиться в [подготовленном состоянии]({{ pg.docs.org }}/current/sql-prepare-transaction.html). @@ -159,7 +159,7 @@ Подробнее см. в [документации {{ GP }}]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#max_prepared_transactions). -* **Max slot wal keep size**{#setting-max-slot-wal-keep-size} {{ tag-con }} {{ tag-api }} +* **Max slot wal keep size**{#setting-max-slot-wal-keep-size} {{ tag-con }} {{ tag-tf }} {{ tag-api }} Максимальный размер (в байтах) файлов лога [WAL](https://www.postgresql.org/docs/current/wal-intro.html) (Write-Ahead Log) при репликации. @@ -171,7 +171,7 @@ Подробнее см. в [документации {{ GP }}]({{ gp.docs.vmware }}/6/greenplum-database/ref_guide-config_params-guc-list.html#max_slot_wal_keep_size). -* **Max statement mem**{#setting-max-statement-mem} {{ tag-con }} {{ tag-api }} +* **Max statement mem**{#setting-max-statement-mem} {{ tag-con }} {{ tag-tf }} {{ tag-api }} Максимальный объем памяти (в байтах), выделяемый для обработки запроса. diff --git a/ru/_includes/mdb/mgp/pooling-mode.md b/ru/_includes/mdb/mgp/pooling-mode.md index 33e3903fbee..29dad439afe 100644 --- a/ru/_includes/mdb/mgp/pooling-mode.md +++ b/ru/_includes/mdb/mgp/pooling-mode.md @@ -1,5 +1,5 @@ -* **{{ ui-key.yacloud.mdb.forms.label_greenplum_pool_mode }}** – `SESSION` (сессионный, по умолчанию) или `TRANSACTION` (транзакционный). +* **{{ ui-key.yacloud.mdb.forms.label_greenplum_pool_mode }}** — `SESSION` (сессионный, по умолчанию) или `TRANSACTION` (транзакционный). * **{{ ui-key.yacloud.mdb.forms.label_greenplum_pool_size }}** — количество клиентских соединений. * **{{ ui-key.yacloud.mdb.forms.label_greenplum_pool_client-idle-timeout }}** — время неактивности клиентского соединения (в миллисекундах), после которого соединение разрывается. diff --git a/ru/_includes/mdb/mkf-zk-hosts.md b/ru/_includes/mdb/mkf-zk-hosts.md deleted file mode 100644 index a91928d6ac0..00000000000 --- a/ru/_includes/mdb/mkf-zk-hosts.md +++ /dev/null @@ -1,5 +0,0 @@ -{% note warning %} - -Если вы создаете кластер из более чем одного хоста, в кластер будут добавлены три выделенных хоста {{ ZK }}. Подробнее см. в разделе [Взаимосвязь ресурсов в {{ mkf-name }}](../../managed-kafka/concepts/index.md). - -{% endnote %} \ No newline at end of file diff --git a/ru/_includes/mdb/mkf/connect-properties-no-ssl.md b/ru/_includes/mdb/mkf/connect-properties-no-ssl.md new file mode 100644 index 00000000000..083a3285f07 --- /dev/null +++ b/ru/_includes/mdb/mkf/connect-properties-no-ssl.md @@ -0,0 +1,11 @@ +Создайте файлы с параметрами для подключения к кластеру: файл для производителя и файл для потребителя. + +Эти файлы имеют одинаковое содержимое, различаются только реквизиты пользователя: + +```ini +sasl.mechanism=SCRAM-SHA-512 +sasl.jaas.config=org.apache.kafka.common.security.scram.ScramLoginModule required \ + username="<логин_производителя_или_потребителя>" \ + password="<пароль_производителя_или_потребителя>"; +security.protocol=SASL_PLAINTEXT +``` diff --git a/ru/_includes/mdb/mkf/kafka-cli-tools-intro.md b/ru/_includes/mdb/mkf/kafka-cli-tools-intro.md new file mode 100644 index 00000000000..a755cf981d6 --- /dev/null +++ b/ru/_includes/mdb/mkf/kafka-cli-tools-intro.md @@ -0,0 +1,4 @@ +В состав [архивов с бинарными файлами {{ KF }}](https://kafka.apache.org/downloads) включен [набор инструментов](https://docs.confluent.io/kafka/operations-tools/kafka-tools.html), который позволяет управлять кластером {{ KF }} и сущностями в нем. Далее на примере будет показано, как указать реквизиты пользователя для подключения и использовать инструменты с этими реквизитами: + +* С помощью [kafka-console-producer](https://docs.confluent.io/kafka/operations-tools/kafka-tools.html#kafka-console-producer-sh) будет отправлено сообщение в топик. +* С помощью [kafka-console-consumer](https://docs.confluent.io/kafka/operations-tools/kafka-tools.html#kafka-console-consumer-sh) будет получено сообщение из топика. diff --git a/ru/_includes/mdb/mkf/kraft-cluster-topology.md b/ru/_includes/mdb/mkf/kraft-cluster-topology.md index dba9fc5a7e9..eb30480a688 100644 --- a/ru/_includes/mdb/mkf/kraft-cluster-topology.md +++ b/ru/_includes/mdb/mkf/kraft-cluster-topology.md @@ -3,4 +3,4 @@ * либо все три находятся в одной [зоне доступности](../../../overview/concepts/geo-scope.md); * либо каждый хост расположен в отдельной зоне доступности. -Подробнее о создании кластера {{ mkf-name }} с протоколом {{ kraft-short-name }} см. в [инструкции](../../../managed-kafka/operations/cluster-create.md#higher-version). +Подробнее о создании кластера {{ mkf-name }} с протоколом {{ kraft-short-name }} см. в [инструкции](../../../managed-kafka/operations/cluster-create.md#create-cluster). diff --git a/ru/_includes/mdb/mmg-extra-settings.md b/ru/_includes/mdb/mmg-extra-settings.md index f7ace05ce73..eb64b484a97 100644 --- a/ru/_includes/mdb/mmg-extra-settings.md +++ b/ru/_includes/mdb/mmg-extra-settings.md @@ -14,8 +14,9 @@ {% include [Maintenance window](console/maintenance-window-description.md) %} -- **{{ ui-key.yacloud.mdb.forms.field_diagnostics-enabled }}** — включите эту опцию, чтобы воспользоваться инструментом [{#T}](../../managed-mongodb/operations/performance-diagnostics.md) в кластере. Эта функциональность находится на стадии [Preview](../../overview/concepts/launch-stages.md). +- **{{ ui-key.yacloud.mdb.forms.field_diagnostics-enabled }}** — включите эту опцию, чтобы пользоваться встроенным инструментом для [диагностики производительности](../../managed-mongodb/operations/performance-diagnostics.md) в кластере. Эта функциональность находится на стадии [Preview](../../overview/concepts/launch-stages.md). - {% include [Deletion protection](console/deletion-protection.md) %} {% include [Ограничения защиты от удаления](deletion-protection-limits-db.md) %} + diff --git a/ru/_includes/mdb/mmy-extra-settings-web-console.md b/ru/_includes/mdb/mmy-extra-settings-web-console.md index 58296c4049e..1e4aeface20 100644 --- a/ru/_includes/mdb/mmy-extra-settings-web-console.md +++ b/ru/_includes/mdb/mmy-extra-settings-web-console.md @@ -22,3 +22,4 @@ - {% include [Deletion protection](console/deletion-protection.md) %} {% include [Ограничения защиты от удаления](deletion-protection-limits-db.md) %} + diff --git a/ru/_includes/monitoring/metrics-ref/managed-postgresql.md b/ru/_includes/monitoring/metrics-ref/managed-postgresql.md index 7433f54d250..f137476af3f 100644 --- a/ru/_includes/monitoring/metrics-ref/managed-postgresql.md +++ b/ru/_includes/monitoring/metrics-ref/managed-postgresql.md @@ -12,99 +12,106 @@ node | Тип хоста: `primary`, `replica` subcluster_name | Имя подкластера ## Метрики CPU {#managed-postgresql-cpu-metrics} + Загрузка процессорных ядер. | Имя
    Тип, единицы измерения | Описание | | ----- | ----- | -| `cpu.guest`
    `DGAUGE`, % | Использование процессорных ядер, тип потребления `guest`. | -| `cpu.idle`
    `DGAUGE`, % | Использование процессорных ядер, тип потребления `idle`. | -| `cpu.iowait`
    `DGAUGE`, % | Использование процессорных ядер, тип потребления `iowait`. | -| `cpu.irq`
    `DGAUGE`, % | Использование процессорных ядер, тип потребления `irq`. | -| `cpu.nice`
    `DGAUGE`, % | Использование процессорных ядер, тип потребления `nice`. | -| `cpu.softirq`
    `DGAUGE`, % | Использование процессорных ядер, тип потребления `softirq`. | -| `cpu.steal`
    `DGAUGE`, % | Использование процессорных ядер, тип потребления `steal`. | -| `cpu.system`
    `DGAUGE`, % | Использование процессорных ядер, тип потребления `system`. | +| `cpu.guest`
    `DGAUGE`, % | Использование процессорных ядер, тип потребления `guest`. | +| `cpu.idle`
    `DGAUGE`, % | Использование процессорных ядер, тип потребления `idle`. | +| `cpu.iowait`
    `DGAUGE`, % | Использование процессорных ядер, тип потребления `iowait`. | +| `cpu.irq`
    `DGAUGE`, % | Использование процессорных ядер, тип потребления `irq`. | +| `cpu.nice`
    `DGAUGE`, % | Использование процессорных ядер, тип потребления `nice`. | +| `cpu.softirq`
    `DGAUGE`, % | Использование процессорных ядер, тип потребления `softirq`. | +| `cpu.steal`
    `DGAUGE`, % | Использование процессорных ядер, тип потребления `steal`. | +| `cpu.system`
    `DGAUGE`, % | Использование процессорных ядер, тип потребления `system`. | | `cpu.user`
    `DGAUGE`, % | Использование процессорных ядер, тип потребления `user`. | -| `load.avg_15min`
    `DGAUGE`, % | Средняя нагрузка за 15 минут. | -| `load.avg_1min`
    `DGAUGE`, % | Средняя нагрузка за 1 минуту. | +| `load.avg_15min`
    `DGAUGE`, % | Средняя нагрузка за 15 минут. | +| `load.avg_1min`
    `DGAUGE`, % | Средняя нагрузка за 1 минуту. | | `load.avg_5min`
    `DGAUGE`, % | Средняя нагрузка за 5 минут. | | `pg_backend_cpu`
    `DGAUGE`, % | Утилизация CPU процессом {{ PG }}. | ## Метрики диска {#managed-postgresql-disk-metrics} + | Имя
    Тип, единицы измерения | Описание | | ----- | ----- | -| `disk.free_bytes`
    `DGAUGE`, байты | Свободное место. | -| `disk.free_inodes`
    `DGAUGE`, штуки | Свободное количество inodes. | -| `disk.temp_files_size`
    `DGAUGE`, байты | Размер временных файлов. | -| `disk.total_bytes`
    `DGAUGE`, байты | Доступное место. | -| `disk.total_inodes`
    `DGAUGE`, штуки | Доступное количество inodes. | -| `disk.used_bytes`
    `DGAUGE`, байты | Занятое место. | +| `disk.free_bytes`
    `DGAUGE`, байты | Свободное место. | +| `disk.free_inodes`
    `DGAUGE`, штуки | Свободное количество inodes. | +| `disk.temp_files_size`
    `DGAUGE`, байты | Размер временных файлов. | +| `disk.total_bytes`
    `DGAUGE`, байты | Доступное место. | +| `disk.total_inodes`
    `DGAUGE`, штуки | Доступное количество inodes. | +| `disk.used_bytes`
    `DGAUGE`, байты | Занятое место. | | `disk.used_inodes`
    `DGAUGE`, штуки | Занятое количество inodes. | | `disk.wal_size`
    `DGAUGE`, байты | Размер журнала упреждающей записи. | | `pg_backend_read_bytes`
    `DGAUGE`, байты/с | Скорость чтения данных процессом {{ PG }}. | | `pg_backend_write_bytes`
    `DGAUGE`, байты/с | Скорость записи данных процессом {{ PG }}. | ## Метрики дисковых операций {#managed-postgresql-diskio-metrics} + | Имя
    Тип, единицы измерения | Описание | | ----- | ----- | -| `io.avg_read_time`
    `DGAUGE`, миллисекунды | Среднее время чтения с дисков. | -| `io.avg_write_time`
    `DGAUGE`, миллисекунды | Среднее время записи на диски. | -| `io.disk*.avg_read_time`
    `DGAUGE`, миллисекунды | Среднее время чтения с конкретного диска. | -| `io.disk*.avg_write_time`
    `DGAUGE`, миллисекунды | Среднее время записи на конкретный диск. | -| `io.disk*.read_bytes`
    `DGAUGE`, байт/с | Скорость чтения с конкретного диска. | -| `io.disk*.read_count`
    `DGAUGE`, операций/с | Количество операций чтения с конкретного диска в секунду. | -| `io.disk*.read_merged_count`
    `DGAUGE`, операций/с | Количество слитых операций чтения с конкретного диска в секунду. | -| `io.disk*.utilization`
    `DGAUGE`, % | Использование конкретного диска. Не работает для сетевых дисков. | -| `io.disk*.write_bytes`
    `DGAUGE`, байт/с | Скорость записи на конкретный диск. | -| `io.disk*.write_count`
    `DGAUGE`, операций/с | Количество операций записи на конкретный диск в секунду. | +| `io.avg_read_time`
    `DGAUGE`, миллисекунды | Среднее время чтения с дисков. | +| `io.avg_write_time`
    `DGAUGE`, миллисекунды | Среднее время записи на диски. | +| `io.disk*.avg_read_time`
    `DGAUGE`, миллисекунды | Среднее время чтения с конкретного диска. | +| `io.disk*.avg_write_time`
    `DGAUGE`, миллисекунды | Среднее время записи на конкретный диск. | +| `io.disk*.read_bytes`
    `DGAUGE`, байт/с | Скорость чтения с конкретного диска. | +| `io.disk*.read_count`
    `DGAUGE`, операций/с | Количество операций чтения с конкретного диска в секунду. | +| `io.disk*.read_merged_count`
    `DGAUGE`, операций/с | Количество слитых операций чтения с конкретного диска в секунду. | +| `io.disk*.utilization`
    `DGAUGE`, % | Использование конкретного диска. Не работает для сетевых дисков. | +| `io.disk*.write_bytes`
    `DGAUGE`, байт/с | Скорость записи на конкретный диск. | +| `io.disk*.write_count`
    `DGAUGE`, операций/с | Количество операций записи на конкретный диск в секунду. | | `io.disk*.write_merged_count`
    `DGAUGE`, операций/с | Количество слитых операций записи на конкретный диск в секунду. | -| `io.read_bytes`
    `DGAUGE`, байт/с | Скорость чтения с дисков. | -| `io.read_count`
    `DGAUGE`, операций/с | Количество операций чтения в секунду. | -| `io.read_merged_count`
    `DGAUGE`, операций/с | Количество слитых операций чтения в секунду. | -| `io.utilization`
    `DGAUGE`, % | Использование дисков. | -| `io.write_bytes`
    `DGAUGE`, байт/с | Скорость записи на диски. | -| `io.write_count`
    `DGAUGE`, операций/с | Количество операций записи в секунду. | +| `io.read_bytes`
    `DGAUGE`, байт/с | Скорость чтения с дисков. | +| `io.read_count`
    `DGAUGE`, операций/с | Количество операций чтения в секунду. | +| `io.read_merged_count`
    `DGAUGE`, операций/с | Количество слитых операций чтения в секунду. | +| `io.utilization`
    `DGAUGE`, % | Использование дисков. | +| `io.write_bytes`
    `DGAUGE`, байт/с | Скорость записи на диски. | +| `io.write_count`
    `DGAUGE`, операций/с | Количество операций записи в секунду. | | `io.write_merged_count`
    `DGAUGE`, операций/с | Количество слитых операций записи в секунду. | ## Метрики RAM {#managed-postgresql-ram-metrics} + | Имя
    Тип, единицы измерения | Описание | | ----- | ----- | -| `mem.active_bytes`
    `DGAUGE`, байты | Объем оперативной памяти, которая используется наиболее часто и освобождается только в крайнем случае. | -| `mem.available_bytes`
    `DGAUGE`, байты | Использование оперативной памяти, тип потребления `available`. | -| `mem.buffers_bytes`
    `DGAUGE`, байты | Использование оперативной памяти, тип потребления `buffers`. | -| `mem.cached_bytes`
    `DGAUGE`, байты | Использование оперативной памяти, тип потребления `cached`. | +| `mem.active_bytes`
    `DGAUGE`, байты | Объем оперативной памяти, которая используется наиболее часто и освобождается только в крайнем случае. | +| `mem.available_bytes`
    `DGAUGE`, байты | Использование оперативной памяти, тип потребления `available`. | +| `mem.buffers_bytes`
    `DGAUGE`, байты | Использование оперативной памяти, тип потребления `buffers`. | +| `mem.cached_bytes`
    `DGAUGE`, байты | Использование оперативной памяти, тип потребления `cached`. | | `mem.free_bytes`
    `DGAUGE`, байты | Объем свободной оперативной памяти, доступной для использования, без учета `mem.buffers_bytes` и `mem.cached_bytes`. | -| `mem.shared_bytes`
    `DGAUGE`, байты | Использование оперативной памяти, тип потребления `shared`. | -| `mem.total_bytes`
    `DGAUGE`, байты | Использование оперативной памяти, тип потребления `total`. | -| `mem.used_bytes`
    `DGAUGE`, байты | Объем оперативной памяти, которую в данный момент используют запущенные процессы. | +| `mem.shared_bytes`
    `DGAUGE`, байты | Использование оперативной памяти, тип потребления `shared`. | +| `mem.total_bytes`
    `DGAUGE`, байты | Использование оперативной памяти, тип потребления `total`. | +| `mem.used_bytes`
    `DGAUGE`, байты | Объем оперативной памяти, которую в данный момент используют запущенные процессы. | | `oom_count`
    `DGAUGE`, штуки | Количество случаев нехватки памяти. | ## Метрики сети {#managed-postgresql-net-metrics} + | Имя
    Тип, единицы измерения | Описание | | ----- | ----- | -| `net.bytes_recv`
    `DGAUGE`, байт/с | Скорость получения данных по сети. | -| `net.bytes_sent`
    `DGAUGE`, байт/с | Скорость отправки данных по сети. | -| `net.dropin`
    `DGAUGE`, штуки | Количество пакетов, отброшенных при получении. | -| `net.dropout`
    `DGAUGE`, штуки | Количество пакетов, отброшенных при отправке. | -| `net.errin`
    `DGAUGE`, штуки | Количество ошибок при получении. | -| `net.errout`
    `DGAUGE`, штуки | Количество ошибок при отправке. | -| `net.packets_recv`
    `DGAUGE`, пакетов/с | Интенсивность получения данных по сети. | +| `net.bytes_recv`
    `DGAUGE`, байт/с | Скорость получения данных по сети. | +| `net.bytes_sent`
    `DGAUGE`, байт/с | Скорость отправки данных по сети. | +| `net.dropin`
    `DGAUGE`, штуки | Количество пакетов, отброшенных при получении. | +| `net.dropout`
    `DGAUGE`, штуки | Количество пакетов, отброшенных при отправке. | +| `net.errin`
    `DGAUGE`, штуки | Количество ошибок при получении. | +| `net.errout`
    `DGAUGE`, штуки | Количество ошибок при отправке. | +| `net.packets_recv`
    `DGAUGE`, пакетов/с | Интенсивность получения данных по сети. | | `net.packets_sent`
    `DGAUGE`, пакетов/с | Интенсивность отправки данных по сети. | ## Метрики сервиса {#managed-postgresql-metrics} + #### Метрики кластера {#managed-postgresql-cluster-metrics} + | Имя
    Тип, единицы измерения | Описание | | ----- | ----- | -| `can_read`
    `DGAUGE`, 0/1 | Показатель доступности на чтение.
    Принимает значение `1`, если кластер доступен на чтение, `0`, если нет. | +| `can_read`
    `DGAUGE`, 0/1 | Показатель доступности на чтение.
    Принимает значение `1`, если кластер доступен на чтение, `0`, если нет. | | `can_write`
    `DGAUGE`, 0/1 | Показатель доступности на запись.
    Принимает значение `1`, если кластер доступен на запись, `0`, если нет. | -| `postgres-is_alive`
    `DGAUGE`, 0/1 | Показатель работоспособности хоста.
    Принимает значение `1`, если хост БД работает, `0`, если нет. | -| `postgres-is_primary`
    `DGAUGE`, 0/1 | Показатель хоста-мастера.
    Принимает значение `1`, если хост БД является мастером, `0`, если нет. | -| `postgres-is_replica`
    `DGAUGE`, 0/1 | Показатель хоста-реплики.
    Принимает значение `1`, если хост БД является репликой, `0`, если нет. | -| `postgres-log_errors`
    `DGAUGE`, сообщений/с| Количество логированных ошибок в секунду. | -| `postgres-log_fatals`
    `DGAUGE`, сообщений/с| Количество фатальных логированных ошибок в секунду. | -| `postgres-log_slow_queries`
    `DGAUGE`, запросов/с| Количество логированных медленных запросов в секунду. | -| `postgres-log_warnings`
    `DGAUGE`, сообщений/с| Количество логированных предупреждений в секунду. | -| `postgres-replication_lag`
    `DGAUGE`, секунды | Время задержки репликации. | +| `postgres-is_alive`
    `DGAUGE`, 0/1 | Показатель работоспособности хоста.
    Принимает значение `1`, если хост БД работает, `0`, если нет. | +| `postgres-is_primary`
    `DGAUGE`, 0/1 | Показатель хоста-мастера.
    Принимает значение `1`, если хост БД является мастером, `0`, если нет. | +| `postgres-is_replica`
    `DGAUGE`, 0/1 | Показатель хоста-реплики.
    Принимает значение `1`, если хост БД является репликой, `0`, если нет. | +| `postgres-log_errors`
    `DGAUGE`, сообщений/с| Количество логированных ошибок в секунду. | +| `postgres-log_fatals`
    `DGAUGE`, сообщений/с| Количество фатальных логированных ошибок в секунду. | +| `postgres-log_slow_queries`
    `DGAUGE`, запросов/с| Количество логированных медленных запросов в секунду. | +| `postgres-log_warnings`
    `DGAUGE`, сообщений/с| Количество логированных предупреждений в секунду. | +| `postgres-replication_lag`
    `DGAUGE`, секунды | Время задержки репликации. | | `postgres_max_connections`
    `DGAUGE`, штуки | Максимальное количество подключений. | | `postgres-oldest_inactive_replication_slot_duration`
    `DGAUGE`, секунды | Длительность самого старого неактивного слота репликации. | | `postgres_oldest_prepared_xact_duration`
    `DGAUGE`, секунды | Длительность самой старой подготовленной транзакции. | @@ -112,65 +119,78 @@ subcluster_name | Имя подкластера | `postgres_oldest_transaction_duration`
    `DGAUGE`, секунды | Длительность самой старой транзакции. | | `postgres_role_conn_limit`
    `DGAUGE`, штуки | Максимально возможное количество одновременных сессий пользователя. | | `postgres_role_total_conn_limit`
    `DGAUGE`, штуки | Максимально возможное количество одновременных сессий всех пользователей. | -| `postgres_total_connections`
    `DGAUGE`, штуки | Количество подключений. | +| `postgres_total_connections`
    `DGAUGE`, штуки | Количество подключений. | | `postgres_wal_rate_bytes`
    `DGAUGE`, байт/с | Скорость записи в журнал упреждающей записи. | | `postgres_xid_left`
    `DGAUGE`, штуки | Количество оставшихся счетчиков транзакций. | | `postgres_xid_left_percent`
    `DGAUGE`, % | Доля оставшихся счетчиков транзакций. | | `postgres_xid_used_percent`
    `DGAUGE`, % | Доля использованных счетчиков транзакций. | #### Метрики базы данных {#managed-postgresql-db-metrics} + | Имя
    Тип, единицы измерения | Описание | | ----- | ----- | -| `_pg_database_size`
    `DGAUGE`, байты | Размер базы.
    Дополнительные метки: `dbname`| -| `<имя_БД>_tup_deleted`
    `DGAUGE`, штуки | Количество строк, удаленное запросами в этой базе данных `<имя_БД>`. | -| `<имя_БД>_tup_fetched`
    `DGAUGE`, штуки | Количество строк, извлеченное запросами в этой базе данных `<имя_БД>`. | -| `<имя_БД>_tup_inserted`
    `DGAUGE`, штуки | Количество строк, вставленное запросами в этой базе данных `<имя_БД>`. | -| `<имя_БД>_tup_returned`
    `DGAUGE`, штуки | Количество строк, возвращенное запросами в этой базе данных `<имя_БД>`. | +| `_pg_database_size`
    `DGAUGE`, байты | Размер базы.
    Дополнительные метки: `dbname`| +| `<имя_БД>_tup_deleted`
    `DGAUGE`, штуки | Количество строк, удаленное запросами в этой базе данных `<имя_БД>`. | +| `<имя_БД>_tup_fetched`
    `DGAUGE`, штуки | Количество строк, извлеченное запросами в этой базе данных `<имя_БД>`. | +| `<имя_БД>_tup_inserted`
    `DGAUGE`, штуки | Количество строк, вставленное запросами в этой базе данных `<имя_БД>`. | +| `<имя_БД>_tup_returned`
    `DGAUGE`, штуки | Количество строк, возвращенное запросами в этой базе данных `<имя_БД>`. | | `<имя_БД>_tup_updated`
    `DGAUGE`, штуки | Количество строк, измененное запросами в этой базе данных `<имя_БД>`. | #### Метрики менеджера подключений {#managed-postgresql-pooler-metrics} + | Имя
    Тип, единицы измерения | Описание | | ----- | ----- | -| `pooler-avg_query_time`
    `DGAUGE`, миллисекунды | Среднее время выполнения одного запроса на каждом из хостов БД. | -| `pooler-avg_xact_time`
    `DGAUGE`, миллисекунды | Среднее время выполнения одной транзакции на каждом из хостов БД. | -| `pooler-bytes_recieved`
    `DGAUGE`, байты | Объем полученных данных. | +| `pooler-avg_query_time`
    `DGAUGE`, миллисекунды | Среднее время выполнения одного запроса на каждом из хостов БД. | +| `pooler-avg_xact_time`
    `DGAUGE`, миллисекунды | Среднее время выполнения одной транзакции на каждом из хостов БД. | +| `pooler-bytes_recieved`
    `DGAUGE`, байты | Объем полученных данных. | | `pooler-bytes_recieved-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, байты | Объем данных, полученных пользователем `<имя_пользователя>` через базу данных `<имя_БД>`. | -| `pooler-bytes_sent`
    `DGAUGE`, байты | Объем отправленных данных. | +| `pooler-bytes_sent`
    `DGAUGE`, байты | Объем отправленных данных. | | `pooler-bytes_sent-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, байты | Объем данных, отправленных пользователем `<имя_пользователя>` через базу данных `<имя_БД>`. | -| `pooler-free_clients`
    `DGAUGE`, штуки | Количество оставшихся клиентских подключений в менеджере подключений. | -| `pooler-free_servers`
    `DGAUGE`, штуки | Количество оставшихся серверных подключений в менеджере подключений. | +| `pooler-free_clients`
    `DGAUGE`, штуки | Количество оставшихся клиентских подключений в менеджере подключений. | +| `pooler-free_servers`
    `DGAUGE`, штуки | Количество оставшихся серверных подключений в менеджере подключений. | | `pooler-is_alive`
    `DGAUGE`, 0/1 | Работоспособность менеджера подключений, для каждого хоста в каждой из ролей: мастера и реплики. | | `pooler-login_clients`
    `DGAUGE`, штуки | Количество совершенных клиентских подключений в менеджере соединений. | -| `pooler-pgbouncer_tcp_connections`
    `DGAUGE`, подключений/с | Количество TCP-подключений postgresql. | -| `pooler-postgres_tcp_connections`
    `DGAUGE`, подключений/с | Количество TCP-подключений pgbouncer. | -| `pooler-query_0.5`
    `DGAUGE`, секунды | Время выполнения запросов, медиана. | -| `pooler-query_0.5-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, секунды | Время выполнения запросов пользователем `<имя_пользователя>` через базу данных `<имя_БД>`, медиана. | -| `pooler-query_0.75`
    `DGAUGE`, секунды | Время выполнения запросов, 0.75 процентиль. | -| `pooler-query_0.75-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, секунды | Время выполнения запросов пользователем `<имя_пользователя>` через базу данных `<имя_БД>`, 0.75 процентиль. | -| `pooler-query_0.9`
    `DGAUGE`, секунды | Время выполнения запросов, 0.9 процентиль. | -| `pooler-query_0.9-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, секунды | Время выполнения запросов пользователем `<имя_пользователя>` через базу данных `<имя_БД>`, 0.9 процентиль. | -| `pooler-query_0.95`
    `DGAUGE`, секунды | Время выполнения запросов, 0.95 процентиль. | -| `pooler-query_0.95-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, секунды | Время выполнения запросов пользователем `<имя_пользователя>` через базу данных `<имя_БД>`, 0.95 процентиль. | -| `pooler-query_0.99`
    `DGAUGE`, секунды | Время выполнения запросов, 0.99 процентиль. | -| `pooler-query_0.99-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, секунды | Время выполнения запросов пользователем `<имя_пользователя>` через базу данных `<имя_БД>`, 0.99 процентиль. | -| `pooler-query_0.999`
    `DGAUGE`, секунды | Время выполнения запросов, 0.999 процентиль. | -| `pooler-query_0.999-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, секунды | Время выполнения запросов пользователем `<имя_пользователя>` через базу данных `<имя_БД>`, 0.999 процентиль. | -| `pooler-query_count`
    `DGAUGE`, штуки | Количество запросов, выполняющихся на каждом из хостов БД. | -| `pooler-tcp_conn_count`
    `DGAUGE`, штуки | Количество TCP-подключений к каждому хосту БД. | -| `pooler-tcp_conn_count-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, штуки | Количество TCP-подключений к каждому хосту БД пользователем `<имя_пользователя>` через базу данных `<имя_БД>`. | -| `pooler-total_tcp_connections`
    `DGAUGE`, подключений/с | Количество TCP-подключений postgresql и pgbouncer. | -| `pooler-transaction_0.5`
    `DGAUGE`, секунды | Время обработки транзакций, медиана. | -| `pooler-transaction_0.5-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, секунды | Время обработки транзакций пользователем `<имя_пользователя>` через базу данных `<имя_БД>`, медиана. | -| `pooler-transaction_0.75`
    `DGAUGE`, секунды | Время обработки транзакций, 0.75 процентиль. | -| `pooler-transaction_0.75-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, секунды | Время обработки транзакций пользователем `<имя_пользователя>` через базу данных `<имя_БД>`, 0.75 процентиль. | -| `pooler-transaction_0.9`
    `DGAUGE`, секунды | Время обработки транзакций, 0.9 процентиль. | -| `pooler-transaction_0.9-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, секунды | Время обработки транзакций пользователем `<имя_пользователя>` через базу данных `<имя_БД>`, 0.9 процентиль. | -| `pooler-transaction_0.95`
    `DGAUGE`, секунды | Время обработки транзакций, 0.95 процентиль. | -| `pooler-transaction_0.95-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, секунды | Время обработки транзакций пользователем `<имя_пользователя>` через базу данных `<имя_БД>`, 0.95 процентиль. | -| `pooler-transaction_0.99`
    `DGAUGE`, секунды | Время обработки транзакций, 0.99 процентиль. | -| `pooler-transaction_0.99-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, секунды | Время обработки транзакций пользователем `<имя_пользователя>` через базу данных `<имя_БД>`, 0.99 процентиль. | -| `pooler-transaction_0.999`
    `DGAUGE`, секунды | Время обработки транзакций, 0.999 процентиль. | -| `pooler-transaction_0.999-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, секунды | Время обработки транзакций пользователем `<имя_пользователя>` через базу данных `<имя_БД>`, 0.999 процентиль. | -| `pooler-used_clients`
    `DGAUGE`, штуки | Количество клиентских подключений в менеджере подключений. | +| `pooler-pgbouncer_tcp_connections`
    `DGAUGE`, подключений/с | Количество TCP-подключений postgresql. | +| `pooler-postgres_tcp_connections`
    `DGAUGE`, подключений/с | Количество TCP-подключений pgbouncer. | +| `pooler-query_0.5`
    `DGAUGE`, секунды | Время выполнения запросов, медиана. | +| `pooler-query_0.5-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, секунды | Время выполнения запросов пользователем `<имя_пользователя>` через базу данных `<имя_БД>`, медиана. | +| `pooler-query_0.75`
    `DGAUGE`, секунды | Время выполнения запросов, 0.75 процентиль. | +| `pooler-query_0.75-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, секунды | Время выполнения запросов пользователем `<имя_пользователя>` через базу данных `<имя_БД>`, 0.75 процентиль. | +| `pooler-query_0.9`
    `DGAUGE`, секунды | Время выполнения запросов, 0.9 процентиль. | +| `pooler-query_0.9-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, секунды | Время выполнения запросов пользователем `<имя_пользователя>` через базу данных `<имя_БД>`, 0.9 процентиль. | +| `pooler-query_0.95`
    `DGAUGE`, секунды | Время выполнения запросов, 0.95 процентиль. | +| `pooler-query_0.95-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, секунды | Время выполнения запросов пользователем `<имя_пользователя>` через базу данных `<имя_БД>`, 0.95 процентиль. | +| `pooler-query_0.99`
    `DGAUGE`, секунды | Время выполнения запросов, 0.99 процентиль. | +| `pooler-query_0.99-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, секунды | Время выполнения запросов пользователем `<имя_пользователя>` через базу данных `<имя_БД>`, 0.99 процентиль. | +| `pooler-query_0.999`
    `DGAUGE`, секунды | Время выполнения запросов, 0.999 процентиль. | +| `pooler-query_0.999-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, секунды | Время выполнения запросов пользователем `<имя_пользователя>` через базу данных `<имя_БД>`, 0.999 процентиль. | +| `pooler-query_count`
    `DGAUGE`, штуки | Количество запросов, выполняющихся на каждом из хостов БД. | +| `pooler-tcp_conn_count`
    `DGAUGE`, штуки | Количество TCP-подключений к каждому хосту БД. | +| `pooler-tcp_conn_count-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, штуки | Количество TCP-подключений к каждому хосту БД пользователем `<имя_пользователя>` через базу данных `<имя_БД>`. | +| `pooler-total_tcp_connections`
    `DGAUGE`, подключений/с | Количество TCP-подключений postgresql и pgbouncer. | +| `pooler-transaction_0.5`
    `DGAUGE`, секунды | Время обработки транзакций, медиана. | +| `pooler-transaction_0.5-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, секунды | Время обработки транзакций пользователем `<имя_пользователя>` через базу данных `<имя_БД>`, медиана. | +| `pooler-transaction_0.75`
    `DGAUGE`, секунды | Время обработки транзакций, 0.75 процентиль. | +| `pooler-transaction_0.75-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, секунды | Время обработки транзакций пользователем `<имя_пользователя>` через базу данных `<имя_БД>`, 0.75 процентиль. | +| `pooler-transaction_0.9`
    `DGAUGE`, секунды | Время обработки транзакций, 0.9 процентиль. | +| `pooler-transaction_0.9-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, секунды | Время обработки транзакций пользователем `<имя_пользователя>` через базу данных `<имя_БД>`, 0.9 процентиль. | +| `pooler-transaction_0.95`
    `DGAUGE`, секунды | Время обработки транзакций, 0.95 процентиль. | +| `pooler-transaction_0.95-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, секунды | Время обработки транзакций пользователем `<имя_пользователя>` через базу данных `<имя_БД>`, 0.95 процентиль. | +| `pooler-transaction_0.99`
    `DGAUGE`, секунды | Время обработки транзакций, 0.99 процентиль. | +| `pooler-transaction_0.99-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, секунды | Время обработки транзакций пользователем `<имя_пользователя>` через базу данных `<имя_БД>`, 0.99 процентиль. | +| `pooler-transaction_0.999`
    `DGAUGE`, секунды | Время обработки транзакций, 0.999 процентиль. | +| `pooler-transaction_0.999-<имя_БД>-<имя_пользователя>`
    `DGAUGE`, секунды | Время обработки транзакций пользователем `<имя_пользователя>` через базу данных `<имя_БД>`, 0.999 процентиль. | +| `pooler-used_clients`
    `DGAUGE`, штуки | Количество клиентских подключений в менеджере подключений. | | `pooler-used_servers`
    `DGAUGE`, штуки | Количество серверных подключений в менеджере подключений. | | `pooler-xact_count`
    `DGAUGE`, штуки | Количество транзакций, выполняющихся на каждом из хостов БД. | + +#### Метрики vacuum {#managed-postgresql-vacuum} + +| Имя
    Тип, единицы измерения | Описание | +| ----- | ----- | +| `postgres_autovacuum.autovacuum_max_workers`
    `DGAUGE`, штуки | Максимальное количество autovacuum-процессов. Значение этой метрики управляется настройкой `autovacuum_max_workers`. | +| `postgres_autovacuum.total_regular_workers`
    `DGAUGE`, штуки | Количество активных autovacuum-процессов. | +| `postgres_autovacuum.total_user_workers`
    `DGAUGE`, штуки | Количество активных vacuum-процессов, вручную запущенных пользователем. | +| `postgres_autovacuum.total_wraparound_workers`
    `DGAUGE`, штуки | Количество активных autovacuum-процессов, запущенных для предотвращения [wraparound](https://www.postgresql.org/docs/current/routine-vacuuming.html#VACUUM-FOR-WRAPAROUND). | +| `postgres_autovacuum.scanned_pct`
    `DGAUGE`, % | Процент строк в таблице, просканированных процессом autovacuum. | +| `postgres_autovacuum.vacuumed_pct`
    `DGAUGE`, % | Процент строк в таблице, очищенных процессом autovacuum. | diff --git a/ru/_includes/speechsense-limits.md b/ru/_includes/speechsense-limits.md new file mode 100644 index 00000000000..edcd20cd859 --- /dev/null +++ b/ru/_includes/speechsense-limits.md @@ -0,0 +1,7 @@ +#### Лимиты {#limits} + +Вид ограничения | Значение +----- | ----- +Срок хранения пользовательских данных | 3 месяца +Пересчет измененных и вновь созданных [тегов](../speechsense/concepts/tags.md) за месяц | Раз в сутки ночью +Количество возвращаемых результатов [поиска](../speechsense/operations/data/search-data.md) | 10 000 diff --git a/ru/_includes/speechsense/tag/tag-settings.md b/ru/_includes/speechsense/tag/tag-settings.md index 23c49b53c79..2c5e83e6247 100644 --- a/ru/_includes/speechsense/tag/tag-settings.md +++ b/ru/_includes/speechsense/tag/tag-settings.md @@ -43,7 +43,7 @@ * (Опционально) В поле **{{ ui-key.yc-ui-talkanalytics.tags.words-between-key-value }}** укажите разрыв между словами во фразе-исключении, который допустим при поиске. -* **{{ ui-key.yc-ui-talkanalytics.tags.restrictions }}** — добавьте или удалите [ограничения](../../../speechsense/concepts/tags.md#tag-limitations). +* **{{ ui-key.yc-ui-talkanalytics.tags.restrictions }}** — добавьте или удалите [ограничения](../../../speechsense/concepts/tags.md#tag-limitations). Если выбрано ограничение **{{ ui-key.yc-ui-talkanalytics.tags.binding-events.silence-key-value }}**, задайте длительность паузы в секундах. diff --git a/ru/_includes/terraform-intro.md b/ru/_includes/terraform-intro.md new file mode 100644 index 00000000000..6b43554f280 --- /dev/null +++ b/ru/_includes/terraform-intro.md @@ -0,0 +1,3 @@ +[{{ TF }}](https://www.terraform.io/) позволяет быстро создать облачную инфраструктуру в {{ yandex-cloud }} и управлять ею с помощью файлов конфигураций. В файлах конфигураций хранится описание инфраструктуры на языке HCL (HashiCorp Configuration Language). При изменении файлов конфигураций {{ TF }} автоматически определяет, какая часть вашей конфигурации уже развернута, что следует добавить или удалить. + +{{ TF }} распространяется под лицензией [Business Source License](https://github.com/hashicorp/terraform/blob/main/LICENSE), а [провайдер {{ yandex-cloud }} для {{ TF }}](https://github.com/yandex-cloud/terraform-provider-yandex) — под лицензией [MPL-2.0](https://www.mozilla.org/en-US/MPL/2.0/). \ No newline at end of file diff --git a/ru/_includes/terraform-ref-intro.md b/ru/_includes/terraform-ref-intro.md index 87ffc675ac8..6bfa8dc5d26 100644 --- a/ru/_includes/terraform-ref-intro.md +++ b/ru/_includes/terraform-ref-intro.md @@ -1,6 +1,4 @@ -[{{ TF }}](https://www.terraform.io/) позволяет быстро создать облачную инфраструктуру в {{ yandex-cloud }} и управлять ею с помощью файлов конфигураций. В файлах конфигураций хранится описание инфраструктуры на языке HCL (HashiCorp Configuration Language). {{ TF }} и его провайдеры распространяются под лицензией [Business Source License](https://github.com/hashicorp/terraform/blob/main/LICENSE). - -При изменении файлов конфигураций {{ TF }} автоматически определяет, какая часть вашей конфигурации уже развернута, что следует добавить или удалить. +{% include [terraform-intro](../_includes/terraform-intro.md) %} Подробнее о {{ TF }} [читайте в документации](../tutorials/infrastructure-management/terraform-quickstart.md#install-terraform). diff --git a/ru/_includes/tracker/color-issue.md b/ru/_includes/tracker/color-issue.md index 8ab2942d725..66b9f8ce622 100644 --- a/ru/_includes/tracker/color-issue.md +++ b/ru/_includes/tracker/color-issue.md @@ -4,7 +4,7 @@ Чтобы выбрать другую цветовую схему: -1. Над временной шкалой справа нажмите ![](../../_assets/tracker/svg/gantt-settings-button.svg) **{{ ui-key.startrek.ui_components_Gantt.timeline-config }}**. +1. Над временной шкалой справа нажмите ![](../../_assets/tracker/svg/gantt-settings-button.svg) **Настройки диаграммы**. 1. В блоке **{{ ui-key.startrek-backend.fields.issue.paletteColor }}** вы можете выбрать подходящий вариант цветовой схемы: {% list tabs %} @@ -13,10 +13,10 @@ С помощью этой опции вы сможете назначать цвета для задач прямо на диаграмме. - 1. Выберите **{{ ui-key.startrek.ui_components_Gantt.color-type-by-manual }}**. + 1. Выберите **назначать вручную**. 1. Нажмите кнопку **Применить**. - В списке слева от диаграммы выберите задачу и нажмите кнопку ![](../../_assets/horizontal-ellipsis.svg) **{{ ui-key.startrek.ui_components_Gantt_IssueActionsCell.issue-action-menu-title }}**. Откроется палитра, из которой вы сможете назначить задаче цвет. + В списке слева от диаграммы выберите задачу и нажмите кнопку ![](../../_assets/horizontal-ellipsis.svg) **Меню действий задачи**. Откроется палитра, из которой вы сможете назначить задаче цвет. ![](../../_assets/tracker/three-dots-menu.png) @@ -24,7 +24,7 @@ Опция пригодится, если нужно различать задачи по некоторому параметру, например, очереди или тегу. - 1. Выберите **{{ ui-key.startrek.ui_components_Gantt.color-type-by-parameter }}**. + 1. Выберите **по параметрам задачи**. 1. Укажите параметр, значениям которого вы будете назначать цвет. 1. Нажмите кнопку **Применить**. @@ -32,7 +32,7 @@ Полосы всех задач на диаграмме будут отображаться в голубом цвете. - 1. Выберите **{{ ui-key.startrek.ui_components_Gantt.color-type-monochrome }}**. + 1. Выберите **однотонный**. 1. Нажмите кнопку **Применить**. {% endlist %} diff --git a/ru/_includes/tracker/external-blockers.md b/ru/_includes/tracker/external-blockers.md index 62a456273bf..f5f687ec66a 100644 --- a/ru/_includes/tracker/external-blockers.md +++ b/ru/_includes/tracker/external-blockers.md @@ -1 +1 @@ -* Чтобы включить отображение внешних блокеров в списке задач, активируйте опцию **{{ ui-key.startrek.ui_components_Gantt.show-external-blockers }}**. +* Чтобы включить отображение внешних блокеров в списке задач, активируйте опцию **Показывать внешние блокеры**. diff --git a/ru/_includes/tracker/gantt-assigned.md b/ru/_includes/tracker/gantt-assigned.md index 65b31d0d519..b7c9760ac6a 100644 --- a/ru/_includes/tracker/gantt-assigned.md +++ b/ru/_includes/tracker/gantt-assigned.md @@ -6,6 +6,6 @@ {% note info %} -Если кнопка ![](../../_assets/tracker/svg/pick-user.svg) не отображается на полосе задачи, перейдите в ![](../../_assets/tracker/svg/gantt-settings-button.svg) **{{ ui-key.startrek.ui_components_Gantt.timeline-config }}** и в разделе **Полоса задачи** отметьте пункт **исполнителя**. +Если кнопка ![](../../_assets/tracker/svg/pick-user.svg) не отображается на полосе задачи, перейдите в ![](../../_assets/tracker/svg/gantt-settings-button.svg) **Настройки диаграммы** и в разделе **Полоса задачи** отметьте пункт **исполнителя**. {% endnote %} diff --git a/ru/_includes/tracker/gantt-time-scale.md b/ru/_includes/tracker/gantt-time-scale.md index 94d38be075e..282db61882e 100644 --- a/ru/_includes/tracker/gantt-time-scale.md +++ b/ru/_includes/tracker/gantt-time-scale.md @@ -1 +1 @@ -Чтобы настроить временной масштаб, в нижнем правом углу диаграммы выберите **{{ ui-key.startrek.ui_components_Gantt.scale-days }}**, **{{ ui-key.startrek.ui_components_Gantt.scale-month }}** или **{{ ui-key.startrek.ui_components_Gantt.scale-quarters }}**. Настройки масштаба сохранятся после обновления страницы или при повторном переходе в диаграмму. \ No newline at end of file +Чтобы настроить временной масштаб, в нижнем правом углу диаграммы выберите **Неделя**, **Месяц** или **Квартал**. Настройки масштаба сохранятся после обновления страницы или при повторном переходе в диаграмму. \ No newline at end of file diff --git a/ru/_includes/tracker/gantt-timing-prolongate.md b/ru/_includes/tracker/gantt-timing-prolongate.md index 7409c8c5b6a..fed3d9f40b2 100644 --- a/ru/_includes/tracker/gantt-timing-prolongate.md +++ b/ru/_includes/tracker/gantt-timing-prolongate.md @@ -1 +1 @@ -* Чтобы настроить автоматическое изменение сроков для зависимых задач, перейдите в ![](../../_assets/tracker/svg/gantt-settings-button.svg) **{{ ui-key.startrek.ui_components_Gantt.timeline-config }}** и отметьте пункт **{{ ui-key.startrek.ui_components_Gantt.shift-blocked-with-blocker }}**. Если дедлайн блокирующей задачи позже, чем дата начала работ по зависимой задаче, дата начала работ по зависимой задаче будет сдвигаться в соответствии с новым дедлайном блокирующей задачи. +* Чтобы настроить автоматическое изменение сроков для зависимых задач, перейдите в ![](../../_assets/tracker/svg/gantt-settings-button.svg) **Настройки диаграммы** и отметьте пункт **Автоматически сдвигать сроки зависимой задачи при переносе дедлайна блокирующей задачи**. Если дедлайн блокирующей задачи позже, чем дата начала работ по зависимой задаче, дата начала работ по зависимой задаче будет сдвигаться в соответствии с новым дедлайном блокирующей задачи. diff --git a/ru/_includes/tracker/issue-bar.md b/ru/_includes/tracker/issue-bar.md index 9bd2a1e4af9..e5285ecb1d1 100644 --- a/ru/_includes/tracker/issue-bar.md +++ b/ru/_includes/tracker/issue-bar.md @@ -1,7 +1,7 @@ -Над временной шкалой справа нажмите ![](../../_assets/tracker/svg/gantt-settings-button.svg) **{{ ui-key.startrek.ui_components_Gantt.timeline-config }}** и в разделе **Полоса задачи** выберите настройку: +Над временной шкалой справа нажмите ![](../../_assets/tracker/svg/gantt-settings-button.svg) **Настройки диаграммы** и в разделе **Полоса задачи** выберите настройку: -* Чтобы на полосе задачи отображалось ее название, отметьте пункт **{{ ui-key.startrek.ui_components_Gantt.show-issue-title }}**. +* Чтобы на полосе задачи отображалось ее название, отметьте пункт **название**. -* Чтобы на полосе задачи отображался значок исполнителя, отметьте пункт **{{ ui-key.startrek.ui_components_Gantt.show-issue-assignee }}**. +* Чтобы на полосе задачи отображался значок исполнителя, отметьте пункт **исполнителя**. * Чтобы отметить на диаграмме красным цветом признак просроченной задачи (разницу между дедлайном и текущей датой), отметьте пункт **просроченный дедлайн**. diff --git a/ru/_includes/tracker/issues-table-project.md b/ru/_includes/tracker/issues-table-project.md index df9df03727f..70f901662b1 100644 --- a/ru/_includes/tracker/issues-table-project.md +++ b/ru/_includes/tracker/issues-table-project.md @@ -1,8 +1,8 @@ * Чтобы выбрать поля, которые вы хотите видеть в таблице списка задач слева от диаграммы, нажмите значок ![](../../_assets/tracker/svg/settings-old.svg). Отметьте нужные пункты и нажмите **Применить**. -* Чтобы найти задачи в списке, в поле **{{ ui-key.startrek.ui_components_filter-pane.search-placeholder }}** введите текст. +* Чтобы найти задачи в списке, в поле **{{ ui-key.startrek.ui_Common_smart-components_filter-pane.search-placeholder }}** введите текст. -* Чтобы настроить порядок отображения в списке, нажмите ![](../../_assets/tracker/svg/sorting.svg) **{{ ui-key.startrek.ui_components_SortButton.default-title }}**, укажите параметр и нажмите ![](../../_assets/tracker/svg/new-first.svg). В этом случае ручное перемещение задач станет недоступно. +* Чтобы настроить порядок отображения в списке, нажмите ![](../../_assets/tracker/svg/sorting.svg) **{{ ui-key.startrek.ui_Common_smart-components_SortButton.default-title }}**, укажите параметр и нажмите ![](../../_assets/tracker/svg/new-first.svg). В этом случае ручное перемещение задач станет недоступно. * Чтобы сгруппировать задачи по статусу, исполнителю или другим параметрам, нажмите кнопку ![](../../_assets/tracker/svg/group.svg) **Без группировки** и выберите подходящий вариант из списка. @@ -14,7 +14,7 @@ * Чтобы скрыть блок со списком задач, нажмите на значок ![](../../_assets/tracker/svg/close-block.svg). -* Чтобы изменить вид списка задач, выберите ![](../../_assets/tracker/svg/flat-list.svg) **{{ ui-key.startrek.ui_components_filter-pane.list-mode-flat }}** или ![](../../_assets/tracker/svg/tree-list.svg) **{{ ui-key.startrek.ui_components_filter-pane.list-mode-tree }}**.{#trees} +* Чтобы изменить вид списка задач, выберите ![](../../_assets/tracker/svg/flat-list.svg) **{{ ui-key.startrek.ui_Common_smart-components_filter-pane.list-mode-flat }}** или ![](../../_assets/tracker/svg/tree-list.svg) **{{ ui-key.startrek.ui_Common_smart-components_filter-pane.list-mode-tree }}**.{#trees} {% note info %} @@ -26,7 +26,7 @@ В режиме древовидного списка можно создавать новые подзадачи или изменять связи для подзадач: - * Чтобы создать подзадачу, напротив задачи нажмите кнопку ![](../../_assets/tracker/svg/icon-add.svg) **{{ ui-key.startrek.ui_components_projects_Table.add-sub-issue }}**: + * Чтобы создать подзадачу, напротив задачи нажмите кнопку ![](../../_assets/tracker/svg/icon-add.svg) **Добавить подзадачу**: * Чтобы создать новую задачу, перейдите на вкладку **Новая задача**. Введите название и нажмите клавишу **Enter**. * Если задача уже существует, перейдите на вкладку **Существующая задача** и укажите ее ключ или название, затем выберите задачу из списка. Найти ключ можно на странице задачи над ее названием (например, `TEST-1234`). @@ -37,6 +37,6 @@ {% note info %} - Ручное перемещение задач доступно, если в поле **{{ ui-key.startrek.ui_components_SortButton.default-title }}** не выбран параметр сортировки. По умолчанию для списка задач выбран ручной режим сортировки: вы можете перетаскивать задачи в списке. + Ручное перемещение задач доступно, если в поле **{{ ui-key.startrek.ui_Common_smart-components_SortButton.default-title }}** не выбран параметр сортировки. По умолчанию для списка задач выбран ручной режим сортировки: вы можете перетаскивать задачи в списке. {% endnote %} \ No newline at end of file diff --git a/ru/_includes/tracker/issues-table-queue-filter-project.md b/ru/_includes/tracker/issues-table-queue-filter-project.md index 0b899641140..8f522da0d00 100644 --- a/ru/_includes/tracker/issues-table-queue-filter-project.md +++ b/ru/_includes/tracker/issues-table-queue-filter-project.md @@ -1,12 +1,12 @@ * Чтобы выбрать поля, которые вы хотите видеть в таблице списка задач слева от диаграммы, нажмите значок ![](../../_assets/tracker/svg/settings-old.svg). Отметьте нужные пункты и нажмите **Применить**. -* Чтобы найти задачи в списке, в поле **{{ ui-key.startrek.ui_components_filter-pane.search-placeholder }}** введите текст. +* Чтобы найти задачи в списке, в поле **{{ ui-key.startrek.ui_Common_smart-components_filter-pane.search-placeholder }}** введите текст. -* Чтобы настроить порядок отображения в списке, нажмите ![](../../_assets/tracker/svg/sorting.svg) **{{ ui-key.startrek.ui_components_SortButton.default-title }}**, укажите параметр и нажмите ![](../../_assets/tracker/svg/new-first.svg). В этом случае ручное перемещение задач станет недоступно. +* Чтобы настроить порядок отображения в списке, нажмите ![](../../_assets/tracker/svg/sorting.svg) **{{ ui-key.startrek.ui_Common_smart-components_SortButton.default-title }}**, укажите параметр и нажмите ![](../../_assets/tracker/svg/new-first.svg). В этом случае ручное перемещение задач станет недоступно. * Чтобы сгруппировать задачи по статусу, исполнителю или другим параметрам, нажмите кнопку ![](../../_assets/tracker/svg/group.svg) **Без группировки** и выберите подходящий вариант из списка. -* Чтобы отфильтровать список задач, используйте конструктор фильтров. Для этого на панели ![](../../_assets/tracker/svg/filter.svg) **{{ ui-key.startrek.ui_components_IssueTabs.fields-tab }}** выберите параметры и укажите значения, по которым будет сформирован список задач. +* Чтобы отфильтровать список задач, используйте конструктор фильтров. Для этого на панели ![](../../_assets/tracker/svg/filter.svg) **Параметры** выберите параметры и укажите значения, по которым будет сформирован список задач. * Чтобы поменять местами столбцы списка, над списком нажмите значок ![](../../_assets/tracker/svg/settings-old.svg). Затем в блоке **Добавленные** зажмите параметр и перетащите его внутри блока. Нажмите **Применить**. diff --git a/ru/_includes/tracker/on-premise-server.md b/ru/_includes/tracker/on-premise-server.md index 7d5be89f6c3..7a8082a87b2 100644 --- a/ru/_includes/tracker/on-premise-server.md +++ b/ru/_includes/tracker/on-premise-server.md @@ -6,11 +6,11 @@ 1. В поле **Платформа** выберите платформу, к которой подключен ваш сервер. -1. В поле **{{ ui-key.startrek.ui_components_admin-repositories_ConnectRepositoryDialog_fields_UrlField.server-url-label }}** укажите адрес вашего сервера до любого доступного по токену репозитория. +1. В поле **Ссылка на репозиторий** укажите адрес вашего сервера до любого доступного по токену репозитория. 1. Получите на GitLab OAuth-токен для своего репозитория. Подробную инструкцию о том, как получить токен, читайте в [документации GitLab](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#create-a-personal-access-token). Для корректной работы {{ tracker-name }} при настройке разрешения включите опции **read_repository** и **read_api**. -1. В поле **{{ ui-key.startrek.ui_components_admin-repositories_ConnectRepositoryDialog.token-label }}** укажите токен для подключения к вашему серверу. +1. В поле **{{ ui-key.startrek.ui_Common_smart-components_admin-repositories_ConnectRepositoryDialog.token-label }}** укажите токен для подключения к вашему серверу. 1. Нажмите кнопку **Подключить**. diff --git a/ru/_includes/tracker/open-personal-settings.md b/ru/_includes/tracker/open-personal-settings.md index b1e82156f96..50deba61a8c 100644 --- a/ru/_includes/tracker/open-personal-settings.md +++ b/ru/_includes/tracker/open-personal-settings.md @@ -1 +1 @@ -На панели слева нажмите ![](../../_assets/tracker/svg/settings.svg) **{{ ui-key.startrek.ui_components_PageAgileBoard_PageAgileBoardHeader.settings }}**. +На панели слева нажмите ![](../../_assets/tracker/svg/settings.svg) **{{ ui-key.startrek.ui_Boards_pages_PageAgileBoard_PageAgileBoardHeader.settings }}**. diff --git a/ru/_includes/tracker/repository-path.md b/ru/_includes/tracker/repository-path.md index d81d6e2919f..0d908642251 100644 --- a/ru/_includes/tracker/repository-path.md +++ b/ru/_includes/tracker/repository-path.md @@ -1 +1 @@ -На панели слева нажмите ![](../../_assets/tracker/svg/still.svg) → выберите **Администрирование** → ![](../../_assets/tracker/svg/repositories.svg) **{{ ui-key.startrek.ui_components_page-admin_PageAdmin.menu-item-repositories }}** → **{{ ui-key.startrek.ui_components_admin-repositories_ConnectRepositoryDialog.connect }}**. \ No newline at end of file +На панели слева нажмите ![](../../_assets/tracker/svg/still.svg) → выберите **Администрирование** → ![](../../_assets/tracker/svg/repositories.svg) **{{ ui-key.startrek.ui_Common_smart-components_page-admin_PageAdmin.menu-item-repositories }}** → **{{ ui-key.startrek.ui_Common_smart-components_admin-repositories_ConnectRepositoryDialog.connect }}**. \ No newline at end of file diff --git a/ru/_includes/tracker/task-by-mail.md b/ru/_includes/tracker/task-by-mail.md index 93bcd4210a0..61d3157fc5e 100644 --- a/ru/_includes/tracker/task-by-mail.md +++ b/ru/_includes/tracker/task-by-mail.md @@ -14,8 +14,8 @@ 1. Настройте почтовый ящик для получения писем: - 1. В разделе **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.mail-settings-title }}**, в поле **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.mail-address }}**, укажите почтовый адрес, который вы завели на шаге 1, вместе с доменом, например, `{{ example-account }}`. Поле **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.mail-login }}** заполнится автоматически. - 1. В поле **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.mail-password }}** укажите пароль для почтового адреса. Если выбранный почтовый сервер позволяет контролировать доступ к почтовому ящику с помощью пароля приложения, укажите в этом поле пароль приложения для почтовых клиентов. + 1. В разделе **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.mail-settings-title }}**, в поле **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.mail-address }}**, укажите почтовый адрес, который вы завели на шаге 1, вместе с доменом, например, `{{ example-account }}`. Поле **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.mail-login }}** заполнится автоматически. + 1. В поле **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.mail-password }}** укажите пароль для почтового адреса. Если выбранный почтовый сервер позволяет контролировать доступ к почтовому ящику с помощью пароля приложения, укажите в этом поле пароль приложения для почтовых клиентов. {% note info "Если в процессе настройки возникла ошибка 422" %} @@ -26,15 +26,15 @@ [Узнать больше о паролях приложений в документации Яндекс ID]({{ link-yandex }}/support/id/authorization/app-passwords.html). - 1. Укажите **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.mail-imap }}** и **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.mail-port }}** почтового сервера — это необходимо для сбора писем. Узнать эти данные можно в параметрах учетной записи почты. - 1. Чтобы включить шифрование с помощью протокола SSL, активируйте опцию **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.mail-ssl }}**. - 1. Если требуется обрабатывать письма не только от сотрудников организации, но и от внешних пользователей, активируйте настройку **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.mail-allow-external }}**. + 1. Укажите **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.mail-imap }}** и **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.mail-port }}** почтового сервера — это необходимо для сбора писем. Узнать эти данные можно в параметрах учетной записи почты. + 1. Чтобы включить шифрование с помощью протокола SSL, активируйте опцию **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.mail-ssl }}**. + 1. Если требуется обрабатывать письма не только от сотрудников организации, но и от внешних пользователей, активируйте настройку **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.mail-allow-external }}**. {% cut "Дополнительные параметры" %} - * **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.mail-incoming-folder }}** — создайте папку для писем от {{ tracker-name }} и укажите ее название. Из писем, поступающих в эту папку, будут автоматически создаваться задачи в очереди. - * **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.mail-archive-folder }}** — создайте папку для архивации писем от {{ tracker-name }} и укажите ее название. - * **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.mail-process-messages-from }}** — укажите дату. Письма, пришедшие до указанной даты, не обрабатываются и автоматически попадают в **Папку для архива**. + * **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.mail-incoming-folder }}** — создайте папку для писем от {{ tracker-name }} и укажите ее название. Из писем, поступающих в эту папку, будут автоматически создаваться задачи в очереди. + * **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.mail-archive-folder }}** — создайте папку для архивации писем от {{ tracker-name }} и укажите ее название. + * **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.mail-process-messages-from }}** — укажите дату. Письма, пришедшие до указанной даты, не обрабатываются и автоматически попадают в **Папку для архива**. {% note alert %} @@ -49,15 +49,15 @@ 1. Укажите параметры, с которыми будут создаваться задачи из почты: тип задачи и [компоненты](../../tracker/manager/components.md). 1. Если вы хотите, чтобы комментарии из задачи также отправлялись в виде писем, настройте почтовый ящик для отправки писем: - 1. В разделе **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesFormSendPanel.send-settings-title }}** нажмите ![](../../_assets/tracker/svg/add-address.svg) **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesStateList.action-add-mail }}**. - 1. В поле **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesFormSendPanel.send-mail-login }}** укажите почту, с которой будут отправляться письма — комментарии из задачи, например, `{{ example-account }}`. - 1. В поле **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesFormSendPanel.send-mail-password }}** укажите пароль для почтового адреса. - 1. Укажите **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesFormSendPanel.send-mail-smtp }}** и **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesFormSendPanel.send-mail-port }}** — это необходимо для работы исходящей почты. Узнать эти данные можно в параметрах учетной записи почты. - 1. Чтобы включить шифрование с помощью протокола SSL, активируйте опцию **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesFormSendPanel.send-mail-ssl }}**. - 1. Настройте **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesFormSendPanel.signature-settings-title }}** для отправляемых писем. Обязательно укажите **{{ ui-key.startrek.ui_components_page-queue-admin_Signature.alias-title }}**: по нему вы сможете различать подписи в общем списке. Получатели письма увидят псевдоним вместо имени отправителя письма. - 1. Проверьте, что все работает: нажмите ![](../../_assets/tracker/svg/send-email.svg) **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesFormSendPanel.test-mail-button }}**. + 1. В разделе **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesFormSendPanel.send-settings-title }}** нажмите ![](../../_assets/tracker/svg/add-address.svg) **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesStateList.action-add-mail }}**. + 1. В поле **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesFormSendPanel.send-mail-login }}** укажите почту, с которой будут отправляться письма — комментарии из задачи, например, `{{ example-account }}`. + 1. В поле **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesFormSendPanel.send-mail-password }}** укажите пароль для почтового адреса. + 1. Укажите **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesFormSendPanel.send-mail-smtp }}** и **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesFormSendPanel.send-mail-port }}** — это необходимо для работы исходящей почты. Узнать эти данные можно в параметрах учетной записи почты. + 1. Чтобы включить шифрование с помощью протокола SSL, активируйте опцию **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesFormSendPanel.send-mail-ssl }}**. + 1. Настройте **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesFormSendPanel.signature-settings-title }}** для отправляемых писем. Обязательно укажите **Псевдоним**: по нему вы сможете различать подписи в общем списке. Получатели письма увидят псевдоним вместо имени отправителя письма. + 1. Проверьте, что все работает: нажмите ![](../../_assets/tracker/svg/send-email.svg) **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesFormSendPanel.test-mail-button }}**. - 1. Нажмите **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.save-button }}**. Почтовый адрес, который вы создали для очереди, заработает в течение часа после создания. + 1. Нажмите **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.save-button }}**. Почтовый адрес, который вы создали для очереди, заработает в течение часа после создания. 1. Включите отправку комментариев в виде писем из задачи: 1. В настройках очереди выберите раздел **Основные параметры**. @@ -79,17 +79,17 @@ 1. В разделе **Почта** нажмите **Настроить почтовые ящики**. Перейдите на вкладку **На домене в {{ yandex-360 }}**. - 1. Проверьте, настроен ли у вашей организации в {{ ya-360 }} [почтовый домен]({{ support-business-domain }}). Если нет, нажмите **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesStateList.action-domain }}** — откроется {{ ya-360 }}, и вы сможете создать домен. Если у вас уже настроен почтовый домен в другом сервисе, вы можете создать для него поддомен и [подключить в {{ ya-360 }}]({{ support-business-domain }}). + 1. Проверьте, настроен ли у вашей организации в {{ ya-360 }} [почтовый домен]({{ support-business-domain }}). Если нет, нажмите **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesStateList.action-domain }}** — откроется {{ ya-360 }}, и вы сможете создать домен. Если у вас уже настроен почтовый домен в другом сервисе, вы можете создать для него поддомен и [подключить в {{ ya-360 }}]({{ support-business-domain }}). 1. Нажмите **Настроить почту**. 1. Настройте почтовый ящик для получения и отправки писем: - 1. В поле **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.mail-address }}** укажите новый почтовый адрес, который будет использоваться только для очереди. - 1. Если требуется обрабатывать письма не только от сотрудников организации, но и от внешних пользователей, активируйте настройку **{{ ui-key.startrek.ui_components_page-queue-admin_AliasesCreateForm.mail-allow-external }}**. + 1. В поле **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.mail-address }}** укажите новый почтовый адрес, который будет использоваться только для очереди. + 1. Если требуется обрабатывать письма не только от сотрудников организации, но и от внешних пользователей, активируйте настройку **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_AliasesCreateForm.mail-allow-external }}**. 1. Укажите параметры, с которыми должны создаваться задачи очереди: [тип задачи](../../tracker/manager/add-ticket-type.md) и [компоненты](../../tracker/manager/components.md). - 1. Настройте подписи для отправляемых писем. Обязательно укажите **{{ ui-key.startrek.ui_components_page-queue-admin_Signature.alias-title }}** — по нему вы сможете различать подписи в общем списке. Получатели письма увидят псевдоним вместо имени отправителя письма. Проверьте, что все работает: отправьте тестовое письмо. + 1. Настройте подписи для отправляемых писем. Обязательно укажите **Псевдоним** — по нему вы сможете различать подписи в общем списке. Получатели письма увидят псевдоним вместо имени отправителя письма. Проверьте, что все работает: отправьте тестовое письмо. 1. Нажмите **Создать**. Почтовый адрес, который вы создали для очереди, заработает в течение часа после создания. diff --git a/ru/_includes/tracker/timeline-area.md b/ru/_includes/tracker/timeline-area.md index d998e78944a..100afcedb29 100644 --- a/ru/_includes/tracker/timeline-area.md +++ b/ru/_includes/tracker/timeline-area.md @@ -1,8 +1,8 @@ На диаграмме можно настроить логику сдвигов зависимых задач и родительских задач, а также отображение связей. -Над временной шкалой справа нажмите ![](../../_assets/tracker/svg/gantt-settings-button.svg) **{{ ui-key.startrek.ui_components_Gantt.timeline-config }}** и в блоке **Полоса задачи** выберите настройку: +Над временной шкалой справа нажмите ![](../../_assets/tracker/svg/gantt-settings-button.svg) **Настройки диаграммы** и в блоке **Полоса задачи** выберите настройку: -* Чтобы задачи со связью «Зависит от — Блокирует» соединялись стрелкой на диаграмме, отметьте пункт **{{ ui-key.startrek.ui_components_Gantt.show-links }}**. +* Чтобы задачи со связью «Зависит от — Блокирует» соединялись стрелкой на диаграмме, отметьте пункт **Показывать блокирующие связи**. * Чтобы автоматически сдвигать сроки зависимой задачи при переносе дедлайна блокирующей задачи, активируйте соответствующую опцию. diff --git a/ru/_includes/yandexgpt-limits.md b/ru/_includes/yandexgpt-limits.md index c2cb970bc3b..7c6eac5f152 100644 --- a/ru/_includes/yandexgpt-limits.md +++ b/ru/_includes/yandexgpt-limits.md @@ -5,7 +5,8 @@ **[Векторизация текста](../foundation-models/concepts/embeddings.md)** | Количество запросов на векторизацию текста, в секунду | 10 **[Генерация текста](../foundation-models/concepts/yandexgpt/index.md)** | -Количество одновременных генераций | 1 +Количество одновременных генераций, [синхронный режим](../foundation-models/concepts/index.md#working-mode) | 10 +Количество одновременных генераций, модель {{ yagpt-name }} 32k | 1 Количество запросов в секунду, [асинхронный режим](../foundation-models/concepts/index.md#working-mode) (запрос) | 10 Количество запросов в секунду, асинхронный режим (получение ответа) | 50 Количество запросов в час, асинхронный режим (запрос) | 5000 @@ -13,8 +14,8 @@ **[Классификация текста](../foundation-models/concepts/classifier/index.md)** | Количество запросов на классификацию текста в секунду | 1 **[Генерация изображений](../foundation-models/concepts/yandexart/index.md)** | -Количество запросов на генерацию в минуту | 10 -Количество запросов на генерацию в сутки | 500 +Количество запросов на генерацию в минуту | 500 +Количество запросов на генерацию в сутки | 5000 Количество запросов результата в секунду | 50 #### Лимиты {#yandexgpt-limits} diff --git a/ru/_pricing/compute/kzt-instance-resources.md b/ru/_pricing/compute/kzt-instance-resources.md index dad56d0e5cd..b1142a9dc51 100644 --- a/ru/_pricing/compute/kzt-instance-resources.md +++ b/ru/_pricing/compute/kzt-instance-resources.md @@ -19,6 +19,10 @@ | 100% vCPU | {{ sku|KZT|compute.vm.cpu.c100.v3|string }} | {{ sku|KZT|compute.vm.cpu.c100.preemptible.v3|string }} | {{ sku|KZT|v1.commitment.selfcheckout.m6.compute.vm.cpu.c100.standard.v3|string }} | {{ sku|KZT|v1.commitment.selfcheckout.y1.compute.vm.cpu.c100.standard.v3|string }} | | 1 GPU Nvidia T4 | {{ sku|KZT|compute.vm.gpu.standard.v3-t4|string }} | {{ sku|KZT|compute.vm.gpu.standard.v3-t4.preemptible|string }} | − | − | | RAM (за 1 ГБ) | {{ sku|KZT|compute.vm.ram.v3|string }} | {{ sku|KZT|compute.vm.ram.preemptible.v3|string }} | {{ sku|KZT|v1.commitment.selfcheckout.m6.compute.vm.ram.standard.v3|string }} | {{ sku|KZT|v1.commitment.selfcheckout.y1.compute.vm.ram.standard.v3|string }} | +| **Intel Ice Lake with T4i** | Обычная ВМ | Прерываемая ВМ | | | +| 100% vCPU | 5,25 ₸ | 5,25 ₸ | - | - | +| 1 GPU | 720,00 ₸ | 720,00 ₸ | - | - | +| RAM (за 1 ГБ) | 1,40 ₸ | 1,40 ₸ | - | - | | **Intel Ice Lake (Compute Optimized)** | Обычная ВМ | Прерываемая ВМ | | | | 100% vCPU | {{ sku|KZT|compute.vm.cpu.c100.highfreq-v3|string }} | - | − | − | | RAM (за 1 ГБ) | {{ sku|KZT|compute.vm.ram.highfreq-v3|string }} | - | − | − | diff --git a/ru/_pricing/compute/rub-instance-resources.md b/ru/_pricing/compute/rub-instance-resources.md index c0de8d1aa8a..91270073f8b 100644 --- a/ru/_pricing/compute/rub-instance-resources.md +++ b/ru/_pricing/compute/rub-instance-resources.md @@ -19,6 +19,10 @@ | 100% vCPU | {{ sku|RUB|compute.vm.cpu.c100.v3|string }} | {{ sku|RUB|compute.vm.cpu.c100.preemptible.v3|string }} | {{ sku|RUB|v1.commitment.selfcheckout.m6.compute.vm.cpu.c100.standard.v3|string }} | {{ sku|RUB|v1.commitment.selfcheckout.y1.compute.vm.cpu.c100.standard.v3|string }} | | 1 GPU Nvidia T4 | {{ sku|RUB|compute.vm.gpu.standard.v3-t4|string }} | {{ sku|RUB|compute.vm.gpu.standard.v3-t4.preemptible|string }} | − | − | | RAM (за 1 ГБ) | {{ sku|RUB|compute.vm.ram.v3|string }} | {{ sku|RUB|compute.vm.ram.preemptible.v3|string }} | {{ sku|RUB|v1.commitment.selfcheckout.m6.compute.vm.ram.standard.v3|string }} | {{ sku|RUB|v1.commitment.selfcheckout.y1.compute.vm.ram.standard.v3|string }} | +| **Intel Ice Lake with T4i** | Обычная ВМ | Прерываемая ВМ | | | +| 100% vCPU | 1,05 ₽ | 1,05 ₽ | - | - | +| 1 GPU | 144,00 ₽ | 144,00 ₽ | - | - | +| RAM (за 1 ГБ) | 0,28 ₽ | 0,28 ₽ | - | - | | **Intel Ice Lake (Compute Optimized)** | Обычная ВМ | Прерываемая ВМ | | | | 100% vCPU | {{ sku|RUB|compute.vm.cpu.c100.highfreq-v3|string }} | - | − | − | | RAM (за 1 ГБ) | {{ sku|RUB|compute.vm.ram.highfreq-v3|string }} | - | − | − | diff --git a/ru/_pricing_examples/datalens/kzt-users-1.md b/ru/_pricing_examples/datalens/kzt-users-1.md new file mode 100644 index 00000000000..642a851572e --- /dev/null +++ b/ru/_pricing_examples/datalens/kzt-users-1.md @@ -0,0 +1,3 @@ +> 3 × {{ sku|KZT|datalens.users.v1|string }} = {% calc [currency=KZT] 3 × 4950,00 %} +> +> Итого: {% calc [currency=KZT] 3 × 4950,00 %} — стоимость использования сервиса за июнь. diff --git a/ru/_pricing_examples/datalens/kzt-users-2.md b/ru/_pricing_examples/datalens/kzt-users-2.md new file mode 100644 index 00000000000..c5ec9924598 --- /dev/null +++ b/ru/_pricing_examples/datalens/kzt-users-2.md @@ -0,0 +1,3 @@ +> 2 × {{ sku|KZT|datalens.users.v1|string }} = {% calc [currency=KZT] 2 × 4950,00 %} +> +> Итого: {% calc [currency=KZT] 2 × 4950,00 %} — стоимость использования сервиса за июль. diff --git a/ru/_pricing_examples/datalens/kzt-users-3.md b/ru/_pricing_examples/datalens/kzt-users-3.md new file mode 100644 index 00000000000..6ae9050e686 --- /dev/null +++ b/ru/_pricing_examples/datalens/kzt-users-3.md @@ -0,0 +1,3 @@ +> 5 × {{ sku|KZT|datalens.users.v1|string }} = {% calc [currency=KZT] 5 × 4950,00 %} +> +> Итого: {% calc [currency=KZT] 5 × 4950,00 %} — стоимость использования сервиса за август. diff --git a/ru/_pricing_examples/datalens/rub-users-1.md b/ru/_pricing_examples/datalens/rub-users-1.md new file mode 100644 index 00000000000..19bdd9c763a --- /dev/null +++ b/ru/_pricing_examples/datalens/rub-users-1.md @@ -0,0 +1,3 @@ +> 3 × {{ sku|RUB|datalens.users.v1|string }} = {% calc [currency=RUB] 3 × {{ sku|RUB|datalens.users.v1|number }} %} +> +> Итого: {% calc [currency=RUB] 3 × {{ sku|RUB|datalens.users.v1|number }} %} — стоимость использования сервиса за июнь. diff --git a/ru/_pricing_examples/datalens/rub-users-2.md b/ru/_pricing_examples/datalens/rub-users-2.md new file mode 100644 index 00000000000..eb84edbe6da --- /dev/null +++ b/ru/_pricing_examples/datalens/rub-users-2.md @@ -0,0 +1,3 @@ +> 2 × {{ sku|RUB|datalens.users.v1|string }} = {% calc [currency=RUB] 2 × {{ sku|RUB|datalens.users.v1|number }} %} +> +> Итого: {% calc [currency=RUB] 2 × {{ sku|RUB|datalens.users.v1|number }} %} — стоимость использования сервиса за июль. diff --git a/ru/_pricing_examples/datalens/rub-users-3.md b/ru/_pricing_examples/datalens/rub-users-3.md new file mode 100644 index 00000000000..995fb255bde --- /dev/null +++ b/ru/_pricing_examples/datalens/rub-users-3.md @@ -0,0 +1,3 @@ +> 5 × {{ sku|RUB|datalens.users.v1|string }} = {% calc [currency=RUB] 5 × {{ sku|RUB|datalens.users.v1|number }} %} +> +> Итого: {% calc [currency=RUB] 5 × {{ sku|RUB|datalens.users.v1|number }} %} — стоимость использования сервиса за август. diff --git a/ru/_pricing_examples/managed-kafka/kzt-hour.md b/ru/_pricing_examples/managed-kafka/kzt-hour.md index fffa4f60b79..d3fdbd7b409 100644 --- a/ru/_pricing_examples/managed-kafka/kzt-hour.md +++ b/ru/_pricing_examples/managed-kafka/kzt-hour.md @@ -1,60 +1,60 @@ Расчет стоимости для хостов-брокеров {{ KF }}: -> 3 × (2 × 7,55 ₸ + 8 × 2,00 ₸) = 93,30 ₸ +> 3 × (2 × {{ sku|KZT|mdb.cluster.kafka.v3.cpu.c100|string }} + 8 × {{ sku|KZT|mdb.cluster.kafka.v3.ram|string }}) = {% calc [currency=KZT] 3 × (2 × {{ sku|KZT|mdb.cluster.kafka.v3.cpu.c100|number }} + 8 × {{ sku|KZT|mdb.cluster.kafka.v3.ram|number }}) %} > -> Итого: 93,30 ₸ — стоимость часа работы хостов-брокеров {{ KF }}. +> Итого: {% calc [currency=KZT] 3 × (2 × {{ sku|KZT|mdb.cluster.kafka.v3.cpu.c100|number }} + 8 × {{ sku|KZT|mdb.cluster.kafka.v3.ram|number }}) %} — стоимость часа работы хостов-брокеров {{ KF }}. Где: * 3 — количество хостов-брокеров {{ KF }}. * 2 — количество vCPU. -* 7,55 ₸ — стоимость часа использования 100% vCPU. +* {{ sku|KZT|mdb.cluster.kafka.v3.cpu.c100|string }} — стоимость часа использования 100% vCPU. * 8 — объем RAM одного хоста (в гигабайтах). -* 2,00 ₸ — стоимость часа использования 1 ГБ RAM на 100% vCPU. +* {{ sku|KZT|mdb.cluster.kafka.v3.ram|string }} — стоимость часа использования 1 ГБ RAM на 100% vCPU. Расчет стоимости хранилища для хостов-брокеров {{ KF }}: -> 3 × 100 × 16,00 ₸ = 4 800,00 ₸ +> 3 × 100 × {{ sku|KZT|mdb.cluster.network-hdd.kafka|month|string }} = {% calc [currency=KZT] 3 × 100 × {{ sku|KZT|mdb.cluster.network-hdd.kafka|month|number }} %} > -> Итого: 4 800,00 ₸ — стоимость хранилища для хостов-брокеров {{ KF }}. +> Итого: {% calc [currency=KZT] 3 × 100 × {{ sku|KZT|mdb.cluster.network-hdd.kafka|month|number }} %} — стоимость хранилища для хостов-брокеров {{ KF }}. Где: * 3 — количество хостов-брокеров {{ KF }}. * 100 — объем хранилища на сетевых HDD-дисках (в гигабайтах). -* 16,00 ₸ — стоимость месяца использования 1 ГБ хранилища на сетевых HDD-дисках. +* {{ sku|KZT|mdb.cluster.network-hdd.kafka|month|string }} — стоимость месяца использования 1 ГБ хранилища на сетевых HDD-дисках. Расчет стоимости для хостов {{ ZK }}: -> 3 × (2 × 3,50 ₸ + 4 × 1,40 ₸) = 37,80 ₸ +> 3 × (2 × {{ sku|KZT|mdb.zk.kafka.v3.cpu.c50|string }} + 4 × {{ sku|KZT|mdb.zk.kafka.v3.ram|string }}) = {% calc [currency=KZT] 3 × (2 × {{ sku|KZT|mdb.zk.kafka.v3.cpu.c50|number }} + 4 × {{ sku|KZT|mdb.zk.kafka.v3.ram|number }}) %} > -> Итого: 37,80 ₸ — стоимость часа работы хостов {{ ZK }}. +> Итого: {% calc [currency=KZT] 3 × (2 × {{ sku|KZT|mdb.zk.kafka.v3.cpu.c50|number }} + 4 × {{ sku|KZT|mdb.zk.kafka.v3.ram|number }}) %} — стоимость часа работы хостов {{ ZK }}. Где: * 3 — количество хостов {{ ZK }}. * 2 — количество vCPU. -* 3,50 ₸ — стоимость часа использования 50% vCPU. +* {{ sku|KZT|mdb.zk.kafka.v3.cpu.c50|string }} — стоимость часа использования 50% vCPU. * 4 — объем RAM одного хоста (в гигабайтах). -* 1,40 ₸ — стоимость часа использования 1 ГБ RAM на 50% vCPU. +* {{ sku|KZT|mdb.zk.kafka.v3.ram|string }} — стоимость часа использования 1 ГБ RAM на 50% vCPU. Расчет стоимости хранилища для хостов {{ ZK }}: -> 3 × 10 × 65,05 ₸ = 1 951,50 ₸ +> 3 × 10 × {{ sku|KZT|mdb.cluster.network-nvme.kafka|month|string }} = {% calc [currency=KZT] 3 × 10 × {{ sku|KZT|mdb.cluster.network-nvme.kafka|month|number }} %} > -> Итого: 1 951,50 ₸ — стоимость хранилища для хостов {{ ZK }}. +> Итого: {% calc [currency=KZT] 3 × 10 × {{ sku|KZT|mdb.cluster.network-nvme.kafka|month|number }} %} — стоимость хранилища для хостов {{ ZK }}. Где: * 3 — количество хостов {{ ZK }}. * 10 — объем хранилища на сетевых SSD-дисках (в гигабайтах). -* 65,05 ₸ — стоимость месяца использования 1 ГБ хранилища на сетевых SSD-дисках. +* {{ sku|KZT|mdb.cluster.network-nvme.kafka|month|string }} — стоимость месяца использования 1 ГБ хранилища на сетевых SSD-дисках. Расчет итоговой стоимости: -> 720 × (93,30 ₸ + 37,80 ₸) + 4 800,00 ₸ + 1 951,50 ₸ = 101 143,50 ₸ +> 720 × ({% calc [currency=KZT] 3 × (2 × {{ sku|KZT|mdb.cluster.kafka.v3.cpu.c100|number }} + 8 × {{ sku|KZT|mdb.cluster.kafka.v3.ram|number }}) %} + {% calc [currency=KZT] 3 × (2 × {{ sku|KZT|mdb.zk.kafka.v3.cpu.c50|number }} + 4 × {{ sku|KZT|mdb.zk.kafka.v3.ram|number }}) %}) + {% calc [currency=KZT] 3 × 100 × {{ sku|KZT|mdb.cluster.network-hdd.kafka|month|number }} %} + {% calc [currency=KZT] 3 × 10 × {{ sku|KZT|mdb.cluster.network-nvme.kafka|month|number }} %} = {% calc [currency=KZT] 720 × ((3 × (2 × {{ sku|KZT|mdb.cluster.kafka.v3.cpu.c100|number }} + 8 × {{ sku|KZT|mdb.cluster.kafka.v3.ram|number }})) + (3 × (2 × {{ sku|KZT|mdb.zk.kafka.v3.cpu.c50|number }} + 4 × {{ sku|KZT|mdb.zk.kafka.v3.ram|number }}))) + (3 × 100 × {{ sku|KZT|mdb.cluster.network-hdd.kafka|month|number }}) + (3 × 10 × {{ sku|KZT|mdb.cluster.network-nvme.kafka|month|number }}) %} > -> Итого: 101 143,50 ₸ — стоимость использования кластера в течение 30 дней. +> Итого: {% calc [currency=KZT] 720 × ((3 × (2 × {{ sku|KZT|mdb.cluster.kafka.v3.cpu.c100|number }} + 8 × {{ sku|KZT|mdb.cluster.kafka.v3.ram|number }})) + (3 × (2 × {{ sku|KZT|mdb.zk.kafka.v3.cpu.c50|number }} + 4 × {{ sku|KZT|mdb.zk.kafka.v3.ram|number }}))) + (3 × 100 × {{ sku|KZT|mdb.cluster.network-hdd.kafka|month|number }}) + (3 × 10 × {{ sku|KZT|mdb.cluster.network-nvme.kafka|month|number }}) %} — стоимость использования кластера в течение 30 дней. Где: * 720 — количество часов в 30 днях. -* 93,30 ₸ — стоимость часа работы хостов-брокеров {{ KF }}. -* 37,80 ₸ — стоимость часа работы хостов {{ ZK }}. -* 4 800,00 ₸ — стоимость хранилища для хостов-брокеров {{ KF }}. -* 1 951,50 ₸ — стоимость хранилища для хостов {{ ZK }}. \ No newline at end of file +* {% calc [currency=KZT] 3 × (2 × {{ sku|KZT|mdb.cluster.kafka.v3.cpu.c100|number }} + 8 × {{ sku|KZT|mdb.cluster.kafka.v3.ram|number }}) %} — стоимость часа работы хостов-брокеров {{ KF }}. +* {% calc [currency=KZT] 3 × (2 × {{ sku|KZT|mdb.zk.kafka.v3.cpu.c50|number }} + 4 × {{ sku|KZT|mdb.zk.kafka.v3.ram|number }}) %} — стоимость часа работы хостов {{ ZK }}. +* {% calc [currency=KZT] 3 × 100 × {{ sku|KZT|mdb.cluster.network-hdd.kafka|month|number }} %} — стоимость хранилища для хостов-брокеров {{ KF }}. +* {% calc [currency=KZT] 3 × 10 × {{ sku|KZT|mdb.cluster.network-nvme.kafka|month|number }} %} — стоимость хранилища для хостов {{ ZK }}. \ No newline at end of file diff --git a/ru/_pricing_examples/managed-kafka/rub-hour.md b/ru/_pricing_examples/managed-kafka/rub-hour.md index b803641b339..c82e8ed65fb 100644 --- a/ru/_pricing_examples/managed-kafka/rub-hour.md +++ b/ru/_pricing_examples/managed-kafka/rub-hour.md @@ -1,60 +1,60 @@ Расчет стоимости для хостов-брокеров {{ KF }}: -> 3 × (2 × 1,51 ₽ + 8 × 0,40 ₽) = 18,66 ₽ +> 3 × (2 × {{ sku|RUB|mdb.cluster.kafka.v3.cpu.c100|string }} + 8 × {{ sku|RUB|mdb.cluster.kafka.v3.ram|string }}) = {% calc [currency=RUB] 3 × (2 × {{ sku|RUB|mdb.cluster.kafka.v3.cpu.c100|number }} + 8 × {{ sku|RUB|mdb.cluster.kafka.v3.ram|number }}) %} > -> Итого: 18,66 ₽ — стоимость часа работы хостов-брокеров {{ KF }}. +> Итого: {% calc [currency=RUB] 3 × (2 × {{ sku|RUB|mdb.cluster.kafka.v3.cpu.c100|number }} + 8 × {{ sku|RUB|mdb.cluster.kafka.v3.ram|number }}) %} — стоимость часа работы хостов-брокеров {{ KF }}. Где: * 3 — количество хостов-брокеров {{ KF }}. * 2 — количество vCPU. -* 1,51 ₽ — стоимость часа использования 100% vCPU. +* {{ sku|RUB|mdb.cluster.kafka.v3.cpu.c100|string }} — стоимость часа использования 100% vCPU. * 8 — объем RAM одного хоста (в гигабайтах). -* 0,40 ₽ — стоимость часа использования 1 ГБ RAM на 100% vCPU. +* {{ sku|RUB|mdb.cluster.kafka.v3.ram|string }} — стоимость часа использования 1 ГБ RAM на 100% vCPU. Расчет стоимости хранилища для хостов-брокеров {{ KF }}: -> 3 × 100 × 3,20 ₽ = 960,00 ₽ +> 3 × 100 × {{ sku|RUB|mdb.cluster.network-hdd.kafka|month|string }} = {% calc [currency=RUB] 3 × 100 × {{ sku|RUB|mdb.cluster.network-hdd.kafka|month|number }} %} > -> Итого: 960,00 ₽ — стоимость хранилища для хостов-брокеров {{ KF }}. +> Итого: {% calc [currency=RUB] 3 × 100 × {{ sku|RUB|mdb.cluster.network-hdd.kafka|month|number }} %} — стоимость хранилища для хостов-брокеров {{ KF }}. Где: * 3 — количество хостов-брокеров {{ KF }}. * 100 — объем хранилища на сетевых HDD-дисках (в гигабайтах). -* 3,20 ₽ — стоимость месяца использования 1 ГБ хранилища на сетевых HDD-дисках. +* {{ sku|RUB|mdb.cluster.network-hdd.kafka|month|string }} — стоимость месяца использования 1 ГБ хранилища на сетевых HDD-дисках. Расчет стоимости для хостов {{ ZK }}: -> 3 × (2 × 0,70 ₽ + 4 × 0,28 ₽) = 7,56 ₽ +> 3 × (2 × {{ sku|RUB|mdb.zk.kafka.v3.cpu.c50|string }} + 4 × {{ sku|RUB|mdb.zk.kafka.v3.ram|string }}) = {% calc [currency=RUB] 3 × (2 × {{ sku|RUB|mdb.zk.kafka.v3.cpu.c50|number }} + 4 × {{ sku|RUB|mdb.zk.kafka.v3.ram|number }}) %} > -> Итого: 7,56 ₽ — стоимость часа работы хостов {{ ZK }}. +> Итого: {% calc [currency=RUB] 3 × (2 × {{ sku|RUB|mdb.zk.kafka.v3.cpu.c50|number }} + 4 × {{ sku|RUB|mdb.zk.kafka.v3.ram|number }}) %} — стоимость часа работы хостов {{ ZK }}. Где: * 3 — количество хостов {{ ZK }}. * 2 — количество vCPU. -* 0,70 ₽ — стоимость часа использования 50% vCPU. +* {{ sku|RUB|mdb.zk.kafka.v3.cpu.c50|string }} — стоимость часа использования 50% vCPU. * 4 — объем RAM одного хоста (в гигабайтах). -* 0,28 ₽ — стоимость часа использования 1 ГБ RAM на 50% vCPU. +* {{ sku|RUB|mdb.zk.kafka.v3.ram|string }} — стоимость часа использования 1 ГБ RAM на 50% vCPU. Расчет стоимости хранилища для хостов {{ ZK }}: -> 3 × 10 × 13,01 ₽ = 390,30 ₽ +> 3 × 10 × {{ sku|RUB|mdb.cluster.network-nvme.kafka|month|string }} = {% calc [currency=RUB] 3 × 10 × {{ sku|RUB|mdb.cluster.network-nvme.kafka|month|number }} %} > -> Итого: 390,30 ₽ — стоимость хранилища для хостов {{ ZK }}. +> Итого: {% calc [currency=RUB] 3 × 10 × {{ sku|RUB|mdb.cluster.network-nvme.kafka|month|number }} %} — стоимость хранилища для хостов {{ ZK }}. Где: * 3 — количество хостов {{ ZK }}. * 10 — объем хранилища на сетевых SSD-дисках (в гигабайтах). -* 13,01 ₽ — стоимость месяца использования 1 ГБ хранилища на сетевых SSD-дисках. +* {{ sku|RUB|mdb.cluster.network-nvme.kafka|month|string }} — стоимость месяца использования 1 ГБ хранилища на сетевых SSD-дисках. Расчет итоговой стоимости: -> 720 × (18,66 ₽ + 7,56 ₽) + 960,00 ₽ + 390,30 ₽ = 20 228,70 ₽ +> 720 × ({% calc [currency=RUB] 3 × (2 × {{ sku|RUB|mdb.cluster.kafka.v3.cpu.c100|number }} + 8 × {{ sku|RUB|mdb.cluster.kafka.v3.ram|number }}) %} + {% calc [currency=RUB] 3 × (2 × {{ sku|RUB|mdb.zk.kafka.v3.cpu.c50|number }} + 4 × {{ sku|RUB|mdb.zk.kafka.v3.ram|number }}) %}) + {% calc [currency=RUB] 3 × 100 × {{ sku|RUB|mdb.cluster.network-hdd.kafka|month|number }} %} + {% calc [currency=RUB] 3 × 10 × {{ sku|RUB|mdb.cluster.network-nvme.kafka|month|number }} %} = {% calc [currency=RUB] 720 × ((3 × (2 × {{ sku|RUB|mdb.cluster.kafka.v3.cpu.c100|number }} + 8 × {{ sku|RUB|mdb.cluster.kafka.v3.ram|number }})) + (3 × (2 × {{ sku|RUB|mdb.zk.kafka.v3.cpu.c50|number }} + 4 × {{ sku|RUB|mdb.zk.kafka.v3.ram|number }}))) + (3 × 100 × {{ sku|RUB|mdb.cluster.network-hdd.kafka|month|number }}) + (3 × 10 × {{ sku|RUB|mdb.cluster.network-nvme.kafka|month|number }}) %} > -> Итого: 20 228,70 ₽ — стоимость использования кластера в течение 30 дней. +> Итого: {% calc [currency=RUB] 720 × ((3 × (2 × {{ sku|RUB|mdb.cluster.kafka.v3.cpu.c100|number }} + 8 × {{ sku|RUB|mdb.cluster.kafka.v3.ram|number }})) + (3 × (2 × {{ sku|RUB|mdb.zk.kafka.v3.cpu.c50|number }} + 4 × {{ sku|RUB|mdb.zk.kafka.v3.ram|number }}))) + (3 × 100 × {{ sku|RUB|mdb.cluster.network-hdd.kafka|month|number }}) + (3 × 10 × {{ sku|RUB|mdb.cluster.network-nvme.kafka|month|number }}) %} — стоимость использования кластера в течение 30 дней. Где: * 720 — количество часов в 30 днях. -* 18,66 ₽ — стоимость часа работы хостов-брокеров {{ KF }}. -* 7,56 ₽ — стоимость часа работы хостов {{ ZK }}. -* 960,00 ₽ — стоимость хранилища для хостов-брокеров {{ KF }}. -* 390,30 ₽ — стоимость хранилища для хостов {{ ZK }}. \ No newline at end of file +* {% calc [currency=RUB] 3 × (2 × {{ sku|RUB|mdb.cluster.kafka.v3.cpu.c100|number }} + 8 × {{ sku|RUB|mdb.cluster.kafka.v3.ram|number }}) %} — стоимость часа работы хостов-брокеров {{ KF }}. +* {% calc [currency=RUB] 3 × (2 × {{ sku|RUB|mdb.zk.kafka.v3.cpu.c50|number }} + 4 × {{ sku|RUB|mdb.zk.kafka.v3.ram|number }}) %} — стоимость часа работы хостов {{ ZK }}. +* {% calc [currency=RUB] 3 × 100 × {{ sku|RUB|mdb.cluster.network-hdd.kafka|month|number }} %} — стоимость хранилища для хостов-брокеров {{ KF }}. +* {% calc [currency=RUB] 3 × 10 × {{ sku|RUB|mdb.cluster.network-nvme.kafka|month|number }} %} — стоимость хранилища для хостов {{ ZK }}. \ No newline at end of file diff --git a/ru/_pricing_examples/managed-mongodb/kzt-host.md b/ru/_pricing_examples/managed-mongodb/kzt-host.md index 8a4553215dd..88f68dd0eb8 100644 --- a/ru/_pricing_examples/managed-mongodb/kzt-host.md +++ b/ru/_pricing_examples/managed-mongodb/kzt-host.md @@ -1,10 +1,10 @@ -> 3 × (2 × 8,00 ₸ + 8 × 4,50 ₸) = 156,00 ₸ +> 3 × (2 × {{ sku|KZT|mdb.cluster.mongodb.v3.cpu.c100|string }} + 8 × {{ sku|KZT|mdb.cluster.mongodb.v3.ram|string }}) = {% calc [currency=KZT] 3 × (2 × {{ sku|KZT|mdb.cluster.mongodb.v3.cpu.c100|number }} + 8 × {{ sku|KZT|mdb.cluster.mongodb.v3.ram|number }}) %} > -> Итого: 156,00 ₸ — стоимость часа работы хостов {{ MG }}. +> Итого: {% calc [currency=KZT] 3 × (2 × {{ sku|KZT|mdb.cluster.mongodb.v3.cpu.c100|number }} + 8 × {{ sku|KZT|mdb.cluster.mongodb.v3.ram|number }}) %} — стоимость часа работы хостов {{ MG }}. Где: * 3 — количество хостов {{ MG }}. * 2 — количество vCPU. -* 8,00 ₸ — стоимость часа использования 100% vCPU. +* {{ sku|KZT|mdb.cluster.mongodb.v3.cpu.c100|string }} — стоимость часа использования 100% vCPU. * 8 — объем RAM одного хоста {{ MG }} (в гигабайтах). -* 4,50 ₸ — стоимость часа использования 1 ГБ RAM на 100% vCPU. \ No newline at end of file +* {{ sku|KZT|mdb.cluster.mongodb.v3.ram|string }} — стоимость часа использования 1 ГБ RAM на 100% vCPU. \ No newline at end of file diff --git a/ru/_pricing_examples/managed-mongodb/kzt-storage.md b/ru/_pricing_examples/managed-mongodb/kzt-storage.md index 876e117eb95..f1e860ae0a0 100644 --- a/ru/_pricing_examples/managed-mongodb/kzt-storage.md +++ b/ru/_pricing_examples/managed-mongodb/kzt-storage.md @@ -1,9 +1,9 @@ -> 720 × 156,00 ₸ + 100 × 16,00 ₸ = 113 920,00 ₸ +> 720 × {% calc [currency=KZT] 3 × (2 × {{ sku|KZT|mdb.cluster.mongodb.v3.cpu.c100|number }} + 8 × {{ sku|KZT|mdb.cluster.mongodb.v3.ram|number }}) %} + 100 × {{ sku|KZT|mdb.cluster.network-hdd.ch|month|string }} = {% calc [currency=KZT] 720 × (3 × (2 × {{ sku|KZT|mdb.cluster.mongodb.v3.cpu.c100|number }} + 8 × {{ sku|KZT|mdb.cluster.mongodb.v3.ram|number }})) + 100 × {{ sku|KZT|mdb.cluster.network-hdd.ch|month|number }} %} > -> Итого: 113 920,00 ₸ — стоимость использования кластера в течение 30 дней. +> Итого: {% calc [currency=KZT] 720 × (3 × (2 × {{ sku|KZT|mdb.cluster.mongodb.v3.cpu.c100|number }} + 8 × {{ sku|KZT|mdb.cluster.mongodb.v3.ram|number }})) + 100 × {{ sku|KZT|mdb.cluster.network-hdd.ch|month|number }} %} — стоимость использования кластера в течение 30 дней. Где: * 720 — количество часов в 30 днях. -* 156,00 ₸ — стоимость часа работы хостов {{ MG }}. +* {% calc [currency=KZT] 3 × (2 × {{ sku|KZT|mdb.cluster.mongodb.v3.cpu.c100|number }} + 8 × {{ sku|KZT|mdb.cluster.mongodb.v3.ram|number }}) %} — стоимость часа работы хостов {{ MG }}. * 100 — объем хранилища на сетевых HDD-дисках (в гигабайтах). -* 16,00 ₸ — стоимость месяца использования 1 ГБ хранилища на сетевых HDD-дисках. \ No newline at end of file +* {{ sku|KZT|mdb.cluster.network-hdd.ch|month|string }} — стоимость месяца использования 1 ГБ хранилища на сетевых HDD-дисках. \ No newline at end of file diff --git a/ru/_pricing_examples/managed-mongodb/rub-host.md b/ru/_pricing_examples/managed-mongodb/rub-host.md index bdb43934851..acd75cb627c 100644 --- a/ru/_pricing_examples/managed-mongodb/rub-host.md +++ b/ru/_pricing_examples/managed-mongodb/rub-host.md @@ -1,10 +1,10 @@ -> 3 × (2 × 1,60 ₽ + 8 × 0,90 ₽) = 31,20 ₽ +> 3 × (2 × {{ sku|RUB|mdb.cluster.mongodb.v3.cpu.c100|string }} + 8 × {{ sku|RUB|mdb.cluster.mongodb.v3.ram|string }}) = {% calc [currency=RUB] 3 × (2 × {{ sku|RUB|mdb.cluster.mongodb.v3.cpu.c100|number }} + 8 × {{ sku|RUB|mdb.cluster.mongodb.v3.ram|number }}) %} > -> Итого: 31,20 ₽ — стоимость часа работы хостов {{ MG }}. +> Итого: {% calc [currency=RUB] 3 × (2 × {{ sku|RUB|mdb.cluster.mongodb.v3.cpu.c100|number }} + 8 × {{ sku|RUB|mdb.cluster.mongodb.v3.ram|number }}) %} — стоимость часа работы хостов {{ MG }}. Где: * 3 — количество хостов {{ MG }}. * 2 — количество vCPU. -* 1,60 ₽ — стоимость часа использования 100% vCPU. +* {{ sku|RUB|mdb.cluster.mongodb.v3.cpu.c100|string }} — стоимость часа использования 100% vCPU. * 8 — объем RAM одного хоста {{ MG }} (в гигабайтах). -* 0,90 ₽ — стоимость часа использования 1 ГБ RAM на 100% vCPU. \ No newline at end of file +* {{ sku|RUB|mdb.cluster.mongodb.v3.ram|string }} — стоимость часа использования 1 ГБ RAM на 100% vCPU. \ No newline at end of file diff --git a/ru/_pricing_examples/managed-mongodb/rub-storage.md b/ru/_pricing_examples/managed-mongodb/rub-storage.md index 988f533ff1e..bc8749c0ce0 100644 --- a/ru/_pricing_examples/managed-mongodb/rub-storage.md +++ b/ru/_pricing_examples/managed-mongodb/rub-storage.md @@ -1,9 +1,9 @@ -> 720 × 31,20 ₽ + 100 × 3,20 ₽ = 22 784,00 ₽ +> 720 × {% calc [currency=RUB] 3 × (2 × {{ sku|RUB|mdb.cluster.mongodb.v3.cpu.c100|number }} + 8 × {{ sku|RUB|mdb.cluster.mongodb.v3.ram|number }}) %} + 100 × {{ sku|RUB|mdb.cluster.network-hdd.ch|month|string }} = {% calc [currency=RUB] 720 × (3 × (2 × {{ sku|RUB|mdb.cluster.mongodb.v3.cpu.c100|number }} + 8 × {{ sku|RUB|mdb.cluster.mongodb.v3.ram|number }})) + 100 × {{ sku|RUB|mdb.cluster.network-hdd.ch|month|number }} %} > -> Итого: 22 784,00 ₽ — стоимость использования кластера в течение 30 дней. +> Итого: {% calc [currency=RUB] 720 × (3 × (2 × {{ sku|RUB|mdb.cluster.mongodb.v3.cpu.c100|number }} + 8 × {{ sku|RUB|mdb.cluster.mongodb.v3.ram|number }})) + 100 × {{ sku|RUB|mdb.cluster.network-hdd.ch|month|number }} %} — стоимость использования кластера в течение 30 дней. Где: * 720 — количество часов в 30 днях. -* 31,20 ₽ — стоимость часа работы хостов {{ MG }}. +* {% calc [currency=RUB] 3 × (2 × {{ sku|RUB|mdb.cluster.mongodb.v3.cpu.c100|number }} + 8 × {{ sku|RUB|mdb.cluster.mongodb.v3.ram|number }}) %} — стоимость часа работы хостов {{ MG }}. * 100 — объем хранилища на сетевых HDD-дисках (в гигабайтах). -* 3,20 ₽ — стоимость месяца использования 1 ГБ хранилища на сетевых HDD-дисках. \ No newline at end of file +* {{ sku|RUB|mdb.cluster.network-hdd.ch|month|string }} — стоимость месяца использования 1 ГБ хранилища на сетевых HDD-дисках. \ No newline at end of file diff --git a/ru/_pricing_examples/managed-mysql/kzt-host.md b/ru/_pricing_examples/managed-mysql/kzt-host.md new file mode 100644 index 00000000000..a4e5e134ef9 --- /dev/null +++ b/ru/_pricing_examples/managed-mysql/kzt-host.md @@ -0,0 +1,10 @@ +> 3 × (2 × {{ sku|KZT|mdb.cluster.mysql.v3.cpu.c100|string }} + 8 × {{ sku|KZT|mdb.cluster.mysql.v3.ram|string }}) = {% calc [currency=KZT] 3 × (2 × {{ sku|KZT|mdb.cluster.mysql.v3.cpu.c100|number }} + 8 × {{ sku|KZT|mdb.cluster.mysql.v3.ram|number }}) %} +> +> Итого: {% calc [currency=KZT] 3 × (2 × {{ sku|KZT|mdb.cluster.mysql.v3.cpu.c100|number }} + 8 × {{ sku|KZT|mdb.cluster.mysql.v3.ram|number }}) %} — стоимость часа работы хостов {{ MY }}. + +Где: +* 3 — количество хостов {{ MY }}. +* 2 — количество vCPU. +* {{ sku|KZT|mdb.cluster.mysql.v3.cpu.c100|string }} — стоимость часа использования 100% vCPU. +* 8 — объем RAM одного хоста {{ MY }} (в гигабайтах). +* {{ sku|KZT|mdb.cluster.mysql.v3.ram|string }} — стоимость часа использования 1 ГБ RAM на 100% vCPU. \ No newline at end of file diff --git a/ru/_pricing_examples/managed-mysql/kzt-storage.md b/ru/_pricing_examples/managed-mysql/kzt-storage.md new file mode 100644 index 00000000000..89a4bba0821 --- /dev/null +++ b/ru/_pricing_examples/managed-mysql/kzt-storage.md @@ -0,0 +1,9 @@ +> 720 × {% calc [currency=KZT] 3 × (2 × {{ sku|KZT|mdb.cluster.mysql.v3.cpu.c100|number }} + 8 × {{ sku|KZT|mdb.cluster.mysql.v3.ram|number }}) %} + 100 × {{ sku|KZT|mdb.cluster.network-hdd.mysql|month|string }} = {% calc [currency=KZT] 720 × (3 × (2 × {{ sku|KZT|mdb.cluster.mysql.v3.cpu.c100|number }} + 8 × {{ sku|KZT|mdb.cluster.mysql.v3.ram|number }})) + 100 × {{ sku|KZT|mdb.cluster.network-hdd.mysql|month|number }} %} +> +> Итого: {% calc [currency=KZT] 720 × (3 × (2 × {{ sku|KZT|mdb.cluster.mysql.v3.cpu.c100|number }} + 8 × {{ sku|KZT|mdb.cluster.mysql.v3.ram|number }})) + 100 × {{ sku|KZT|mdb.cluster.network-hdd.mysql|month|number }} %} — стоимость использования кластера в течение 30 дней. + +Где: +* 720 — количество часов в 30 днях. +* {% calc [currency=KZT] 3 × (2 × {{ sku|KZT|mdb.cluster.mysql.v3.cpu.c100|number }} + 8 × {{ sku|KZT|mdb.cluster.mysql.v3.ram|number }}) %} — стоимость часа работы хостов {{ MY }}. +* 100 — объем хранилища на сетевых HDD-дисках (в гигабайтах). +* {{ sku|KZT|mdb.cluster.network-hdd.mysql|month|string }} — стоимость месяца использования 1 ГБ хранилища на сетевых HDD-дисках. \ No newline at end of file diff --git a/ru/_pricing_examples/managed-mysql/rub-host.md b/ru/_pricing_examples/managed-mysql/rub-host.md new file mode 100644 index 00000000000..e7f2d946ed7 --- /dev/null +++ b/ru/_pricing_examples/managed-mysql/rub-host.md @@ -0,0 +1,10 @@ +> 3 × (2 × {{ sku|RUB|mdb.cluster.mysql.v3.cpu.c100|string }} + 8 × {{ sku|RUB|mdb.cluster.mysql.v3.ram|string }}) = {% calc [currency=RUB] 3 × (2 × {{ sku|RUB|mdb.cluster.mysql.v3.cpu.c100|number }} + 8 × {{ sku|RUB|mdb.cluster.mysql.v3.ram|number }}) %} +> +> Итого: {% calc [currency=RUB] 3 × (2 × {{ sku|RUB|mdb.cluster.mysql.v3.cpu.c100|number }} + 8 × {{ sku|RUB|mdb.cluster.mysql.v3.ram|number }}) %} — стоимость часа работы хостов {{ MY }}. + +Где: +* 3 — количество хостов {{ MY }}. +* 2 — количество vCPU. +* {{ sku|RUB|mdb.cluster.mysql.v3.cpu.c100|string }} — стоимость часа использования 100% vCPU. +* 8 — объем RAM одного хоста {{ MY }} (в гигабайтах). +* {{ sku|RUB|mdb.cluster.mysql.v3.ram|string }} — стоимость часа использования 1 ГБ RAM на 100% vCPU. \ No newline at end of file diff --git a/ru/_pricing_examples/managed-mysql/rub-storage.md b/ru/_pricing_examples/managed-mysql/rub-storage.md new file mode 100644 index 00000000000..e5f0eb199ad --- /dev/null +++ b/ru/_pricing_examples/managed-mysql/rub-storage.md @@ -0,0 +1,9 @@ +> 720 × {% calc [currency=RUB] 3 × (2 × {{ sku|RUB|mdb.cluster.mysql.v3.cpu.c100|number }} + 8 × {{ sku|RUB|mdb.cluster.mysql.v3.ram|number }}) %} + 100 × {{ sku|RUB|mdb.cluster.network-hdd.mysql|month|string }} = {% calc [currency=RUB] 720 × (3 × (2 × {{ sku|RUB|mdb.cluster.mysql.v3.cpu.c100|number }} + 8 × {{ sku|RUB|mdb.cluster.mysql.v3.ram|number }})) + 100 × {{ sku|RUB|mdb.cluster.network-hdd.mysql|month|number }} %} +> +> Итого: {% calc [currency=RUB] 720 × (3 × (2 × {{ sku|RUB|mdb.cluster.mysql.v3.cpu.c100|number }} + 8 × {{ sku|RUB|mdb.cluster.mysql.v3.ram|number }})) + 100 × {{ sku|RUB|mdb.cluster.network-hdd.mysql|month|number }} %} — стоимость использования кластера в течение 30 дней. + +Где: +* 720 — количество часов в 30 днях. +* {% calc [currency=RUB] 3 × (2 × {{ sku|RUB|mdb.cluster.mysql.v3.cpu.c100|number }} + 8 × {{ sku|RUB|mdb.cluster.mysql.v3.ram|number }}) %} — стоимость часа работы хостов {{ MY }}. +* 100 — объем хранилища на сетевых HDD-дисках (в гигабайтах). +* {{ sku|RUB|mdb.cluster.network-hdd.mysql|month|string }} — стоимость месяца использования 1 ГБ хранилища на сетевых HDD-дисках. \ No newline at end of file diff --git a/ru/_pricing_examples/smartwebsecurity/kzt-smartwebsecurity-pack.md b/ru/_pricing_examples/smartwebsecurity/kzt-smartwebsecurity-pack.md index 078bb97bfff..e00e8ac73af 100644 --- a/ru/_pricing_examples/smartwebsecurity/kzt-smartwebsecurity-pack.md +++ b/ru/_pricing_examples/smartwebsecurity/kzt-smartwebsecurity-pack.md @@ -1,7 +1,7 @@ | Количество запросов в месяц, млн | Стоимость запросов, разрешенных профилем безопасности, вкл. НДС | Стоимость запросов, разрешенных профилями безопасности и WAF, вкл. НДС | | --- | --- | --- | -| 1 | 125 000,00 ₸ | 250 000,00 ₸ | -| 10 | 282 500,00 ₸ | 565 000,00 ₸ | -| 100 | 372 500,00 ₸ | 745 000,00 ₸ | -| 1 000 | 1 002 500,00 ₸ | 2 005 000,00 ₸ | -| 10 000 | 3 252 500,00 ₸ | 6 505 000,00 ₸ | \ No newline at end of file +| 1 | {{ sku|KZT|sws.requests.v1|pricingRate.0.01|string }} | {% calc [currency=KZT] {{ sku|KZT|sws.requests.v1|pricingRate.0.01|number }} + {{ sku|KZT|sws.waf.requests.v1|pricingRate.0.01|number }} %} | +| 10 | {% calc [currency=KZT] {{ sku|KZT|sws.requests.v1|pricingRate.0.01|number }} + {{ sku|KZT|sws.requests.v1|pricingRate.1|number }} × 9 %} | {% calc [currency=KZT] ({{ sku|KZT|sws.requests.v1|pricingRate.0.01|number }} + {{ sku|KZT|sws.requests.v1|pricingRate.1|number }} × 9) + ({{ sku|KZT|sws.waf.requests.v1|pricingRate.0.01|number }} + {{ sku|KZT|sws.waf.requests.v1|pricingRate.1|number }} × 9) %} | +| 100 | {% calc [currency=KZT] {{ sku|KZT|sws.requests.v1|pricingRate.0.01|number }} + {{ sku|KZT|sws.requests.v1|pricingRate.1|number }} × 9 + {{ sku|KZT|sws.requests.v1|pricingRate.10|number }} × 90 %} | {% calc [currency=KZT] ({{ sku|KZT|sws.requests.v1|pricingRate.0.01|number }} + {{ sku|KZT|sws.requests.v1|pricingRate.1|number }} × 9 + {{ sku|KZT|sws.requests.v1|pricingRate.10|number }} × 90) + ({{ sku|KZT|sws.waf.requests.v1|pricingRate.0.01|number }} + {{ sku|KZT|sws.waf.requests.v1|pricingRate.1|number }} × 9 + {{ sku|KZT|sws.waf.requests.v1|pricingRate.10|number }} × 90) %} | +| 1 000 | {% calc [currency=KZT] {{ sku|KZT|sws.requests.v1|pricingRate.0.01|number }} + {{ sku|KZT|sws.requests.v1|pricingRate.1|number }} × 9 + {{ sku|KZT|sws.requests.v1|pricingRate.10|number }} × 90 + {{ sku|KZT|sws.requests.v1|pricingRate.100|number }} × 900 %} | {% calc [currency=KZT] ({{ sku|KZT|sws.requests.v1|pricingRate.0.01|number }} + {{ sku|KZT|sws.requests.v1|pricingRate.1|number }} × 9 + {{ sku|KZT|sws.requests.v1|pricingRate.10|number }} × 90 + {{ sku|KZT|sws.requests.v1|pricingRate.100|number }} × 900) + ({{ sku|KZT|sws.waf.requests.v1|pricingRate.0.01|number }} + {{ sku|KZT|sws.waf.requests.v1|pricingRate.1|number }} × 9 + {{ sku|KZT|sws.waf.requests.v1|pricingRate.10|number }} × 90 + {{ sku|KZT|sws.waf.requests.v1|pricingRate.100|number }} × 900) %} | +| 10 000 | {% calc [currency=KZT] {{ sku|KZT|sws.requests.v1|pricingRate.0.01|number }} + {{ sku|KZT|sws.requests.v1|pricingRate.1|number }} × 9 + {{ sku|KZT|sws.requests.v1|pricingRate.10|number }} × 90 + {{ sku|KZT|sws.requests.v1|pricingRate.100|number }} × 900 + {{ sku|KZT|sws.requests.v1|pricingRate.1000|number }} × 9000 %} | {% calc [currency=KZT] ({{ sku|KZT|sws.requests.v1|pricingRate.0.01|number }} + {{ sku|KZT|sws.requests.v1|pricingRate.1|number }} × 9 + {{ sku|KZT|sws.requests.v1|pricingRate.10|number }} × 90 + {{ sku|KZT|sws.requests.v1|pricingRate.100|number }} × 900 + {{ sku|KZT|sws.requests.v1|pricingRate.1000|number }} × 9000) + ({{ sku|KZT|sws.waf.requests.v1|pricingRate.0.01|number }} + {{ sku|KZT|sws.waf.requests.v1|pricingRate.1|number }} × 9 + {{ sku|KZT|sws.waf.requests.v1|pricingRate.10|number }} × 90 + {{ sku|KZT|sws.waf.requests.v1|pricingRate.100|number }} × 900 + {{ sku|KZT|sws.waf.requests.v1|pricingRate.1000|number }} × 9000) %} | \ No newline at end of file diff --git a/ru/_pricing_examples/smartwebsecurity/kzt-smartwebsecurity-waf.md b/ru/_pricing_examples/smartwebsecurity/kzt-smartwebsecurity-waf.md index d5ef015a7ab..958ff920b7c 100644 --- a/ru/_pricing_examples/smartwebsecurity/kzt-smartwebsecurity-waf.md +++ b/ru/_pricing_examples/smartwebsecurity/kzt-smartwebsecurity-waf.md @@ -1,13 +1,13 @@ Профиль WAF можно подключить только при использовании профиля безопасности. Поэтому запросы, обработанные правилами WAF, оплачиваются и за обработку правилами профиля безопасности. > Рассчитаем стоимость 315,04 млн легитимных запросов в месяц, обработанных правилами профиля безопасности и WAF: -> (0,01 × 0,00 ₸ + 0,99 × 125 000,00 ₸ + 9 × 17 500,00 ₸ + 90 × 1 000,00 ₸ + 215,04 × 700,00 ₸) × 2 = 1 043 556,00 ₸, вкл. НДС. +> (0,01 × {{ sku|KZT|sws.waf.requests.v1|number }} ₸ + 0,99 × {{ sku|KZT|sws.waf.requests.v1|pricingRate.0.01|string }} + 9 × {{ sku|KZT|sws.waf.requests.v1|pricingRate.1|string }} + 90 × {{ sku|KZT|sws.waf.requests.v1|pricingRate.10|string }} + 215,04 × {{ sku|KZT|sws.waf.requests.v1|pricingRate.100|string }}) × 2 = {% calc [currency=KZT] (0,01 × {{ sku|KZT|sws.waf.requests.v1|number }} + 0,99 × {{ sku|KZT|sws.waf.requests.v1|pricingRate.0.01|number }} + 9 × {{ sku|KZT|sws.waf.requests.v1|pricingRate.1|number }} + 90 × {{ sku|KZT|sws.waf.requests.v1|pricingRate.10|number }} + 215,04 × {{ sku|KZT|sws.waf.requests.v1|pricingRate.100|number }}) × 2 %}, вкл. НДС. Где: -* 0,01 × 0,00 ₸ — нетарифицируемый порог — 0,01 млн запросов. -* 0,99 × 125 000,00 ₸ — стоимость последующих 0,99 млн запросов. -* 9 × 17 500,00 ₸ — стоимость последующих 9 млн запросов. -* 90 × 1 000,00 ₸ — стоимость последующих 90 млн запросов. -* 215,04 × 700,00 ₸ — стоимость оставшихся 215,04 млн запросов. +* 0,01 × {{ sku|KZT|sws.waf.requests.v1|number }} ₸ — нетарифицируемый порог, первые 0,01 млн запросов. +* 0,99 × {{ sku|KZT|sws.waf.requests.v1|pricingRate.0.01|string }} — стоимость последующих 0,99 млн запросов. +* 9 × {{ sku|KZT|sws.waf.requests.v1|pricingRate.1|string }} — стоимость последующих 9 млн запросов. +* 90 × {{ sku|KZT|sws.waf.requests.v1|pricingRate.10|string }} — стоимость последующих 90 млн запросов. +* 215,04 × {{ sku|KZT|sws.waf.requests.v1|pricingRate.100|string }} — стоимость оставшихся 215,04 млн запросов. * × 2 — итоговая стоимость умножается на `2`, поскольку каждый запрос последовательно обрабатывался правилами из профиля безопасности, а затем правилами из профиля WAF. \ No newline at end of file diff --git a/ru/_pricing_examples/smartwebsecurity/kzt-smartwebsecurity.md b/ru/_pricing_examples/smartwebsecurity/kzt-smartwebsecurity.md index 20f51ce5ea6..725b5750a6e 100644 --- a/ru/_pricing_examples/smartwebsecurity/kzt-smartwebsecurity.md +++ b/ru/_pricing_examples/smartwebsecurity/kzt-smartwebsecurity.md @@ -1,10 +1,10 @@ -> Рассчитаем стоимость 315,04 млн легитимных запросов в месяц, обработанных правилами профиля безопасности: -> 0,01 × 0,00 ₸ + 0,99 × 125 000,00 ₸ + 9 × 17 500,00 ₸ + 90 × 1 000,00 ₸ + 215,04 × 700,00 ₸ = 521 778,00 ₸, вкл. НДС. +> Рассчитаем стоимость 315,04 млн легитимных запросов в месяц, обработанных правилами профиля безопасности: +> 0,01 × {{ sku|KZT|sws.requests.v1|number }} ₸ + 0,99 × {{ sku|KZT|sws.requests.v1|pricingRate.0.01|string }} + 9 × {{ sku|KZT|sws.requests.v1|pricingRate.1|string }} + 90 × {{ sku|KZT|sws.requests.v1|pricingRate.10|string }} + 215,04 × {{ sku|KZT|sws.requests.v1|pricingRate.100|string }} = {% calc [currency=KZT] 0,01 × {{ sku|KZT|sws.requests.v1|number }} + 0,99 × {{ sku|KZT|sws.requests.v1|pricingRate.0.01|number }} + 9 × {{ sku|KZT|sws.requests.v1|pricingRate.1|number }} + 90 × {{ sku|KZT|sws.requests.v1|pricingRate.10|number }} + 215,04 × {{ sku|KZT|sws.requests.v1|pricingRate.100|number }} %}, вкл. НДС. Где: -* 0,01 × 0,00 ₸ — нетарифицируемый порог — 0,01 млн запросов. -* 0,99 × 125 000,00 ₸ — стоимость последующих 0,99 млн запросов. -* 9 × 17 500,00 ₸ — стоимость последующих 9 млн запросов. -* 90 × 1 000,00 ₸ — стоимость последующих 90 млн запросов. -* 215,04 × 700,00 ₸ — стоимость оставшихся 215,04 млн запросов. \ No newline at end of file +* 0,01 × {{ sku|KZT|sws.requests.v1|number }} ₸ — нетарифицируемый порог, первые 0,01 млн запросов. +* 0,99 × {{ sku|KZT|sws.requests.v1|pricingRate.0.01|string }} — стоимость последующих 0,99 млн запросов. +* 9 × {{ sku|KZT|sws.requests.v1|pricingRate.1|string }} — стоимость последующих 9 млн запросов. +* 90 × {{ sku|KZT|sws.requests.v1|pricingRate.10|string }} — стоимость последующих 90 млн запросов. +* 215,04 × {{ sku|KZT|sws.requests.v1|pricingRate.100|string }} — стоимость оставшихся 215,04 млн запросов. \ No newline at end of file diff --git a/ru/_pricing_examples/smartwebsecurity/rub-smartwebsecurity-pack.md b/ru/_pricing_examples/smartwebsecurity/rub-smartwebsecurity-pack.md index 16a87b16e78..2342026fd5e 100644 --- a/ru/_pricing_examples/smartwebsecurity/rub-smartwebsecurity-pack.md +++ b/ru/_pricing_examples/smartwebsecurity/rub-smartwebsecurity-pack.md @@ -1,7 +1,7 @@ | Количество запросов в месяц, млн | Стоимость запросов, разрешенных профилем безопасности, вкл. НДС | Стоимость запросов, разрешенных профилями безопасности и WAF, вкл. НДС | | --- | --- | --- | -| 1 | 25 000,00 ₽ | 50 000,00 ₽ | -| 10 | 56 500,00 ₽ | 113 000,00 ₽ | -| 100 | 74 500,00 ₽ | 149 000,00 ₽ | -| 1 000 | 200 500,00 ₽ | 401 000,00 ₽ | -| 10 000 | 650 500,00 ₽ | 1 301 000,00 ₽ | \ No newline at end of file +| 1 | {{ sku|RUB|sws.requests.v1|pricingRate.0.01|string }} | {% calc [currency=RUB] {{ sku|RUB|sws.requests.v1|pricingRate.0.01|number }} + {{ sku|RUB|sws.waf.requests.v1|pricingRate.0.01|number }} %} | +| 10 | {% calc [currency=RUB] {{ sku|RUB|sws.requests.v1|pricingRate.0.01|number }} + {{ sku|RUB|sws.requests.v1|pricingRate.1|number }} × 9 %} | {% calc [currency=RUB] ({{ sku|RUB|sws.requests.v1|pricingRate.0.01|number }} + {{ sku|RUB|sws.requests.v1|pricingRate.1|number }} × 9) + ({{ sku|RUB|sws.waf.requests.v1|pricingRate.0.01|number }} + {{ sku|RUB|sws.waf.requests.v1|pricingRate.1|number }} × 9) %} | +| 100 | {% calc [currency=RUB] {{ sku|RUB|sws.requests.v1|pricingRate.0.01|number }} + {{ sku|RUB|sws.requests.v1|pricingRate.1|number }} × 9 + {{ sku|RUB|sws.requests.v1|pricingRate.10|number }} × 90 %} | {% calc [currency=RUB] ({{ sku|RUB|sws.requests.v1|pricingRate.0.01|number }} + {{ sku|RUB|sws.requests.v1|pricingRate.1|number }} × 9 + {{ sku|RUB|sws.requests.v1|pricingRate.10|number }} × 90) + ({{ sku|RUB|sws.waf.requests.v1|pricingRate.0.01|number }} + {{ sku|RUB|sws.waf.requests.v1|pricingRate.1|number }} × 9 + {{ sku|RUB|sws.waf.requests.v1|pricingRate.10|number }} × 90) %} | +| 1 000 | {% calc [currency=RUB] {{ sku|RUB|sws.requests.v1|pricingRate.0.01|number }} + {{ sku|RUB|sws.requests.v1|pricingRate.1|number }} × 9 + {{ sku|RUB|sws.requests.v1|pricingRate.10|number }} × 90 + {{ sku|RUB|sws.requests.v1|pricingRate.100|number }} × 900 %} | {% calc [currency=RUB] ({{ sku|RUB|sws.requests.v1|pricingRate.0.01|number }} + {{ sku|RUB|sws.requests.v1|pricingRate.1|number }} × 9 + {{ sku|RUB|sws.requests.v1|pricingRate.10|number }} × 90 + {{ sku|RUB|sws.requests.v1|pricingRate.100|number }} × 900) + ({{ sku|RUB|sws.waf.requests.v1|pricingRate.0.01|number }} + {{ sku|RUB|sws.waf.requests.v1|pricingRate.1|number }} × 9 + {{ sku|RUB|sws.waf.requests.v1|pricingRate.10|number }} × 90 + {{ sku|RUB|sws.waf.requests.v1|pricingRate.100|number }} × 900) %} | +| 10 000 | {% calc [currency=RUB] {{ sku|RUB|sws.requests.v1|pricingRate.0.01|number }} + {{ sku|RUB|sws.requests.v1|pricingRate.1|number }} × 9 + {{ sku|RUB|sws.requests.v1|pricingRate.10|number }} × 90 + {{ sku|RUB|sws.requests.v1|pricingRate.100|number }} × 900 + {{ sku|RUB|sws.requests.v1|pricingRate.1000|number }} × 9000 %} | {% calc [currency=RUB] ({{ sku|RUB|sws.requests.v1|pricingRate.0.01|number }} + {{ sku|RUB|sws.requests.v1|pricingRate.1|number }} × 9 + {{ sku|RUB|sws.requests.v1|pricingRate.10|number }} × 90 + {{ sku|RUB|sws.requests.v1|pricingRate.100|number }} × 900 + {{ sku|RUB|sws.requests.v1|pricingRate.1000|number }} × 9000) + ({{ sku|RUB|sws.waf.requests.v1|pricingRate.0.01|number }} + {{ sku|RUB|sws.waf.requests.v1|pricingRate.1|number }} × 9 + {{ sku|RUB|sws.waf.requests.v1|pricingRate.10|number }} × 90 + {{ sku|RUB|sws.waf.requests.v1|pricingRate.100|number }} × 900 + {{ sku|RUB|sws.waf.requests.v1|pricingRate.1000|number }} × 9000) %} | \ No newline at end of file diff --git a/ru/_pricing_examples/smartwebsecurity/rub-smartwebsecurity-waf.md b/ru/_pricing_examples/smartwebsecurity/rub-smartwebsecurity-waf.md index 7465cecc73e..d6faaaf48e2 100644 --- a/ru/_pricing_examples/smartwebsecurity/rub-smartwebsecurity-waf.md +++ b/ru/_pricing_examples/smartwebsecurity/rub-smartwebsecurity-waf.md @@ -1,13 +1,13 @@ Профиль WAF можно подключить только при использовании профиля безопасности. Поэтому запросы, обработанные правилами WAF, оплачиваются и за обработку правилами профиля безопасности. > Рассчитаем стоимость 315,04 млн легитимных запросов в месяц, обработанных правилами профиля безопасности и WAF: -> (0,01 × 0,00 ₽ + 0,99 × 25 000,00 ₽ + 9 × 3 500,00 ₽ + 90 × 200,00 ₽ + 215,04 × 140,00 ₽) × 2 = 208 711,20 ₽, вкл. НДС. +> (0,01 × {{ sku|RUB|sws.waf.requests.v1|number }} ₽ + 0,99 × {{ sku|RUB|sws.waf.requests.v1|pricingRate.0.01|string }} + 9 × {{ sku|RUB|sws.waf.requests.v1|pricingRate.1|string }} + 90 × {{ sku|RUB|sws.waf.requests.v1|pricingRate.10|string }} + 215,04 × {{ sku|RUB|sws.waf.requests.v1|pricingRate.100|string }}) × 2 = {% calc [currency=RUB] (0,01 × {{ sku|RUB|sws.waf.requests.v1|number }} + 0,99 × {{ sku|RUB|sws.waf.requests.v1|pricingRate.0.01|number }} + 9 × {{ sku|RUB|sws.waf.requests.v1|pricingRate.1|number }} + 90 × {{ sku|RUB|sws.waf.requests.v1|pricingRate.10|number }} + 215,04 × {{ sku|RUB|sws.waf.requests.v1|pricingRate.100|number }}) × 2 %}, вкл. НДС. Где: -* 0,01 × 0,00 ₽ — нетарифицируемый порог, первые 0,01 млн запросов. -* 0,99 × 25 000,00 ₽ — стоимость последующих 0,99 млн запросов. -* 9 × 3 500,00 ₽ — стоимость последующих 9 млн запросов. -* 90 × 200,00 ₽ — стоимость последующих 90 млн запросов. -* 215,04 × 140,00 ₽ — стоимость оставшихся 215,04 млн запросов. +* 0,01 × {{ sku|RUB|sws.waf.requests.v1|number }} ₽ — нетарифицируемый порог, первые 0,01 млн запросов. +* 0,99 × {{ sku|RUB|sws.waf.requests.v1|pricingRate.0.01|string }} — стоимость последующих 0,99 млн запросов. +* 9 × {{ sku|RUB|sws.waf.requests.v1|pricingRate.1|string }} — стоимость последующих 9 млн запросов. +* 90 × {{ sku|RUB|sws.waf.requests.v1|pricingRate.10|string }} — стоимость последующих 90 млн запросов. +* 215,04 × {{ sku|RUB|sws.waf.requests.v1|pricingRate.100|string }} — стоимость оставшихся 215,04 млн запросов. * × 2 — итоговая стоимость умножается на `2`, поскольку каждый запрос последовательно обрабатывался правилами из профиля безопасности, а затем правилами из профиля WAF. \ No newline at end of file diff --git a/ru/_pricing_examples/smartwebsecurity/rub-smartwebsecurity.md b/ru/_pricing_examples/smartwebsecurity/rub-smartwebsecurity.md index 4b225b6f86b..c5dc0c9913c 100644 --- a/ru/_pricing_examples/smartwebsecurity/rub-smartwebsecurity.md +++ b/ru/_pricing_examples/smartwebsecurity/rub-smartwebsecurity.md @@ -1,10 +1,10 @@ -> Рассчитаем стоимость 315,04 млн легитимных запросов в месяц, обработанных правилами профиля безопасности: -> 0,01 × 0,00 ₽ + 0,99 × 25 000,00 ₽ + 9 × 3 500,00 ₽ + 90 × 200,00 ₽ + 215,04 × 140,00 ₽ = 104 355,60 ₽, вкл. НДС. +> Рассчитаем стоимость 315,04 млн легитимных запросов в месяц, обработанных правилами профиля безопасности: +> 0,01 × {{ sku|RUB|sws.requests.v1|number }} ₽ + 0,99 × {{ sku|RUB|sws.requests.v1|pricingRate.0.01|string }} + 9 × {{ sku|RUB|sws.requests.v1|pricingRate.1|string }} + 90 × {{ sku|RUB|sws.requests.v1|pricingRate.10|string }} + 215,04 × {{ sku|RUB|sws.requests.v1|pricingRate.100|string }} = {% calc [currency=RUB] 0,01 × {{ sku|RUB|sws.requests.v1|number }} + 0,99 × {{ sku|RUB|sws.requests.v1|pricingRate.0.01|number }} + 9 × {{ sku|RUB|sws.requests.v1|pricingRate.1|number }} + 90 × {{ sku|RUB|sws.requests.v1|pricingRate.10|number }} + 215,04 × {{ sku|RUB|sws.requests.v1|pricingRate.100|number }} %}, вкл. НДС. Где: -* 0,01 × 0,00 ₽ — нетарифицируемый порог — первые 0,01 млн запросов. -* 0,99 × 25 000,00 ₽ — стоимость последующих 0,99 млн запросов. -* 9 × 3 500,00 ₽ — стоимость последующих 9 млн запросов. -* 90 × 200,00 ₽ — стоимость последующих 90 млн запросов. -* 215,04 × 140,00 ₽ — стоимость оставшихся 215,04 млн запросов. \ No newline at end of file +* 0,01 × {{ sku|RUB|sws.requests.v1|number }} ₽ — нетарифицируемый порог, первые 0,01 млн запросов. +* 0,99 × {{ sku|RUB|sws.requests.v1|pricingRate.0.01|string }} — стоимость последующих 0,99 млн запросов. +* 9 × {{ sku|RUB|sws.requests.v1|pricingRate.1|string }} — стоимость последующих 9 млн запросов. +* 90 × {{ sku|RUB|sws.requests.v1|pricingRate.10|string }} — стоимость последующих 90 млн запросов. +* 215,04 × {{ sku|RUB|sws.requests.v1|pricingRate.100|string }} — стоимость оставшихся 215,04 млн запросов. \ No newline at end of file diff --git a/ru/_qa/billing/billing-account.md b/ru/_qa/billing/billing-account.md index 153359e1156..6e2c5e10a70 100644 --- a/ru/_qa/billing/billing-account.md +++ b/ru/_qa/billing/billing-account.md @@ -36,12 +36,10 @@ После создания платежного аккаунта вы не можете изменить его тип, однако можете [создать новый](../../billing/operations/create-new-account.md). - #### Как подключить порог оплаты? {#credit} [Порог оплаты](../../billing/concepts/billing-threshold.md) подключается автоматически после [активации платной версии](../../billing/operations/activate-commercial.md) и завершения первого отчетного периода. - {% include [change-payment-method](../../billing/_includes/change-payment-method.md) %} #### Как изменить платежные реквизиты или адрес доставки документов? {#change-email} @@ -65,14 +63,12 @@ - #### Не могу привязать банковскую карту при создании платежного аккаунта. Что делать? {#cant-create} Скорее всего, платежная система вашей карты не поддерживается нашим сервисом. Для решения проблемы попробуйте привязать другую карту или, если вы являетесь юридическим лицом, создайте платежный аккаунт с типом **{{ ui-key.yacloud_billing.billing.account.create-new.account-type_label_company }}** и способом оплаты **{{ ui-key.yacloud_billing.billing.account.create-new.payment-type_label_invoice }}**. - #### Почему при создании платежного аккаунта появляется ошибка «Недоступная страна для плательщика»? {#account-error} Скорее всего, вы авторизованы на Яндексе под аккаунтом, к которому уже привязан плательщик с другим резидентством. diff --git a/ru/_qa/billing/common.md b/ru/_qa/billing/common.md index add71f2c97a..4695df18e1c 100644 --- a/ru/_qa/billing/common.md +++ b/ru/_qa/billing/common.md @@ -6,7 +6,7 @@ #### Где можно ознакомиться с Соглашением об уровне обслуживания (SLA)? {#sla} -В {{ yandex-cloud }} для каждого сервиса предусмотрен свой [SLA](../../glossary/sla.md). Ознакомиться с SLA можно в разделе [Правовые документы](https://yandex.ru/legal/cloud_sla/?lang=ru). +В {{ yandex-cloud }} для каждого сервиса предусмотрен свой [SLA](../../glossary/sla.md). Ознакомиться с SLA можно в разделе [Правовые документы]({{ link-sla }}). #### Где я могу найти реквизиты {{ yandex-cloud }}? {#requisites} diff --git a/ru/_qa/billing/contract.md b/ru/_qa/billing/contract.md index ebb759d9777..af727bf0534 100644 --- a/ru/_qa/billing/contract.md +++ b/ru/_qa/billing/contract.md @@ -11,7 +11,7 @@ - Резиденты Российской Федерации {#russia} - Резиденты Российской Федерации, а также налоговые резиденты Республики Беларусь (РБ) могут ознакомиться с условиями договора в разделе [Правовые документы]({{ billing-oferta-url }}?lang=ru). + Резиденты Российской Федерации, а также налоговые резиденты Республики Беларусь (РБ) могут ознакомиться с условиями договора в разделе [Правовые документы]({{ billing-oferta-url }}). - Резиденты Республики Казахстан {#kazakhstan} @@ -20,7 +20,7 @@ - Нерезиденты Российской Федерации и Республики Казахстан {#nonresidents} - С условиями договора вы можете ознакомиться в разделе [Правовые документы](https://yandex.com/legal/cloud_customer_agreement/?lang=ru). + В зависимости от того, с какой компанией вы заключали договор, ознакомиться с условиями договора вы можете в разделе «Правовые документы» для [Iron Hive doo Beograd (Сербия)](https://yandex.com/legal/cloud_customer_agreement/) или [Direct Cursus Technology L.L.C. (Дубай)](https://yandex.com/legal/cloud_customer_agreement_uae/). {% endlist %} @@ -31,8 +31,10 @@ #### Как сослаться на подписанный договор? {#refer-to-contract} + Договор представлен [офертой]({{ billing-oferta-url }}). Укажите номер договора и приложите ссылку на оферту или ее распечатанную версию. Согласно статье 435 ГК РФ, это полностью соответствует правовому статусу подписанного договора на оказание услуг. + #### Как получить договор в бумажном виде? {#paper-contract} Обратитесь в [техническую поддержку]({{ link-console-support }}). С вами свяжется менеджер {{ yandex-cloud }} для обсуждения условий подписания. Подготовка документа займет примерно две недели: представитель компании подпишет его, и мы оформим почтовую отправку. \ No newline at end of file diff --git a/ru/_qa/billing/payment.md b/ru/_qa/billing/payment.md index 6cf0d43eb99..80fdbb8c928 100644 --- a/ru/_qa/billing/payment.md +++ b/ru/_qa/billing/payment.md @@ -13,11 +13,9 @@ {% include [change-payment-method](../../billing/_includes/change-payment-method.md) %} - #### Какие карты принимаются к оплате? {#card-types} {% include [payment-card-types](../../_includes/billing/payment-card-types.md) %} - #### Существует ли минимальная сумма платежа? {#minimum} Минимальная сумма платежа составляет в зависимости от валюты: @@ -60,7 +58,6 @@ - #### Я привязал карту к платежному бизнес-аккаунту. Когда с меня спишут деньги? {#unlink-card} Если вы используете пробный период, средства с привязанной карты не списываются. @@ -72,7 +69,6 @@ 1. Удалите все ресурсы тарифицируемых сервисов. 1. Обратитесь в [службу технической поддержки]({{ link-console-support }}) для деактивации аккаунта. - #### Я привязал облако к новому платежному аккаунту. Как теперь оплачивать услуги? {#unlink-cloud} Если [облако ранее было привязано](../../billing/operations/pin-cloud.md) к другому платежному аккаунту, учитывайте период использования сервисов: до момента переноса оплачивать услуги необходимо с предыдущего платежного аккаунта, после момента переноса — с аккаунта, к которому теперь привязано облако. Способ оплаты соответствует [типу платежного аккаунта](../../billing/concepts/billing-account.md#ba-types). @@ -85,7 +81,10 @@ #### Если оплатить счет с помощью банковского перевода после окончания отчетного периода, будут ли мои ресурсы заблокированы? {#payment-delay} -Согласно [оферте]({{ billing-oferta-url }}), после окончания отчетного периода внести платеж можно в течение 14 календарных дней (не включая нерабочие праздничные дни). Если внести платеж в течение этого времени, ресурсы не будут заблокированы. Учитывайте, что поступление денежных средств занимает до трех рабочих дней, не откладывайте платеж. + +Согласно [оферте]({{ billing-oferta-url }}), после окончания отчетного периода внести платеж можно в течение 14 календарных дней (не включая нерабочие праздничные дни). + + Если внести платеж в течение этого времени, ресурсы не будут заблокированы. Учитывайте, что поступление денежных средств занимает до трех рабочих дней, не откладывайте платеж. #### Из чего складывается стоимость потребления сервиса {{ marketplace-full-name }}? {#marketplace} diff --git a/ru/_qa/datalens/change-source-data.md b/ru/_qa/datalens/change-source-data.md new file mode 100644 index 00000000000..9b532ac95d4 --- /dev/null +++ b/ru/_qa/datalens/change-source-data.md @@ -0,0 +1,5 @@ +### Как с помощью {{ datalens-short-name }} изменить данные в источнике? {#how-to-change-source-data} + +С помощью {{ datalens-short-name }} нельзя изменить данные в источнике. + +Вы можете обработать полученные из источника данные на стороне {{ datalens-short-name }}, использовав [вычисляемые поля](../../datalens/concepts/calculations/index.md). \ No newline at end of file diff --git a/ru/_qa/partner/contracts.md b/ru/_qa/partner/contracts.md index 1a910c182f1..638ce678d15 100644 --- a/ru/_qa/partner/contracts.md +++ b/ru/_qa/partner/contracts.md @@ -51,8 +51,8 @@ 1. В [консоли управления]({{ link-console-main }}) нажмите ![image](../../_assets/console-icons/dots-9.svg) **Все сервисы**. 1. Выберите сервис ![image](../../_assets/console-icons/credit-card.svg) [**{{ billing-name }}**]({{ link-console-billing }}). 1. Выберите платежный аккаунт. -1. Нажмите кнопку **{{ ui-key.yacloud.billing.account.dashboard-overview.button_refill }}**. -1. Введите сумму платежа и нажмите кнопку **{{ ui-key.yacloud.billing.account.dashboard-overview.popup-refill_button_company-action }}**. +1. Нажмите кнопку **{{ ui-key.yacloud_billing.billing.account.dashboard-overview.button_refill }}**. +1. Введите сумму платежа и нажмите кнопку **{{ ui-key.yacloud_billing.billing.account.dashboard-overview.popup-refill_button_company-action }}**. 1. Документ откроется в новой вкладке браузера и сохранится в формате `.pdf`. #### Как подключиться к ЭДО? {#edm} diff --git a/ru/_tutorials/_tutorials_includes/terraform-definition.md b/ru/_tutorials/_tutorials_includes/terraform-definition.md index 89f1f3e954b..a455616777e 100644 --- a/ru/_tutorials/_tutorials_includes/terraform-definition.md +++ b/ru/_tutorials/_tutorials_includes/terraform-definition.md @@ -1,5 +1,3 @@ -[{{ TF }}](https://www.terraform.io/) позволяет быстро создать облачную инфраструктуру в {{ yandex-cloud }} и управлять ей с помощью файлов конфигураций. В файлах конфигураций хранится описание инфраструктуры на языке HCL (HashiCorp Configuration Language). {{ TF }} и его провайдеры распространяются под лицензией [Business Source License](https://github.com/hashicorp/terraform/blob/main/LICENSE). +{% include [terraform-intro](../../_includes/terraform-intro.md) %} -Подробную информацию о ресурсах провайдера смотрите в документации на сайте [{{ TF }}](https://www.terraform.io/docs/providers/yandex/index.html) или в [зеркале]({{ tf-docs-link }}). - -При изменении файлов конфигураций {{ TF }} автоматически определяет, какая часть вашей конфигурации уже развернута, что следует добавить или удалить. \ No newline at end of file +Подробную информацию о ресурсах провайдера смотрите в документации на сайте [{{ TF }}](https://www.terraform.io/docs/providers/yandex/index.html) или в [зеркале]({{ tf-docs-link }}). \ No newline at end of file diff --git a/ru/_tutorials/applied/bind-domain-vm.md b/ru/_tutorials/applied/bind-domain-vm.md index 609042f3aa3..b3fa9422105 100644 --- a/ru/_tutorials/applied/bind-domain-vm.md +++ b/ru/_tutorials/applied/bind-domain-vm.md @@ -249,7 +249,7 @@ * В поле **{{ ui-key.yacloud.component.compute.network-select.field_external }}** выберите `{{ ui-key.yacloud.component.compute.network-select.switch_auto }}`. * В поле **{{ ui-key.yacloud.component.compute.network-select.field_security-groups }}** выберите созданную ранее группу безопасности `webserver-sg`. - 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** укажите данные для доступа к ВМ: + 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** выберите **{{ ui-key.yacloud.compute.instance.access-method.label_oslogin-control-ssh-option-title }}** и укажите данные для доступа к ВМ: * В поле **{{ ui-key.yacloud.compute.instances.create.field_user }}** введите имя пользователя `yc-user`. * {% include [access-ssh-key](../../_includes/compute/create/access-ssh-key.md) %} diff --git a/ru/_tutorials/applied/flask.md b/ru/_tutorials/applied/flask.md index 295ead5a249..eb7d7bddace 100644 --- a/ru/_tutorials/applied/flask.md +++ b/ru/_tutorials/applied/flask.md @@ -239,7 +239,7 @@ * В поле **{{ ui-key.yacloud.component.compute.network-select.field_external }}** выберите `{{ ui-key.yacloud.component.compute.network-select.switch_auto }}`. * В поле **{{ ui-key.yacloud.component.compute.network-select.field_security-groups }}** выберите созданную ранее группу безопасности `webserver-sg`. - 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** укажите данные для доступа к ВМ: + 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** выберите **{{ ui-key.yacloud.compute.instance.access-method.label_oslogin-control-ssh-option-title }}** и укажите данные для доступа к ВМ: * В поле **{{ ui-key.yacloud.compute.instances.create.field_user }}** укажите имя пользователя `yc-user`. * {% include [access-ssh-key](../../_includes/compute/create/access-ssh-key.md) %} diff --git a/ru/_tutorials/archive/backup-and-archive-to-sftp.md b/ru/_tutorials/archive/backup-and-archive-to-sftp.md index 1cc898eb7e7..241414a3163 100644 --- a/ru/_tutorials/archive/backup-and-archive-to-sftp.md +++ b/ru/_tutorials/archive/backup-and-archive-to-sftp.md @@ -66,7 +66,7 @@ * В поле **{{ ui-key.yacloud.component.compute.network-select.field_external }}** выберите `{{ ui-key.yacloud.component.compute.network-select.switch_auto }}`, чтобы назначить виртуальной машине случайный внешний IP-адрес из пула {{ yandex-cloud }}. Чтобы внешний IP-адрес не изменялся после остановки виртуальной машины, [сделайте его статическим](../../vpc/operations/set-static-ip.md). - 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** укажите данные для доступа к ВМ: + 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** выберите **{{ ui-key.yacloud.compute.instance.access-method.label_oslogin-control-ssh-option-title }}** и укажите данные для доступа к ВМ: * В поле **{{ ui-key.yacloud.compute.instances.create.field_user }}** введите имя пользователя, который будет создан на виртуальной машине, например `yc-user`. * {% include [access-ssh-key](../../_includes/compute/create/access-ssh-key.md) %} diff --git a/ru/_tutorials/archive/backup-with-bacula.md b/ru/_tutorials/archive/backup-with-bacula.md index b1a5c100f95..d4b436a47a4 100644 --- a/ru/_tutorials/archive/backup-with-bacula.md +++ b/ru/_tutorials/archive/backup-with-bacula.md @@ -97,7 +97,7 @@ Bacula состоит из нескольких компонентов: * В поле **{{ ui-key.yacloud.component.compute.network-select.field_external }}** выберите `{{ ui-key.yacloud.component.compute.network-select.switch_auto }}`, чтобы назначить виртуальной машине случайный внешний IP-адрес из пула {{ yandex-cloud }}, или выберите статический адрес из списка, если вы зарезервировали его заранее. - 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** укажите данные для доступа к ВМ: + 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** выберите **{{ ui-key.yacloud.compute.instance.access-method.label_oslogin-control-ssh-option-title }}** и укажите данные для доступа к ВМ: * В поле **{{ ui-key.yacloud.compute.instances.create.field_user }}** введите имя пользователя, который будет создан на виртуальной машине, например `yc-user`. diff --git a/ru/_tutorials/archive/hystax-backup.md b/ru/_tutorials/archive/hystax-backup.md index 5898f4c02c8..6307a37d320 100644 --- a/ru/_tutorials/archive/hystax-backup.md +++ b/ru/_tutorials/archive/hystax-backup.md @@ -149,7 +149,7 @@ Hystax Acura Backup будет выполнять действия от имен * Если доступен список **{{ ui-key.yacloud.component.compute.network-select.field_security-groups }}**, выберите [группу безопасности](../../vpc/concepts/security-groups.md#default-security-group), для которой ранее настраивали разрешения сетевого трафика. Если такого списка нет, для ВМ будет разрешен любой входящий и исходящий трафик. - 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** укажите данные для доступа к ВМ: + 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** выберите **{{ ui-key.yacloud.compute.instance.access-method.label_oslogin-control-ssh-option-title }}** и укажите данные для доступа к ВМ: * В поле **{{ ui-key.yacloud.compute.instances.create.field_user }}** введите имя пользователя, например, `yc-user`. * {% include [access-ssh-key](../../_includes/compute/create/access-ssh-key.md) %} diff --git a/ru/_tutorials/archive/hystax-disaster-recovery.md b/ru/_tutorials/archive/hystax-disaster-recovery.md index 6c752fde03f..ef8cb8ff4dc 100644 --- a/ru/_tutorials/archive/hystax-disaster-recovery.md +++ b/ru/_tutorials/archive/hystax-disaster-recovery.md @@ -119,7 +119,7 @@ * Если доступен список **{{ ui-key.yacloud.component.compute.network-select.field_security-groups }}**, выберите [группу безопасности](../../vpc/concepts/security-groups.md#default-security-group), для которой ранее настраивали разрешения сетевого трафика. Если такого списка нет, для ВМ будет разрешен любой входящий и исходящий трафик. - 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** укажите данные для доступа к ВМ: + 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** выберите **{{ ui-key.yacloud.compute.instance.access-method.label_oslogin-control-ssh-option-title }}** и укажите данные для доступа к ВМ: * В поле **{{ ui-key.yacloud.compute.instances.create.field_user }}** введите имя пользователя, например, `yc-user`. * {% include [access-ssh-key](../../_includes/compute/create/access-ssh-key.md) %} diff --git a/ru/_tutorials/archive/hystax-migration.md b/ru/_tutorials/archive/hystax-migration.md index e68af8fcfcd..a42984bad4d 100644 --- a/ru/_tutorials/archive/hystax-migration.md +++ b/ru/_tutorials/archive/hystax-migration.md @@ -105,7 +105,7 @@ * Если доступен список **{{ ui-key.yacloud.component.compute.network-select.field_security-groups }}**, выберите [группу безопасности](../../vpc/concepts/security-groups.md#default-security-group), для которой ранее настраивали разрешения сетевого трафика. Если такого списка нет, для ВМ будет разрешен любой входящий и исходящий трафик. - 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** укажите данные для доступа к ВМ: + 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** выберите **{{ ui-key.yacloud.compute.instance.access-method.label_oslogin-control-ssh-option-title }}** и укажите данные для доступа к ВМ: * В поле **{{ ui-key.yacloud.compute.instances.create.field_user }}** введите имя пользователя, например, `yc-user`. * {% include [access-ssh-key](../../_includes/compute/create/access-ssh-key.md) %} diff --git a/ru/_tutorials/archive/single-node-file-server-console.md b/ru/_tutorials/archive/single-node-file-server-console.md index 6a2c4ce18bd..dc3bcd0ca5b 100644 --- a/ru/_tutorials/archive/single-node-file-server-console.md +++ b/ru/_tutorials/archive/single-node-file-server-console.md @@ -102,7 +102,7 @@ * В поле **{{ ui-key.yacloud.component.compute.network-select.field_external }}** выберите `{{ ui-key.yacloud.component.compute.network-select.switch_auto }}`, чтобы назначить виртуальной машине случайный внешний IP-адрес из пула {{ yandex-cloud }}, или выберите статический адрес из списка, если вы зарезервировали его заранее. * В поле **{{ ui-key.yacloud.component.compute.network-select.field_security-groups }}** выберите созданную ранее группу безопасности `fileserver-sg`. - 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** укажите данные для доступа к ВМ: + 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** выберите **{{ ui-key.yacloud.compute.instance.access-method.label_oslogin-control-ssh-option-title }}** и укажите данные для доступа к ВМ: * В поле **{{ ui-key.yacloud.compute.instances.create.field_user }}** введите имя пользователя, который будет создан на виртуальной машине, например `ubuntu`. diff --git a/ru/_tutorials/datalens/data-from-ch-to-geolayers-visualization.md b/ru/_tutorials/datalens/data-from-ch-to-geolayers-visualization.md index be9c5ecaaa6..9b0f52ddcee 100644 --- a/ru/_tutorials/datalens/data-from-ch-to-geolayers-visualization.md +++ b/ru/_tutorials/datalens/data-from-ch-to-geolayers-visualization.md @@ -1,296 +1,403 @@ -# Анализ продаж и локаций пиццерий на данных из БД {{ CH }} и Marketplace +# Анализ продаж и локаций пиццерий на данных из БД {{ CH }} и {{ marketplace-short-name }} -В качестве источника будут использованы подключение базы данных {{ CH }} и продукт **Организации: спрос и предложение** из Marketplace. +{% include [datalens-folder-navigation-note](../../_includes/datalens/datalens-folder-navigation-note.md) %} -В этом сценарии вы подготовите дашборд по выбору помещений для открытия новых пиццерий Додо. +В этом руководстве вы подготовите дашборд по выбору помещений для открытия новых пиццерий Додо. С помощью {{ datalens-short-name }} вы проанализируете локации на основе реальных данных: -- Выручка по текущим пиццериям Додо. -- Поисковые запросы к пиццериям по локациям (данные Яндекса). -- Численность всех пиццерий по локациям (данные Яндекса). -Сценарий также доступен в [записи](https://www.youtube.com/watch?v=cw6PotbQYng) на YouTube-канале {{ yandex-cloud }}. +* Выручка по текущим пиццериям Додо. +* Поисковые запросы к пиццериям по локациям (данные Яндекса). +* Численность всех пиццерий по локациям (данные Яндекса). + +В качестве источника используется демонстрационная база данных {{ CH }} и продукт **Организации: спрос и предложение** из {{ marketplace-short-name }}. + +Руководство также доступно в [записи](https://www.youtube.com/watch?v=cw6PotbQYng) на YouTube-канале {{ yandex-cloud }}. Для визуализации и исследования данных [подготовьте {{ datalens-short-name }} к работе](#before-you-begin), затем выполните следующие шаги: -1. [Импортируйте геослои из Marketplace](#step1). -1. [Создайте подключение](#step2). -1. [Настройте поля датасета](#step3). -1. [Создайте чарт — столбчатая диаграмма](#step4). -1. [Создайте чарт — линейчатая диаграмма](#step5). -1. [Создайте чарт — индикатор](#step6). -1. [Создайте чарт — карта](#step7). -1. [Создайте дашборд](#step8). -1. [Добавьте геослои на дашборд](#step9). +1. [Создайте воркбук](#create-workbook). +1. [Импортируйте геослои из {{ marketplace-short-name }}](#import-from-marketplace). +1. [Изучите дашборд](#view-dashboard). +1. [Создайте подключение](#create-connection). +1. [Создайте датасет](#create-dataset). +1. [Проанализируйте динамику открытия пиццерий](#create-column-chart). +1. [Исследуйте выручку пиццерий](#create-bar-chart). +1. [Посчитайте сумму выручки и количество пиццерий](#create-indicator-chart). +1. [Исследуйте плотность заказов на карте](#create-map-chart). +1. [Создайте дашборд](#create-dashboard). +1. [Добавьте геослои на дашборд](#add-geolayers). ## Перед началом работы {#before-you-begin} {% include [before-you-begin](../_tutorials_includes/before-you-begin-datalens.md) %} -## Шаг 1. Импортируйте геослои из Marketplace {#step1} +## Создайте воркбук {#create-workbook} + +1. Перейдите на [главную страницу]({{ link-datalens-main }}) {{ datalens-short-name }}. +1. На панели слева выберите ![collections](../../_assets/console-icons/rectangles-4.svg) **Коллекции и воркбуки**. +1. В правом верхнем углу нажмите **Создать** → **Создать воркбук**. +1. Введите название [воркбука](../../datalens/workbooks-collections/index.md) — `Организации: спрос и предложение`. +1. Нажмите кнопку **Создать**. + +## Импортируйте геослои из {{ marketplace-short-name }} {#import-from-marketplace} -1. Перейдите в [Marketplace]({{ link-datalens-main }}/marketplace) {{ datalens-short-name }}. +1. Перейдите в [{{ marketplace-short-name }}]({{ link-datalens-main }}/marketplace) {{ datalens-short-name }}. 1. Выберите категорию **Геослои**, затем товар **Организации: спрос и предложение**. 1. Нажмите **Развернуть** в открывшейся карточке товара. -1. Сохраните покупку в папке **Purchases**. -1. Нажмите кнопку **Открыть**. -1. В открывшемся окне будет представлен набор объектов {{ datalens-short-name }}: [подключение](../../datalens/concepts/connection.md), [датасет](../../datalens/dataset/index.md), [чарт](../../datalens/concepts/chart/index.md) и [дашборд](../../datalens/concepts/dashboard.md). Нажмите желтую иконку дашборда в конце списка. - - ![organization-list](../../_assets/datalens/solution-09/00-organization-list.png) +1. Выберите воркбук `Организации: спрос и предложение`. +1. Нажмите кнопку **Развернуть**. + + ![workbook-choose](../../_assets/datalens/solution-09/01-workbook-choose.png) + +## Изучите дашборд {#view-dashboard} + +1. Откройте дашборд `Организации: спрос и предложение`. +1. Изучите дашборд: + + * В верхней части находятся фильтры по городу, рубрике и типу полигона. + * В таблицах можно посмотреть информацию о спросе и предложении: -1. Изучите дашборд и его описание в нижней части экрана: - * Спрос — число поисковых запросов пользователей геосервисов Яндекса к выбранной категории организаций или услуг. Категория (рубрика) определяется из запроса. Учитываются локальные запросы с мобильных устройств с радиусом поиска менее 3 км. - * Предложение — число существующих организаций выбранной категории. Используются данные организаций из [Яндекс Справочника](https://business.yandex.ru/sprav/). + * `Спрос` — число поисковых запросов пользователей геосервисов Яндекса к выбранной категории организаций или услуг. Категория (рубрика) определяется из запроса. Учитываются локальные запросы с мобильных устройств с радиусом поиска менее 3 км. + * `Предложение` — число существующих организаций выбранной категории. Используются данные организаций из [Яндекс Справочника](https://business.yandex.ru/sprav/). + * `Спрос на предложение` — показывает, насколько предложение покрывает спрос в полигоне относительно всего города. -1. Выберите рубрику **Пиццерия** и ознакомьтесь на карте с показателями **Спрос**, **Предложение** и **Спрос на предложение на город**. + * На карте отображается распределение спроса и предложения по городу. - ![organization-dash](../../_assets/datalens/solution-09/35-organization-dash.png) +1. Выберите рубрику `Пиццерия` и ознакомьтесь на карте с показателями `Спрос`, `Предложение` и `Спрос на предложение на город`. -## Шаг 2. Создайте подключение {#step2} + ![dashboard](../../_assets/datalens/solution-09/03-dashboard-90.png) -1. Перейдите в [{{ datalens-short-name }}]({{ link-datalens-main }}). -1. На панели слева выберите ![image](../../_assets/console-icons/thunderbolt.svg) **Подключения** и нажмите кнопку **Создать подключение**. -1. Выберите подключение **ClickHouse**. - 1. В открывшемся окне укажите параметры подключения: - * Подключение — тип **Указать вручную**. - * Имя хоста — `rc1a-g1gicp3imcc0pnsg.{{ dns-zone }},rc1b-vbbl6tob599tr3oi.{{ dns-zone }},rc1d-qf1ven1igeihhbep.{{ dns-zone }}` (указать через запятую). - * Порт HTTP-интерфейса — `8443` (по умолчанию). - * Имя пользователя — `datalens-marathon-2020-11-ro`. - * Пароль — `/4b+xBF6aSCgN9wKTevYGuDjxC9IO4Fa`. - 1. Проверьте подключение и нажмите кнопку **Создать подключение**. - 1. Укажите название подключения — `DODO Con` и нажмите кнопку **Создать**. +## Создайте подключение {#create-connection} - ![create-connection](../../_assets/datalens/solution-09/08-create-connection.png) +1. Перейдите в воркбук `Организации: спрос и предложение` — нажмите его название в пути до дашборда. + + ![chart-settings](../../_assets/datalens/solution-09/03-2-bread-crumbs.png) + +1. В правом верхнем углу нажмите **Создать** → ![image](../../_assets/console-icons/thunderbolt.svg) **Подключение**. +1. В разделе **Базы данных** выберите подключение **{{ CH }}**. + + 1. В открывшемся окне выберите тип подключения `Указать вручную` и укажите параметры подключения: + + * **Имя хоста** — `rc1a-g1gicp3imcc0pnsg.{{ dns-zone }},rc1b-vbbl6tob599tr3oi.{{ dns-zone }},rc1d-qf1ven1igeihhbep.{{ dns-zone }}` (указать через запятую). + * **Порт HTTP-интерфейса** — `8443` (по умолчанию). + * **Имя пользователя** — `datalens-marathon-2020-11-ro`. + * **Пароль** — `/4b+xBF6aSCgN9wKTevYGuDjxC9IO4Fa`. + + 1. Нажмите кнопку **Проверить подключение** и убедитесь, что появился зеленый значок. + 1. Нажмите кнопку **Создать подключение**. + 1. Введите название подключения — `DODO Con`. + 1. Нажмите кнопку **Создать**. + + ![create-connection](../../_assets/datalens/solution-09/04-create-connection.png) Дождитесь сохранения подключения. -## Шаг 3. Настройте поля датасета {#step3} +## Создайте датасет {#create-dataset} -1. В открывшемся окне нажмите кнопку **Создать датасет**. -1. В созданном датасете перенесите таблицу `marathon-2020-11.DODO_opendata` на рабочую область. +Создайте [датасет](../../datalens/dataset/index.md) на базе подключения `DODO Con`: - ![drag-table](../../_assets/datalens/solution-09/12-drag-table.png) +1. На странице подключения в правом верхнем углу нажмите кнопку **Создать датасет**. +1. Перенесите на рабочую область таблицу `marathon-2020-11.DODO_opendata`. -1. Откройте вкладку **Поля**. - 1. Переименуйте поле **Name** в **Pizzerias** в столбце **Имя**. - 1. Для поля **Coordinates** выберите тип `геоточка`. - 1. Для поля **Revenue** выберите в столбце **Агрегация** тип агрегации **Сумма**. - 1. Продублируйте поле **Pizzerias**. Нажмите кнопку ![add-field](../../_assets/console-icons/ellipsis.svg) и выберите вариант **Продублировать**. + ![drag-table](../../_assets/datalens/solution-09/05-drag-table.png) - ![dublicate-field](../../_assets/datalens/solution-09/13-dublicate-field.png) +1. Перейдите на вкладку **Поля**. +1. Переименуйте поле `Name` в `Pizzerias`. Чтобы изменить название поля, нажмите на его имя, удалите текущее имя и введите новое. +1. Для поля `Coordinates` в столбце **Тип** выберите **Геоточка**. +1. Для поля `Revenue` укажите тип агрегации **Сумма**. Поля с определенными функциями агрегации становятся показателями и меняют свой цвет на синий. - 1. Переименуйте созданное поле **Pizzerias**→**The number of pizzerias**. - 1. Для поля **The number of pizzerias** выберите в столбце **Агрегация** тип агрегации **Количество уникальных**. - 1. Нажмите кнопку **Добавить поле**. + ![image](../../_assets/datalens/solution-09/06-field-changes.png) - ![add-field](../../_assets/datalens/solution-09/01-add-field.png) +1. Создайте показатель с количеством пиццерий: - 1. Создайте расчетное поле с рангом по выручке: - * Формула — `RANK([Revenue])`. - * Название поля — Rank по выручке. + 1. Продублируйте поле `Pizzerias` — в правой части строки с полем нажмите ![image](../../_assets/console-icons/ellipsis.svg) и выберите **Дублировать**. + 1. Переименуйте дубликат поля `Pizzerias (1)` в `The number of pizzerias`. + 1. Измените тип агрегации на **Количество уникальных**. - Это поле будет использоваться при построении чартов для фильтрации ТОП-N. + ![dublicate-field](../../_assets/datalens/solution-09/07-dublicate-field.png) - 1. Нажмите кнопку **Создать**. +1. Создайте вычисляемое поле для ранжирования пиццерий по выручке: - ![rank-field](../../_assets/datalens/solution-09/27-rank-field.png) + 1. В правом верхнем углу нажмите кнопку **Добавить поле**. + 1. Слева вверху укажите название поля — `Rank по выручке`. + 1. В поле для формулы введите: `RANK([Revenue])`. + 1. Нажмите кнопку **Создать**. - 1. В правом верхнем углу нажмите кнопку **Сохранить**. В открывшемся окне укажите название датасета **DODO** и нажмите **Создать**. + ![add-field](../../_assets/datalens/solution-09/08-add-rank-field.png) -## Шаг 4. Создайте чарт — столбчатая диаграмма {#step4} +1. Сохраните датасет: -1. Нажмите кнопку **Создать чарт** на рабочей панели датасета **DODO**. + 1. В правом верхнем углу нажмите кнопку **Сохранить**. + 1. Введите название датасета — `DODO` и нажмите кнопку **Создать**. - ![create-chart](../../_assets/datalens/solution-09/07-create-chart.png) +## Проанализируйте динамику открытия пиццерий {#create-column-chart} -1. В открывшемся окне выберите измерение **OpenDate** в секции **X** и показатель **The number of pizzerias** в секции **Y**. +Для визуализации динамики открытия пиццерий по месяцам создайте [столбчатую диаграмму](../../datalens/visualization-ref/column-chart.md): - ![add-measure-selector](../../_assets/datalens/solution-09/02-add-measure-selector.png) - - График покажет статистику — сколько открылось новых пиццерий по дням. -1. Настройте группировку **Даты открытия** по месяцам. - 1. Нажмите кнопку календаря в поле **OpenDate**. - 1. В списке **Группировка** выберите **Округление** → **Месяц**. - 1. Нажмите **Применить**. +1. На странице датасета в правом верхнем углу нажмите кнопку **Создать чарт**. +1. Добавьте в чарт дату открытия. Для этого из раздела **Измерения** перетащите поле `OpenDate` в секцию **X**. +1. Добавьте в чарт показатель — число пиццерий. Для этого из раздела **Показатели** перетащите поле `The number of pizzerias` в секцию **Y**. - ![round-month](../../_assets/datalens/solution-09/28-round-month.png) + ![add-measure-selector](../../_assets/datalens/solution-09/09-create-column-chart.png) -1. Нажмите кнопку **Cохранить** в правом верхнем углу. Назовите чарт **Динамика открытий** и нажмите **Сохранить**. + Диаграмма покажет, сколько открылось новых пиццерий по дням. -## Шаг 5. Создайте чарт — линейчатая диаграмма {#step5} +1. Отобразите чарт по месяцам: -1. Выберите другой тип чарта — **Линейчатая диаграмма**. + 1. Нажмите на иконку с календарем у поля `OpenDate` в секции **X**. + 1. В поле **Группировка** выберите **Округление** ⟶ **Месяц**, затем нажмите **Применить**. - ![bar-chart](../../_assets/datalens/solution-09/03-bar-chart.png) + ![image](../../_assets/datalens/solution-09/10-date-to-month.png) -1. Добавьте измерение **Pizzerias** в секцию **Y**. Удалите из секции **Y** измерение **OpenDate**. -1. Добавьте показатель **Revenue** в секцию **X**. Удалите из секции **X** показатель **The number of pizzerias**. -1. Добавьте показатель **Revenue** в секцию **Сортировка**. +1. Сохраните чарт: - ![sort-rank](../../_assets/datalens/solution-09/33-sort-rank.png) + 1. В правом верхнем углу нажмите кнопку **Сохранить**. + 1. В открывшемся окне введите название чарта `Динамика открытий` и нажмите кнопку **Сохранить**. + + ![image](../../_assets/datalens/solution-09/11-save-column-chart.png) + +## Исследуйте выручку пиццерий {#create-bar-chart} + +Чтобы отобразить рейтинг топ-10 пиццерий по выручке, создайте [линейчатую диаграмму](../../datalens/visualization-ref/bar-chart.md): + +1. Создайте копию чарта, созданного на предыдущем шаге: + + 1. В правом верхнем углу нажмите значок ![image](../../_assets/console-icons/chevron-down.svg) → **Сохранить как копию**. + + ![save-chart-as-copy](../../_assets/datalens/solution-09/12-save-chart-as-copy.png) + + 1. В открывшемся окне введите название нового чарта `Топ-10 пиццерий` и нажмите кнопку **Сохранить**. + +1. Выберите тип визуализации **Линейчатая диаграмма**. + + ![image](../../_assets/datalens/solution-09/13-choose-bar-chart.png) + +1. Замените месяцы на названия пиццерий на оси Y. Для этого из раздела **Измерения** перетащите поле `Pizzerias` в секцию **Y** и наведите его над полем `OpenDate`, пока то не станет красным. +1. Замените количество пиццерий на сумму выручки на оси X. Для этого из раздела **Показатели** перетащите поле `Revenue` в секцию **X** и наведите его над полем `The number of pizzerias`, пока то не станет красным. +1. Отсортируйте диаграмму по убыванию выручки. Для этого из раздела **Показатели** перетащите поле `Revenue` в секцию **Сортировка**. На диаграмме отобразилась сумма выручки по пиццериям. +1. Добавьте фильтрацию для топ-10 пиццерий по выручке: + + 1. Из раздела **Показатели** перетащите поле `Rank по выручке` в секцию **Фильтры**. + 1. Из списка **Операция** выберите `Меньше или равно`. + 1. В поле **Значение** укажите число `10`. + + ![image](../../_assets/datalens/solution-09/14-add-chart-filter.png) -1. Добавьте показатель **Rank по выручке** в секцию **Фильтры**: - 1. Выберите **Меньше или равно** из списка **Операция**. - 1. Укажите число **10** в поле **Значение**. 1. Нажмите кнопку **Применить фильтр**. -1. На графике отобразится рейтинг **Топ-10 пиццерий по России**. -1. В правом верхнем углу нажмите значок ![save-button](../../_assets/console-icons/chevron-down.svg) → **Сохранить как**. Назовите чарт **Топ-10 пиццерий** и нажмите **Сохранить**. - ![bar-chart-1](../../_assets/datalens/solution-09/04-bar-chart-1.png) + На диаграмме отобразится рейтинг топ-10 пиццерий по России. + + ![image](../../_assets/datalens/solution-09/15-bar-chart-section.png) + +1. В правом верхнем углу нажмите кнопку **Сохранить**. + +## Посчитайте сумму выручки и количество пиццерий {#create-indicator-chart} -## Шаг 6. Создайте чарт — индикатор {#step6} +Чтобы отобразить сумму выручки, создайте [индикатор](../../datalens/visualization-ref/indicator-chart.md): -1. Выберите тип чарта **Индикатор**. +1. Создайте копию чарта, созданного на предыдущем шаге: - ![indicator](../../_assets/datalens/solution-09/15-indicator.png) + 1. В правом верхнем углу нажмите значок ![image](../../_assets/console-icons/chevron-down.svg) → **Сохранить как копию**. + 1. В открывшемся окне введите название нового чарта `Выручка` и нажмите кнопку **Сохранить**. -1. Удалите показатель **RANK по выручке** из поля **Фильтры**. -1. Добавьте показатель **Revenue** в секцию **Показатель**. +1. Выберите тип визуализации **Индикатор**. - ![delete-filters](../../_assets/datalens/solution-09/11-delete-filters.png) + ![choose-indicator](../../_assets/datalens/solution-09/16-choose-indicator.png) -1. В правом верхнем углу нажмите значок ![save-button](../../_assets/console-icons/chevron-down.svg) → **Сохранить как**. Назовите чарт **Выручка** и нажмите **Сохранить**. -1. Удалите показатель **sum(Revenue)** из секции **Показатель**. -1. Добавьте показатель **The number of pizzerias** в секцию **Показатель**. +1. Уберите фильтрацию топ-10 пиццерий по выручке — в секции **Фильтры** напротив поля `Rank по выручке` нажмите значок ![image](../../_assets/console-icons/xmark.svg) (значок появляется при наведении указателя на поле). +1. Из раздела **Показатели** перетащите поле `Revenue` в секцию **Показатель**. +1. Уберите отображение заголовка в настройках чарта: - ![indicator-metric](../../_assets/datalens/solution-09/16-indicator-metric.png) + 1. Справа от типа визуализации нажмите значок ![image](../../_assets/console-icons/gear.svg). + 1. Выберите для заголовка значение **Скрыть**. + 1. Нажмите кнопку **Применить**. -1. В правом верхнем углу нажмите значок ![save-button](../../_assets/console-icons/chevron-down.svg) → **Сохранить как**. Назовите чарт **Количество пиццерий** и нажмите **Сохранить**. + ![title-option-off](../../_assets/datalens/solution-09/16-2-title-hide.png) -## Шаг 7. Создайте чарт — карта {#step7} +1. В правом верхнем углу нажмите кнопку **Сохранить**. -1. Выберите тип чарта **Карта**. + ![indicator](../../_assets/datalens/solution-09/17-save-indicator.png) - ![map-chart](../../_assets/datalens/solution-09/18-map-chart.png) +Чтобы отобразить количество пиццерий, создайте еще один индикатор: -1. Добавьте измерение **Coordinates** в секцию **Геоточки**. -1. Добавьте показатель **Revenue** в секции **Размер** и **Цвета**. +1. Создайте копию чарта, созданного на предыдущем шаге: - ![map-measure](../../_assets/datalens/solution-09/21-map-measure.png) + 1. В правом верхнем углу нажмите значок ![image](../../_assets/console-icons/chevron-down.svg) → **Сохранить как копию**. + 1. В открывшемся окне введите название нового чарта `Количество пиццерий` и нажмите кнопку **Сохранить**. -1. Добавьте в секцию **Тултипы**: - * Pizzerias; - * Address; - * OpenDate; - * Revenue. -1. Перейдите к настройкам секции **Цвета**. +1. Замените выручку на количество пиццерий. Для этого из раздела **Показатели** перетащите поле `The number of pizzerias` в секцию **Показатель** и наведите его над полем `Revenue`, пока то не станет красным. +1. В правом верхнем углу нажмите кнопку **Сохранить**. - ![map-colour](../../_assets/datalens/solution-09/19-map-colour.png) + ![indicator-metric](../../_assets/datalens/solution-09/18-indicator-metric.png) - 1. Выберите тип градиента **Двухцветный** и цвет **Желтый (оттенки)**. - 1. Нажмите кнопку **Применить**. -1. Сохраните чарт с названием **Пиццерии на карте**. +## Исследуйте плотность заказов на карте {#create-map-chart} - ![pizzerias-on-the-map](../../_assets/datalens/solution-09/25-pizzerias-on-the-map.png) +Для визуализации плотности заказов на карте России создайте [карту](../../datalens/visualization-ref/point-map-chart.md). -## Шаг 8. Создайте дашборд {#step8} +1. Создайте копию чарта, созданного на предыдущем шаге: -1. Перейдите в [{{ datalens-short-name }}]({{ link-datalens-main }}). -1. Нажмите кнопку **Создать дашборд**. -1. В открывшемся окне в правом верхнем углу нажмите кнопку **Добавить** и выберите **Чарт**. -1. Выберите чарт с названием **Количество пиццерий**. + 1. В правом верхнем углу нажмите значок ![image](../../_assets/console-icons/chevron-down.svg) → **Сохранить как копию**. + 1. В открывшемся окне введите название нового чарта `Пиццерии на карте` и нажмите кнопку **Сохранить**. + +1. Выберите тип визуализации **Карта**. + + ![image](../../_assets/datalens/solution-09/19-choose-map.png) + +1. Добавьте на карту координаты пиццерий. Для этого из раздела **Измерения** перетащите поле `Coordinates` в секцию **Точки (Геоточки)**. +1. Измените размер точек относительно показателя выручки. Для этого из раздела **Показатели** перетащите поле `Revenue` в секцию **Размер**. +1. Измените цвет точек относительно показателя выручки. Для этого из раздела **Показатели** перетащите поле `Revenue` в секцию **Цвета**. +1. Добавьте в секцию **Тултипы** поля: + + * `Pizzerias`; + * `Address`; + * `OpenDate`; + * `Revenue`. + + ![map-measure](../../_assets/datalens/solution-09/20-map-sections-90.png) + +1. Измените настройки секции **Цвета**: + + 1. В секции **Цвета** нажмите значок ![image](../../_assets/console-icons/gear.svg) (значок появляется при наведении указателя на секцию). + 1. Выберите тип градиента **Двухцветный** и цвет **Желтый (оттенки)**. + 1. Нажмите кнопку **Применить**. + + ![map-colour](../../_assets/datalens/solution-09/21-map-colour-90.png) + +1. В правом верхнем углу нажмите кнопку **Сохранить**. + + ![pizzerias-on-the-map](../../_assets/datalens/solution-09/22-pizzerias-on-the-map-90.png) + +## Создайте дашборд {#create-dashboard} + +1. Перейдите в воркбук `Организации: спрос и предложение` — нажмите его название в пути до дашборда. +1. В правом верхнем углу нажмите **Создать** → ![image](../../_assets/console-icons/layout-cells-large.svg) **Дашборд**. +1. На панели в нижней части страницы выберите виджет **Чарт**. + + ![add-chart](../../_assets/datalens/solution-09/23-add-chart.png) + +1. В открывшемся окне нажмите кнопку **Выбрать**. +1. Выберите чарт `Динамика открытий`. После этого автоматически заполнится поле **Название**. 1. Нажмите кнопку **Добавить**. - ![chart-tab](../../_assets/datalens/solution-09/05-chart-tab.png) + ![add-chart-window](../../_assets/datalens/solution-09/24-add-chart-window.png) + +1. Повторите шаги 3-6, чтобы добавить чарты: + + * `Топ-10 пиццерий`; + * `Выручка`; + * `Количество пиццерий`; + * `Пиццерии на карте`. -1. Повторите шаги 4-6 для остальных чартов. -1. Для чартов-индикаторов (**Количество пиццерий** и **Выручка**) уберите отображение названия. Для этого отключите опцию **Показывать** в окне **Настройка таба**. +1. Установите размеры чартов с помощью мыши и расположите их на дашборде в удобном для вас порядке. - ![off-option](../../_assets/datalens/solution-09/22-off-option.png) + ![image](../../_assets/datalens/solution-09/26-dashboard1.png) -1. Чтобы чарты не формировались в одну колонку, перетащите каждый чарт в любую свободную область на дашборде. -1. В верхнем правом углу нажмите **Добавить** → **Селектор**. - 1. В открывшемся окне выберите датасет **DODO**. - 1. В настройках селектора: - 1. Активируйте опцию **Показывать** для отображения названия. - 1. Выберите поле **City**. - 1. Нажмите кнопку **Добавить**. +Добавьте [селектор](../../datalens/dashboard/selector.md), чтобы фильтровать чарты по городу: - ![selector-settings](../../_assets/datalens/solution-09/31-selector-settings.png) +1. На панели в нижней части страницы выберите виджет **Селектор**. -1. Перенесите селектор наверх, при необходимости скорректируйте размеры чартов. + ![image](../../_assets/datalens/solution-09/27-add-selector.png) + +1. Добавьте селектор с календарем по датам заказа: + + 1. Выберите датасет `DODO`. + 1. Выберите поле `City`. + 1. Укажите заголовок: `Город`. + 1. Нажмите кнопку **Сохранить**. + + ![image](../../_assets/datalens/solution-09/28-selector1.png) + +1. Перетащите селектор вверх дашборда. 1. Сохраните дашборд: - 1. В правом верхнем углу нажмите кнопку **Сохранить**. - 1. Введите название дашборда **DODO Dashboard** и нажмите кнопку **Создать**. + 1. В правом верхнем углу дашборда нажмите кнопку **Сохранить**. + 1. Введите название дашборда `DODO Dashboard` и нажмите кнопку **Создать**. + +Дашборд готов. + +![image](../../_assets/datalens/solution-09/29-saved-dashboard.png) + +Выберите в селекторе город `Москва`. Если фокус карты остался на прежней локации, обновите страницу браузера. {{ datalens-name }} фиксирует масштаб и местоположение карты, если вы изменяли их в рамках текущей сессии. -1. Выберите в селекторе город Москва. Если при изменении города в фильтре фокус карты остался на прежней локации, обновите страницу веб-браузера. {{ datalens-name }} фиксирует масштаб и местоположение карты, если вы изменяли их в рамках текущей сессии. +![dashboard-pizza](../../_assets/datalens/solution-09/30-dashboard-pizza-moscow.png) - ![dashboard-pizza](../../_assets/datalens/solution-09/09-dashboard-pizza-moscow.png) +## Добавьте геослои на дашборд {#add-geolayers} -## Шаг 9. Добавьте геослои на дашборд {#step9} +1. Убедитесь, что на дашборде в фильтре города выбрана только Москва. В правом верхнем углу карты нажмите значок ![image](../../_assets/console-icons/ellipsis.svg) → ![image](../../_assets/console-icons/pencil.svg) **Редактировать**. -1. Убедитесь, что на дашборде в фильтре города у вас выбрана только Москва. -1. Нажмите кнопку меню в правом верхнем углу карты. -1. Выберите **Редактировать**. + ![map-editor](../../_assets/datalens/solution-09/31-map-edit.png) - ![map-editor](../../_assets/datalens/solution-09/20-map-editor.png) +1. Нажмите на название датасета **DODO**. +1. Нажмите кнопку ![image](../../_assets/console-icons/plus.svg) **Добавить датасет**. +1. Выберите датасет `Организации`, [импортированный из {{ marketplace-short-name }}](#import-from-marketplace). + + ![organizations](../../_assets/datalens/solution-09/32-add-dataset.png) -1. Нажмите на название датасета **DODO** и выберите **Добавить датасет**. -1. В выпадающем списке вместо **Личной папки** выберите **Датасеты**. -1. Выберите **Организации** (датасет, импортированный из Marketplace на [шаге 1](#step-1)). - - ![organizations](../../_assets/datalens/solution-09/23-organizations.png) - 1. После выбора датасета появится окно настройки связей. По умолчанию связь устанавливается по полям с одинаковыми названиями. - - 1. Нажмите кнопку **Добавить связь**. - 1. Установите связь между полями датасетов **City** (DODO) и **Город** (Организации) и нажмите **Сохранить**. + + 1. Нажмите кнопку **Добавить связь**. + 1. Установите связь между полями датасетов `City` (DODO) и `Город` (Организации) и нажмите **Сохранить**. - ![links](../../_assets/datalens/solution-09/17-links.png) + ![links](../../_assets/datalens/solution-09/33-add-links.png) 1. Закройте окно **Cвязи**, нажав кнопку **Сохранить**. -1. В секции слой переименуйте **Слой 1**. - 1. Для этого нажмите на слой и выберите ![links](../../_assets/console-icons/ellipsis.svg). - - ![select-layer](../../_assets/datalens/solution-09/30-select-layer.png) - - 1. В открывшемся окне **Настройки слоя** укажите название **ДОДО** и нажмите кнопку **Применить**. -1. Нажмите кнопку ![plus](../../_assets/console-icons/square-plus.svg), чтобы добавить еще один слой. Переименуйте его в **Спрос на предложение**. -1. Измените тип геослоя **Точки** на **Полигоны**. - ![geopolygon](../../_assets/datalens/solution-09/14-geopolygon.png) +1. Переименуйте слой **Слой 1**: + + 1. Нажмите на слой и справа от названия нажмите значок ![image](../../_assets/console-icons/ellipsis.svg) (значок появляется при наведении указателя на слой). + + ![select-layer](../../_assets/datalens/solution-09/34-select-layer.png) + + 1. В открывшемся окне **Настройки слоя** укажите название `ДОДО` и нажмите кнопку **Применить**. + +1. Добавьте еще один слой: + + 1. Нажмите кнопку ![image](../../_assets/console-icons/square-plus.svg) справа от слоя. + 1. Переименуйте слой в `Спрос на предложение`. + 1. Измените тип геослоя **Точки (Геоточки)** на **Полигоны (Геополигоны)**. -1. Убедитесь, что текущий датасет – **Организации**, а не **DODO**. Если текущий датасет **DODO**, то нажмите в левом верхнем углу на название датасета и выберите **Организации**. + ![geopolygon](../../_assets/datalens/solution-09/35-geopolygon.png) - ![organizations-dataset](../../_assets/datalens/solution-09/24-organizations-dataset.png) +1. Убедитесь, что текущий датасет – `Организации`, а не `DODO`. Если текущий датасет `DODO`, то нажмите в левом верхнем углу на название датасета и выберите `Организации`. -1. Добавьте измерение **Полигон** в секцию **Полигоны**. -1. Добавьте измерение **Полигон.Тип** в секцию **Фильтры** и укажите значение **hash7**. Нажмите кнопку **Применить фильтр**. -1. Добавьте измерение **Рубрика** в секцию **Фильтры слоя** и выберите значение **Пиццерия**. Нажмите кнопку **Применить фильтр**. -1. Добавьте показатель **Спрос на предложение на город** в секцию **Цвета**. -1. В настройках цвета выберите трехцветный градиент **Синий-Серый-Красный** и нажмите **Применить**. + ![organizations-dataset](../../_assets/datalens/solution-09/36-organizations-dataset.png) - ![colour-settings](../../_assets/datalens/solution-09/06-colour-settings.png) +1. Перетащите измерение `Полигон` в секцию **Полигоны**. +1. Добавьте измерение `Полигон.Тип` в секцию **Фильтры** и выберите значение `hash7`. Нажмите кнопку **Применить фильтр**. +1. Добавьте измерение `Рубрика` в секцию **Фильтры слоя** и выберите значение `Пиццерия`. Нажмите кнопку **Применить фильтр**. +1. Добавьте показатель `Спрос на предложение на город` в секцию **Цвета**. +1. В настройках цвета выберите трехцветный градиент `Синий-Серый-Красный` и нажмите **Применить**. -1. Измените уровень прозрачности до 60. + ![colour-settings](../../_assets/datalens/solution-09/37-colour-settings.png) - ![transparency](../../_assets/datalens/solution-09/36-transparency.png) +1. Измените уровень прозрачности до `60`. -1. Добавьте в секцию **Тултипы**: + ![transparency](../../_assets/datalens/solution-09/38-transparency.png) - * Спрос; - * Предложение; - * Спрос на предложение на город; - * Топ запросов; - * Топ компаний. +1. Добавьте в секцию **Тултипы** поля: -1. Нажмите **Сохранить** в верхнем правом углу. + * `Спрос`; + * `Предложение`; + * `Спрос на предложение на город`; + * `Топ запросов`; + * `Топ компаний`. - ![34-map-geolayers](../../_assets/datalens/solution-09/34-map-geolayers.png) + ![map-geolayers](../../_assets/datalens/solution-09/39-map-geolayers.png) -1. Вернитесь наш дашборд (должен быть открыт на предыдущей вкладке браузера) и обновите страницу браузера. -1. Выберите в секторе Санкт-Петербург. После этого дашборд, включая карту и внешний геослой, будет отфильтрован полностью по этому селектору. +1. Сохраните чарт — в правом верхнем углу нажмите кнопку **Сохранить**. +1. Вернитесь на дашборд, открытый на предыдущей вкладке браузера, и обновите страницу. +1. Выберите в селекторе `Санкт-Петербург`. После этого дашборд, включая карту и внешний геослой, отфильтруется полностью по этому селектору. - ![dashboard-spb](../../_assets/datalens/solution-09/10-dashboard-spb.png) + ![dashboard-spb](../../_assets/datalens/solution-09/40-dashboard-spb.png) -Если при изменении города в фильтре фокус карты остался на прежней локации, обновите страницу веб-браузера. {{ datalens-name }} фиксирует масштаб и местоположение карты, если вы изменяли их в рамках текущей сессии. +Если при изменении города в фильтре фокус карты остался на прежней локации, обновите страницу браузера. {{ datalens-name }} фиксирует масштаб и местоположение карты, если вы изменяли их в рамках текущей сессии. ## Дополнительно {#additional} В качестве идей для дальнейшей самостоятельной работы предлагаем: -1. Добавить геослой с организациями категории **Где поесть** (в целом рестораны и фастфуд, не только пиццерии). -1. Добавить из Marketplace продукт [Аудитория: интересы и соцдем]({{ link-datalens-main }}/marketplace/f2eemc2dui59rn72h0ck), чтобы аналогично отобразить на карте данные по аудитории города. +1. Добавить геослой с организациями категории `Где поесть` (в целом рестораны и фастфуд, не только пиццерии). +1. Добавить из {{ marketplace-short-name }} продукт [Аудитория: интересы и соцдем]({{ link-datalens-main }}/marketplace/f2eemc2dui59rn72h0ck), чтобы аналогично отобразить на карте данные по аудитории города. 1. На примере Воронежа можно изучить бесплатные [геослои от компании Геоинтеллект]({{ link-datalens-main }}/marketplace/f2eu3edujf1jdmaihu7u). Демонабор содержит посчитанные индексы бизнес-потенциала локации для фастфуда. diff --git a/ru/_tutorials/datalens/data-from-metrica-visualization.md b/ru/_tutorials/datalens/data-from-metrica-visualization.md index c85d9d89f00..80af742c072 100644 --- a/ru/_tutorials/datalens/data-from-metrica-visualization.md +++ b/ru/_tutorials/datalens/data-from-metrica-visualization.md @@ -5,17 +5,22 @@ {% include [datalens-metrica-pro-note](../../_includes/datalens/datalens-metrica-pro-note.md) %} -В качестве источника данных будет использован один из счетчиков Яндекс Метрики, к которому у вас есть доступ. Просмотреть список доступных вам счетчиков можно по ссылке [https://metrika.yandex.ru/list](https://metrika.yandex.ru/list). +В этом руководстве демонстрируется работа {{ datalens-full-name }} с сервисом {{ metrika }} в режиме прямого доступа. + +В качестве источника данных используйте один из счетчиков Яндекс Метрики, к которому у вас есть доступ. Посмотреть список доступных счетчиков можно по [ссылке](https://metrika.yandex.ru/list). ![image](../../_assets/datalens/solution-03/01-metrica-list.png) -Если в вашем списке не оказалось доступных счетчиков, то получите доступ к счетчику или используйте демонстрационный дашборд Яндекс Метрики. Он создается автоматически при создании экземпляра {{ datalens-short-name }}. +Если в вашем списке не оказалось доступных счетчиков, используйте [демонстрационный дашборд]({{ link-datalens-main }}/marketplace/f2e5hpq5mc7bscsjc6jr) Яндекс Метрики. + +{% include [datalens-folder-navigation-note](../../_includes/datalens/datalens-folder-navigation-note.md) %} Для визуализации и исследования данных [подготовьте {{ datalens-short-name }} к работе](#before-you-begin), затем выполните следующие шаги: -1. [Создайте подключение и стандартный дашборд](#step1). -1. [Измените стандартный дашборд](#step2). -1. [Измените чарт](#step3). +1. [Создайте воркбук](#create-workbook). +1. [Создайте подключение и стандартный дашборд](#create-connection). +1. [Измените стандартный дашборд](#edit-dashboard). +1. [Измените чарт](#edit-chart). ## Перед началом работы {#before-you-begin} @@ -23,82 +28,72 @@ {% include [before-you-begin](../_tutorials_includes/before-you-begin-datalens.md) %} -## Шаг 1. Создайте подключение и стандартный дашборд {#step1} +## Создайте воркбук {#create-workbook} -{% note warning %} +1. Перейдите на [главную страницу]({{ link-datalens-main }}) {{ datalens-short-name }}. +1. На панели слева выберите ![collections](../../_assets/console-icons/rectangles-4.svg) **Коллекции и воркбуки**. +1. В правом верхнем углу нажмите **Создать** → **Создать воркбук**. +1. Введите название [воркбука](../../datalens/workbooks-collections/index.md) — `Metrica Live Demo`. +1. Нажмите кнопку **Создать**. -Данный шаг доступен для пользователей, у которых есть права на какой-либо счетчик Яндекс Метрики. Если у вас нет прав на счетчик, разверните [дашборд из {{ datalens-short-name }} {{ marketplace-short-name }}]({{ link-datalens-main }}/marketplace/f2e5hpq5mc7bscsjc6jr) и перейдите к шагу 2. +## Создайте подключение и стандартный дашборд {#create-connection} -{% endnote %} +{% note warning %} -1. Перейдите на [главную страницу]({{ link-datalens-main }}) {{ datalens-short-name }}. -1. На панели слева выберите ![image](../../_assets/console-icons/thunderbolt.svg) **Подключения** и нажмите кнопку **Создать подключение**. -1. Выберите **Metrica**. +На этом шаге описываются действия для пользователей, у которых есть права на какой-либо счетчик Яндекс Метрики. Если у вас нет прав на счетчик, разверните [дашборд из {{ datalens-short-name }} {{ marketplace-short-name }}]({{ link-datalens-main }}/marketplace/f2e5hpq5mc7bscsjc6jr) и перейдите к шагу [Измените стандартный дашборд](#edit-dashboard). - ![image](../../_assets/datalens/solution-03/03-choose-metrica.png) +{% endnote %} +1. В правом верхнем углу воркбука нажмите **Создать** → ![image](../../_assets/console-icons/thunderbolt.svg) **Подключение**. +1. В разделе **Файлы и сервисы** выберите подключение **{{ metrika }}**. 1. Нажмите кнопку **Получить токен**. - ![image](../../_assets/datalens/solution-03/04-metrica-creation1.png) - Если вы первый раз создаете подключение к счетчику Яндекс Метрики, то предоставьте сервису необходимые разрешения. 1. Выберите необходимый счетчик из выпадающего списка. - - ![image](../../_assets/datalens/solution-03/05-metrica-creation2.png) - 1. Выберите уровень [точности](https://yandex.ru/dev/metrika/doc/api2/api_v1/sampling-docpage/) из выпадающего списка. - - ![image](../../_assets/datalens/solution-03/06-01-metrica-creation-accuracy.png) - 1. Включите опцию **Автоматически создать дашборд, чарты и датасет над подключением**. 1. Нажмите кнопку **Создать подключение**. - ![image](../../_assets/datalens/solution-03/06-metrica-creation3.png) + ![image](../../_assets/datalens/solution-03/03-create-metrica-coonection.png) - После создания подключения откроется папка с набором датасетов, чартов и дашбордом. + 1. Введите название подключения — `Demo Connection to Metrica Live`. + 1. Нажмите кнопку **Создать**. - {% include [datalens-metrica-note](../../_includes/datalens/datalens-metrica-note.md) %} + После создания подключения откроется воркбук или папка с набором датасетов, чартов и дашбордом. -1. Перейдите на **Дашборд по данным Метрики**. + ![image](../../_assets/datalens/solution-03/04-metrica-objects-list.png) - ![image](../../_assets/datalens/solution-03/07-open-dashboard.png) + {% include [datalens-metrica-note](../../_includes/datalens/datalens-metrica-note.md) %} -## Шаг 2. Измените стандартный дашборд {#step2} +## Измените стандартный дашборд {#edit-dashboard} {% note warning %} -Если у вас нет счетчика Яндекс Метрики и вы пропустили шаг 1, разверните [дашборд из {{ datalens-short-name }} {{ marketplace-short-name }}]({{ link-datalens-main }}/marketplace/f2e5hpq5mc7bscsjc6jr). +Если вы пропустили шаг [Создайте подключение и стандартный дашборд](#create-connection), разверните [дашборд из {{ datalens-short-name }} {{ marketplace-short-name }}]({{ link-datalens-main }}/marketplace/f2e5hpq5mc7bscsjc6jr). {% endnote %} -Вы можете изменять стандартный [дашборд](../../datalens/concepts/dashboard.md) так, как вам удобно. Например, вы можете удалить ненужный график. +Стандартный [дашборд](../../datalens/concepts/dashboard.md) можно настроить под себя: например, удалить, переместить или редактировать чарты. +1. Откройте `Metrica Live Demo Dashboard`. 1. В правом верхнем углу дашборда нажмите кнопку **Редактировать**. - - ![image](../../_assets/datalens/solution-03/09-edit-dashboard.png) - -1. Удалите чарт **Глубина просмотров**. Для этого в правом верхнем углу графика нажмите значок ![image](../../_assets/console-icons/ellipsis.svg) и выберите **Удалить**. +1. Удалите чарт `Глубина просмотров`. Для этого в правом верхнем углу чарта нажмите значок ![image](../../_assets/console-icons/ellipsis.svg) и выберите **Удалить**. ![image](../../_assets/datalens/solution-03/10-delete-charts1.png) -1. Разместите чарты **Отказы** и **Время на сайте** таким образом, чтобы они заполнили пустое пространство после удаления чарта на предыдущем шаге. Перетащите чарт, нажав на сам чарт. Измените размер чарта, потянув за треугольник в нижнем правом углу чарта. +1. Разместите чарты `Отказы` и `Время на сайте` так, чтобы они заполнили пустое пространство после удаления чарта на предыдущем шаге: ![image](../../_assets/datalens/solution-03/11-replace-charts.png) -1. Удалите чарты **Доля визитов по браузерам** и **Визиты, просмотры и посетители по браузерам**. +1. Удалите чарты `Доля визитов по браузерам` и `Визиты, просмотры и посетители по браузерам`. +1. В правом верхнем углу дашборда нажмите кнопку **Сохранить**. - ![image](../../_assets/datalens/solution-03/12-delete-charts2.png) +## Измените чарт {#edit-chart} -1. В правом верхнем углу нажмите кнопку **Сохранить**. +Вы можете отредактировать любой чарт на дашборде. Например, поменяйте тип визуализации для диаграммы `Визиты по типам устройств и ОС` из раздела **Технологии**. - ![image](../../_assets/datalens/solution-03/13-save-dashboard.png) - -## Шаг 3. Измените чарт {#step3} - -Вы можете отредактировать любой чарт на дашборде. Например, поменяйте тип визуализации для диаграммы **Визиты по типам устройств и ОС** из раздела **Технологии**. - -1. В правом верхнем углу графика **Визиты по типам устройств и ОС** нажмите значок ![image](../../_assets/console-icons/ellipsis.svg). +1. В правом верхнем углу чарта `Визиты по типам устройств и ОС` нажмите значок ![image](../../_assets/console-icons/ellipsis.svg). 1. Выберите **Редактировать**. ![image](../../_assets/datalens/solution-03/14-edit-chart.png) @@ -108,10 +103,7 @@ ![image](../../_assets/datalens/solution-03/15-choose-pie.png) 1. В правом верхнем углу нажмите кнопку **Сохранить**. - - ![image](../../_assets/datalens/solution-03/16-save-chart.png) - -1. Закройте вкладку с редактированием чарта и вернитесь в окно с дашбордом. +1. Закройте страницу с редактированием чарта и вернитесь в окно с дашбордом. 1. Обновите дашборд и убедитесь, что в разделе **Технологии** чарт изменился. ![image](../../_assets/datalens/solution-03/17-refresh-dashboard.png) diff --git a/ru/_tutorials/dataplatform/opensearch-saml-keycloak.md b/ru/_tutorials/dataplatform/opensearch-saml-keycloak.md index eb258c399d5..4212ed3ef36 100644 --- a/ru/_tutorials/dataplatform/opensearch-saml-keycloak.md +++ b/ru/_tutorials/dataplatform/opensearch-saml-keycloak.md @@ -173,6 +173,8 @@ * **{{ ui-key.yacloud.opensearch.auth.field_subject-key }}** — оставьте поле пустым. + * **{{ ui-key.yacloud.opensearch.auth.field_jwt-default-expiration-timeout }}** — оставьте значение `0`. + * **{{ ui-key.yacloud.opensearch.auth.field_enabled }}** — убедитесь, что эта опция включена. 1. Нажмите кнопку **{{ ui-key.yacloud.opensearch.auth.button_save }}**. diff --git a/ru/_tutorials/dev/ci-for-snapshots.md b/ru/_tutorials/dev/ci-for-snapshots.md index 5f424b5b916..007fb0c3df2 100644 --- a/ru/_tutorials/dev/ci-for-snapshots.md +++ b/ru/_tutorials/dev/ci-for-snapshots.md @@ -51,7 +51,7 @@ * **{{ ui-key.yacloud.component.compute.resources.field_memory }}** — `1 {{ ui-key.yacloud.common.units.label_gigabyte }}`. 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_network }}** выберите, к какой подсети необходимо подключить ВМ при создании. -1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** укажите данные для доступа к ВМ: +1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** выберите **{{ ui-key.yacloud.compute.instance.access-method.label_oslogin-control-ssh-option-title }}** и укажите данные для доступа к ВМ: * В поле **{{ ui-key.yacloud.compute.instances.create.field_user }}** введите имя пользователя, который будет создан на виртуальной машине, например `yc-user`. @@ -299,7 +299,7 @@ * **{{ ui-key.yacloud.component.compute.resources.field_memory }}** — `2 {{ ui-key.yacloud.common.units.label_gigabyte }}`. 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_network }}** выберите, к какой подсети необходимо подключить ВМ при создании. -1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** укажите данные для доступа к ВМ: +1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** выберите **{{ ui-key.yacloud.compute.instance.access-method.label_oslogin-control-ssh-option-title }}** и укажите данные для доступа к ВМ: * В поле **{{ ui-key.yacloud.compute.instances.create.field_user }}** введите имя пользователя, который будет создан на виртуальной машине, например `yc-user`. diff --git a/ru/_tutorials/dev/external-gitlab-tracker-integration.md b/ru/_tutorials/dev/external-gitlab-tracker-integration.md index b872a3630ac..cd1bafb7775 100644 --- a/ru/_tutorials/dev/external-gitlab-tracker-integration.md +++ b/ru/_tutorials/dev/external-gitlab-tracker-integration.md @@ -1,7 +1,7 @@ # Интеграция {{ GL }} с {{ tracker-full-name }} -В [задачах {{ tracker-name }}](../../tracker/about-tracker.md#zadacha) можно автоматически добавлять ссылки на [мерж-реквесты]({{ gl.docs }}/ee/user/project/merge_requests/) из {{ GL }}, указывая [ключ](../../tracker/glossary.md#key) нужной задачи в названии или описании нового мерж-реквеста. Ссылки будут размещаться в разделе [{{ ui-key.startrek.ui_components_issue-links_ExternalLinksCollapse.external-relations }}](../../tracker/external-links.md). +В [задачах {{ tracker-name }}](../../tracker/about-tracker.md#zadacha) можно автоматически добавлять ссылки на [мерж-реквесты]({{ gl.docs }}/ee/user/project/merge_requests/) из {{ GL }}, указывая [ключ](../../tracker/glossary.md#key) нужной задачи в названии или описании нового мерж-реквеста. Ссылки будут размещаться в разделе [{{ ui-key.startrek.ui_Issues_smart-components_issue-links_ExternalLinksCollapse.external-relations }}](../../tracker/external-links.md). Дополнительно можно включить автоматическое создание комментариев в задаче с информацией о мерж-реквестах. Автоматическое комментирование доступно только для [{{ mgl-name }}](../../managed-gitlab/). @@ -99,7 +99,7 @@ 1. [Создайте задачу](../../tracker/user/create-ticket.md#create-task) в {{ tracker-name }}. 1. [Создайте мерж-реквест]({{ gl.docs }}/ee/user/project/merge_requests/creating_merge_requests.html) в {{ GL }} и укажите в его названии или описании [ключ задачи](../../tracker/glossary.md#key). -1. Убедитесь, что в задаче {{ tracker-name }} в разделе [{{ ui-key.startrek.ui_components_issue-links_ExternalLinksCollapse.external-relations}}](../../tracker/external-links.md) появилась ссылка на мерж-реквест из {{ GL }}. +1. Убедитесь, что в задаче {{ tracker-name }} в разделе [{{ ui-key.startrek.ui_Issues_smart-components_issue-links_ExternalLinksCollapse.external-relations}}](../../tracker/external-links.md) появилась ссылка на мерж-реквест из {{ GL }}. Если вы использовали {{ mgl-name }} и включили автоматическое комментирование при [создании хука](#create-hook), то в задаче появится комментарий со ссылкой на мерж-реквест и информацией о нем. diff --git a/ru/_tutorials/dev/hpc-on-preemptible.md b/ru/_tutorials/dev/hpc-on-preemptible.md index 4e2bf94606f..d9675d3e29d 100644 --- a/ru/_tutorials/dev/hpc-on-preemptible.md +++ b/ru/_tutorials/dev/hpc-on-preemptible.md @@ -59,7 +59,7 @@ * В поле **{{ ui-key.yacloud.component.compute.network-select.field_external }}** выберите `{{ ui-key.yacloud.component.compute.network-select.switch_auto }}`, чтобы назначить виртуальной машине случайный внешний IP-адрес из пула {{ yandex-cloud }}, или выберите статический адрес из списка, если вы зарезервировали его заранее. -1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** укажите данные для доступа к ВМ: +1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** выберите **{{ ui-key.yacloud.compute.instance.access-method.label_oslogin-control-ssh-option-title }}** и укажите данные для доступа к ВМ: * В поле **{{ ui-key.yacloud.compute.instances.create.field_user }}** введите имя пользователя, который будет создан на виртуальной машине, например `ubuntu`. diff --git a/ru/_tutorials/dev/jenkins.md b/ru/_tutorials/dev/jenkins.md index 1260f49ade3..75ccd1cc970 100644 --- a/ru/_tutorials/dev/jenkins.md +++ b/ru/_tutorials/dev/jenkins.md @@ -100,7 +100,7 @@ Jenkins будет получать изменения в конфигураци * В поле **{{ ui-key.yacloud.component.compute.network-select.field_external }}** выберите `{{ ui-key.yacloud.component.compute.network-select.switch_auto }}`, чтобы назначить виртуальной машине случайный внешний IP-адрес из пула {{ yandex-cloud }}, или выберите статический адрес из списка, если вы зарезервировали его заранее. -1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** укажите данные для доступа к ВМ: +1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** выберите **{{ ui-key.yacloud.compute.instance.access-method.label_oslogin-control-ssh-option-title }}** и укажите данные для доступа к ВМ: * В поле **{{ ui-key.yacloud.compute.instances.create.field_user }}** введите имя пользователя, который будет создан на виртуальной машине, например `yc-user`. diff --git a/ru/_tutorials/infrastructure/autoscale-monitoring.md b/ru/_tutorials/infrastructure/autoscale-monitoring.md index 36252ee8c79..18d8a8d321b 100644 --- a/ru/_tutorials/infrastructure/autoscale-monitoring.md +++ b/ru/_tutorials/infrastructure/autoscale-monitoring.md @@ -426,7 +426,7 @@ 1. В [консоли управления]({{ link-console-main }}) выберите каталог `example-folder`. 1. В списке сервисов выберите **{{ ui-key.yacloud.iam.folder.dashboard.label_vpc }}**. 1. Перейдите на вкладку ![image](../../_assets/console-icons/nodes-right.svg) **{{ ui-key.yacloud.vpc.switch_networks }}**. - 1. В списке подсетей найдите `queue-autoscale-subnet-a` и скопируйте ее **{{ ui-key.yacloud.vpc.network.overview.column_subnetwork_id }}**. + 1. В списке подсетей найдите `queue-autoscale-subnet-a` и скопируйте ее **{{ ui-key.yacloud.common.id }}**. - CLI {#cli} diff --git a/ru/_tutorials/infrastructure/minecraft-server.md b/ru/_tutorials/infrastructure/minecraft-server.md index 93509cb9943..0fb1b4da7da 100644 --- a/ru/_tutorials/infrastructure/minecraft-server.md +++ b/ru/_tutorials/infrastructure/minecraft-server.md @@ -98,7 +98,7 @@ * В поле **{{ ui-key.yacloud.component.compute.network-select.field_external }}** выберите `{{ ui-key.yacloud.component.compute.network-select.switch_auto }}`, чтобы назначить виртуальной машине случайный внешний IP-адрес из пула {{ yandex-cloud }}, или выберите статический адрес из списка, если вы зарезервировали его заранее. * В поле **{{ ui-key.yacloud.component.compute.network-select.field_security-groups }}** выберите созданную ранее группу безопасности `minecraft-sg`. - 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** укажите данные для доступа к ВМ: + 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** выберите **{{ ui-key.yacloud.compute.instance.access-method.label_oslogin-control-ssh-option-title }}** и укажите данные для доступа к ВМ: * В поле **{{ ui-key.yacloud.compute.instances.create.field_user }}** введите имя пользователя, который будет создан на виртуальной машине, например `ubuntu`. diff --git a/ru/_tutorials/infrastructure/serverless-trigger-budget-queue-vm-tg.md b/ru/_tutorials/infrastructure/serverless-trigger-budget-queue-vm-tg.md index c6a876fdae9..53a5e72b152 100644 --- a/ru/_tutorials/infrastructure/serverless-trigger-budget-queue-vm-tg.md +++ b/ru/_tutorials/infrastructure/serverless-trigger-budget-queue-vm-tg.md @@ -792,7 +792,7 @@ git clone https://github.com/yandex-cloud-examples/yc-telegram-bot-with-trigger- * В поле **{{ ui-key.yacloud.component.compute.network-select.field_subnetwork }}** выберите созданную ранее подсеть `sample-subnet-{{ region-id }}-b`. * В поле **{{ ui-key.yacloud.component.compute.network-select.field_external }}** выберите `{{ ui-key.yacloud.component.compute.network-select.switch_auto }}`. - 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** укажите данные для доступа к ВМ: + 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** выберите **{{ ui-key.yacloud.compute.instance.access-method.label_oslogin-control-ssh-option-title }}** и укажите данные для доступа к ВМ: * В поле **{{ ui-key.yacloud.compute.instances.create.field_user }}** введите имя пользователя, например, `yc-user`. * {% include [access-ssh-key](../../_includes/compute/create/access-ssh-key.md) %} diff --git a/ru/_tutorials/infrastructure/terraform-state-lock.md b/ru/_tutorials/infrastructure/terraform-state-lock.md index 700985714eb..ccb37d7b14b 100644 --- a/ru/_tutorials/infrastructure/terraform-state-lock.md +++ b/ru/_tutorials/infrastructure/terraform-state-lock.md @@ -6,7 +6,9 @@ description: При работе с {{ TF }} в облаке важно искл # Блокировка состояний {{ TF }} с помощью {{ ydb-full-name }} -В {{ yandex-cloud }} поддерживается [управление инфраструктурой с помощью {{ TF }}](../../tutorials/infrastructure-management/terraform-quickstart.md). Чтобы управлять инфраструктурой могли несколько пользователей одновременно, состояния {{ TF }} можно [автоматически загружать и хранить в {{ objstorage-full-name }}](../../tutorials/infrastructure-management/terraform-state-storage.md). +{% include [terraform-ref-intro](../../_includes/terraform-ref-intro.md) %} + +Чтобы управлять инфраструктурой могли несколько пользователей одновременно, состояния {{ TF }} можно [автоматически загружать и хранить в {{ objstorage-full-name }}](../../tutorials/infrastructure-management/terraform-state-storage.md). Когда несколько пользователей одновременно работают с одним состоянием из {{ objstorage-name }}, возможны конфликты. Чтобы предотвратить их, вы можете развернуть базу данных в [{{ ydb-full-name }}](../../ydb/) и использовать ее для механизма блокировок, встроенного в {{ TF }} (state locking). При каждом изменении инфраструктуры через {{ TF }} состояние будет автоматически блокироваться, пока изменение не применится. @@ -23,8 +25,6 @@ description: При работе с {{ TF }} в облаке важно искл Если созданные ресурсы вам больше не нужны, [удалите их](#clear-out). -{{ TF }} и его провайдеры распространяются под лицензией [Business Source License](https://github.com/hashicorp/terraform/blob/main/LICENSE). - ## Подготовьте облако к работе {#before-you-begin} {% include [before-you-begin](../_tutorials_includes/before-you-begin.md) %} @@ -127,7 +127,7 @@ description: При работе с {{ TF }} в облаке важно искл ``` - PowerShell {#powershell} - + ```powershell $Env:AWS_ACCESS_KEY_ID="<идентификатор_ключа>" $Env:AWS_SECRET_ACCESS_KEY="<секретный_ключ>" diff --git a/ru/_tutorials/infrastructure/terraform-state-storage.md b/ru/_tutorials/infrastructure/terraform-state-storage.md index 152c26fe585..f112bc55079 100644 --- a/ru/_tutorials/infrastructure/terraform-state-storage.md +++ b/ru/_tutorials/infrastructure/terraform-state-storage.md @@ -1,10 +1,12 @@ # Загрузка состояний {{ TF }} в {{ objstorage-full-name }} +{% include [terraform-ref-intro](../../_includes/terraform-ref-intro.md) %} + В инструкции описываются шаги загрузки состояния {{ TF }} в [{{ objstorage-name }}](../../storage/). Состояние {{ TF }} описывает текущую развернутую инфраструктуру и хранится в файлах с расширением `.tfstate`. Файл состояния создается после развертывания инфраструктуры и может быть сразу загружен в {{ objstorage-name }}. Загруженный файл состояния будет обновляться после изменений созданной инфраструктуры. - + В этом примере сохраненное состояние позволит другим пользователям получить идентификатор одной из созданных [подсетей](../../vpc/concepts/network.md#subnet), чтобы подключить к ней новую [виртуальную машину](../../compute/concepts/vm.md). Чтобы настроить хранение состояний {{ TF }} в {{ objstorage-name }} и использовать его для создания новых ресурсов: @@ -18,8 +20,6 @@ Если созданные ресурсы вам больше не нужны, [удалите их](#clear-out). -{{ TF }} и его провайдеры распространяются под лицензией [Business Source License](https://github.com/hashicorp/terraform/blob/main/LICENSE). - ## Подготовьте облако к работе {#before-you-begin} {% include [before-you-begin](../_tutorials_includes/before-you-begin.md) %} @@ -137,7 +137,7 @@ } data "terraform_remote_state" "vpc" { - backend = "s3" + backend = "s3" config = { endpoints = { s3 = "https://{{ s3-storage-host }}" diff --git a/ru/_tutorials/ml-ai/yagpt-tuning-multilabel.md b/ru/_tutorials/ml-ai/yagpt-tuning-multilabel.md index 35393142ad9..af1588cf40f 100644 --- a/ru/_tutorials/ml-ai/yagpt-tuning-multilabel.md +++ b/ru/_tutorials/ml-ai/yagpt-tuning-multilabel.md @@ -8,7 +8,7 @@ {% note info %} -Сервис {{ foundation-models-full-name }} находится на стадии [Preview](../../overview/concepts/launch-stages.md). +Классификаторы на базе {{ yagpt-name }} находятся на стадии [Preview](../../overview/concepts/launch-stages.md). {% endnote %} diff --git a/ru/_tutorials/ml-ai/yagpt-tuning.md b/ru/_tutorials/ml-ai/yagpt-tuning.md index b555b40a96b..18101aabbc8 100644 --- a/ru/_tutorials/ml-ai/yagpt-tuning.md +++ b/ru/_tutorials/ml-ai/yagpt-tuning.md @@ -6,12 +6,6 @@ {% endnote %} -{% note info %} - -Сервис {{ foundation-models-full-name }} находится на стадии [Preview](../../overview/concepts/launch-stages.md). - -{% endnote %} - Чтобы дообучить модель {{ yagpt-name }}: 1. [Подготовьте инфраструктуру](#infra). @@ -113,7 +107,7 @@ ```python import requests req = { - "modelUri": "ds://<идентификатор_дообученной_модели>", + "modelUri": "ds://<идентификатор_каталога>/<идентификатор_дообученной_модели>", "completionOptions": { "stream": False, "temperature": 0.1, @@ -126,8 +120,7 @@ } ] } - headers = {"Authorization" : "Bearer " + '', - "x-folder-id": "<идентификатор_каталога>", } + headers = {"Authorization" : "Bearer " + ''} res = requests.post("https://llm.{{ api-host }}/foundationModels/v1/completion", headers=headers, json=req) print(res.json()) @@ -135,18 +128,17 @@ Где: - * `modelUri` — идентификатор дообученной модели. Можно [найти](#model-tuning) в списке доступных ресурсов проекта. + * `modelUri` — идентификатор дообученной модели. Можно [найти](#model-tuning) в списке доступных ресурсов проекта. Параметр содержит [идентификатор каталога](../../resource-manager/operations/folder/get-id.md), у которого есть доступ к сервису {{ yagpt-name }}. * `temperature` — температура. Чем выше значение, тем более непредсказуемым будет результат выполнения запроса. * `maxTokens` — максимальное число токенов в ответе модели. * `` — значение [IAM-токена сервисного аккаунта](../../iam/operations/iam-token/create-for-sa.md). - * `<идентификатор_каталога>` — [идентификатор каталога](../../resource-manager/operations/folder/get-id.md) {{ yandex-cloud }}, у которого есть доступ к сервису {{ yagpt-name }}. Если вы использовали инструкцию для дообучения, укажите ее текст в сообщении с ролью `system`: ```python import requests req = { - "modelUri": "ds://<идентификатор_дообученной_модели>", + "modelUri": "ds://<идентификатор_каталога>/<идентификатор_дообученной_модели>", "completionOptions": { "stream": False, "temperature": 0.1, @@ -163,8 +155,7 @@ } ] } - headers = {"Authorization" : "Bearer " + '', - "x-folder-id": "<идентификатор_каталога>", } + headers = {"Authorization" : "Bearer " + ''} res = requests.post("https://llm.{{ api-host }}/foundationModels/v1/completion", headers=headers, json=req) print(res.json()) @@ -180,7 +171,7 @@ ```json { - "modelUri": "ds://<идентификатор_дообученной_модели>", + "modelUri": "ds://<идентификатор_каталога>/<идентификатор_дообученной_модели>", "completionOptions": { "stream": false, "temperature": 0.1, @@ -197,7 +188,7 @@ Где: - * `modelUri` — идентификатор дообученной модели. Можно [найти](#model-tuning) в списке доступных ресурсов проекта. + * `modelUri` — идентификатор дообученной модели. Можно [найти](#model-tuning) в списке доступных ресурсов проекта. Параметр содержит [идентификатор каталога](../../resource-manager/operations/folder/get-id.md), у которого есть доступ к сервису {{ yagpt-name }}. * `temperature` — температура. Чем выше значение, тем более непредсказуемым будет результат выполнения запроса. * `maxTokens` — максимальное число токенов в ответе модели. * `text` — текст запроса. @@ -206,7 +197,7 @@ ```json { - "modelUri": "ds://<идентификатор_дообученной_модели>", + "modelUri": "ds://<идентификатор_каталога>/<идентификатор_дообученной_модели>", "completionOptions": { "stream": false, "temperature": 0.1, diff --git a/ru/_tutorials/routing/gre-over-ipsec.md b/ru/_tutorials/routing/gre-over-ipsec.md index 05cfdf81967..42bba04dc35 100644 --- a/ru/_tutorials/routing/gre-over-ipsec.md +++ b/ru/_tutorials/routing/gre-over-ipsec.md @@ -57,7 +57,7 @@ - Консоль управления {#console} - 1. В [консоли управления]({{ link-console-main }}) выберите [облако](../../resource-manager/concepts/resources-hierarchy.md#cloud) и справа сверху нажмите кнопку ![image](../../_assets/create.png) **{{ ui-key.yacloud.component.console-dashboard.button_action-create-folder }}**. + 1. В [консоли управления]({{ link-console-main }}) выберите [облако](../../resource-manager/concepts/resources-hierarchy.md#cloud) и справа сверху нажмите кнопку ![image](../../_assets/console-icons/plus.svg) **{{ ui-key.yacloud.component.console-dashboard.button_action-create-folder }}**. 1. Введите имя [каталога](../../resource-manager/concepts/resources-hierarchy.md#folder): `site-a`. 1. При желании, добавьте описание каталога. 1. Выберите опцию **{{ ui-key.yacloud.iam.cloud.folders-create.field_default-net }}**. diff --git a/ru/_tutorials/routing/high-accessible-dmz.md b/ru/_tutorials/routing/high-accessible-dmz.md index f05f2014b09..7fe51337066 100644 --- a/ru/_tutorials/routing/high-accessible-dmz.md +++ b/ru/_tutorials/routing/high-accessible-dmz.md @@ -105,7 +105,6 @@ Next-Generation Firewall используется для защиты и сег ## Подготовьте окружение {#prepare-environment} В руководстве используется программное обеспечение для ОС Windows и подсистема [Windows Subsystem for Linux](https://ru.wikipedia.org/wiki/Windows_Subsystem_for_Linux). - Инфраструктура разворачивается с помощью [{{ TF }}](https://www.terraform.io/). ### Настройте WSL {#setup-wsl} @@ -127,7 +126,6 @@ Next-Generation Firewall используется для защиты и сег 1. Если WSL не установлена, [установите](https://learn.microsoft.com/en-us/windows/wsl/install) ее и повторите предыдущий шаг. 1. Дополнительно можно установить на подсистему WSL привычный вам дистрибутив ОС Linux, например, [Ubuntu](https://ubuntu.com/tutorials/install-ubuntu-on-wsl2-on-windows-11-with-gui-support#1-overview). - 1. Чтобы сделать установленный дистрибутив системой по умолчанию, выполните команду: ```bash @@ -493,9 +491,11 @@ Next-Generation Firewall используется для защиты и сег 1. Слева сверху в выпадающем списке **Objects** выберите **More object types → Network Object → Gateways and Servers → New Gateway...**. 1. Нажмите **Wizard Mode**. 1. В открывшемся диалоге введите: + * **Gateway name**: `FW-A` * **Gateway platform**: `CloudGuard IaaS` * **IPv4**: `192.168.1.10` + 1. Нажмите **Next**. 1. Получите пароль доступа к межсетевым экранам. Для этого в терминале выполните команду: @@ -688,6 +688,7 @@ terraform apply ```bash ping 192.168.1.101 ``` + Выполнение команды должно завершиться ошибкой в соответствии с запрещающим правилом `Cleanup rule`. ### Проверка отказоустойчивости {#fault-tolerance-check} @@ -739,7 +740,6 @@ terraform apply ``` 1. В [консоли управления]({{ link-console-main }}) {{ yandex-cloud }} в каталоге `mgmt` [остановите](../../compute/operations/vm-control/vm-stop-and-start.md#stop) ВМ `fw-a`, эмулируя отказ основного межсетевого экрана. - 1. Наблюдайте за пропаданием пакетов, отправляемых `httping` и `ping`. После отказа FW-A может наблюдаться пропадание трафика на протяжении приблизительно 1 мин, после чего трафик должен восстановиться. 1. Убедитесь, что в таблице маршрутизации `dmz-rt` в каталоге `dmz` для `next hop` используется адрес FW-B. 1. В [консоли управления]({{ link-console-main }}) {{ yandex-cloud }} [запустите](../../compute/operations/vm-control/vm-stop-and-start.md#start) ВМ `fw-a`, эмулируя восстановление основного межсетевого экрана. @@ -755,4 +755,4 @@ terraform apply ``` {{ TF }} удалит все ресурсы **без возможности восстановления**: сети, подсети, виртуальные машины, балансировщики, каталоги и т.д. -Так как созданные ресурсы расположены в каталогах, то в качестве более быстрого способа удаления всех ресурсов можно использовать удаление всех каталогов через консоль {{ yandex-cloud }} с последующим удалением файла `terraform.tfstate` из папки `yc-dmz-with-high-available-ngfw` на вашем ПК. \ No newline at end of file +Так как созданные ресурсы расположены в каталогах, то в качестве более быстрого способа удаления всех ресурсов можно использовать удаление всех каталогов через консоль {{ yandex-cloud }} с последующим удалением файла `terraform.tfstate` из папки `yc-dmz-with-high-available-ngfw` на вашем ПК. diff --git a/ru/_tutorials/routing/nat-instance-console.md b/ru/_tutorials/routing/nat-instance-console.md index c6210665958..6b879b14e37 100644 --- a/ru/_tutorials/routing/nat-instance-console.md +++ b/ru/_tutorials/routing/nat-instance-console.md @@ -84,7 +84,7 @@ * В поле **{{ ui-key.yacloud.component.compute.network-select.field_security-groups }}** выберите созданную ранее группу `nat-instance-sg`. * Разверните блок **{{ ui-key.yacloud.component.compute.network-select.section_additional }}** и в поле **{{ ui-key.yacloud.component.internal-v4-address-field.field_internal-ipv4-address }}** выберите `{{ ui-key.yacloud.component.compute.network-select.switch_auto }}`. - 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** укажите данные для доступа к ВМ: + 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** выберите **{{ ui-key.yacloud.compute.instance.access-method.label_oslogin-control-ssh-option-title }}** и укажите данные для доступа к ВМ: * В поле **{{ ui-key.yacloud.compute.instances.create.field_user }}** введите имя пользователя, например, `yc-user`. * {% include [access-ssh-key](../../_includes/compute/create/access-ssh-key.md) %} @@ -117,7 +117,7 @@ * В поле **{{ ui-key.yacloud.component.compute.network-select.field_security-groups }}** выберите созданную ранее группу `nat-instance-sg`. * Разверните блок **{{ ui-key.yacloud.component.compute.network-select.section_additional }}** и в поле **{{ ui-key.yacloud.component.internal-v4-address-field.field_internal-ipv4-address }}** выберите `{{ ui-key.yacloud.component.compute.network-select.switch_auto }}`. - 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** укажите данные для доступа к ВМ: + 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** выберите **{{ ui-key.yacloud.compute.instance.access-method.label_oslogin-control-ssh-option-title }}** и укажите данные для доступа к ВМ: * В поле **{{ ui-key.yacloud.compute.instances.create.field_user }}** введите имя пользователя, например, `yc-user`. * {% include [access-ssh-key](../../_includes/compute/create/access-ssh-key.md) %} diff --git a/ru/_tutorials/routing/network-segmentation-checkpoint.md b/ru/_tutorials/routing/network-segmentation-checkpoint.md index e58fafc4bf9..427210cdb47 100644 --- a/ru/_tutorials/routing/network-segmentation-checkpoint.md +++ b/ru/_tutorials/routing/network-segmentation-checkpoint.md @@ -1,4 +1,4 @@ -# Сегментация облачной инфраструктуры с помощью решения Check Point Next-Generation Firewall +# Сегментация облачной инфраструктуры с помощью решения Check Point Next-Generation Firewall С помощью руководства вы развернете защищенную сетевую инфраструктуру на основе Check Point Next-Generation Firewall. Инфраструктура состоит из трех сегментов, каждый из которых содержит ресурсы одного назначения, обособленные от других ресурсов. Например, выделенный [DMZ](https://ru.wikipedia.org/wiki/DMZ_(компьютерные_сети)) сегмент предназначен для размещения общедоступных приложений, а сегмент mgmt содержит ресурсы, используемые для управления облачной сетевой инфраструктурой. Связь между сегментами происходит через виртуальную машину [Check Point](https://www.checkpoint.com/quantum/next-generation-firewall/) [Next-Generation Firewall](https://en.wikipedia.org/wiki/Next-generation_firewall), обеспечивающую комплексную защиту сегментов и контроль трафика между сегментами. @@ -173,8 +173,8 @@ Результат: ```text - id: ajehr0to1g8bh0la8c8r - folder_id: b1gv87ssvu497lpgjh5o + id: ajehr0to1g8b******** + folder_id: b1gv87ssvu49******** created_at: "2024-01-04T09:03:11.665153755Z" name: sa-terraform ``` @@ -311,8 +311,8 @@ Результат: ```text - id: aje8nn871qo4a8bbopvb - service_account_id: ajehr0to1g8bh0la8c8r + id: aje8nn871qo4******** + service_account_id: ajehr0to1g8b******** created_at: "2023-03-04T09:16:43.479156798Z" key_algorithm: RSA_2048 ``` @@ -383,7 +383,7 @@ | Название
    параметра | Нужно
    изменение | Описание | Тип | Пример | | ----------- | ----------- | ----------- | ----------- | ----------- | - | `cloud_id` | да | Идентификатор вашего облака в Yandex Cloud | `string` | `b1g8dn6s3v2eiid9dbci` | + | `cloud_id` | да | Идентификатор вашего облака в Yandex Cloud | `string` | `b1g8dn6s3v2e********` | | `az_name` | - | Зона доступности Yandex Cloud для размещения ресурсов | `string` | `{{ region-id }}-d` | | `security_segment_names` | - | Список названий сегментов. Первый сегмент для размещения ресурсов управления, второй с публичным доступом в интернет, третий для DMZ. Если требуются дополнительные сегменты, то нужно добавлять их в конец списка. При добавлении сегмента обязательно добавьте префикс для подсети в список `subnet_prefix_list`. | `list(string)` | `["mgmt", "public", "dmz"]` | | `subnet_prefix_list` | - | Список сетевых префиксов для подсетей, соответствующих списку названия сегментов `security_segment_names`. По одному префиксу для сегмента. | `list(string)` | `["192.168.1.0/24", "172.16.1.0/24", "10.160.1.0/24"]` | diff --git a/ru/_tutorials/serverless/bucket-to-bucket-copying.md b/ru/_tutorials/serverless/bucket-to-bucket-copying.md index ffa52b23693..0328a39aed8 100644 --- a/ru/_tutorials/serverless/bucket-to-bucket-copying.md +++ b/ru/_tutorials/serverless/bucket-to-bucket-copying.md @@ -17,6 +17,7 @@ Если созданные ресурсы вам больше не нужны, [удалите их](#clear-out). + ## Подготовьте облако к работе {#before-begin} {% include [before-you-begin](../_tutorials_includes/before-you-begin.md) %} @@ -31,143 +32,173 @@ * плата за хранение секретов (см. [тарифы {{ lockbox-full-name }}](../../lockbox/pricing.md)). + ## Создайте сервисные аккаунты {#create-sa} -1. Создайте [сервисный аккаунт](../../iam/concepts/users/service-accounts.md) `s3-copy-fn`, от имени которого будет работать функция: +Создайте [сервисный аккаунт](../../iam/concepts/users/service-accounts.md) `s3-copy-fn` с ролями `storage.uploader`, `storage.viewer` и `{{ roles-lockbox-payloadviewer }}`, от имени которого будет работать функция, и `s3-copy-trigger` с ролью `{{ roles-functions-invoker }}` для вызова функции. - {% list tabs group=instructions %} +{% list tabs group=instructions %} - - Консоль управления {#console} +- Консоль управления {#console} - 1. В [консоли управления]({{ link-console-main }}) выберите каталог, в котором хотите создать сервисный аккаунт. - 1. В списке сервисов выберите **{{ ui-key.yacloud.iam.folder.dashboard.label_iam }}**. - 1. Нажмите кнопку **{{ ui-key.yacloud.iam.folder.service-accounts.button_add }}**. - 1. Введите имя сервисного аккаунта: `s3-copy-fn`. - 1. Нажмите **{{ ui-key.yacloud.iam.folder.service-account.label_add-role }}** и выберите роли `storage.uploader`, `storage.viewer` и `{{ roles-lockbox-payloadviewer }}`. - 1. Нажмите кнопку **{{ ui-key.yacloud.iam.folder.service-account.popup-robot_button_add }}**. - - - {{ yandex-cloud }} CLI {#cli} + 1. В [консоли управления]({{ link-console-main }}) выберите каталог, в котором хотите создать сервисный аккаунт. + 1. В списке сервисов выберите **{{ ui-key.yacloud.iam.folder.dashboard.label_iam }}**. + 1. Нажмите кнопку **{{ ui-key.yacloud.iam.folder.service-accounts.button_add }}**. + 1. Укажите имя сервисного аккаунта: `s3-copy-fn`. + 1. Нажмите **{{ ui-key.yacloud.iam.folder.service-account.label_add-role }}** и выберите роли `storage.uploader`, `storage.viewer` и `{{ roles-lockbox-payloadviewer }}`. + 1. Нажмите кнопку **{{ ui-key.yacloud.iam.folder.service-account.popup-robot_button_add }}**. + 1. Повторите предыдущие шаги и создайте сервисный аккаунт `s3-copy-trigger` с ролью `{{ roles-functions-invoker }}`, от имени которого будет вызываться функция. - {% include [cli-install](../../_includes/cli-install.md) %} +- {{ yandex-cloud }} CLI {#cli} - {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% include [cli-install](../../_includes/cli-install.md) %} - 1. Создайте сервисный аккаунт `s3-copy-fn`: + {% include [default-catalogue](../../_includes/default-catalogue.md) %} - ```bash - yc iam service-account create --name s3-copy-fn - ``` + 1. Создайте сервисный аккаунт `s3-copy-fn`: - Результат: + ```bash + yc iam service-account create --name s3-copy-fn + ``` - ``` - id: nfersamh4sjq******** - folder_id: b1gc1t4cb638******** - created_at: "2023-03-21T10:36:29.726397755Z" - name: s3-copy-fn - ``` + Результат: - Сохраните идентификатор сервисного аккаунта `s3-copy-fn` (`id`) и каталога, в котором его создали (`folder_id`). + ```text + id: nfersamh4sjq******** + folder_id: b1gc1t4cb638******** + created_at: "2023-03-21T10:36:29.726397755Z" + name: s3-copy-fn + ``` - 1. Назначьте сервисному аккаунту роли `storage.uploader`, `storage.viewer` и `{{ roles-lockbox-payloadviewer }}` на каталог: + Сохраните идентификатор сервисного аккаунта `s3-copy-fn` (`id`) и каталога, в котором его создали (`folder_id`). - ```bash - yc resource-manager folder add-access-binding <идентификатор_каталога> \ - --role storage.uploader \ - --subject serviceAccount:<идентификатор_сервисного_аккаунта> + 1. Назначьте сервисному аккаунту роли `storage.uploader`, `storage.viewer` и `{{ roles-lockbox-payloadviewer }}` на каталог: - yc resource-manager folder add-access-binding <идентификатор_каталога> \ - --role storage.viewer \ - --subject serviceAccount:<идентификатор_сервисного_аккаунта> + ```bash + yc resource-manager folder add-access-binding <идентификатор_каталога> \ + --role storage.uploader \ + --subject serviceAccount:<идентификатор_сервисного_аккаунта> - yc resource-manager folder add-access-binding <идентификатор_каталога> \ - --role lockbox.payloadViewer \ - --subject serviceAccount:<идентификатор_сервисного_аккаунта> - ``` + yc resource-manager folder add-access-binding <идентификатор_каталога> \ + --role storage.viewer \ + --subject serviceAccount:<идентификатор_сервисного_аккаунта> - Результат: + yc resource-manager folder add-access-binding <идентификатор_каталога> \ + --role {{ roles-lockbox-payloadviewer }} \ + --subject serviceAccount:<идентификатор_сервисного_аккаунта> + ``` - ``` - done (1s) - ``` + Результат: - - {{ TF }} {#tf} + ```text + done (1s) + ``` + 1. Создайте сервисный аккаунт `s3-copy-trigger`: - {% include [terraform-install](../../_includes/terraform-install.md) %} + ```bash + yc iam service-account create --name s3-copy-trigger + ``` + Сохраните идентификаторы сервисного аккаунта `s3-copy-trigger` (`id`) и каталога, в котором он был создан (`folder_id`). - 1. Опишите в конфигурационном файле параметры сервисного аккаунта: + 1. Назначьте сервисному аккаунту роль `{{ roles-functions-invoker }}` на каталог: - ```hcl - resource "yandex_iam_service_account" "s3-copy-fn" { - name = "s3-copy-fn" - folder_id = "<идентификатор_каталога>" - } + ```bash + yc resource-manager folder add-access-binding <идентификатор_каталога> \ + --role storage.uploader \ + --subject serviceAccount:<идентификатор_сервисного_аккаунта> + ``` - resource "yandex_resourcemanager_folder_iam_member" "uploader" { - folder_id = "<идентификатор_каталога>" - role = "storage.uploader" - member = "serviceAccount:${yandex_iam_service_account.s3-copy-fn id}" - } +- {{ TF }} {#tf} - resource "yandex_resourcemanager_folder_iam_member" "viewer" { - folder_id = "<идентификатор_каталога>" - role = "storage.viewer" - member = "serviceAccount:${yandex_iam_service_account.s3-copy-fn id}" - } - resource "yandex_resourcemanager_folder_iam_member" "payloadViewer" { - folder_id = "<идентификатор_каталога>" - role = "lockbox.payloadViewer" - member = "serviceAccount:${yandex_iam_service_account.s3-copy-fn id}" - } - ``` + {% include [terraform-install](../../_includes/terraform-install.md) %} - Где: - * `name` — имя сервисного аккаунта. Обязательный параметр. - * `folder_id` — [идентификатор каталога](../../resource-manager/operations/folder/get-id.md). Необязательный параметр. По умолчанию будет использовано значение, указанное в настройках провайдера. - * `role` — назначаемая роль. + 1. Опишите в конфигурационном файле параметры сервисных аккаунтов: + + ```hcl + // Сервисный аккаунт для работы функции + resource "yandex_iam_service_account" "s3-copy-fn" { + name = "s3-copy-fn" + folder_id = "<идентификатор_каталога>" + } + + resource "yandex_resourcemanager_folder_iam_member" "uploader" { + folder_id = "<идентификатор_каталога>" + role = "storage.uploader" + member = "serviceAccount:${yandex_iam_service_account.s3-copy-fn.id}" + } + + resource "yandex_resourcemanager_folder_iam_member" "viewer" { + folder_id = "<идентификатор_каталога>" + role = "storage.viewer" + member = "serviceAccount:${yandex_iam_service_account.s3-copy-fn.id}" + } - Более подробную информацию о параметрах ресурса `yandex_iam_service_account` в {{ TF }}, см. в [документации провайдера]({{ tf-provider-resources-link }}/iam_service_account). + resource "yandex_resourcemanager_folder_iam_member" "payloadViewer" { + folder_id = "<идентификатор_каталога>" + role = "{{ roles-lockbox-payloadviewer }}" + member = "serviceAccount:${yandex_iam_service_account.s3-copy-fn.id}" + } - 1. Проверьте корректность конфигурационных файлов. + // Сервисный аккаунт для вызова функции + resource "yandex_iam_service_account" "s3-copy-trigger" { + name = "s3-copy-trigger" + folder_id = "<идентификатор_каталога>" + } - 1. В командной строке перейдите в папку, где вы создали конфигурационный файл. - 1. Выполните проверку с помощью команды: + resource "yandex_resourcemanager_folder_iam_member" "functionInvoker" { + folder_id = "<идентификатор_каталога>" + role = "{{ roles-functions-invoker }}" + member = "serviceAccount:${yandex_iam_service_account.s3-copy-trigger.id}" + } + ``` - ```bash - terraform plan - ``` + Где: - Если конфигурация описана верно, в терминале отобразится информация о сервисном аккаунте. Если в конфигурации есть ошибки, {{ TF }} на них укажет. + * `name` — имя сервисного аккаунта. Обязательный параметр. + * `folder_id` — [идентификатор каталога](../../resource-manager/operations/folder/get-id.md). Необязательный параметр. По умолчанию будет использовано значение, указанное в настройках провайдера. + * `role` — назначаемая роль. - 1. Разверните облачные ресурсы. + Более подробную информацию о параметрах ресурса `yandex_iam_service_account` в {{ TF }}, см. в [документации провайдера]({{ tf-provider-resources-link }}/iam_service_account). - 1. Если в конфигурации нет ошибок, выполните команду: + 1. Проверьте корректность конфигурационных файлов. + + 1. В командной строке перейдите в папку, где вы создали конфигурационный файл. + 1. Выполните проверку с помощью команды: - ```bash - terraform apply - ``` + ```bash + terraform plan + ``` - 1. Подтвердите создание сервисного аккаунта: введите в терминал слово `yes` и нажмите **Enter**. + Если конфигурация описана верно, в терминале отобразится информация о сервисном аккаунте. Если в конфигурации есть ошибки, {{ TF }} на них укажет. - После этого будет создан сервисный аккаунт. Проверить появление сервисного аккаунта можно в [консоли управления]({{ link-console-main }}) или с помощью команды [CLI](../../cli/quickstart.md): + 1. Разверните облачные ресурсы. - ```bash - yc iam service-account list - ``` + 1. Если в конфигурации нет ошибок, выполните команду: - - API {#api} + ```bash + terraform apply + ``` - Чтобы создать сервисный аккаунт, воспользуйтесь методом [create](../../iam/api-ref/ServiceAccount/create.md) для ресурса [ServiceAccount](../../iam/api-ref/ServiceAccount/index.md) или вызовом gRPC API [ServiceAccountService/Create](../../iam/api-ref/grpc/ServiceAccount/create.md). + 1. Подтвердите создание сервисных аккаунтов: введите в терминал слово `yes` и нажмите **Enter**. - Чтобы назначить сервисному аккаунту роли `storage.uploader`, `storage.viewer` и `{{ roles-lockbox-payloadviewer }}` на каталог, воспользуйтесь методом [setAccessBindings](../../iam/api-ref/ServiceAccount/setAccessBindings.md) для ресурса [ServiceAccount](../../iam/api-ref/ServiceAccount/index.md) или вызовом gRPC API [ServiceAccountService/SetAccessBindings](../../iam/api-ref/grpc/ServiceAccount/setAccessBindings.md). + После этого будут созданы сервисные аккаунты. Проверить появление сервисных аккаунтов можно в [консоли управления]({{ link-console-main }}) или с помощью команды [CLI](../../cli/quickstart.md): - {% endlist %} + ```bash + yc iam service-account list + ``` + +- API {#api} + + Чтобы создать сервисный аккаунт, воспользуйтесь методом [create](../../iam/api-ref/ServiceAccount/create.md) для ресурса [ServiceAccount](../../iam/api-ref/ServiceAccount/index.md) или вызовом gRPC API [ServiceAccountService/Create](../../iam/api-ref/grpc/ServiceAccount/create.md). + + Чтобы назначить сервисному аккаунту роли на каталог, воспользуйтесь методом [setAccessBindings](../../iam/api-ref/ServiceAccount/setAccessBindings.md) для ресурса [ServiceAccount](../../iam/api-ref/ServiceAccount/index.md) или вызовом gRPC API [ServiceAccountService/SetAccessBindings](../../iam/api-ref/grpc/ServiceAccount/setAccessBindings.md). + +{% endlist %} -1. Таким же образом создайте сервисный аккаунт `s3-copy-trigger` с ролью `{{ roles-functions-invoker }}`, от имени которого будет вызываться функция. ## Создайте статический ключ {#create-key} @@ -180,7 +211,7 @@ 1. В [консоли управления]({{ link-console-main }}) перейдите в каталог, в котором находится сервисный аккаунт. 1. В списке сервисов выберите **{{ ui-key.yacloud.iam.folder.dashboard.label_iam }}**. - 1. На панели слева выберите ![FaceRobot](../../_assets/console-icons/face-robot.svg) **{{ ui-key.yacloud.iam.label_service-accounts }}** и выберите нужный сервисный аккаунт. + 1. На панели слева выберите ![FaceRobot](../../_assets/console-icons/face-robot.svg) **{{ ui-key.yacloud.iam.label_service-accounts }}** и выберите сервисный аккаунт `s3-copy-fn`. 1. На верхней панели нажмите кнопку **{{ ui-key.yacloud.iam.folder.service-account.overview.button_create-key-popup }}**. 1. Выберите **{{ ui-key.yacloud.iam.folder.service-account.overview.button_create_service-account-key }}**. 1. Задайте описание ключа и нажмите кнопку **{{ ui-key.yacloud.iam.folder.service-account.overview.popup-key_button_create }}**. @@ -190,20 +221,20 @@ 1. Выполните команду: - ```bash - yc iam access-key create --service-account-name s3-copy-fn - ``` + ```bash + yc iam access-key create --service-account-name s3-copy-fn + ``` - Результат: + Результат: - ```text - access_key: - id: aje6t3vsbj8l******** - service_account_id: ajepg0mjt06s******** - created_at: "2023-03-21T14:37:51Z" - key_id: 0n8X6WY6S24******** - secret: JyTRFdqw8t1kh2-OJNz4JX5ZTz9Dj1rI******** - ``` + ```text + access_key: + id: aje6t3vsbj8l******** + service_account_id: ajepg0mjt06s******** + created_at: "2023-03-21T14:37:51Z" + key_id: 0n8X6WY6S24******** + secret: JyTRFdqw8t1kh2-OJNz4JX5ZTz9Dj1rI******** + ``` 1. Сохраните идентификатор (`key_id`) и секретный ключ (`secret`). Получить значение ключа снова будет невозможно. @@ -211,45 +242,45 @@ 1. Опишите в конфигурационном файле параметры ключа: - ```hcl - resource "yandex_iam_service_account_static_access_key" "sa-static-key" { - service_account_id = "<идентификатор_сервисного_аккаунта>" - } - ``` + ```hcl + resource "yandex_iam_service_account_static_access_key" "sa-static-key" { + service_account_id = "<идентификатор_сервисного_аккаунта>" + } + ``` + + Где `service_account_id` — идентификатор сервисного аккаунта `s3-copy-fn`. - Где `service_account_id` — идентификатор сервисного аккаунта `s3-copy-fn`. + Более подробную информацию о параметрах ресурса `yandex_iam_service_account_static_access_key` в {{ TF }}, см. в [документации провайдера]({{ tf-provider-resources-link }}/iam_service_account_static_access_key). - Более подробную информацию о параметрах ресурса `yandex_iam_service_account_static_access_key` в {{ TF }}, см. в [документации провайдера]({{ tf-provider-resources-link }}/iam_service_account_static_access_key). - 1. Проверьте корректность конфигурационных файлов. - 1. В командной строке перейдите в папку, где вы создали конфигурационный файл. - 1. Выполните проверку с помощью команды: + 1. В командной строке перейдите в папку, где вы создали конфигурационный файл. + 1. Выполните проверку с помощью команды: - ```bash - terraform plan - ``` + ```bash + terraform plan + ``` - Если конфигурация описана верно, в терминале отобразится список создаваемых ресурсов и их параметров. Если в конфигурации есть ошибки, {{ TF }} на них укажет. + Если конфигурация описана верно, в терминале отобразится список создаваемых ресурсов и их параметров. Если в конфигурации есть ошибки, {{ TF }} на них укажет. 1. Разверните облачные ресурсы. - 1. Если в конфигурации нет ошибок, выполните команду: + 1. Если в конфигурации нет ошибок, выполните команду: - ```bash - terraform apply - ``` + ```bash + terraform apply + ``` - 1. Подтвердите создание статического ключа доступа: введите в терминал слово `yes` и нажмите **Enter**. + 1. Подтвердите создание статического ключа доступа: введите в терминал слово `yes` и нажмите **Enter**. - Если при создании ключа возникли ошибки, {{ TF }} на них укажет. - При успешном создании ключа {{ TF }} запишет его в свою конфигурацию, но не покажет пользователю. В терминал будет выведен только идентификатор созданного ключа. + Если при создании ключа возникли ошибки, {{ TF }} на них укажет. + При успешном создании ключа {{ TF }} запишет его в свою конфигурацию, но не покажет пользователю. В терминал будет выведен только идентификатор созданного ключа. - Проверить появление ключа у сервисного аккаунта можно в [консоли управления]({{ link-console-main }}) или с помощью команды [CLI](../../cli/quickstart.md): - - ```bash - yc iam access-key list --service-account-name=s3-copy-fn - ``` + Проверить появление ключа у сервисного аккаунта можно в [консоли управления]({{ link-console-main }}) или с помощью команды [CLI](../../cli/quickstart.md): + + ```bash + yc iam access-key list --service-account-name=s3-copy-fn + ``` - API {#api} @@ -257,6 +288,7 @@ {% endlist %} + ## Создайте секрет {#create-secret} Создайте [секрет](../../lockbox/quickstart.md) {{ lockbox-name }} для хранения статического ключа доступа. @@ -268,19 +300,21 @@ 1. В [консоли управления]({{ link-console-main }}) выберите каталог, в котором хотите создать секрет. 1. В списке сервисов выберите **{{ ui-key.yacloud.iam.folder.dashboard.label_lockbox }}**. 1. Нажмите кнопку **{{ ui-key.yacloud.lockbox.button_create-secret }}**. - 1. В поле **{{ ui-key.yacloud.common.name }}** введите имя секрета: `s3-static-key`. - 1. В блоке **{{ ui-key.yacloud.lockbox.label_version-dialog-title }}**: + 1. В поле **{{ ui-key.yacloud.common.name }}** укажите имя секрета: `s3-static-key`. + + 1. В блоке **{{ ui-key.yacloud.lockbox.forms.title_secret-data-section }}**: - 1. Добавьте значение идентификатора ключа: + 1. Выберите тип секрета **{{ ui-key.yacloud.lockbox.forms.title_secret-type-custom }}**. + 1. Добавьте значение идентификатора ключа: - * В поле **{{ ui-key.yacloud.lockbox.forms.label_key }}** введите `key_id`. - * В поле **{{ ui-key.yacloud.lockbox.forms.label_value }}** введите значение идентификатора ключа, которое [получили ранее](#create-key). - - 1. Нажмите кнопку **{{ ui-key.yacloud.lockbox.forms.button_add-pair }}**. - 1. Добавьте значение секретного ключа: + * В поле **{{ ui-key.yacloud.lockbox.forms.label_key }}** укажите: `key_id`. + * В поле **{{ ui-key.yacloud.lockbox.forms.label_value }}** укажите значение идентификатора ключа, которое [получили ранее](#create-key). - * В поле **{{ ui-key.yacloud.lockbox.forms.label_key }}** введите `secret`. - * В поле **{{ ui-key.yacloud.lockbox.forms.label_value }}** введите значение секретного ключа, которое [получили ранее](#create-key). + 1. Нажмите кнопку **{{ ui-key.yacloud.lockbox.forms.button_add-pair }}**. + 1. Добавьте значение секретного ключа: + + * В поле **{{ ui-key.yacloud.lockbox.forms.label_key }}** укажите: `secret`. + * В поле **{{ ui-key.yacloud.lockbox.forms.label_value }}** укажите значение секретного ключа, которое [получили ранее](#create-key). 1. Нажмите кнопку **{{ ui-key.yacloud.common.create }}**. @@ -294,8 +328,8 @@ ``` Результат: - - ``` + + ```text id: e6q2ad0j9b55******** folder_id: b1gktjk2rg49******** created_at: "2021-11-08T19:23:00.383Z" @@ -314,58 +348,58 @@ - {{ TF }} {#tf} 1. Опишите в конфигурационном файле параметры секрета: - - ```hcl - resource "yandex_lockbox_secret" "my_secret" { - name = "s3-static-key" - } - - resource "yandex_lockbox_secret_version" "my_version" { - secret_id = yandex_lockbox_secret.my_secret.id - entries { - key = "key_id" - text_value = "<идентификатор_ключа>" - } - entries { - key = "secret" - text_value = "<значение_секретного_ключа>" - } - } - ``` - - Где: - - * `name` — имя секрета. - * `key` — название ключа. - * `text_value` — значение ключа. - - {% include [secret-version-tf-note](../../_includes/lockbox/secret-version-tf-note.md) %} - - Более подробную информацию о параметрах используемых ресурсов в {{ TF }} см. в документации провайдера: - - * [yandex_lockbox_secret]({{ tf-provider-resources-link }}/lockbox_secret); - * [yandex_lockbox_secret_version]({{ tf-provider-resources-link }}/lockbox_secret_version). - + + ```hcl + resource "yandex_lockbox_secret" "my_secret" { + name = "s3-static-key" + } + + resource "yandex_lockbox_secret_version" "my_version" { + secret_id = yandex_lockbox_secret.my_secret.id + entries { + key = "key_id" + text_value = "<идентификатор_ключа>" + } + entries { + key = "secret" + text_value = "<значение_секретного_ключа>" + } + } + ``` + + Где: + + * `name` — имя секрета. + * `key` — название ключа. + * `text_value` — значение ключа. + + {% include [secret-version-tf-note](../../_includes/lockbox/secret-version-tf-note.md) %} + + Более подробную информацию о параметрах используемых ресурсов в {{ TF }} см. в документации провайдера: + + * [yandex_lockbox_secret]({{ tf-provider-resources-link }}/lockbox_secret); + * [yandex_lockbox_secret_version]({{ tf-provider-resources-link }}/lockbox_secret_version). + 1. Проверьте корректность конфигурационных файлов. - 1. В командной строке перейдите в папку, где вы создали конфигурационный файл. - 1. Выполните проверку с помощью команды: + 1. В командной строке перейдите в папку, где вы создали конфигурационный файл. + 1. Выполните проверку с помощью команды: - ```bash - terraform plan - ``` + ```bash + terraform plan + ``` - Если конфигурация описана верно, в терминале отобразится список создаваемых ресурсов и их параметров. Если в конфигурации есть ошибки, {{ TF }} на них укажет. + Если конфигурация описана верно, в терминале отобразится список создаваемых ресурсов и их параметров. Если в конфигурации есть ошибки, {{ TF }} на них укажет. 1. Разверните облачные ресурсы. - 1. Если в конфигурации нет ошибок, выполните команду: + 1. Если в конфигурации нет ошибок, выполните команду: - ```bash - terraform apply - ``` + ```bash + terraform apply + ``` - 1. Подтвердите создание секрета: введите в терминал слово `yes` и нажмите **Enter**. + 1. Подтвердите создание секрета: введите в терминал слово `yes` и нажмите **Enter**. - API {#api} @@ -373,9 +407,10 @@ {% endlist %} + ## Создайте бакеты {{ objstorage-name }} {#create-buckets} -Создайте два бакета: основной — где будут храниться файлы, резервный — куда будут копироваться файлы из основного бакета. +Создайте два бакета: основной — где будут храниться файлы, и резервный — куда будут копироваться файлы из основного бакета. {% list tabs group=instructions %} @@ -385,29 +420,33 @@ 1. В списке сервисов выберите **{{ ui-key.yacloud.iam.folder.dashboard.label_storage }}**. 1. Создайте основной бакет: - 1. Нажмите кнопку **{{ ui-key.yacloud.storage.buckets.button_create }}**. - 1. В поле **{{ ui-key.yacloud.storage.bucket.settings.field_name }}** укажите имя бакета. - 1. В полях **{{ ui-key.yacloud.storage.bucket.settings.field_access-read }}**, **{{ ui-key.yacloud.storage.bucket.settings.field_access-list }}** и **{{ ui-key.yacloud.storage.bucket.settings.field_access-config-read }}** выберите `{{ ui-key.yacloud.storage.bucket.settings.access_value_private }}`. - 1. Нажмите кнопку **{{ ui-key.yacloud.storage.buckets.create.button_create }}**. + 1. Нажмите кнопку **{{ ui-key.yacloud.storage.buckets.button_create }}**. + 1. В поле **{{ ui-key.yacloud.storage.bucket.settings.field_name }}** укажите имя для основного бакета. + 1. В полях **{{ ui-key.yacloud.storage.bucket.settings.field_access-read }}**, **{{ ui-key.yacloud.storage.bucket.settings.field_access-list }}** и **{{ ui-key.yacloud.storage.bucket.settings.field_access-config-read }}** выберите `{{ ui-key.yacloud.storage.bucket.settings.access_value_private }}`. + 1. Нажмите кнопку **{{ ui-key.yacloud.storage.buckets.create.button_create }}**. 1. Таким же образом создайте резервный бакет. - AWS CLI {#cli} - 1. Создайте основной бакет: + Если у вас еще нет интерфейса командной строки AWS CLI, [установите и сконфигурируйте его](../../storage/tools/aws-cli.md). - ```bash - aws --endpoint-url https://{{ s3-storage-host }} \ - s3 mb s3://<имя_основного_бакета> - ``` + Создайте основной и резервный бакеты: - Результат: + ```bash + aws --endpoint-url https://{{ s3-storage-host }} \ + s3 mb s3://<имя_основного_бакета> - ``` - make_bucket: s3://<имя_основного_бакета> - ``` + aws --endpoint-url https://{{ s3-storage-host }} \ + s3 mb s3://<имя_резервного_бакета> + ``` - 1. Таким же образом создайте резервный бакет. + Результат: + + ```text + make_bucket: <имя_основного_бакета> + make_bucket: <имя_резервного_бакета> + ``` - {{ TF }} {#tf} @@ -415,46 +454,46 @@ 1. Опишите в конфигурационном файле параметры для создания сервисного аккаунта и ключа доступа: - {% include [terraform-sa-key](../../_includes/storage/terraform-sa-key.md) %} + {% include [terraform-sa-key](../../_includes/storage/terraform-sa-key.md) %} 1. Опишите в конфигурационном файле параметры основного и резервного бакетов: - ``` - resource "yandex_storage_bucket" "main-bucket" { - access_key = yandex_iam_service_account_static_access_key.sa-static-key.access_key - secret_key = yandex_iam_service_account_static_access_key.sa-static-key.secret_key - bucket = "<имя_основного_бакета>" - } + ```hcl + resource "yandex_storage_bucket" "main-bucket" { + access_key = yandex_iam_service_account_static_access_key.sa-static-key.access_key + secret_key = yandex_iam_service_account_static_access_key.sa-static-key.secret_key + bucket = "<имя_основного_бакета>" + } - resource "yandex_storage_bucket" "reserve-bucket" { - access_key = yandex_iam_service_account_static_access_key.sa-static-key.access_key - secret_key = yandex_iam_service_account_static_access_key.sa-static-key.secret_key - bucket = "<имя_резервного_бакета>" - } - ``` + resource "yandex_storage_bucket" "reserve-bucket" { + access_key = yandex_iam_service_account_static_access_key.sa-static-key.access_key + secret_key = yandex_iam_service_account_static_access_key.sa-static-key.secret_key + bucket = "<имя_резервного_бакета>" + } + ``` - Подробнее о ресурсе `yandex_storage_bucket` см. в [документации]({{ tf-provider-resources-link }}/storage_bucket) провайдера {{ TF }}. + Подробнее о ресурсе `yandex_storage_bucket` см. в [документации]({{ tf-provider-resources-link }}/storage_bucket) провайдера {{ TF }}. 1. Проверьте корректность конфигурационных файлов. - 1. В командной строке перейдите в папку, где вы создали конфигурационный файл. - 1. Выполните проверку с помощью команды: + 1. В командной строке перейдите в папку, где вы создали конфигурационный файл. + 1. Выполните проверку с помощью команды: - ```bash - terraform plan - ``` + ```bash + terraform plan + ``` - Если конфигурация описана верно, в терминале отобразится список создаваемых ресурсов и их параметров. Если в конфигурации есть ошибки, {{ TF }} на них укажет. + Если конфигурация описана верно, в терминале отобразится список создаваемых ресурсов и их параметров. Если в конфигурации есть ошибки, {{ TF }} на них укажет. 1. Разверните облачные ресурсы. - 1. Если в конфигурации нет ошибок, выполните команду: + 1. Если в конфигурации нет ошибок, выполните команду: - ```bash - terraform apply - ``` + ```bash + terraform apply + ``` - 1. Подтвердите создание бакетов: введите в терминал слово `yes` и нажмите **Enter**. + 1. Подтвердите создание бакетов: введите в терминал слово `yes` и нажмите **Enter**. - API {#api} @@ -462,24 +501,26 @@ {% endlist %} + ## Подготовьте ZIP-архив с кодом функции {#create-zip} 1. Сохраните следующий код в файл с названием `handler.sh`: - ```bash - set -e - ( - cat | jq -c '.messages[]' | while read message; - do - SRC_BUCKET=$(echo "$message" | jq -r .details.bucket_id) - SRC_OBJECT=$(echo "$message" | jq -r .details.object_id) - aws --endpoint-url="$S3_ENDPOINT" s3 cp "s3://$SRC_BUCKET/$SRC_OBJECT" "s3://$DST_BUCKET/$SRC_OBJECT" - done; - ) 1>&2 - ``` + ```bash + set -e + ( + cat | jq -c '.messages[]' | while read message; + do + SRC_BUCKET=$(echo "$message" | jq -r .details.bucket_id) + SRC_OBJECT=$(echo "$message" | jq -r .details.object_id) + aws --endpoint-url="$S3_ENDPOINT" s3 cp "s3://$SRC_BUCKET/$SRC_OBJECT" "s3://$DST_BUCKET/$SRC_OBJECT" + done; + ) 1>&2 + ``` 1. Добавьте файл `handler.sh` в ZIP-архив `handler-sh.zip`. + ## Создайте функцию {#create-function} Создайте функцию, которая при добавлении нового [объекта](../../storage/concepts/object.md) в основной бакет будет копировать его в резервный бакет. @@ -492,185 +533,184 @@ 1. В списке сервисов выберите **{{ ui-key.yacloud.iam.folder.dashboard.label_serverless-functions }}** 1. Создайте функцию: - 1. Нажмите кнопку **{{ ui-key.yacloud.serverless-functions.list.button_create }}**. - 1. Введите имя функции — `copy-function`. - 1. Нажмите кнопку **{{ ui-key.yacloud.common.create }}**. - + 1. Нажмите кнопку **{{ ui-key.yacloud.serverless-functions.list.button_create }}**. + 1. Укажите имя функции — `copy-function`. + 1. Нажмите кнопку **{{ ui-key.yacloud.common.create }}**. + 1. Создайте версию функции: - 1. Выберите среду выполнения `Bash`, отключите опцию **{{ ui-key.yacloud.serverless-functions.item.editor.label_with-template }}** и нажмите кнопку **{{ ui-key.yacloud.serverless-functions.item.editor.button_action-continue }}**. - 1. Укажите способ загрузки `{{ ui-key.yacloud.serverless-functions.item.editor.value_method-zip-file }}` и выберите архив `handler-sh.zip`, который создали на предыдущем шаге. - 1. Укажите точку входа `handler.sh`. - 1. В блоке **{{ ui-key.yacloud.serverless-functions.item.editor.label_title-params }}** укажите: + 1. Выберите среду выполнения `Bash`, отключите опцию **{{ ui-key.yacloud.serverless-functions.item.editor.label_with-template }}** и нажмите кнопку **{{ ui-key.yacloud.serverless-functions.item.editor.button_action-continue }}**. + 1. Укажите способ загрузки `{{ ui-key.yacloud.serverless-functions.item.editor.value_method-zip-file }}` и выберите архив `handler-sh.zip`, который создали на предыдущем шаге. + 1. Укажите точку входа `handler.sh`. + 1. В блоке **{{ ui-key.yacloud.serverless-functions.item.editor.label_title-params }}** укажите: + + * **{{ ui-key.yacloud.serverless-functions.item.editor.field_timeout }}** — `600`. + * **{{ ui-key.yacloud.serverless-functions.item.editor.field_resources-memory }}** — `128 {{ ui-key.yacloud.common.units.label_megabyte }}`. + * **{{ ui-key.yacloud.forms.label_service-account-select }}** — `s3-copy-fn`. + * **{{ ui-key.yacloud.serverless-functions.item.editor.field_environment-variables }}**: - * **{{ ui-key.yacloud.serverless-functions.item.editor.field_timeout }}** — `600`. - * **{{ ui-key.yacloud.serverless-functions.item.editor.field_resources-memory }}** — `128 {{ ui-key.yacloud.common.units.label_megabyte }}`. - * **{{ ui-key.yacloud.forms.label_service-account-select }}** — `s3-copy-fn`. - * **{{ ui-key.yacloud.serverless-functions.item.editor.field_environment-variables }}**: + * `S3_ENDPOINT` — `https://{{ s3-storage-host }}`. + * `DST_BUCKET` — имя резервного бакета, в который нужно копировать объекты. - * `S3_ENDPOINT` — `https://{{ s3-storage-host }}`. - * `DST_BUCKET` — имя резервного бакета, в который нужно копировать объекты. + * **{{ ui-key.yacloud.serverless-functions.item.editor.label_lockbox-secret }}**: - * **{{ ui-key.yacloud.serverless-functions.item.editor.label_lockbox-secret }}**: + * `AWS_ACCESS_KEY_ID` — идентификатор секрета `s3-static-key`, идентификатор версии `latest`, ключ секрета `key_id`. + * `AWS_SECRET_ACCESS_KEY` — идентификатор секрета `s3-static-key`, идентификатор версии `latest`, ключ секрета `secret`. - * `AWS_ACCESS_KEY_ID` — ключ `key_id` секрета `s3-static-key`. - * `AWS_SECRET_ACCESS_KEY` — ключ `secret` секрета `s3-static-key`. - 1. Нажмите кнопку **{{ ui-key.yacloud.serverless-functions.item.editor.button_deploy-version }}**. - {{ yandex-cloud }} CLI {#cli} 1. Создайте функцию `copy-function`: - ```bash - yc serverless function create --name=copy-function - ``` + ```bash + yc serverless function create --name=copy-function + ``` - Результат: + Результат: - ``` - id: b09bhaokchn9******** - folder_id: aoek49ghmknn******** - created_at: "2023-03-21T10:03:37.475Z" - name: copy-function - log_group_id: eolm8aoq9vcp******** - http_invoke_url: https://{{ sf-url }}/b09bhaokchn9******** - status: ACTIVE - ``` + ```text + id: b09bhaokchn9******** + folder_id: <идентификатор_каталога> + created_at: "2024-10-21T20:40:03.451Z" + name: copy-function + http_invoke_url: https://{{ sf-url }}/b09bhaokchn9******** + status: ACTIVE + ``` 1. Создайте версию функции `copy-function`: - ```bash - yc serverless function version create \ - --function-name copy-function \ - --memory=128m \ - --execution-timeout=600s \ - --runtime=bash \ - --entrypoint=handler.sh \ - --service-account-id=<идентификатор_сервисного_аккаунта> \ - --environment DST_BUCKET=<имя_резервного_бакета> \ - --environment S3_ENDPOINT=https://{{ s3-storage-host }} \ - --secret name=s3-static-key,key=key_id,environment-variable=AWS_ACCESS_KEY_ID \ - --secret name=s3-static-key,key=secret,environment-variable=AWS_SECRET_ACCESS_KEY \ - --source-path=./handler-sh.zip - ``` - - Где: - - * `--function-name` — имя функции, версия которой создается. - * `--memory` — объем RAM. - * `--execution-timeout` — максимальное время выполнения функции до таймаута. - * `--runtime` — среда выполнения. - * `--entrypoint` — точка входа. - * `--service-account-id` — идентификатор сервисного аккаунта `s3-copy-fn`. - * `--environment` — переменные окружения. - * `--secret` — секрет, содержащий части статического ключа доступа. - * `--source-path` — путь до ZIP-архива `handler-sh.zip`. - - Результат: - - ``` - done (1s) - id: d4e6qqlh53nu******** - function_id: d4emc80mnp5n******** - created_at: "2023-03-22T16:49:41.800Z" - runtime: bash - entrypoint: handler.sh - resources: - memory: "134217728" - execution_timeout: 600s - service_account_id: aje20nhregkc******** - image_size: "4096" - status: ACTIVE - tags: - - $latest - log_group_id: ckgmc3l93cl0******** - environment: - DST_BUCKET: <имя_резервного_бакета> - S3_ENDPOINT: https://{{ s3-storage-host }} - secrets: - - id: e6q5qe9a1hgk******** - version_id: e6qrdn2e1acb******** - key: key_id - environment_variable: AWS_ACCESS_KEY_ID - - id: e6q5qe9a1hgk******** - version_id: e6qrdn2e1acb******** - key: secret - environment_variable: AWS_SECRET_ACCESS_KEY - log_options: - folder_id: b1g86q4m5vej******** - ``` + ```bash + yc serverless function version create \ + --function-name copy-function \ + --memory=128m \ + --execution-timeout=600s \ + --runtime=bash \ + --entrypoint=handler.sh \ + --service-account-id=<идентификатор_сервисного_аккаунта> \ + --environment DST_BUCKET=<имя_резервного_бакета> \ + --environment S3_ENDPOINT=https://{{ s3-storage-host }} \ + --secret name=s3-static-key,key=key_id,environment-variable=AWS_ACCESS_KEY_ID \ + --secret name=s3-static-key,key=secret,environment-variable=AWS_SECRET_ACCESS_KEY \ + --source-path=./handler-sh.zip + ``` + + Где: + + * `--function-name` — имя функции, версия которой создается. + * `--memory` — объем RAM. + * `--execution-timeout` — максимальное время выполнения функции до таймаута. + * `--runtime` — среда выполнения. + * `--entrypoint` — точка входа. + * `--service-account-id` — идентификатор сервисного аккаунта `s3-copy-fn`. + * `--environment` — переменные окружения. + * `--secret` — секрет, содержащий части статического ключа доступа. + * `--source-path` — путь до ZIP-архива `handler-sh.zip`. + + Результат: + + ```text + done (1s) + id: d4e394pt4nhf******** + function_id: d4efnkn79m7n******** + created_at: "2024-10-21T20:41:01.345Z" + runtime: bash + entrypoint: handler.sh + resources: + memory: "134217728" + execution_timeout: 600s + service_account_id: ajelprpohp7r******** + image_size: "4096" + status: ACTIVE + tags: + - $latest + environment: + DST_BUCKET: <имя_резервного_бакета> + S3_ENDPOINT: https://{{ s3-storage-host }} + secrets: + - id: e6qo2oprlmgn******** + version_id: e6q6i1qt0ae8******** + key: key_id + environment_variable: AWS_ACCESS_KEY_ID + - id: e6qo2oprlmgn******** + version_id: e6q6i1qt0ae8******** + key: secret + environment_variable: AWS_SECRET_ACCESS_KEY + log_options: + folder_id: b1g681qpemb4******** + concurrency: "1" + ``` - {{ TF }} {#tf} 1. Опишите в конфигурационном файле параметры функции: - ``` - resource "yandex_function" "copy-function" { - name = "copy-functionn" - user_hash = "first function" - runtime = "bash" - entrypoint = "handler.sh" - memory = "128" - execution_timeout = "600" - service_account_id = "aje20nhregkcvu******" - environment = { - DST_BUCKET = "<имя_резервного_бакета>" - S3_ENDPOINT = "https://{{ s3-storage-host }}" - } - secrets = { - id = "e6q5qe9a1hgk1a******" - version_id = "e6qrdn2e1acb7e******" - key = "key_id" - environment_variable = "AWS_ACCESS_KEY_ID" - } - secrets = { - id = "e6q5qe9a1hgk1a******" - version_id = "e6qrdn2e1acb7e******" - key = "secret" - environment_variable = "AWS_SECRET_ACCESS_KEY" - } - content { - zip_filename = "./handler-sh.zip" - } - } - ``` - - Где: - - * `name` — имя функции. - * `user_hash` — произвольная строка, определяющая версию функции. - * `runtime` — [среда выполнения](../../functions/concepts/runtime/index.md) функции. - * `entrypoint` — точка входа. - * `memory` — объем памяти в мегабайтах, отведенный для выполнения функции. - * `execution_timeout` — таймаут выполнения функции. - * `service_account_id` — идентификатор сервисного аккаунта `s3-copy-fn`. - * `environment` — переменные окружения. - * `secrets` — секрет, содержащий части статического ключа доступа. - * `content` — путь до ZIP-архива `handler-sh.zip` c исходным кодом функции. - - Более подробную информацию о параметрах ресурса `yandex_function` см. в [документации провайдера]({{ tf-provider-resources-link }}/function). + ```hcl + resource "yandex_function" "copy-function" { + name = "copy-functionn" + user_hash = "first function" + runtime = "bash" + entrypoint = "handler.sh" + memory = "128" + execution_timeout = "600" + service_account_id = "<идентификатор_сервисного_аккаунта>" + environment = { + DST_BUCKET = "<имя_резервного_бакета>" + S3_ENDPOINT = "https://{{ s3-storage-host }}" + } + secrets = { + id = "<идентификатор_секрета>" + version_id = "<идентификатор_версии_секрета>" + key = "key_id" + environment_variable = "AWS_ACCESS_KEY_ID" + } + secrets = { + id = "<идентификатор_секрета>" + version_id = "<идентификатор_версии_секрета>" + key = "secret" + environment_variable = "AWS_SECRET_ACCESS_KEY" + } + content { + zip_filename = "./handler-sh.zip" + } + } + ``` + + Где: + + * `name` — имя функции. + * `user_hash` — произвольная строка, определяющая версию функции. + * `runtime` — [среда выполнения](../../functions/concepts/runtime/index.md) функции. + * `entrypoint` — точка входа. + * `memory` — объем памяти в мегабайтах, отведенный для выполнения функции. + * `execution_timeout` — таймаут выполнения функции. + * `service_account_id` — идентификатор сервисного аккаунта `s3-copy-fn`. + * `environment` — переменные окружения. + * `secrets` — секрет, содержащий части статического ключа доступа. + * `content` — путь до ZIP-архива `handler-sh.zip` c исходным кодом функции. + + Более подробную информацию о параметрах ресурса `yandex_function` см. в [документации провайдера]({{ tf-provider-resources-link }}/function). 1. Проверьте корректность конфигурационных файлов. - 1. В командной строке перейдите в папку, где вы создали конфигурационный файл. - 1. Выполните проверку с помощью команды: + 1. В командной строке перейдите в папку, где вы создали конфигурационный файл. + 1. Выполните проверку с помощью команды: - ```bash - terraform plan - ``` + ```bash + terraform plan + ``` - Если конфигурация описана верно, в терминале отобразится список создаваемых ресурсов и их параметров. Если в конфигурации есть ошибки, {{ TF }} на них укажет. + Если конфигурация описана верно, в терминале отобразится список создаваемых ресурсов и их параметров. Если в конфигурации есть ошибки, {{ TF }} на них укажет. 1. Разверните облачные ресурсы. - 1. Если в конфигурации нет ошибок, выполните команду: + 1. Если в конфигурации нет ошибок, выполните команду: - ```bash - terraform apply - ``` + ```bash + terraform apply + ``` - 1. Подтвердите создание функции: введите в терминал слово `yes` и нажмите **Enter**. + 1. Подтвердите создание функции: введите в терминал слово `yes` и нажмите **Enter**. - API {#api} @@ -680,6 +720,7 @@ {% endlist %} + ## Создайте триггер {#create-trigger} Создайте триггер для {{ objstorage-name }}, который будет вызывать функцию `copy-function` при создании нового объекта в основном бакете. @@ -694,19 +735,19 @@ 1. Нажмите кнопку **{{ ui-key.yacloud.serverless-functions.triggers.list.button_create }}**. 1. В блоке **{{ ui-key.yacloud.serverless-functions.triggers.form.section_base }}**: - * Введите имя триггера: `bucket-to-bucket-copying`. - * В поле **{{ ui-key.yacloud.serverless-functions.triggers.form.field_type }}** выберите **{{ ui-key.yacloud.serverless-functions.triggers.form.label_storage }}**. - * В поле **{{ ui-key.yacloud.serverless-functions.triggers.form.field_invoke }}** выберите **{{ ui-key.yacloud.serverless-functions.triggers.form.label_function }}**. + * Укажите имя триггера: `bucket-to-bucket-copying`. + * В поле **{{ ui-key.yacloud.serverless-functions.triggers.form.field_type }}** выберите `{{ ui-key.yacloud.serverless-functions.triggers.form.label_storage }}`. + * В поле **{{ ui-key.yacloud.serverless-functions.triggers.form.field_invoke }}** выберите `{{ ui-key.yacloud.serverless-functions.triggers.form.label_function }}`. 1. В блоке **{{ ui-key.yacloud.serverless-functions.triggers.form.section_storage }}**: - * В поле **{{ ui-key.yacloud.serverless-functions.triggers.form.field_bucket }}** выберите основной бакет. - * В поле **{{ ui-key.yacloud.serverless-functions.triggers.form.field_event-types }}** выберите `{{ ui-key.yacloud.serverless-functions.triggers.form.value_event-type-create-object}}`. + * В поле **{{ ui-key.yacloud.serverless-functions.triggers.form.field_bucket }}** выберите основной бакет. + * В поле **{{ ui-key.yacloud.serverless-functions.triggers.form.field_event-types }}** выберите `{{ ui-key.yacloud.serverless-functions.triggers.form.value_event-type-create-object}}`. 1. В блоке **{{ ui-key.yacloud.serverless-functions.triggers.form.section_function }}**: - * В поле **{{ ui-key.yacloud.serverless-functions.triggers.form.field_function }}** выберите функцию `copy-function`. - * В поле **{{ ui-key.yacloud.serverless-functions.triggers.form.field_function_service-account }}** выберите сервисный аккаунт `s3-copy-trigger`. + * В поле **{{ ui-key.yacloud.serverless-functions.triggers.form.field_function }}** выберите функцию `copy-function`. + * В поле **{{ ui-key.yacloud.serverless-functions.triggers.form.field_function_service-account }}** выберите сервисный аккаунт `s3-copy-trigger`. 1. Нажмите кнопку **{{ ui-key.yacloud.serverless-functions.triggers.form.button_create-trigger }}**. @@ -717,7 +758,7 @@ ```bash yc serverless trigger create object-storage \ --name bucket-to-bucket-copying \ - --bucket-id <идентификатор_бакета> \ + --bucket-id <имя_основного_бакета> \ --events 'create-object' \ --invoke-function-name copy-function \ --invoke-function-service-account-name s3-copy-trigger @@ -726,7 +767,7 @@ Где: * `--name` — имя триггера. - * `--bucket-id` — идентификатор основного бакета. + * `--bucket-id` — имя основного бакета. * `--events` — [события](../../functions/concepts/trigger/os-trigger.md#event), после наступления которых триггер запускается. * `--invoke-function-name` — имя вызываемой функции. * `--invoke-function-service-account-name` — имя сервисного аккаунта, от имени которого будет вызываться функция. @@ -736,13 +777,16 @@ ```text id: a1s92agr8mpg******** folder_id: b1g88tflru0e******** - created_at: "2023-03-22T09:47:50.079103Z" + created_at: "2024-10-21T21:04:01.866959640Z" name: bucket-to-bucket-copying rule: object_storage: event_type: - - OBJECT_STORAGE_EVENT_TYPE_CREATE_OBJECT + - OBJECT_STORAGE_EVENT_TYPE_CREATE_OBJECT bucket_id: <имя_основного_бакета> + batch_settings: + size: "1" + cutoff: 1s invoke_function: function_id: d4eofc7n0m03******** function_tag: $latest @@ -754,52 +798,52 @@ 1. Опишите в конфигурационном файле параметры триггера: - ```hcl - resource "yandex_function_trigger" "my_trigger" { - name = "bucket-to-bucket-copying" - object_storage { - bucket_id = "<идентификатор_бакета>" - create = true - } - function { - id = "<идентификатор_функции>" - service_account_id = "<идентификатор_сервисного_аккаунта>" - } - } - ``` - - Где: - - * `name` — имя триггера. - * `object_storage` — параметры хранилища: - * `bucket_id` — идентификатор бакета. - * `create` — триггер вызовет функцию при создании нового объекта в хранилище. - * `function` — настройки функции, которую будет запускать триггер: - * `id` — идентификатор функции `copy-function`. - * `service_account_id` — идентификатор сервисного аккаунта `s3-copy-trigger`. - - Более подробную информацию о параметрах ресурсов в {{ TF }} см. в [документации провайдера]({{ tf-provider-resources-link }}/function_trigger). + ```hcl + resource "yandex_function_trigger" "my_trigger" { + name = "bucket-to-bucket-copying" + object_storage { + bucket_id = "<имя_основного_бакета>" + create = true + } + function { + id = "<идентификатор_функции>" + service_account_id = "<идентификатор_сервисного_аккаунта>" + } + } + ``` + + Где: + + * `name` — имя триггера. + * `object_storage` — параметры хранилища: + * `bucket_id` — имя основного бакета. + * `create` — триггер вызовет функцию при создании нового объекта в хранилище. + * `function` — настройки функции, которую будет запускать триггер: + * `id` — идентификатор функции `copy-function`. + * `service_account_id` — идентификатор сервисного аккаунта `s3-copy-trigger`. + + Более подробную информацию о параметрах ресурсов в {{ TF }} см. в [документации провайдера]({{ tf-provider-resources-link }}/function_trigger). 1. Проверьте корректность конфигурационных файлов. - 1. В командной строке перейдите в папку, где вы создали конфигурационный файл. - 1. Выполните проверку с помощью команды: + 1. В командной строке перейдите в папку, где вы создали конфигурационный файл. + 1. Выполните проверку с помощью команды: - ```bash - terraform plan - ``` + ```bash + terraform plan + ``` - Если конфигурация описана верно, в терминале отобразится список создаваемых ресурсов и их параметров. Если в конфигурации есть ошибки, {{ TF }} на них укажет. + Если конфигурация описана верно, в терминале отобразится список создаваемых ресурсов и их параметров. Если в конфигурации есть ошибки, {{ TF }} на них укажет. 1. Разверните облачные ресурсы. - 1. Если в конфигурации нет ошибок, выполните команду: + 1. Если в конфигурации нет ошибок, выполните команду: - ```bash - terraform apply - ``` + ```bash + terraform apply + ``` - 1. Подтвердите создание триггера: введите в терминал слово `yes` и нажмите **Enter**. + 1. Подтвердите создание триггера: введите в терминал слово `yes` и нажмите **Enter**. - API {#api} @@ -807,6 +851,7 @@ {% endlist %} + ## Протестируйте функцию {#test-function} {% list tabs group=instructions %} @@ -827,6 +872,7 @@ ## Как удалить созданные ресурсы {#clear-out} + Чтобы перестать платить за созданные ресурсы: 1. [Удалите](../../storage/operations/objects/delete-all.md) объекты из бакетов. diff --git a/ru/_tutorials/tracker/tracker-cloud-function.md b/ru/_tutorials/tracker/tracker-cloud-function.md index 081f5824669..a73f8ee8c65 100644 --- a/ru/_tutorials/tracker/tracker-cloud-function.md +++ b/ru/_tutorials/tracker/tracker-cloud-function.md @@ -56,8 +56,8 @@ 1. Перейдите в [{{ tracker-name }}](https://tracker.yandex.ru/). Нажмите кнопку **Войти в Tracker**. 1. На правой панели нажмите кнопку **Администрирование**. -1. В разделе **{{ ui-key.startrek.ui_components_page-admin_PageAdmin.access-and-payment }}** нажмите **{{ ui-key.startrek.ui_components_page-admin_PageAdmin.menu-item-orgs }}**. -1. В блоке **{{ ui-key.startrek.ui_components_page-admin_OrgPanes_DirectoryOrgPane.source-title }}** скопируйте и сохраните идентификатор организации — он понадобится при создании функции. +1. В разделе **{{ ui-key.startrek.ui_Common_smart-components_page-admin_PageAdmin.access-and-payment }}** нажмите **{{ ui-key.startrek.ui_Common_smart-components_page-admin_PageAdmin.menu-item-orgs }}**. +1. В блоке **{{ ui-key.startrek.ui_Common_smart-components_page-admin_OrgPanes_DirectoryOrgPane.source-title }}** скопируйте и сохраните идентификатор организации — он понадобится при создании функции. ## Создайте функцию {{ sf-name }} {#create-function} @@ -87,17 +87,17 @@ ### Создайте очередь -1. На панели слева выберите ![](../../_assets/console-icons/layers-3-diagonal.svg) **{{ ui-key.startrek.ui_components_TrackerSearch.queues }}** → **Создать очередь**. +1. На панели слева выберите ![](../../_assets/console-icons/layers-3-diagonal.svg) **{{ ui-key.startrek.ui_Common_smart-components_TrackerSearch.queues }}** → **Создать очередь**. 1. Выберите шаблон очереди, например **Базовая разработка**. 1. Задайте имя, например `Function Test`. 1. Нажмите кнопку **Создать**. ### Создайте триггер -1. На странице очереди в правом верхнем углу нажмите ![](../../_assets/console-icons/gear.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. На странице очереди в правом верхнем углу нажмите ![](../../_assets/console-icons/gear.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. На панели слева выберите **Автоматизация** → **Триггеры** и нажмите кнопку **Создать триггер**. 1. В поле **Название** введите название триггера, например `timeupdater`. -1. В блоке **Условия срабатывания** выберите **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** → **Затрачено времени**. +1. В блоке **Условия срабатывания** выберите **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** → **Затрачено времени**. 1. В блоке **Действия триггера** выберите **HTTP-запрос**. 1. В открывшейся форме в поле **Адрес** введите: ``` @@ -119,14 +119,14 @@ 1. В открывшейся форме в поле **Название задачи** введите название задачи, например `Parent Task`. 1. Нажмите кнопку **Создать**. 1. Создайте подзадачи: - 1. На странице задачи `Parent Task` в правом верхнем углу в меню **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.title }}** выберите **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.create-subissue }}**. + 1. На странице задачи `Parent Task` в правом верхнем углу в меню **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.title }}** выберите **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.create-subissue }}**. 1. В открывшейся форме в поле **Название задачи** введите название подзадачи, например `Subtask-1`. 1. Аналогичным образом создайте еще одну или несколько подзадач с названиями `Subtask-2`, `Subtask-3` и т. д. ### Внесите данные о затраченном времени в подзадачах -1. На странице подзадачи `Subtask-1` в правом верхнем углу в меню **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.title }}** выберите **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.add-worklog }}**. -1. В открывшемся диалоге в поле **{{ ui-key.startrek.ui_components_issue-actions_worklog_AddWorklogDialog.duration-label }}** укажите любое время, например `1h25m`. +1. На странице подзадачи `Subtask-1` в правом верхнем углу в меню **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.title }}** выберите **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.add-worklog }}**. +1. В открывшемся диалоге в поле **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_worklog_AddWorklogDialog.duration-label }}** укажите любое время, например `1h25m`. 1. Аналогичным образом добавьте затраченное время в других подзадачах. ### Убедитесь в корректной работе функции diff --git a/ru/_tutorials/windows/active-directory.md b/ru/_tutorials/windows/active-directory.md index 2c05dda6f73..beb8586d62f 100644 --- a/ru/_tutorials/windows/active-directory.md +++ b/ru/_tutorials/windows/active-directory.md @@ -133,7 +133,14 @@ Get-LocalUser | Where-Object SID -like *-500 | Set-LocalUser -Password (ConvertT 1. На странице каталога в [консоли управления]({{ link-console-main }}) нажмите кнопку **Создать ресурс** и выберите **Виртуальная машина**. 1. В поле **Имя** введите имя ВМ: `ad-vm-a`. 1. Выберите зону доступности `{{ region-id }}-a`. - 1. В блоке **Выбор образа/загрузочного диска** → **{{ marketplace-name }}** нажмите кнопку **Посмотреть больше**. В открывшемся окне выберите образ [Windows Server 2022 Datacenter](/marketplace/products/yc/windows-server-2022-datacenter) и нажмите **Использовать**. + 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_image }}**: + + * Перейдите на вкладку **{{ ui-key.yacloud.compute.instances.create.image_value_custom_new }}**. + * Нажмите кнопку **{{ ui-key.yacloud.common.select }}** и в открывшемся окне выберите **{{ ui-key.yacloud.common.create-new }}**. + * В поле **{{ ui-key.yacloud.compute.instances.create-disk.field_source }}** выберите `{{ ui-key.yacloud.compute.instances.create-disk.value_source-image }}` и в списке ниже выберите образ **Windows Server 2022 Datacenter**. Как загрузить свой образ для продуктов Microsoft подробнее см. в разделе [Импортировать нужный образ](../../microsoft/byol.md#how-to-import). + * (Опционально) В поле **{{ ui-key.yacloud.compute.field_additional }}** включите опцию **{{ ui-key.yacloud.compute.field_disk-autodelete }}**, если вы хотите автоматически удалять этот диск при удалении ВМ. + * Нажмите кнопку **{{ ui-key.yacloud.compute.component.instance-storage-dialog.button_add-disk }}**. + 1. В блоке **Диски** укажите размер загрузочного [диска](../../compute/concepts/disk.md) 50 ГБ. 1. В блоке **Вычислительные ресурсы**: * Выберите [платформу](../../compute/concepts/vm-platforms.md) **Intel Ice Lake**. @@ -188,7 +195,14 @@ Get-LocalUser | Where-Object SID -like *-500 | Set-LocalUser -Password (ConvertT 1. На странице каталога в [консоли управления]({{ link-console-main }}) нажмите кнопку **Создать ресурс** и выберите **Виртуальная машина**. 1. В поле **Имя** введите имя ВМ: `jump-server-vm`. 1. Выберите зону доступности `{{ region-id }}-d`. - 1. В блоке **Выбор образа/загрузочного диска** → **{{ marketplace-name }}** нажмите кнопку **Посмотреть больше**. В открывшемся окне выберите образ [Windows Server 2022 Datacenter](/marketplace/products/yc/windows-server-2022-datacenter) и нажмите **Использовать**. + 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_image }}**: + + * Перейдите на вкладку **{{ ui-key.yacloud.compute.instances.create.image_value_custom_new }}**. + * Нажмите кнопку **{{ ui-key.yacloud.common.select }}** и в открывшемся окне выберите **{{ ui-key.yacloud.common.create-new }}**. + * В поле **{{ ui-key.yacloud.compute.instances.create-disk.field_source }}** выберите `{{ ui-key.yacloud.compute.instances.create-disk.value_source-image }}` и в списке ниже выберите образ **Windows Server 2022 Datacenter**. Как загрузить свой образ для продуктов Microsoft подробнее см. в разделе [Импортировать нужный образ](../../microsoft/byol.md#how-to-import). + * (Опционально) В поле **{{ ui-key.yacloud.compute.field_additional }}** включите опцию **{{ ui-key.yacloud.compute.field_disk-autodelete }}**, если вы хотите автоматически удалять этот диск при удалении ВМ. + * Нажмите кнопку **{{ ui-key.yacloud.compute.component.instance-storage-dialog.button_add-disk }}**. + 1. В блоке **Диски** укажите размер загрузочного диска 50 ГБ. 1. В блоке **Вычислительные ресурсы**: * Выберите платформу : Intel Ice Lake. @@ -375,4 +389,4 @@ Get-LocalUser | Where-Object SID -like *-500 | Set-LocalUser -Password (ConvertT ## Как удалить созданные ресурсы {#clear-out} -Чтобы перестать платить за развернутые серверы, достаточно удалить все созданные [ВМ](../../compute/operations/vm-control/vm-delete.md). \ No newline at end of file +Чтобы перестать платить за развернутые серверы, достаточно удалить все созданные [ВМ](../../compute/operations/vm-control/vm-delete.md). diff --git a/ru/_tutorials/windows/exchange.md b/ru/_tutorials/windows/exchange.md index c86878ab9e3..7c5f4c95200 100644 --- a/ru/_tutorials/windows/exchange.md +++ b/ru/_tutorials/windows/exchange.md @@ -138,7 +138,14 @@ Get-LocalUser | Where-Object SID -like *-500 | Set-LocalUser -Password (ConvertT 1. На странице каталога в [консоли управления]({{ link-console-main }}) нажмите кнопку **Создать ресурс** и выберите **Виртуальная машина**. 1. В поле **Имя** введите имя виртуальной машины: `ad-vm-a`. 1. Выберите [зону доступности](../../overview/concepts/geo-scope.md) `{{ region-id }}-a`. - 1. В блоке **Выбор образа/загрузочного диска** на вкладке **{{ marketplace-name }}** выберите образ [Windows Server 2016 Datacenter](/marketplace/products/yc/windows-server-2016-datacenter). + 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_image }}**: + + * Перейдите на вкладку **{{ ui-key.yacloud.compute.instances.create.image_value_custom_new }}**. + * Нажмите кнопку **{{ ui-key.yacloud.common.select }}** и в открывшемся окне выберите **{{ ui-key.yacloud.common.create-new }}**. + * В поле **{{ ui-key.yacloud.compute.instances.create-disk.field_source }}** выберите `{{ ui-key.yacloud.compute.instances.create-disk.value_source-image }}` и в списке ниже выберите образ **Windows Server 2016 Datacenter**. Как загрузить свой образ для продуктов Microsoft подробнее см. в разделе [Импортировать нужный образ](../../microsoft/byol.md#how-to-import). + * (Опционально) В поле **{{ ui-key.yacloud.compute.field_additional }}** включите опцию **{{ ui-key.yacloud.compute.field_disk-autodelete }}**, если вы хотите автоматически удалять этот диск при удалении ВМ. + * Нажмите кнопку **{{ ui-key.yacloud.compute.component.instance-storage-dialog.button_add-disk }}**. + 1. В блоке **Диски** укажите размер загрузочного диска 50 ГБ. 1. В блоке **Вычислительные ресурсы**: * Выберите [платформу](../../compute/concepts/vm-platforms.md): Intel Ice Lake. @@ -191,7 +198,14 @@ Get-LocalUser | Where-Object SID -like *-500 | Set-LocalUser -Password (ConvertT 1. На странице каталога в [консоли управления]({{ link-console-main }}) нажмите кнопку **Создать ресурс** и выберите **Виртуальная машина**. 1. В поле **Имя** введите имя виртуальной машины: `fsw-vm`. 1. Выберите [зону доступности](../../overview/concepts/geo-scope.md) `{{ region-id }}-d`. - 1. В блоке **Выбор образа/загрузочного диска** на вкладке **{{ marketplace-name }}** выберите образ [Windows Server 2016 Datacenter](/marketplace/products/yc/windows-server-2016-datacenter). + 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_image }}**: + + * Перейдите на вкладку **{{ ui-key.yacloud.compute.instances.create.image_value_custom_new }}**. + * Нажмите кнопку **{{ ui-key.yacloud.common.select }}** и в открывшемся окне выберите **{{ ui-key.yacloud.common.create-new }}**. + * В поле **{{ ui-key.yacloud.compute.instances.create-disk.field_source }}** выберите `{{ ui-key.yacloud.compute.instances.create-disk.value_source-image }}` и в списке ниже выберите образ **Windows Server 2016 Datacenter**. Как загрузить свой образ для продуктов Microsoft подробнее см. в разделе [Импортировать нужный образ](../../microsoft/byol.md#how-to-import). + * (Опционально) В поле **{{ ui-key.yacloud.compute.field_additional }}** включите опцию **{{ ui-key.yacloud.compute.field_disk-autodelete }}**, если вы хотите автоматически удалять этот диск при удалении ВМ. + * Нажмите кнопку **{{ ui-key.yacloud.compute.component.instance-storage-dialog.button_add-disk }}**. + 1. В блоке **Диски** укажите размер загрузочного диска 50 ГБ. 1. В блоке **Вычислительные ресурсы**: * Выберите [платформу](../../compute/concepts/vm-platforms.md): Intel Ice Lake. diff --git a/ru/_tutorials/windows/rds-gw.md b/ru/_tutorials/windows/rds-gw.md index 3aef3daed39..526bd60b7e2 100644 --- a/ru/_tutorials/windows/rds-gw.md +++ b/ru/_tutorials/windows/rds-gw.md @@ -202,7 +202,14 @@ Remote Desktop Gateway (RDGW) — сервис Windows Server для досту 1. На странице каталога в [консоли управления]({{ link-console-main }}) нажмите кнопку **Создать ресурс** и выберите **Виртуальная машина**. 1. В поле **Имя** введите имя виртуальной машины: `my-rds-gw`. 1. Выберите [зону доступности](../../overview/concepts/geo-scope.md) `{{ region-id }}-a`. - 1. В блоке **Выбор образа/загрузочного диска** перейдите на вкладку **{{ marketplace-name }}** и нажмите кнопку **Посмотреть больше**. В открывшемся окне выберите образ [Windows Server 2022 Datacenter](/marketplace/products/yc/windows-server-2022-datacenter). + 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_image }}**: + + * Перейдите на вкладку **{{ ui-key.yacloud.compute.instances.create.image_value_custom_new }}**. + * Нажмите кнопку **{{ ui-key.yacloud.common.select }}** и в открывшемся окне выберите **{{ ui-key.yacloud.common.create-new }}**. + * В поле **{{ ui-key.yacloud.compute.instances.create-disk.field_source }}** выберите `{{ ui-key.yacloud.compute.instances.create-disk.value_source-image }}` и в списке ниже выберите образ **Windows Server 2022 Datacenter**. Как загрузить свой образ для продуктов Microsoft подробнее см. в разделе [Импортировать нужный образ](../../microsoft/byol.md#how-to-import). + * (Опционально) В поле **{{ ui-key.yacloud.compute.field_additional }}** включите опцию **{{ ui-key.yacloud.compute.field_disk-autodelete }}**, если вы хотите автоматически удалять этот диск при удалении ВМ. + * Нажмите кнопку **{{ ui-key.yacloud.compute.component.instance-storage-dialog.button_add-disk }}**. + 1. В блоке **Диски** укажите размер загрузочного диска 60 ГБ. 1. В блоке **Вычислительные ресурсы**: * Выберите [платформу](../../compute/concepts/vm-platforms.md): Intel Ice Lake. @@ -393,7 +400,14 @@ Remote Desktop Gateway (RDGW) — сервис Windows Server для досту 1. На странице каталога в [консоли управления]({{ link-console-main }}) нажмите кнопку **Создать ресурс** и выберите **Виртуальная машина**. 1. В поле **Имя** введите имя виртуальной машины: `test-vm`. 1. Выберите [зону доступности](../../overview/concepts/geo-scope.md) `{{ region-id }}-a`. - 1. В блоке **Выбор образа/загрузочного диска** перейдите на вкладку **{{ marketplace-name }}** и нажмите кнопку **Посмотреть больше**. В открывшемся окне выберите образ [Windows Server 2022 Datacenter](/marketplace/products/yc/windows-server-2022-datacenter). + 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_image }}**: + + * Перейдите на вкладку **{{ ui-key.yacloud.compute.instances.create.image_value_custom_new }}**. + * Нажмите кнопку **{{ ui-key.yacloud.common.select }}** и в открывшемся окне выберите **{{ ui-key.yacloud.common.create-new }}**. + * В поле **{{ ui-key.yacloud.compute.instances.create-disk.field_source }}** выберите `{{ ui-key.yacloud.compute.instances.create-disk.value_source-image }}` и в списке ниже выберите образ **Windows Server 2022 Datacenter**. Как загрузить свой образ для продуктов Microsoft подробнее см. в разделе [Импортировать нужный образ](../../microsoft/byol.md#how-to-import). + * (Опционально) В поле **{{ ui-key.yacloud.compute.field_additional }}** включите опцию **{{ ui-key.yacloud.compute.field_disk-autodelete }}**, если вы хотите автоматически удалять этот диск при удалении ВМ. + * Нажмите кнопку **{{ ui-key.yacloud.compute.component.instance-storage-dialog.button_add-disk }}**. + 1. В блоке **Диски** укажите размер загрузочного диска 60 ГБ. 1. В блоке **Вычислительные ресурсы**: * Выберите [платформу](../../compute/concepts/vm-platforms.md): Intel Ice Lake. @@ -474,4 +488,4 @@ Remote Desktop Gateway (RDGW) — сервис Windows Server для досту ## Как удалить созданные ресурсы {#clear-out} -Если вам больше не нужны созданные ресурсы, удалите [виртуальные машины](../../compute/operations/vm-control/vm-delete.md) и [сети](../../vpc/operations/network-delete.md). \ No newline at end of file +Если вам больше не нужны созданные ресурсы, удалите [виртуальные машины](../../compute/operations/vm-control/vm-delete.md) и [сети](../../vpc/operations/network-delete.md). diff --git a/ru/_tutorials/windows/secure-password-script.md b/ru/_tutorials/windows/secure-password-script.md new file mode 100644 index 00000000000..e02b05dad8c --- /dev/null +++ b/ru/_tutorials/windows/secure-password-script.md @@ -0,0 +1,451 @@ +# Безопасная передача пароля в скрипт инициализации + +При создании виртуальной машины из образа с операционной системой Windows вы можете использовать скрипт инициализации. Например, в скрипте можно задать логин и пароль администратора и других пользователей системы. Чтобы защитить чувствительные данные, вместо явного указания в скрипте используйте возможности сервиса {{ lockbox-name }}. + +В данном руководстве вы создадите ВМ с ОС Windows используя скрипт инициализации, в котором логины и пароли пользователей системы будут получены из сервиса {{ lockbox-name }}. + +Чтобы создать ВМ и защитить конфиденциальную информацию в скрипте инициализации: + +1. [Создайте сервисный аккаунт](#create-account) +1. [Создайте ключ {{ kms-short-name }}](#create-key) +1. [Создайте секрет](#create-secret) +1. [Создайте ВМ](#create-vm) +1. [Авторизуйтесь в ОС Windows](#login-windows) + +Если созданные ресурсы вам больше не нужны, [удалите их](#clear-out). + +## Перед началом работы {#before-you-begin} + +{% include [before-you-begin](../../_tutorials/_tutorials_includes/before-you-begin.md) %} + +### Необходимые платные ресурсы {#paid-resources} + +В стоимость поддержки инфраструктуры входит: + +* плата за ВМ (см. [тарифы {{ compute-full-name }}](../../compute/pricing.md)); +* плата за использование образа (зависит от образа); +* плата за использование ключа {{ kms-short-name }} (см. [тарифы {{ kms-short-name }}](../../kms/pricing.md)); +* плата за использование секрета (см. [тарифы {{ lockbox-name }}](../../lockbox/pricing.md)). + +## Создайте сервисный аккаунт {#create-account} + +{% list tabs group=instructions %} + +- Консоль управления {#console} + + 1. В [консоли управления]({{ link-console-main }}) выберите каталог, в котором хотите создать сервисный аккаунт. + 1. В списке сервисов выберите **{{ ui-key.yacloud.iam.folder.dashboard.label_iam }}**. + 1. Нажмите кнопку **{{ ui-key.yacloud.iam.folder.service-accounts.button_add }}**. + 1. Введите имя сервисного аккаунта, например, `win-secret-sa`. + 1. Нажмите кнопку **{{ ui-key.yacloud.iam.folder.service-account.popup-robot_button_add }}**. + +- CLI {#cli} + + {% include [default-catalogue](../../_includes/default-catalogue.md) %} + + Выполните команду для создания сервисного аккаунта, указав имя `win-secret-sa`: + + ```bash + yc iam service-account create --name win-secret-sa + ``` + + Где `name` — имя сервисного аккаунта. + + Результат: + + ```text + id: ajehr0to1g8b******** + folder_id: b1gv87ssvu49******** + created_at: "2024-03-15T09:03:11.665153755Z" + name: win-secret-sa + ``` + +- API {#api} + + Чтобы создать сервисный аккаунт, воспользуйтесь вызовом gRPC API [ServiceAccountService/Create](../../iam/api-ref/grpc/ServiceAccount/create.md) или методом [create](../../iam/api-ref/ServiceAccount/create.md) для ресурса `ServiceAccount` REST API. + +{% endlist %} + +## Создайте ключ {{ kms-short-name }} {#create-key} + +1. Создайте [ключ шифрования](../../kms/concepts/key.md): + + {% list tabs group=instructions %} + + - Консоль управления {#console} + + 1. В [консоли управления]({{ link-console-main }}) выберите [каталог](../../resource-manager/concepts/resources-hierarchy.md#folder), в котором будет создан ключ. + 1. Выберите сервис **{{ ui-key.yacloud.iam.folder.dashboard.label_kms }}**. + 1. На панели слева выберите ![image](../../_assets/console-icons/key.svg) **{{ ui-key.yacloud.kms.switch_symmetric-keys }}**. + 1. Нажмите **{{ ui-key.yacloud.kms.symmetric-keys.button_empty-create }}** и задайте атрибуты ключа: + * **{{ ui-key.yacloud.common.name }}** — `win-secret-key`. + * **{{ ui-key.yacloud.kms.symmetric-key.form.field_algorithm }}** — `AES-256`. + * Для остальных параметров оставьте значения по умолчанию. + 1. Нажмите **{{ ui-key.yacloud.common.create }}**. + + Вместе с ключом создается его первая версия: кликните ключ в списке, чтобы открыть страницу с его атрибутами. + + - CLI {#cli} + + Выполните команду: + + ```bash + yc kms symmetric-key create \ + --name win-secret-key \ + --default-algorithm aes-256 + ``` + + Где: + + * `--name` — имя ключа. + * `--default-algorithm` — алгоритм шифрования: `aes-128`, `aes-192` или `aes-256`. + + - {{ TF }} {#tf} + + {% include [terraform-definition](../../_tutorials/_tutorials_includes/terraform-definition.md) %} + + {% include [terraform-install](../../_includes/terraform-install.md) %} + + {% include [terraform-key-create](../../_includes/kms/terraform-key-create.md) %} + + - API {#api} + + Воспользуйтесь методом REST API [create](../../kms/api-ref/SymmetricKey/create.md) для ресурса [SymmetricKey](../../kms/api-ref/SymmetricKey/index.md) или вызовом gRPC API [SymmetricKeyService/Create](../../kms/api-ref/grpc/SymmetricKey/create.md). + + {% endlist %} + +1. Назначьте сервисному аккаунту `win-secret-sa` [роль](../../iam/concepts/access-control/roles.md) `kms.keys.encrypterDercrypter`: + + {% list tabs group=instructions %} + + - Консоль управления {#console} + + 1. На странице ключа перейдите на вкладку **Права доступа**. + 1. Перейдите на вкладку **{{ ui-key.yacloud.common.resource-acl.label_access-bindings }}**. + 1. Найдите аккаунт `win-secret-sa` в списке и нажмите значок ![image](../../_assets/options.svg). + 1. Нажмите кнопку **{{ ui-key.yacloud.common.resource-acl.button_assign-binding }}**. + 1. В открывшемся диалоге нажмите кнопку **Добавить роль** и выберите роль `kms.keys.encrypterDercrypter`. + + - CLI {#cli} + + Выполните команду: + + ```bash + yc resource-manager folder add-access-binding <идентификатор_каталога> \ + --role kms.keys.encrypterDercrypter \ + --subject serviceAccount:<идентификатор_сервисного_аккаунта> + ``` + + - API {#api} + + Чтобы назначить сервисному аккаунту роль на каталог, воспользуйтесь методом REST API [setAccessBindings](../../iam/api-ref/ServiceAccount/setAccessBindings.md) для ресурса [ServiceAccount](../../iam/api-ref/ServiceAccount/index.md) или вызовом gRPC API [ServiceAccountService/SetAccessBindings](../../iam/api-ref/grpc/ServiceAccount/setAccessBindings.md). + + {% endlist %} + +## Создайте секрет {#create-secret} + +Создайте секрет в сервисе {{ lockbox-name }} и сохраните в нем логины и пароли пользователей, для которых будут созданы учетные записи в ОС Windows. + +{% note warning %} + +При выборе пароля обязательно соблюдайте требования к безопасности пароля, иначе учетная запись для пользователя не будет создана. +Пароль должен: + +* быть не короче восьми символов; +* не содержать в себе имени учетной записи; +* содержать знаки минимум трех из четырех групп: + - латинские заглавные буквы (A-Z); + - латинские строчные буквы (a-z); + - цифры (0-9); + - неалфавитные символы (!, ?, %, $, # и т. д.). + +{% endnote %} + +{% list tabs group=instructions %} + +- Консоль управления {#console} + + 1. В [консоли управления]({{ link-console-main }}) выберите [каталог](../../resource-manager/concepts/resources-hierarchy.md#folder), в котором будет создан секрет. + 1. В списке сервисов выберите **{{ ui-key.yacloud.iam.folder.dashboard.label_lockbox }}**. + 1. Нажмите кнопку **{{ ui-key.yacloud.lockbox.button_create-secret }}**. + 1. В поле **{{ ui-key.yacloud.common.name }}** введите имя секрета: `win-secret`. + 1. В поле **{{ ui-key.yacloud.lockbox.forms.title_kms-key }}** укажите ключ `win-secret-key`. + 1. В блоке **{{ ui-key.yacloud.lockbox.label_version-dialog-title }}**: + * В поле **{{ ui-key.yacloud.lockbox.forms.label_key }}** введите логин для администратора `Administrator`. + * В поле **{{ ui-key.yacloud.lockbox.forms.label_value }}** введите пароль для администратора. + 1. При желании, добавьте еще пользователей. Для этого нажмите кнопку **{{ ui-key.yacloud.lockbox.forms.button_add-pair }}** и введите логин и пароль для следующего пользователя. + 1. Нажмите кнопку **{{ ui-key.yacloud.common.create }}**. + +- CLI {#cli} + + 1. Выполните команду: + + ```bash + yc lockbox secret create \ + --name win-secret \ + --kms-key-id <идентификатор_ключа> \ + --payload "[{'key': 'Administrator', 'text_value': '<пароль_администратора>'},{'key': 'user1', 'text_value': '<пароль_пользователя>'}]" \ + --cloud-id <идентификатор_облака> \ + --folder-id <идентификатор_каталога> + ``` + + Где: + + * `--name` — имя секрета. Обязательный параметр. + * `--kms-key-id` — идентификатор ключа {{ kms-short-name }}. + * `--description` — описание секрета. Необязательный параметр. + * `--payload` — содержимое секрета в виде массива формата YAML или JSON. + * `--cloud-id` — [идентификатор облака](../../resource-manager/operations/cloud/get-id.md), в котором будет создан секрет. + * `--folder-id` — [идентификатор каталога](../../resource-manager/operations/folder/get-id.md), в котором будет создан секрет. + +- {{ TF }} {#tf} + + {% include [terraform-install](../../_includes/terraform-install.md) %} + + 1. Опишите в конфигурационном файле параметры ресурсов, которые необходимо создать: + + ```hcl + resource "yandex_lockbox_secret" "win_secret" { + name = "<имя_секрета>" + folder_id = "<идентификатор_каталога>" + kms_key_id = "<идентификатор_ключа_шифрования>" + } + resource "yandex_lockbox_secret_version" "win_secret_version" { + secret_id = yandex_lockbox_secret.win_secret.id + entries { + key = "Administrator" + text_value = "<пароль_администратора>" + } + entries { + key = "user1" + text_value = "<пароль_пользователя>" + } + } + ``` + + Где: + + * `name` — имя секрета. Обязательный параметр. + * `folder_id` — [идентификатор](../../resource-manager/operations/folder/get-id.md) [каталога](../../resource-manager/concepts/resources-hierarchy.md#folder) в котором будет создан секрет. Необязательный параметр. + * `kms_key_id` — идентификатор [ключа шифрования {{ kms-name }}](../../kms/concepts/key.md). Указанный ключ {{ kms-name }} используется для шифрования секрета. + * `entries` — содержимое секрета. + + {% include [secret-version-tf-note](../../_includes/lockbox/secret-version-tf-note.md) %} + + {% note warning %} + + Для повышения безопасности пароль в конфигурационном файле лучше задавать через переменную окружения. + + {% endnote %} + + 1. Создайте ресурсы: + + {% include [terraform-validate-plan-apply](../../_tutorials/_tutorials_includes/terraform-validate-plan-apply.md) %} + +- API {#api} + + Чтобы создать секрет, воспользуйтесь методом REST API [create](../../lockbox/api-ref/Secret/create.md) для ресурса [Secret](../../lockbox/api-ref/Secret/index.md) или вызовом gRPC API [SecretService/Create](../../lockbox/api-ref/grpc/Secret/create.md). + +{% endlist %} + +1. Назначьте сервисному аккаунту `win-secret-sa` [роль](../../iam/concepts/access-control/roles.md) `lockbox.payloadViewer`: + + {% list tabs group=instructions %} + + - Консоль управления {#console} + + 1. На странице секрета перейдите на вкладку **Права доступа**. + 1. Перейдите на вкладку **{{ ui-key.yacloud.common.resource-acl.label_access-bindings }}**. + 1. Найдите аккаунт `win-secret-sa` в списке и нажмите значок ![image](../../_assets/options.svg). + 1. Нажмите кнопку **{{ ui-key.yacloud.common.resource-acl.button_assign-binding }}**. + 1. В открывшемся диалоге нажмите кнопку **Добавить роль** и выберите роль `lockbox.payloadViewer`. + + - CLI {#cli} + + Выполните команду: + + ```bash + yc resource-manager folder add-access-binding <идентификатор_каталога> \ + --role lockbox.payloadViewer \ + --subject serviceAccount:<идентификатор_сервисного_аккаунта> + ``` + + - API {#api} + + Чтобы назначить сервисному аккаунту роль на каталог, воспользуйтесь методом REST API [setAccessBindings](../../iam/api-ref/ServiceAccount/setAccessBindings.md) для ресурса [ServiceAccount](../../iam/api-ref/ServiceAccount/index.md) или вызовом gRPC API [ServiceAccountService/SetAccessBindings](../../iam/api-ref/grpc/ServiceAccount/setAccessBindings.md). + + {% endlist %} + +## Создайте ВМ {#create-vm} + +Создайте ВМ с ОС Windows и учетными записями администратора и пользователей. + +1. Создайте файл `init.ps1` и сохраните в него код: + + ```text + #ps1 + + # logging + Start-Transcript -Path "$ENV:SystemDrive\provision2.txt" -IncludeInvocationHeader -Force + "Bootstrap script started" | Write-Host + + # SECRET'S ID: + $SecretID = "" + + [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 + $SecretURL = "https://payload.lockbox.{{ api-host }}/lockbox/v1/secrets/$SecretID/payload" + + "Secret ID is $SecretID" + "Payload URL is $SecretURL" + + $YCToken = (Invoke-RestMethod -Headers @{'Metadata-Flavor'='Google'} -Uri "http://169.254.169.254/computeMetadata/v1/instance/service-accounts/default/token").access_token + if (!$YCToken) { + throw "Service Account doesn't connected to VM. Please, add Service account with roles lockbox.payloadViewer and kms.key.encryptorDecryptor to VM and try again." + } + + # Creating parameters for REST-invokations + $Headers = @{ + Authorization="Bearer $YCToken" + } + + $Params = @{ + Uri = $SecretURL + Method = "GET" + Headers = $Headers + } + + # Getting secret via REST invoke + $Secret = Invoke-RestMethod @Params + $SecretAdministratorPlainTextPassword = $Secret.entries[0].textValue + + # inserting value's from terraform + if (-not [string]::IsNullOrEmpty($SecretAdministratorPlainTextPassword)) { + "Set local administrator password" | Write-Host + $SecretAdministratorPassword = $SecretAdministratorPlainTextPassword | ConvertTo-SecureString -AsPlainText -Force + # S-1-5-21domain-500 is a well-known SID for Administrator + # https://docs.microsoft.com/en-us/troubleshoot/windows-server/identity/security-identifiers-in-windows + $Administrator = Get-LocalUser | Where-Object -Property "SID" -like "S-1-5-21-*-500" + $Administrator | Set-LocalUser -Password $SecretAdministratorPassword + } + + # Creating new users if any + if($Secret.entries.count -gt 1) { + foreach($User in $Secret.entries[1..($Secret.entries.count-1)]){ + $SecretUserPassword = $User.textValue | ConvertTo-SecureString -AsPlainText -Force + New-LocalUser -Name $User.key -Password $SecretUserPassword -FullName $User.key + Add-LocalGroupMember -Group Users -Member $User.key + Add-LocalGroupMember -Group "Remote Desktop Users" -Member $User.key + } + } + + "Bootstrap script ended" | Write-Host + ``` + +1. В файле `init.ps1` замените плейсхолдер `` на реальный идентификатор секрета, в котором вы сохранили учетки пользователей. + +1. Создайте ВМ: + + {% list tabs group=instructions %} + + - Консоль управления {#console} + + 1. В [консоли управления]({{ link-console-main }}) откройте [каталог](../../resource-manager/concepts/resources-hierarchy.md#folder), в котором будет создана ВМ. + 1. Справа сверху нажмите кнопку **{{ ui-key.yacloud.iam.folder.dashboard.button_add }}**. + 1. В открывшемся списке выберите **{{ ui-key.yacloud.iam.folder.dashboard.value_compute }}**. + 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_base }}**: + * Введите имя ВМ, например, `win-test`. + * Выберите [зону доступности](../../overview/concepts/geo-scope.md), в которой будет находиться ВМ. + 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_image }}** выберите [образ](../../compute/concepts/image.md) с ОС Windows. + 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** укажите данные для доступа на ВМ: + * Выберите [сервисный аккаунт](../../iam/concepts/index.md#sa) `win-secret-sa`. + * В поле **{{ ui-key.yacloud.compute.instances.create.field_access-advanced }}** разрешите доступ к [серийной консоли](../../compute/operations/serial-console/index.md). + 1. В блоке **{{ ui-key.yacloud.common.metadata }}**: + * в поле с плейсхолдером **Ключ** укажите `user-data`; + * в поле с плейсхолдером **Значение** скопируйте содержимое файла `init.ps1`. + 1. Нажмите кнопку **{{ ui-key.yacloud.compute.instances.create.button_create }}**. + + - CLI {#cli} + + Выполните команду: + + ```bash + yc compute instance create --name win-test --hostname windows10 --zone {{ region-id }}-a --create-boot-disk image-id= --cores 2 --core-fraction 100 --memory 4 --metadata-from-file user-data=init.ps1 --network-interface subnet-name=,nat-ip-version=ipv4 --service-account-name win-test-sa --platform standard-v3 + ``` + + Где: + + * imade_id — идентификатор образа с ОС Windows. + * subnet_name — имя подсети в каталоге, в которой вы хотите разместить ВМ. + + {% endlist %} + + +## Авторизуйтесь в ОС Windows {#login-windows} + +Чтобы проверить, что данные из секрета были успешно использованы для создания пользователей, авторизуйтесь в ОС виртуальной машины: + +1. В [консоли управления]({{ link-console-main }}) выберите каталог, которому принадлежит виртуальная машина. +1. Выберите сервис **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. +1. Выберите виртуальную машину `win-test`. +1. Перейдите на вкладку **{{ ui-key.yacloud.compute.instance.switch_console }}**. +1. В блоке **{{ ui-key.yacloud.compute.instance.switch_console }}** выберите `COM2` и нажмите кнопку **{{ ui-key.yacloud.compute.instance.console.connect }}**. В командной строке отобразится приглашение ввода команд: + + ```bash + SAC> + ``` + +1. Просмотрите список открытых каналов: + + ```bash + SAC>ch + Channel List + + (Use "ch -?" for information on using channels) + + # Status Channel Name + 0 (AV) SAC + 1 (AV) Cmd0001 + ``` + +1. Чтобы перейти на канал нажмите сочетание клавиш **ESC** + **TAB** или выполните команду: + + ```bash + SAC>ch -sn Cmd0001 + Name: Cmd0001 + Description: Command + Type: VT-UTF8 + Channel GUID: e203fb79-d80d-11ea-87e3-c2679e14957d + Application Type GUID: 63d02271-8aa4-11d5-bccf-00b0d014a2d0 + + Press for next channel. + Press 0 to return to the SAC channel. + Use any other key to view this channel. + ``` + +1. Нажмите **Enter** и последовательно введите: + + - Имя пользователя. + - Домен, если вход выполняется под доменной учетной записью. Иначе введите имя хоста либо оставьте пустым. + - Пароль. + + ```bash + Please enter login credentials. + Username: Administrator + Domain : + Password: *************** + ``` + +1. Если авторизация прошла успешно, запустится экземпляр интерпретатора командной строки: + + ```bash + C:\Windows\system32> + ``` + + Успешная авторизация означает, что данные из секрета были использованы при создании виртуальной машины. + +## Как удалить созданные ресурсы {#clear-out} + +Чтобы перестать платить за созданные ресурсы: +* [Удалите](../../compute/operations/vm-control/vm-delete.md) ВМ. +* [Удалите](../../lockbox/operations/secret-delete.md) секрет +* [Удалите](../../kms/operations/key.md#delete) ключ. diff --git a/ru/api-gateway/toc.yaml b/ru/api-gateway/toc.yaml index 99decd25fec..da4ec7155d9 100644 --- a/ru/api-gateway/toc.yaml +++ b/ru/api-gateway/toc.yaml @@ -137,6 +137,10 @@ items: Использование {{ api-gw-name }} для настройки синтеза речи в {{ speechkit-full-name }} href: tutorials/speechkit-integrarion-via-agi-gw.md + - name: Сокращатель ссылок + href: tutorials/serverless-url-shortener.md + - name: Ввод данных в системы хранения + href: tutorials/data-ingestion.md - name: Концепции items: - name: Взаимосвязь ресурсов сервиса diff --git a/ru/api-gateway/tutorials/data-ingestion.md b/ru/api-gateway/tutorials/data-ingestion.md new file mode 100644 index 00000000000..daef82382a9 --- /dev/null +++ b/ru/api-gateway/tutorials/data-ingestion.md @@ -0,0 +1,7 @@ +--- +canonical: '{{ link-docs }}/tutorials/serverless/data-ingestion' +--- + +{% include [data-ingestion](../../_tutorials/serverless/data-ingestion.md) %} + +{% include [clickhouse-disclaimer](../../_includes/clickhouse-disclaimer.md) %} \ No newline at end of file diff --git a/ru/api-gateway/tutorials/index.md b/ru/api-gateway/tutorials/index.md index b8d196eab63..5b3cb5185d2 100644 --- a/ru/api-gateway/tutorials/index.md +++ b/ru/api-gateway/tutorials/index.md @@ -17,4 +17,6 @@ description: Различные сценарии использования {{ a * [{#T}](serverless-live-debug.md) * [{#T}](jwt-authorizer-firebase.md) * [{#T}](canary-release.md) -* [{#T}](speechkit-integrarion-via-agi-gw.md) \ No newline at end of file +* [{#T}](speechkit-integrarion-via-agi-gw.md) +* [{#T}](serverless-url-shortener.md) +* [{#T}](data-ingestion.md) \ No newline at end of file diff --git a/ru/api-gateway/tutorials/serverless-url-shortener.md b/ru/api-gateway/tutorials/serverless-url-shortener.md new file mode 100644 index 00000000000..08459418247 --- /dev/null +++ b/ru/api-gateway/tutorials/serverless-url-shortener.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/serverless/serverless-url-shortener' +--- + +{% include [serverless-url-shortener](../../_tutorials/serverless/serverless-url-shortener.md) %} \ No newline at end of file diff --git a/ru/application-load-balancer/api-ref/grpc/BackendGroup/addBackend.md b/ru/application-load-balancer/api-ref/grpc/BackendGroup/addBackend.md index 6fac9a2e780..c5248ee9b3a 100644 --- a/ru/application-load-balancer/api-ref/grpc/BackendGroup/addBackend.md +++ b/ru/application-load-balancer/api-ref/grpc/BackendGroup/addBackend.md @@ -9,7 +9,7 @@ Adds backends to the specified backend group. ## gRPC request -**rpc AddBackend ([AddBackendRequest](#yandex.cloud.apploadbalancer.v1.AddBackendRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc AddBackend ([AddBackendRequest](#yandex.cloud.apploadbalancer.v1.AddBackendRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## AddBackendRequest {#yandex.cloud.apploadbalancer.v1.AddBackendRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/BackendGroup/create.md b/ru/application-load-balancer/api-ref/grpc/BackendGroup/create.md index b66c5382aa8..75f4539fd57 100644 --- a/ru/application-load-balancer/api-ref/grpc/BackendGroup/create.md +++ b/ru/application-load-balancer/api-ref/grpc/BackendGroup/create.md @@ -9,7 +9,7 @@ Creates a backend group in the specified folder. ## gRPC request -**rpc Create ([CreateBackendGroupRequest](#yandex.cloud.apploadbalancer.v1.CreateBackendGroupRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Create ([CreateBackendGroupRequest](#yandex.cloud.apploadbalancer.v1.CreateBackendGroupRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## CreateBackendGroupRequest {#yandex.cloud.apploadbalancer.v1.CreateBackendGroupRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/BackendGroup/delete.md b/ru/application-load-balancer/api-ref/grpc/BackendGroup/delete.md index 6cded6572fd..7823d5d2934 100644 --- a/ru/application-load-balancer/api-ref/grpc/BackendGroup/delete.md +++ b/ru/application-load-balancer/api-ref/grpc/BackendGroup/delete.md @@ -9,7 +9,7 @@ Deletes the specified backend group. ## gRPC request -**rpc Delete ([DeleteBackendGroupRequest](#yandex.cloud.apploadbalancer.v1.DeleteBackendGroupRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Delete ([DeleteBackendGroupRequest](#yandex.cloud.apploadbalancer.v1.DeleteBackendGroupRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## DeleteBackendGroupRequest {#yandex.cloud.apploadbalancer.v1.DeleteBackendGroupRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/BackendGroup/removeBackend.md b/ru/application-load-balancer/api-ref/grpc/BackendGroup/removeBackend.md index b3ed75e2591..88aff0e1cb9 100644 --- a/ru/application-load-balancer/api-ref/grpc/BackendGroup/removeBackend.md +++ b/ru/application-load-balancer/api-ref/grpc/BackendGroup/removeBackend.md @@ -9,7 +9,7 @@ Removes backends from the specified backend group. ## gRPC request -**rpc RemoveBackend ([RemoveBackendRequest](#yandex.cloud.apploadbalancer.v1.RemoveBackendRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc RemoveBackend ([RemoveBackendRequest](#yandex.cloud.apploadbalancer.v1.RemoveBackendRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## RemoveBackendRequest {#yandex.cloud.apploadbalancer.v1.RemoveBackendRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/BackendGroup/update.md b/ru/application-load-balancer/api-ref/grpc/BackendGroup/update.md index 090665aac13..ccfcb96b63a 100644 --- a/ru/application-load-balancer/api-ref/grpc/BackendGroup/update.md +++ b/ru/application-load-balancer/api-ref/grpc/BackendGroup/update.md @@ -9,7 +9,7 @@ Updates the specified backend group. ## gRPC request -**rpc Update ([UpdateBackendGroupRequest](#yandex.cloud.apploadbalancer.v1.UpdateBackendGroupRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Update ([UpdateBackendGroupRequest](#yandex.cloud.apploadbalancer.v1.UpdateBackendGroupRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## UpdateBackendGroupRequest {#yandex.cloud.apploadbalancer.v1.UpdateBackendGroupRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/BackendGroup/updateBackend.md b/ru/application-load-balancer/api-ref/grpc/BackendGroup/updateBackend.md index b2efe5aa94c..cd2e1188cb7 100644 --- a/ru/application-load-balancer/api-ref/grpc/BackendGroup/updateBackend.md +++ b/ru/application-load-balancer/api-ref/grpc/BackendGroup/updateBackend.md @@ -9,7 +9,7 @@ Updates the specified backend. ## gRPC request -**rpc UpdateBackend ([UpdateBackendRequest](#yandex.cloud.apploadbalancer.v1.UpdateBackendRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc UpdateBackend ([UpdateBackendRequest](#yandex.cloud.apploadbalancer.v1.UpdateBackendRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## UpdateBackendRequest {#yandex.cloud.apploadbalancer.v1.UpdateBackendRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/HttpRouter/create.md b/ru/application-load-balancer/api-ref/grpc/HttpRouter/create.md index 0659d3a3263..32c88ef2386 100644 --- a/ru/application-load-balancer/api-ref/grpc/HttpRouter/create.md +++ b/ru/application-load-balancer/api-ref/grpc/HttpRouter/create.md @@ -9,7 +9,7 @@ Creates an HTTP router in the specified folder. ## gRPC request -**rpc Create ([CreateHttpRouterRequest](#yandex.cloud.apploadbalancer.v1.CreateHttpRouterRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Create ([CreateHttpRouterRequest](#yandex.cloud.apploadbalancer.v1.CreateHttpRouterRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## CreateHttpRouterRequest {#yandex.cloud.apploadbalancer.v1.CreateHttpRouterRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/HttpRouter/delete.md b/ru/application-load-balancer/api-ref/grpc/HttpRouter/delete.md index 7de32329953..cf335d740c0 100644 --- a/ru/application-load-balancer/api-ref/grpc/HttpRouter/delete.md +++ b/ru/application-load-balancer/api-ref/grpc/HttpRouter/delete.md @@ -9,7 +9,7 @@ Deletes the specified HTTP router. ## gRPC request -**rpc Delete ([DeleteHttpRouterRequest](#yandex.cloud.apploadbalancer.v1.DeleteHttpRouterRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Delete ([DeleteHttpRouterRequest](#yandex.cloud.apploadbalancer.v1.DeleteHttpRouterRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## DeleteHttpRouterRequest {#yandex.cloud.apploadbalancer.v1.DeleteHttpRouterRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/HttpRouter/update.md b/ru/application-load-balancer/api-ref/grpc/HttpRouter/update.md index 7c457f5fbca..3ad7f93a9df 100644 --- a/ru/application-load-balancer/api-ref/grpc/HttpRouter/update.md +++ b/ru/application-load-balancer/api-ref/grpc/HttpRouter/update.md @@ -9,7 +9,7 @@ Updates the specified HTTP router. ## gRPC request -**rpc Update ([UpdateHttpRouterRequest](#yandex.cloud.apploadbalancer.v1.UpdateHttpRouterRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Update ([UpdateHttpRouterRequest](#yandex.cloud.apploadbalancer.v1.UpdateHttpRouterRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## UpdateHttpRouterRequest {#yandex.cloud.apploadbalancer.v1.UpdateHttpRouterRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/LoadBalancer/addListener.md b/ru/application-load-balancer/api-ref/grpc/LoadBalancer/addListener.md index abd1dacd4c8..fed6d49aa16 100644 --- a/ru/application-load-balancer/api-ref/grpc/LoadBalancer/addListener.md +++ b/ru/application-load-balancer/api-ref/grpc/LoadBalancer/addListener.md @@ -9,7 +9,7 @@ Adds a listener to the specified application load balancer. ## gRPC request -**rpc AddListener ([AddListenerRequest](#yandex.cloud.apploadbalancer.v1.AddListenerRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc AddListener ([AddListenerRequest](#yandex.cloud.apploadbalancer.v1.AddListenerRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## AddListenerRequest {#yandex.cloud.apploadbalancer.v1.AddListenerRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/LoadBalancer/addSniMatch.md b/ru/application-load-balancer/api-ref/grpc/LoadBalancer/addSniMatch.md index d1c08db67f7..6ccbf2c2fdd 100644 --- a/ru/application-load-balancer/api-ref/grpc/LoadBalancer/addSniMatch.md +++ b/ru/application-load-balancer/api-ref/grpc/LoadBalancer/addSniMatch.md @@ -11,7 +11,7 @@ This request does not allow to add [TlsListener.defaultHandler](/docs/applicatio ## gRPC request -**rpc AddSniMatch ([AddSniMatchRequest](#yandex.cloud.apploadbalancer.v1.AddSniMatchRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc AddSniMatch ([AddSniMatchRequest](#yandex.cloud.apploadbalancer.v1.AddSniMatchRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## AddSniMatchRequest {#yandex.cloud.apploadbalancer.v1.AddSniMatchRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/LoadBalancer/create.md b/ru/application-load-balancer/api-ref/grpc/LoadBalancer/create.md index bf13052792f..f24342c6273 100644 --- a/ru/application-load-balancer/api-ref/grpc/LoadBalancer/create.md +++ b/ru/application-load-balancer/api-ref/grpc/LoadBalancer/create.md @@ -9,7 +9,7 @@ Creates an application load balancer in the specified folder. ## gRPC request -**rpc Create ([CreateLoadBalancerRequest](#yandex.cloud.apploadbalancer.v1.CreateLoadBalancerRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Create ([CreateLoadBalancerRequest](#yandex.cloud.apploadbalancer.v1.CreateLoadBalancerRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## CreateLoadBalancerRequest {#yandex.cloud.apploadbalancer.v1.CreateLoadBalancerRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/LoadBalancer/delete.md b/ru/application-load-balancer/api-ref/grpc/LoadBalancer/delete.md index dca67ec14eb..0b64d7325b1 100644 --- a/ru/application-load-balancer/api-ref/grpc/LoadBalancer/delete.md +++ b/ru/application-load-balancer/api-ref/grpc/LoadBalancer/delete.md @@ -9,7 +9,7 @@ Deletes the specified application load balancer. ## gRPC request -**rpc Delete ([DeleteLoadBalancerRequest](#yandex.cloud.apploadbalancer.v1.DeleteLoadBalancerRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Delete ([DeleteLoadBalancerRequest](#yandex.cloud.apploadbalancer.v1.DeleteLoadBalancerRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## DeleteLoadBalancerRequest {#yandex.cloud.apploadbalancer.v1.DeleteLoadBalancerRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/LoadBalancer/removeListener.md b/ru/application-load-balancer/api-ref/grpc/LoadBalancer/removeListener.md index b0ba605e409..e88738c467b 100644 --- a/ru/application-load-balancer/api-ref/grpc/LoadBalancer/removeListener.md +++ b/ru/application-load-balancer/api-ref/grpc/LoadBalancer/removeListener.md @@ -9,7 +9,7 @@ Deletes the specified listener. ## gRPC request -**rpc RemoveListener ([RemoveListenerRequest](#yandex.cloud.apploadbalancer.v1.RemoveListenerRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc RemoveListener ([RemoveListenerRequest](#yandex.cloud.apploadbalancer.v1.RemoveListenerRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## RemoveListenerRequest {#yandex.cloud.apploadbalancer.v1.RemoveListenerRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/LoadBalancer/removeSniMatch.md b/ru/application-load-balancer/api-ref/grpc/LoadBalancer/removeSniMatch.md index 67c5d87e74b..eb13747494e 100644 --- a/ru/application-load-balancer/api-ref/grpc/LoadBalancer/removeSniMatch.md +++ b/ru/application-load-balancer/api-ref/grpc/LoadBalancer/removeSniMatch.md @@ -11,7 +11,7 @@ This request does not allow to delete [TlsListener.defaultHandler](/docs/applica ## gRPC request -**rpc RemoveSniMatch ([RemoveSniMatchRequest](#yandex.cloud.apploadbalancer.v1.RemoveSniMatchRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc RemoveSniMatch ([RemoveSniMatchRequest](#yandex.cloud.apploadbalancer.v1.RemoveSniMatchRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## RemoveSniMatchRequest {#yandex.cloud.apploadbalancer.v1.RemoveSniMatchRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/LoadBalancer/start.md b/ru/application-load-balancer/api-ref/grpc/LoadBalancer/start.md index 369567415af..a194d039033 100644 --- a/ru/application-load-balancer/api-ref/grpc/LoadBalancer/start.md +++ b/ru/application-load-balancer/api-ref/grpc/LoadBalancer/start.md @@ -9,7 +9,7 @@ Starts the specified application load balancer. ## gRPC request -**rpc Start ([StartLoadBalancerRequest](#yandex.cloud.apploadbalancer.v1.StartLoadBalancerRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Start ([StartLoadBalancerRequest](#yandex.cloud.apploadbalancer.v1.StartLoadBalancerRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## StartLoadBalancerRequest {#yandex.cloud.apploadbalancer.v1.StartLoadBalancerRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/LoadBalancer/stop.md b/ru/application-load-balancer/api-ref/grpc/LoadBalancer/stop.md index a74b171db30..f4a9c2ed90e 100644 --- a/ru/application-load-balancer/api-ref/grpc/LoadBalancer/stop.md +++ b/ru/application-load-balancer/api-ref/grpc/LoadBalancer/stop.md @@ -9,7 +9,7 @@ Stops the specified application load balancer. ## gRPC request -**rpc Stop ([StopLoadBalancerRequest](#yandex.cloud.apploadbalancer.v1.StopLoadBalancerRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Stop ([StopLoadBalancerRequest](#yandex.cloud.apploadbalancer.v1.StopLoadBalancerRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## StopLoadBalancerRequest {#yandex.cloud.apploadbalancer.v1.StopLoadBalancerRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/LoadBalancer/update.md b/ru/application-load-balancer/api-ref/grpc/LoadBalancer/update.md index f081e2cbc3a..f1fcb20039f 100644 --- a/ru/application-load-balancer/api-ref/grpc/LoadBalancer/update.md +++ b/ru/application-load-balancer/api-ref/grpc/LoadBalancer/update.md @@ -9,7 +9,7 @@ Updates the specified application load balancer. ## gRPC request -**rpc Update ([UpdateLoadBalancerRequest](#yandex.cloud.apploadbalancer.v1.UpdateLoadBalancerRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Update ([UpdateLoadBalancerRequest](#yandex.cloud.apploadbalancer.v1.UpdateLoadBalancerRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## UpdateLoadBalancerRequest {#yandex.cloud.apploadbalancer.v1.UpdateLoadBalancerRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/LoadBalancer/updateListener.md b/ru/application-load-balancer/api-ref/grpc/LoadBalancer/updateListener.md index 8f4bf9532a6..ced75f29321 100644 --- a/ru/application-load-balancer/api-ref/grpc/LoadBalancer/updateListener.md +++ b/ru/application-load-balancer/api-ref/grpc/LoadBalancer/updateListener.md @@ -9,7 +9,7 @@ Updates the specified listener of the specified application load balancer. ## gRPC request -**rpc UpdateListener ([UpdateListenerRequest](#yandex.cloud.apploadbalancer.v1.UpdateListenerRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc UpdateListener ([UpdateListenerRequest](#yandex.cloud.apploadbalancer.v1.UpdateListenerRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## UpdateListenerRequest {#yandex.cloud.apploadbalancer.v1.UpdateListenerRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/LoadBalancer/updateSniMatch.md b/ru/application-load-balancer/api-ref/grpc/LoadBalancer/updateSniMatch.md index 511787f496b..f2ff0e2458f 100644 --- a/ru/application-load-balancer/api-ref/grpc/LoadBalancer/updateSniMatch.md +++ b/ru/application-load-balancer/api-ref/grpc/LoadBalancer/updateSniMatch.md @@ -11,7 +11,7 @@ This request does not allow to update [TlsListener.defaultHandler](/docs/applica ## gRPC request -**rpc UpdateSniMatch ([UpdateSniMatchRequest](#yandex.cloud.apploadbalancer.v1.UpdateSniMatchRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc UpdateSniMatch ([UpdateSniMatchRequest](#yandex.cloud.apploadbalancer.v1.UpdateSniMatchRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## UpdateSniMatchRequest {#yandex.cloud.apploadbalancer.v1.UpdateSniMatchRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/TargetGroup/addTargets.md b/ru/application-load-balancer/api-ref/grpc/TargetGroup/addTargets.md index 84e1b563f78..761444d7a13 100644 --- a/ru/application-load-balancer/api-ref/grpc/TargetGroup/addTargets.md +++ b/ru/application-load-balancer/api-ref/grpc/TargetGroup/addTargets.md @@ -9,7 +9,7 @@ Adds targets to the specified target group. ## gRPC request -**rpc AddTargets ([AddTargetsRequest](#yandex.cloud.apploadbalancer.v1.AddTargetsRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc AddTargets ([AddTargetsRequest](#yandex.cloud.apploadbalancer.v1.AddTargetsRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## AddTargetsRequest {#yandex.cloud.apploadbalancer.v1.AddTargetsRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/TargetGroup/create.md b/ru/application-load-balancer/api-ref/grpc/TargetGroup/create.md index a11fdf37f71..89cbce63384 100644 --- a/ru/application-load-balancer/api-ref/grpc/TargetGroup/create.md +++ b/ru/application-load-balancer/api-ref/grpc/TargetGroup/create.md @@ -9,7 +9,7 @@ Creates a target group in the specified folder. ## gRPC request -**rpc Create ([CreateTargetGroupRequest](#yandex.cloud.apploadbalancer.v1.CreateTargetGroupRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Create ([CreateTargetGroupRequest](#yandex.cloud.apploadbalancer.v1.CreateTargetGroupRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## CreateTargetGroupRequest {#yandex.cloud.apploadbalancer.v1.CreateTargetGroupRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/TargetGroup/delete.md b/ru/application-load-balancer/api-ref/grpc/TargetGroup/delete.md index 839e51f88db..32651bc9130 100644 --- a/ru/application-load-balancer/api-ref/grpc/TargetGroup/delete.md +++ b/ru/application-load-balancer/api-ref/grpc/TargetGroup/delete.md @@ -9,7 +9,7 @@ Deletes the specified target group. ## gRPC request -**rpc Delete ([DeleteTargetGroupRequest](#yandex.cloud.apploadbalancer.v1.DeleteTargetGroupRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Delete ([DeleteTargetGroupRequest](#yandex.cloud.apploadbalancer.v1.DeleteTargetGroupRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## DeleteTargetGroupRequest {#yandex.cloud.apploadbalancer.v1.DeleteTargetGroupRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/TargetGroup/removeTargets.md b/ru/application-load-balancer/api-ref/grpc/TargetGroup/removeTargets.md index 4516bb52d5a..758b8e55b1d 100644 --- a/ru/application-load-balancer/api-ref/grpc/TargetGroup/removeTargets.md +++ b/ru/application-load-balancer/api-ref/grpc/TargetGroup/removeTargets.md @@ -9,7 +9,7 @@ Removes targets from the specified target group. ## gRPC request -**rpc RemoveTargets ([RemoveTargetsRequest](#yandex.cloud.apploadbalancer.v1.RemoveTargetsRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc RemoveTargets ([RemoveTargetsRequest](#yandex.cloud.apploadbalancer.v1.RemoveTargetsRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## RemoveTargetsRequest {#yandex.cloud.apploadbalancer.v1.RemoveTargetsRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/TargetGroup/update.md b/ru/application-load-balancer/api-ref/grpc/TargetGroup/update.md index ee729d7e0fc..3458fa9f6c4 100644 --- a/ru/application-load-balancer/api-ref/grpc/TargetGroup/update.md +++ b/ru/application-load-balancer/api-ref/grpc/TargetGroup/update.md @@ -9,7 +9,7 @@ Updates the specified target group. ## gRPC request -**rpc Update ([UpdateTargetGroupRequest](#yandex.cloud.apploadbalancer.v1.UpdateTargetGroupRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Update ([UpdateTargetGroupRequest](#yandex.cloud.apploadbalancer.v1.UpdateTargetGroupRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## UpdateTargetGroupRequest {#yandex.cloud.apploadbalancer.v1.UpdateTargetGroupRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/VirtualHost/create.md b/ru/application-load-balancer/api-ref/grpc/VirtualHost/create.md index 61c7e1eacc5..5cf58939776 100644 --- a/ru/application-load-balancer/api-ref/grpc/VirtualHost/create.md +++ b/ru/application-load-balancer/api-ref/grpc/VirtualHost/create.md @@ -9,7 +9,7 @@ Creates a virtual host in the specified HTTP router. ## gRPC request -**rpc Create ([CreateVirtualHostRequest](#yandex.cloud.apploadbalancer.v1.CreateVirtualHostRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Create ([CreateVirtualHostRequest](#yandex.cloud.apploadbalancer.v1.CreateVirtualHostRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## CreateVirtualHostRequest {#yandex.cloud.apploadbalancer.v1.CreateVirtualHostRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/VirtualHost/delete.md b/ru/application-load-balancer/api-ref/grpc/VirtualHost/delete.md index 6d5c93a6c87..a22ee91c02d 100644 --- a/ru/application-load-balancer/api-ref/grpc/VirtualHost/delete.md +++ b/ru/application-load-balancer/api-ref/grpc/VirtualHost/delete.md @@ -9,7 +9,7 @@ Deletes the specified virtual host. ## gRPC request -**rpc Delete ([DeleteVirtualHostRequest](#yandex.cloud.apploadbalancer.v1.DeleteVirtualHostRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Delete ([DeleteVirtualHostRequest](#yandex.cloud.apploadbalancer.v1.DeleteVirtualHostRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## DeleteVirtualHostRequest {#yandex.cloud.apploadbalancer.v1.DeleteVirtualHostRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/VirtualHost/removeRoute.md b/ru/application-load-balancer/api-ref/grpc/VirtualHost/removeRoute.md index 14b3d0c121d..7913953d765 100644 --- a/ru/application-load-balancer/api-ref/grpc/VirtualHost/removeRoute.md +++ b/ru/application-load-balancer/api-ref/grpc/VirtualHost/removeRoute.md @@ -9,7 +9,7 @@ Deletes the specified route from the specified virtual host. ## gRPC request -**rpc RemoveRoute ([RemoveRouteRequest](#yandex.cloud.apploadbalancer.v1.RemoveRouteRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc RemoveRoute ([RemoveRouteRequest](#yandex.cloud.apploadbalancer.v1.RemoveRouteRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## RemoveRouteRequest {#yandex.cloud.apploadbalancer.v1.RemoveRouteRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/VirtualHost/update.md b/ru/application-load-balancer/api-ref/grpc/VirtualHost/update.md index 940c5e38f9a..b0546a036aa 100644 --- a/ru/application-load-balancer/api-ref/grpc/VirtualHost/update.md +++ b/ru/application-load-balancer/api-ref/grpc/VirtualHost/update.md @@ -9,7 +9,7 @@ Updates the specified virtual host of the specified HTTP router. ## gRPC request -**rpc Update ([UpdateVirtualHostRequest](#yandex.cloud.apploadbalancer.v1.UpdateVirtualHostRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc Update ([UpdateVirtualHostRequest](#yandex.cloud.apploadbalancer.v1.UpdateVirtualHostRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## UpdateVirtualHostRequest {#yandex.cloud.apploadbalancer.v1.UpdateVirtualHostRequest} diff --git a/ru/application-load-balancer/api-ref/grpc/VirtualHost/updateRoute.md b/ru/application-load-balancer/api-ref/grpc/VirtualHost/updateRoute.md index 4ab5e21acf3..83abb1508ae 100644 --- a/ru/application-load-balancer/api-ref/grpc/VirtualHost/updateRoute.md +++ b/ru/application-load-balancer/api-ref/grpc/VirtualHost/updateRoute.md @@ -9,7 +9,7 @@ Updates the specified route of the specified virtual host. ## gRPC request -**rpc UpdateRoute ([UpdateRouteRequest](#yandex.cloud.apploadbalancer.v1.UpdateRouteRequest)) returns ([operation.Operation](/docs/application-load-balancer/api-ref/grpc/HttpRouter/get#yandex.cloud.apploadbalancer.v1.HeaderModification.operation))** +**rpc UpdateRoute ([UpdateRouteRequest](#yandex.cloud.apploadbalancer.v1.UpdateRouteRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** ## UpdateRouteRequest {#yandex.cloud.apploadbalancer.v1.UpdateRouteRequest} diff --git a/ru/application-load-balancer/quickstart.md b/ru/application-load-balancer/quickstart.md index 973c55f5384..9acf5a29a6e 100644 --- a/ru/application-load-balancer/quickstart.md +++ b/ru/application-load-balancer/quickstart.md @@ -70,7 +70,7 @@ 1. В блоке **{{ ui-key.yacloud.alb.label_backends }}** нажмите кнопку **{{ ui-key.yacloud.common.add }}**. Задайте настройки бэкенда: 1. Введите имя бэкенда: `backend-1`. 1. В списке **{{ ui-key.yacloud.alb.label_target-group }}** выберите `test-target-group`. - 1. Укажите **{{ ui-key.yacloud.alb.label_port }}**: `80`. + 1. Укажите **{{ ui-key.yacloud.alb.label_port }}**: `8080`. 1. Разверните поле **{{ ui-key.yacloud.alb.label_protocol-settings }}** и задайте их параметры: 1. Выберите тип `{{ ui-key.yacloud.alb.label_proto-http-plain }}`. 1. Нажмите кнопку **{{ ui-key.yacloud.alb.button_add-healthcheck }}** и задайте настройки проверки: @@ -96,7 +96,7 @@ yc alb backend-group add-http-backend \ --backend-group-name test-backend-group \ --name backend-1 \ - --port 80 \ + --port 8080 \ --target-group-name test-target-group \ --target-group-id <идентификатор_целевой_группы> \ --http-healthcheck healthy-threshold=2,unhealthy-threshold=2,timeout=1s,interval=3s,path=/ diff --git a/ru/application-load-balancer/toc.yaml b/ru/application-load-balancer/toc.yaml index 4a5a8617271..64dcae4acbe 100644 --- a/ru/application-load-balancer/toc.yaml +++ b/ru/application-load-balancer/toc.yaml @@ -111,6 +111,10 @@ items: Проверка состояния приложений в кластере {{ k8s }} с помощью Ingress-контроллера {{ alb-name }} href: tutorials/custom-health-checks.md + - name: >- + Реализация защищенной высокодоступной сетевой инфраструктуры с + выделением DMZ на основе Next-Generation Firewall + href: tutorials/high-accessible-dmz.md - name: Концепции items: - name: Обзор diff --git a/ru/application-load-balancer/tutorials/high-accessible-dmz.md b/ru/application-load-balancer/tutorials/high-accessible-dmz.md new file mode 100644 index 00000000000..79b30015022 --- /dev/null +++ b/ru/application-load-balancer/tutorials/high-accessible-dmz.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/routing/high-accessible-dmz' +--- + +{% include [high-accessible-dmz](../../_tutorials/routing/high-accessible-dmz.md) %} \ No newline at end of file diff --git a/ru/application-load-balancer/tutorials/index.md b/ru/application-load-balancer/tutorials/index.md index 1ab81f8b56e..75e63e9ead6 100644 --- a/ru/application-load-balancer/tutorials/index.md +++ b/ru/application-load-balancer/tutorials/index.md @@ -15,5 +15,6 @@ description: Различные сценарии использования {{ a * [{#T}](gateway-api.md) * [{#T}](alb-ingress-controller.md) * [{#T}](alb-ingress-controller-log-options.md) +* [{#T}](high-accessible-dmz.md) * [{#T}](application-load-balancer-website.md) * [{#T}](custom-health-checks.md) \ No newline at end of file diff --git a/ru/audit-trails/api-ref/Trail/list.md b/ru/audit-trails/api-ref/Trail/list.md index 5142bdd86b1..30f2ab5cb6c 100644 --- a/ru/audit-trails/api-ref/Trail/list.md +++ b/ru/audit-trails/api-ref/Trail/list.md @@ -29,7 +29,7 @@ Default value: 100. || || pageToken | **string** Page token. To get the next page of results, set `page_token` to the -[ListTrailsRequest.nextPageToken](#yandex.cloud.audittrails.v1.ListTrailsResponse) returned by a previous list request. || +[ListTrailsRequest.next_page_token] returned by a previous list request. || || filter | **string** A filter expression that filters subscription locks listed in the response. diff --git a/ru/audit-trails/api-ref/Trail/listOperations.md b/ru/audit-trails/api-ref/Trail/listOperations.md index 18fbf88af44..39e713f2901 100644 --- a/ru/audit-trails/api-ref/Trail/listOperations.md +++ b/ru/audit-trails/api-ref/Trail/listOperations.md @@ -35,7 +35,7 @@ Default value: 100. || || pageToken | **string** Page token. To get the next page of results, set `page_token` to the -[ListTrailOperationsRequest.nextPageToken](/docs/audit-trails/api-ref/Trail/list#yandex.cloud.audittrails.v1.ListTrailsResponse) returned by a previous list request. || +[ListTrailOperationsRequest.next_page_token] returned by a previous list request. || |# ## Response {#yandex.cloud.audittrails.v1.ListTrailOperationsResponse} @@ -77,8 +77,8 @@ List of operations for the specified trail. || || nextPageToken | **string** This token allows you to get the next page of results for list requests. If the number of results -is larger than [ListTrailOperationsResponse.pageSize](/docs/audit-trails/api-ref/Trail/list#yandex.cloud.audittrails.v1.ListTrailsRequest), use the `next_page_token` as the value -for the [ListTrailOperationsResponse.pageToken](/docs/audit-trails/api-ref/Trail/list#yandex.cloud.audittrails.v1.ListTrailsRequest) query parameter in the next list request. +is larger than [ListTrailOperationsResponse.page_size], use the `next_page_token` as the value +for the [ListTrailOperationsResponse.page_token] query parameter in the next list request. Each subsequent list request will have its own `next_page_token` to continue paging through the results. || |# diff --git a/ru/audit-trails/api-ref/grpc/Trail/list.md b/ru/audit-trails/api-ref/grpc/Trail/list.md index 725b95b836f..9f02521a05a 100644 --- a/ru/audit-trails/api-ref/grpc/Trail/list.md +++ b/ru/audit-trails/api-ref/grpc/Trail/list.md @@ -37,7 +37,7 @@ Default value: 100. || || pageToken | **string** Page token. To get the next page of results, set `page_token` to the -[ListTrailsRequest.nextPageToken](#yandex.cloud.audittrails.v1.ListTrailsResponse) returned by a previous list request. || +[ListTrailsRequest.next_page_token] returned by a previous list request. || || filter | **string** A filter expression that filters subscription locks listed in the response. diff --git a/ru/audit-trails/api-ref/grpc/Trail/listOperations.md b/ru/audit-trails/api-ref/grpc/Trail/listOperations.md index 121507999e8..c669d45af48 100644 --- a/ru/audit-trails/api-ref/grpc/Trail/listOperations.md +++ b/ru/audit-trails/api-ref/grpc/Trail/listOperations.md @@ -35,7 +35,7 @@ Default value: 100. || || pageToken | **string** Page token. To get the next page of results, set `page_token` to the -[ListTrailOperationsRequest.nextPageToken](/docs/audit-trails/api-ref/grpc/Trail/list#yandex.cloud.audittrails.v1.ListTrailsResponse) returned by a previous list request. || +[ListTrailOperationsRequest.next_page_token] returned by a previous list request. || |# ## ListTrailOperationsResponse {#yandex.cloud.audittrails.v1.ListTrailOperationsResponse} @@ -69,8 +69,8 @@ List of operations for the specified trail. || || nextPageToken | **string** This token allows you to get the next page of results for list requests. If the number of results -is larger than [ListTrailOperationsResponse.pageSize](/docs/audit-trails/api-ref/grpc/Trail/list#yandex.cloud.audittrails.v1.ListTrailsRequest), use the `next_page_token` as the value -for the [ListTrailOperationsResponse.pageToken](/docs/audit-trails/api-ref/grpc/Trail/list#yandex.cloud.audittrails.v1.ListTrailsRequest) query parameter in the next list request. +is larger than [ListTrailOperationsResponse.page_size], use the `next_page_token` as the value +for the [ListTrailOperationsResponse.page_token] query parameter in the next list request. Each subsequent list request will have its own `next_page_token` to continue paging through the results. || |# diff --git a/ru/backup/backup/api-ref/Backup/list.md b/ru/backup/backup/api-ref/Backup/list.md index c6e2c1d5b87..d078e8b7193 100644 --- a/ru/backup/backup/api-ref/Backup/list.md +++ b/ru/backup/backup/api-ref/Backup/list.md @@ -59,6 +59,13 @@ Supported parameters are: Supported logic operators: * AND || +|| type | **enum** (ResourceType) + +Type of resource. Could be compute VM or baremetal server. + +- `RESOURCE_TYPE_UNSPECIFIED` +- `COMPUTE`: Resource is Compute Cloud VM +- `BMS`: Resource is baremetal server || |# ## ArchiveParameters {#yandex.cloud.backup.v1.ListBackupsRequest.ArchiveParameters} diff --git a/ru/backup/backup/api-ref/grpc/Backup/list.md b/ru/backup/backup/api-ref/grpc/Backup/list.md index 0d85e6b1390..b31a9b32a37 100644 --- a/ru/backup/backup/api-ref/grpc/Backup/list.md +++ b/ru/backup/backup/api-ref/grpc/Backup/list.md @@ -30,7 +30,8 @@ List backups using filters. "policyId": "string", // end of the list of possible fields "orderBy": "string", - "filter": "string" + "filter": "string", + "type": "ResourceType" } ``` @@ -78,6 +79,13 @@ Supported parameters are: Supported logic operators: * AND || +|| type | enum **ResourceType** + +Type of resource. Could be compute VM or baremetal server. + +- `RESOURCE_TYPE_UNSPECIFIED` +- `COMPUTE`: Resource is Compute Cloud VM +- `BMS`: Resource is baremetal server || |# ## ArchiveParameters {#yandex.cloud.backup.v1.ListBackupsRequest.ArchiveParameters} diff --git a/ru/billing/_includes/change-payment-method.md b/ru/billing/_includes/change-payment-method.md index 08aeccb0488..dc33eed501b 100644 --- a/ru/billing/_includes/change-payment-method.md +++ b/ru/billing/_includes/change-payment-method.md @@ -1,6 +1,5 @@ - #### Как изменить способ оплаты? {#payment-method} Способ оплаты можно [изменить](../operations/change-payment-method.md) только в платежном аккаунте с типом **{{ ui-key.yacloud_billing.billing.account.create-new.account-type_label_company }}**: вместо оплаты банковской картой вы можете использовать [перевод средств с расчетного счета](../payment/payment-methods-business.md). -В платежном аккаунте с типом **{{ ui-key.yacloud_billing.billing.account.create-new.account-type_label_individual }}** способ оплаты изменить нельзя. +В платежном аккаунте с типом **{{ ui-key.yacloud_billing.billing.account.create-new.account-type_label_individual }}** способ оплаты изменить нельзя. \ No newline at end of file diff --git a/ru/billing/_includes/payment-amount.md b/ru/billing/_includes/payment-amount.md index 89f0e9ac77c..a60c48072a8 100644 --- a/ru/billing/_includes/payment-amount.md +++ b/ru/billing/_includes/payment-amount.md @@ -1,6 +1,5 @@ Итоговая сумма списания зависит от того, был ли использован [грант](../concepts/bonus-account.md) и пополнялся ли [лицевой счет (ЛС)](../concepts/personal-account.md#balance) в течение отчетного периода. - Сумма списания определяется по формуле: ![image](../../_assets/billing/formula.png) diff --git a/ru/billing/api-ref/Customer/createResellerServed.md b/ru/billing/api-ref/Customer/createResellerServed.md index a2462e7001d..6cf74f89453 100644 --- a/ru/billing/api-ref/Customer/createResellerServed.md +++ b/ru/billing/api-ref/Customer/createResellerServed.md @@ -36,11 +36,12 @@ POST https://billing.{{ api-host }}/billing/v1/customers:createResellerServedCus ||Field | Description || || resellerId | **string** -Required field. ID of the reseller that customer will be associated with. +Required field. ID of the reseller that customer will be associated with.
    -Value must match either one of the two regular expressions: -`^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\|[0-9a-f]{32})$` -or `^[a-z][-a-zA-Z0-9.]{0,48}[a-zA-Z0-9]$`. || +Value must match either one of the three regular expressions: +
    - `^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$` +
    - `^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{32})$` +
    - `^[a-z][-a-zA-Z0-9.]{0,48}[a-zA-Z0-9]$` || || name | **string** Required field. Name of the customer. diff --git a/ru/billing/api-ref/grpc/Customer/createResellerServed.md b/ru/billing/api-ref/grpc/Customer/createResellerServed.md index 123dad8e054..7357c415829 100644 --- a/ru/billing/api-ref/grpc/Customer/createResellerServed.md +++ b/ru/billing/api-ref/grpc/Customer/createResellerServed.md @@ -34,11 +34,12 @@ Creates new reseller-served customer. ||Field | Description || || resellerId | **string** -Required field. ID of the reseller that customer will be associated with. +Required field. ID of the reseller that customer will be associated with.
    -Value must match either one of the two regular expressions: -`^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\|[0-9a-f]{32})$` -or `^[a-z][-a-zA-Z0-9.]{0,48}[a-zA-Z0-9]$`. || +Value must match either one of the three regular expressions: +
    - `^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$` +
    - `^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{32})$` +
    - `^[a-z][-a-zA-Z0-9.]{0,48}[a-zA-Z0-9]$` || || name | **string** Required field. Name of the customer. diff --git a/ru/billing/concepts/bill.md b/ru/billing/concepts/bill.md index ded5bf302c8..bcadacb5cc8 100644 --- a/ru/billing/concepts/bill.md +++ b/ru/billing/concepts/bill.md @@ -16,14 +16,16 @@ Счет высылается только на адрес электронной почты владельца [платежного аккаунта](billing-account.md). Изменить адрес нельзя, но можно настроить пересылку писем на другой адрес. Подробнее см. в [Справке Яндекс Почты](https://yandex.ru/support/mail/web/preferences/filters/forwarding.html). - {% note info %} {{ yandex-cloud }} оставляет за собой право выставить счет на оплату в течение текущего отчетного периода, если вы превысите установленный порог оплаты. {% endnote %} + По условиям [оферты]({{ billing-oferta-url }}) (Раздел 6) Клиент, являющийся юридическим лицом, не использующий привязанную корпоративную карту для пополнения лицевого счета, самостоятельно [формирует счет на оплату](../operations/pay-the-bill.md#legal-entities) через Консоль управления. + + Счет на оплату не является первичным учетным документом. Специальных требований к составлению этого документа со стороны законодательства нет. Корректное начисление услуг в бухгалтерском учете происходит по акту и счету-фактуре, в которых указываются все необходимые реквизиты. Счет формируется автоматически без возможности изменить данные клиента. ## Сумма счета {#payment-amount} diff --git a/ru/billing/concepts/billing-threshold.md b/ru/billing/concepts/billing-threshold.md index 9e228e0d988..93bc71a5c9f 100644 --- a/ru/billing/concepts/billing-threshold.md +++ b/ru/billing/concepts/billing-threshold.md @@ -19,8 +19,6 @@ description: Порог оплаты — это отрицательный ба Порог оплаты действует только когда в качестве метода оплаты выбрана оплата картой. В этом случае при достижении порога в целях погашения задолженности произойдет попытка списания средств с карты. -{% include [card-business-nonresidents](../../_includes/billing/card-business-nonresidents.md) %} - ## Размер порога оплаты {#amount} Размер порога оплаты рассчитывается индивидуально и может зависеть от совокупности факторов, в том числе от: diff --git a/ru/billing/concepts/contract.md b/ru/billing/concepts/contract.md index 5e5a9372e2b..6d58762a176 100644 --- a/ru/billing/concepts/contract.md +++ b/ru/billing/concepts/contract.md @@ -8,7 +8,7 @@ С момента принятия оферты обе стороны начинают действовать в рамках договора согласно Гражданскому кодексу РФ. В соответствии с его условиями вы обязаны оплатить потребленные ресурсы по окончании отчетного периода. Подробную информацию см. в разделе [Оплата ресурсов](../payment/index.md). -С условиями договора вы можете ознакомиться в разделе [Правовые документы]({{ billing-oferta-url }}?lang=ru). +С условиями договора вы можете ознакомиться в разделе [Правовые документы]({{ billing-oferta-url }}). {% note info %} @@ -33,7 +33,7 @@ С момента принятия оферты обе стороны начинают действовать в рамках договора. В соответствии с его условиями вы обязаны оплатить потребленные ресурсы по окончании отчетного периода. Подробную информацию см. в разделе [Оплата ресурсов](../payment/index.md). -С условиями договора вы можете ознакомиться в разделе [Правовые документы](https://yandex.com/legal/cloud_customer_agreement/?lang=ru). +В зависимости от того, с какой компанией вы заключали договор, ознакомиться с условиями договора вы можете в разделе «Правовые документы» для [Iron Hive doo Beograd (Сербия)](https://yandex.com/legal/cloud_customer_agreement/) или [Direct Cursus Technology L.L.C. (Дубай)](https://yandex.com/legal/cloud_customer_agreement_uae/). ## Номер договора{#id} @@ -41,4 +41,4 @@ ## Расторжение договора {#termination} -После самостоятельного [удаления платежного аккаунта](../operations/delete-account.md) договор будет расторгнут. В этом случае предупреждать компанию ООО «Яндекс.Облако», ТОО «Облачные Сервисы Казахстан» или Iron Hive doo Beograd (Serbia) о расторжении договора не нужно. +После самостоятельного [удаления платежного аккаунта](../operations/delete-account.md) договор будет расторгнут. В этом случае предупреждать компанию ООО «Яндекс.Облако», ТОО «Облачные Сервисы Казахстан», Iron Hive doo Beograd (Serbia) или Direct Cursus Technology L.L.C. (Dubai) о расторжении договора не нужно. diff --git a/ru/billing/concepts/individual-bill.md b/ru/billing/concepts/individual-bill.md index 75735349756..55afeb05ab2 100644 --- a/ru/billing/concepts/individual-bill.md +++ b/ru/billing/concepts/individual-bill.md @@ -5,12 +5,8 @@ description: Из статьи вы узнаете, что такое чек о # Чек об оплате - В соответствии с [ФЗ-54 «О применении контрольно-кассовой техники»](http://base.garant.ru/12130951/) после оплаты ресурсов с помощью банковской карты вы получите чек об оплате по электронной почте. - -{% include [card-business-nonresidents](../../_includes/billing/card-business-nonresidents.md) %} - Чек об оплате — первичный учетный документ, подтверждающий перевод денежных средств с помощью банковской карты. Мы рекомендуем хранить все чеки — это поможет разобраться, если с каким-либо платежом возникнут проблемы. diff --git a/ru/billing/concepts/personal-account.md b/ru/billing/concepts/personal-account.md index ec2641a9135..24591287d58 100644 --- a/ru/billing/concepts/personal-account.md +++ b/ru/billing/concepts/personal-account.md @@ -1,5 +1,6 @@ # Лицевой счет + Лицевой счет (ЛС) — ваш уникальный идентификатор в сервисе {{ billing-name }}, который используется для оплаты ресурсов в течение всего срока действия [договора](contract.md). Содержит средства, зачисленные вами с помощью банковской карты или банковского перевода (способ зачисления зависит от юридического статуса). Средства с ЛС используются только при отсутствии [грантов](bonus-account.md). @@ -20,10 +21,8 @@ {% include [personal-account-balance](../_includes/personal-account-balance.md) %} - Баланс может становиться отрицательным из-за действия [порога оплаты](billing-threshold.md), применяющегося после активации платной версии и только при оплате банковской картой. - Мы рекомендуем [следить за балансом](../operations/pay-the-bill.md) и пополнять счет до положительного значения. Если вы вовремя не пополните счет, то использование сервисов {{ yandex-cloud }} может быть приостановлено. Перед приостановкой на электронный адрес, указанный в платежном аккаунте, будет выслано уведомление о необходимости оплаты. Уведомление отправляется за седьмой и третий день до приостановки, а также в день приостановки. После пополнения баланса возможность потреблять ресурсы восстановится в течение суток. diff --git a/ru/billing/operations/change-data.md b/ru/billing/operations/change-data.md index 82995512423..f474a3459eb 100644 --- a/ru/billing/operations/change-data.md +++ b/ru/billing/operations/change-data.md @@ -42,7 +42,7 @@ ## Изменение юридического лица или ИНН {#change-legal-entity} Изменить юридическое лицо или ИНН в настройках платежного аккаунта невозможно. Поэтому если у вас изменились эти реквизиты: -1. [Создайте](create-new-account.md) платежный аккаунт с новыми реквизитами, выбрав в качестве типа плательщика **{{ ui-key.startrek.ui_components_page-admin_BillingAccountInfo.person-type-company }}**. +1. [Создайте](create-new-account.md) платежный аккаунт с новыми реквизитами, выбрав в качестве типа плательщика **Юридическое лицо или ИП**. 1. Дождитесь активации платежного аккаунта, чтобы избежать простоя ресурсов. 1. Перенесите все облака со старого платежного аккаунта на новый. Для этого достаточно [привязать](pin-cloud.md) их к новому платежному аккаунту. diff --git a/ru/billing/operations/delete-account.md b/ru/billing/operations/delete-account.md index a45e75915b6..aef1e25b5ce 100644 --- a/ru/billing/operations/delete-account.md +++ b/ru/billing/operations/delete-account.md @@ -9,7 +9,7 @@ description: Следуя данной инструкции, вы сможете {% note info %} -После удаления платежного аккаунта договор с ООО «Яндекс.Облако», ТОО «Облачные Сервисы Казахстан» или Iron Hive doo Beograd (Serbia) соответственно будет расторгнут. +После удаления платежного аккаунта договор с ООО «Яндекс.Облако», ТОО «Облачные Сервисы Казахстан», Iron Hive doo Beograd (Serbia) или Direct Cursus Technology L.L.C. (Dubai) соответственно будет расторгнут. {% endnote %} diff --git a/ru/billing/operations/get-folder-report.md b/ru/billing/operations/get-folder-report.md index 3cd74fcbca7..cec215bdb99 100644 --- a/ru/billing/operations/get-folder-report.md +++ b/ru/billing/operations/get-folder-report.md @@ -10,10 +10,10 @@ 1. {% include [move-to-billing-step](../_includes/move-to-billing-step.md) %} 1. Выберите аккаунт, для которого хотите получить детализацию. - 1. На панели слева выберите ![image](../../_assets/console-icons/chart-area-stacked.svg) **{{ ui-key.yacloud.billing.account.switch_detail }}**. + 1. На панели слева выберите ![image](../../_assets/console-icons/chart-area-stacked.svg) **{{ ui-key.yacloud_billing.billing.account.switch_detail }}**. 1. Нажмите кнопку **{{ ui-key.yacloud_billing.billing.account.detail.button_download-csv }}**. 1. Выберите промежуток времени, за который хотите получить детализацию. - 1. Нажмите кнопку **{{ ui-key.yacloud.billing.account.detail.popup-csv_button_download }}**. + 1. Нажмите кнопку **{{ ui-key.yacloud_billing.billing.account.detail.popup-csv_button_download }}**. {% endlist %} diff --git a/ru/billing/operations/pay-the-bill.md b/ru/billing/operations/pay-the-bill.md index c108daef46c..09773e49f89 100644 --- a/ru/billing/operations/pay-the-bill.md +++ b/ru/billing/operations/pay-the-bill.md @@ -5,24 +5,18 @@ description: Следуя данной инструкции, вы сможете # Пополнить лицевой счет -{% include [card-business-nonresidents](../../_includes/billing/card-business-nonresidents.md) %} - {% include [personal-account-balance](../_includes/personal-account-balance.md) %} - {{ yandex-cloud }} оставляет за собой право автоматически списать средства с привязанной карты в течение текущего отчетного периода, если баланс вашего лицевого счета превысит установленный размер порога оплаты. - Способ пополнения лицевого счета зависит от вашего юридического статуса. - {% note info %} Цикл оплаты выполняется автоматически для [физических лиц](../payment/billing-cycle-individual.md), а также для [организаций и ИП](../payment/billing-cycle-business.md), если к платежному аккаунту привязана банковская карта. {% endnote %} - ## Физическим лицам {#individuals} {% include [individual-nonresidents](../../_includes/billing/individual-nonresidents.md) %} @@ -72,7 +66,10 @@ description: Следуя данной инструкции, вы сможете Перед проведением оплаты убедитесь, что в платежном поручении корректно указаны: * сумма платежа; - * банковские реквизиты ООО «Яндекс.Облако» для Российской Федерации (РФ), ТОО «Облачные Сервисы Казахстан» для Республики Казахстан (РК) и Iron Hive doo Beograd (Serbia) для нерезидентов Российской Федерации и Республики Казахстан; + * банковские реквизиты ООО «Яндекс.Облако» для Российской Федерации (РФ), ТОО «Облачные Сервисы Казахстан» для Республики Казахстан (РК), Iron Hive doo Beograd (Serbia) или Direct Cursus Technology L.L.C. (Dubai) для нерезидентов Российской Федерации и Республики Казахстан; + + {% include [legal-entity-nonresidents](../../_includes/billing/legal-entity-nonresidents.md) %} + * ИНН вашей организации или ИП; * [номер лицевого счета](../concepts/personal-account.md#id) в назначении платежа; * [номер договора](../concepts/contract.md) в назначении платежа. @@ -81,7 +78,6 @@ description: Следуя данной инструкции, вы сможете {% include [payment-bill-note](../_includes/payment-bill-note.md) %} - - Банковская карта {#card} Введите сумму платежа и нажмите кнопку **{{ ui-key.yacloud_billing.billing.account.dashboard-overview.button_refill }}**. Затем введите данные карты и нажмите кнопку **Оплатить**. @@ -89,8 +85,5 @@ description: Следуя данной инструкции, вы сможете {% include [payment-card-types](../../_includes/billing/payment-card-types.md) %} Платеж происходит в режиме реального времени и зачисляется в течение 15 минут. - - - {% endlist %} - + {% endlist %} \ No newline at end of file diff --git a/ru/billing/payment/billing-cycle-business.md b/ru/billing/payment/billing-cycle-business.md index c681f6e18f7..0b418ccfe34 100644 --- a/ru/billing/payment/billing-cycle-business.md +++ b/ru/billing/payment/billing-cycle-business.md @@ -1,11 +1,9 @@ # Цикл оплаты для организаций и ИП - Цикл выставления и оплаты счетов для организаций и ИП, а также приостановки и блокировки использования ресурсов представлен на схеме ниже. ![image](../../_assets/billing/billing-cycle-business-credit.svg) - 1. Вы [активируете платную версию](../operations/activate-commercial.md) до истечения срока действия [пробного периода](../../billing/concepts/trial-period.md). {% include [billing-how-to-use-grant](../../_includes/billing-how-to-use-grant.md) %} @@ -17,13 +15,11 @@ * Если сумма гранта больше нуля и при этом срок действия гранта не истек, вернитесь к шагу 2. * Если срок действия гранта истек или сумма гранта равна нулю, перейдите к шагу 4. - 1. Проверяется способ оплаты: * Если вы оплачиваете ресурсы с расчетного счета, перейдите к шагу 5. * Если вы оплачиваете ресурсы с карты, перейдите к шагу 7. - 1. Вы потребляете ресурсы сервисов {{ yandex-cloud }} и оплачиваете их использование по итогам каждого отчетного периода, при этом услуга [порог оплаты](../concepts/billing-threshold.md) не предоставляется. 1. Проверяется, наступил ли конец отчетного периода: @@ -36,7 +32,6 @@ * Если баланс больше нуля, вернитесь к шагу 5. * Если баланс меньше нуля, перейдите к шагу 10. - 1. [Баланс лицевого счета](../concepts/personal-account.md#balance) уменьшается по мере потребления ресурсов сервисов {{ yandex-cloud }}. 1. В течение всего отчетного периода проверяется баланс вашего лицевого счета: @@ -56,7 +51,6 @@ * Если конец отчетного периода не наступил, вернитесь к шагу 8. * Если наступил конец отчетного периода, формируются [акт](../concepts/act.md) и [счет-фактура](../concepts/invoice.md). Копии этих документов отправляются на электронную почту владельца платежного аккаунта. Перейдите к шагу 10. - 1. Производится оплата за потребленные ресурсы {{ yandex-cloud }}: * Самостоятельно [пополните](../operations/pay-the-bill.md) лицевой счет до положительного значения в сроки, установленные договором. @@ -64,7 +58,6 @@ {% include [pay-by-card-note](../_includes/pay-by-card-note.md) %} - 1. Проверяется оплата потребленных ресурсов: * Если вы пополнили счет в установленные договором сроки или средства были списаны с привязанной карты в течение одного дня, вернитесь к шагу 2. @@ -86,10 +79,8 @@ 1. В противном случае использование сервисов {{ yandex-cloud }} может быть полностью заблокировано. Все ваши данные, включая [платежный аккаунт](../concepts/billing-account.md), будут удалены без возможности восстановления. - {% include [blocked-note](../_includes/blocked-note.md) %} - #### См.также * [Грант](../concepts/bonus-account.md) diff --git a/ru/billing/payment/payment-methods-business.md b/ru/billing/payment/payment-methods-business.md index e8108041b07..cd1f0f01ce4 100644 --- a/ru/billing/payment/payment-methods-business.md +++ b/ru/billing/payment/payment-methods-business.md @@ -7,7 +7,10 @@ Для перевода средств должен быть выставлен [счет на оплату](../concepts/bill.md). Оплатить счет можно в отделении любого банка или через систему клиент-банк.
    Перед переводом убедитесь, что в платежном поручении корректно указаны: * сумма платежа; -* банковские реквизиты ООО «Яндекс.Облако» для Российской Федерации (РФ) и Республики Беларусь (РБ), ТОО «Облачные Сервисы Казахстан» для Республики Казахстан (РК) и Iron Hive doo Beograd (Serbia) для нерезидентов Российской Федерации и Республики Казахстан; +* банковские реквизиты ООО «Яндекс.Облако» для Российской Федерации (РФ) и Республики Беларусь (РБ), ТОО «Облачные Сервисы Казахстан» для Республики Казахстан (РК), Iron Hive doo Beograd (Serbia) или Direct Cursus Technology L.L.C. (Dubai) для нерезидентов Российской Федерации и Республики Казахстан; + + {% include [legal-entity-nonresidents](../../_includes/billing/legal-entity-nonresidents.md) %} + * ИНН вашей организации или ИП; * [номер лицевого счета](../concepts/personal-account.md#id) в назначении платежа; * [номер договора](../concepts/contract.md) в назначении платежа. diff --git a/ru/billing/payment/payment-methods-card-business.md b/ru/billing/payment/payment-methods-card-business.md index ad594f697b1..5461bea64b4 100644 --- a/ru/billing/payment/payment-methods-card-business.md +++ b/ru/billing/payment/payment-methods-card-business.md @@ -1,7 +1,5 @@ # Оплата банковской картой для юридических лиц -{% include [card-business-nonresidents](../../_includes/billing/card-business-nonresidents.md) %} - Организации и ИП могут пополнять лицевой счет и оплачивать потребленные ресурсы с помощью корпоративной банковской карты, привязанной к платежному аккаунту. {% include [payment-card-types](../../_includes/billing/payment-card-types.md) %} diff --git a/ru/cdn/quickstart.md b/ru/cdn/quickstart.md index 62723d4d6d5..3d65e0ef864 100644 --- a/ru/cdn/quickstart.md +++ b/ru/cdn/quickstart.md @@ -7,10 +7,10 @@ description: Следуя данной инструкции, вы сможете Настройте раздачу контента через CDN на примере бакета {{ objstorage-name }}: -1. [{#T}](#create-cdn-resource). -1. [{#T}](#upload-content-to-CDN). -1. [{#T}](#setup-cname). -1. [{#T}](#check-cdn-working). +1. [Создайте CDN-ресурс](#create-cdn-resource). +1. [Загрузите контент в CDN](#upload-content-to-CDN). +1. [Настройте CNAME для своего домена](#setup-cname). +1. [Проверьте работу CDN](#check-cdn-working). ## Перед началом работы {#before-you-begin} diff --git a/ru/cli/cli-ref/managed-services/lockbox/secret/add-version.md b/ru/cli/cli-ref/managed-services/lockbox/secret/add-version.md index 7ffe40bd726..4dd32359886 100644 --- a/ru/cli/cli-ref/managed-services/lockbox/secret/add-version.md +++ b/ru/cli/cli-ref/managed-services/lockbox/secret/add-version.md @@ -21,7 +21,7 @@ Syntax: |`--name`|`string`
    Secret name.| |`--async`|Display information about the operation in progress, without waiting for the operation to complete.| |`--description`|`string`
    Version description.| -|`--payload`|`string`
    YAML or JSON array defining how to change payload from the base version.
    Each item of the array must match the format: https://yandex.cloud/ru/docs/lockbox/api-ref/grpc/secret_service#PayloadEntryChange
    For instance, to modify the value of "password" entry from the base version payload:
    [{"key": "username", "text_value": "alice"}, {"key": "password", "text_value": "p@$$w0rd"}]
    the following JSON can be passed:
    [{"key": "password", "text_value": "another-p@$$w0rd"}]
    so the resulting payload of the newly added version will be:
    [{"key": "username", "text_value": "alice"}, {"key": "password", "text_value": "another-p@$$w0rd"}]
    To remove the entry pass an item containing only the "key" field, e.g.:
    [..., {"key": "the-key-of-the-entry-to-remove"}, ...]
    Use - value to pass payload string via stdin.| +|`--payload`|`string`
    YAML or JSON array defining how to change payload from the base version.
    Each item of the array must match the format: https://yandex.cloud/ru/docs/lockbox/api-ref/grpc/Secret/create#yandex.cloud.lockbox.v1.PayloadEntryChange
    For instance, to modify the value of "password" entry from the base version payload:
    [{"key": "username", "text_value": "alice"}, {"key": "password", "text_value": "p@$$w0rd"}]
    the following JSON can be passed:
    [{"key": "password", "text_value": "another-p@$$w0rd"}]
    so the resulting payload of the newly added version will be:
    [{"key": "username", "text_value": "alice"}, {"key": "password", "text_value": "another-p@$$w0rd"}]
    To remove the entry pass an item containing only the "key" field, e.g.:
    [..., {"key": "the-key-of-the-entry-to-remove"}, ...]
    Use - value to pass payload string via stdin.| |`--base-version-id`|`string`
    Base version id. By default, the current one is used.| #### Global Flags diff --git a/ru/cli/cli-ref/managed-services/lockbox/secret/create.md b/ru/cli/cli-ref/managed-services/lockbox/secret/create.md index fb485017143..bebd11a0828 100644 --- a/ru/cli/cli-ref/managed-services/lockbox/secret/create.md +++ b/ru/cli/cli-ref/managed-services/lockbox/secret/create.md @@ -22,7 +22,7 @@ Syntax: |`--labels`|`key=value[,key=value...]`
    A list of label KEY=VALUE pairs to add. For example, to add two labels named 'foo' and 'bar', both with the value 'baz', use '--labels foo=baz,bar=baz'.| |`--kms-key-id`|`string`
    KMS key ID will be used to encrypt the secret payload.| |`--version-description`|`string`
    Description of the first version.| -|`--payload`|`string`
    YAML or JSON array defining the entries of the secret payload.
    Each item of the array must match the format: https://yandex.cloud/ru/docs/lockbox/api-ref/grpc/secret_service#PayloadEntryChange
    For instance, the following payload JSON defines a payload containing two text value entries:
    [{"key": "username", "text_value": "alice"}, {"key": "password", "text_value": "p@$$w0rd"}]
    Use - value to pass payload string via stdin.| +|`--payload`|`string`
    YAML or JSON array defining the entries of the secret payload.
    Each item of the array must match the format: https://yandex.cloud/ru/docs/lockbox/api-ref/grpc/Secret/create#yandex.cloud.lockbox.v1.PayloadEntryChange
    For instance, the following payload JSON defines a payload containing two text value entries:
    [{"key": "username", "text_value": "alice"}, {"key": "password", "text_value": "p@$$w0rd"}]
    Use - value to pass payload string via stdin.| |`--deletion-protection`|Enable deletion protection for the secret.| |`--async`|Display information about the operation in progress, without waiting for the operation to complete.| diff --git a/ru/cloud-desktop/api-ref/Desktop/create.md b/ru/cloud-desktop/api-ref/Desktop/create.md index 73e530bdafc..0f92e350114 100644 --- a/ru/cloud-desktop/api-ref/Desktop/create.md +++ b/ru/cloud-desktop/api-ref/Desktop/create.md @@ -20,7 +20,8 @@ POST https://cloud-desktop.{{ api-host }}/cloud-desktop/v1/desktops "desktopGroupId": "string", "users": [ { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } ] } @@ -43,6 +44,9 @@ List of users. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# ## Response {#yandex.cloud.operation.Operation} @@ -88,7 +92,8 @@ Required field. Identity of the access binding. || ], "users": [ { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } ] } @@ -262,4 +267,7 @@ Required field. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# \ No newline at end of file diff --git a/ru/cloud-desktop/api-ref/Desktop/get.md b/ru/cloud-desktop/api-ref/Desktop/get.md index 3e5386fefea..22d2927ca92 100644 --- a/ru/cloud-desktop/api-ref/Desktop/get.md +++ b/ru/cloud-desktop/api-ref/Desktop/get.md @@ -51,7 +51,8 @@ To get the desktop ID use a [DesktopService.List](/docs/cloud-desktop/api-ref/De ], "users": [ { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } ] } @@ -126,4 +127,7 @@ Required field. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# \ No newline at end of file diff --git a/ru/cloud-desktop/api-ref/Desktop/getRdpFile.md b/ru/cloud-desktop/api-ref/Desktop/getRdpFile.md index b34871dabc1..ea258499fad 100644 --- a/ru/cloud-desktop/api-ref/Desktop/getRdpFile.md +++ b/ru/cloud-desktop/api-ref/Desktop/getRdpFile.md @@ -40,6 +40,9 @@ User of the desktop. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# ## Response {#yandex.cloud.clouddesktop.v1.api.RdpFileResponse} diff --git a/ru/cloud-desktop/api-ref/Desktop/list.md b/ru/cloud-desktop/api-ref/Desktop/list.md index f6be2e1eb46..ce6a4ed7436 100644 --- a/ru/cloud-desktop/api-ref/Desktop/list.md +++ b/ru/cloud-desktop/api-ref/Desktop/list.md @@ -73,7 +73,8 @@ The default sorting order is ascending. || ], "users": [ { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } ] } @@ -168,4 +169,7 @@ Required field. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# \ No newline at end of file diff --git a/ru/cloud-desktop/api-ref/Desktop/resetPassword.md b/ru/cloud-desktop/api-ref/Desktop/resetPassword.md index 710d4881498..3fcb8f047a0 100644 --- a/ru/cloud-desktop/api-ref/Desktop/resetPassword.md +++ b/ru/cloud-desktop/api-ref/Desktop/resetPassword.md @@ -27,7 +27,8 @@ Required field. ID of the desktop. || ```json { "user": { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } } ``` @@ -46,6 +47,9 @@ Required field. User of the desktop. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# ## Response {#yandex.cloud.clouddesktop.v1.api.ResetPasswordResponse} diff --git a/ru/cloud-desktop/api-ref/DesktopGroup/listDesktops.md b/ru/cloud-desktop/api-ref/DesktopGroup/listDesktops.md index a4322534712..e25efead77e 100644 --- a/ru/cloud-desktop/api-ref/DesktopGroup/listDesktops.md +++ b/ru/cloud-desktop/api-ref/DesktopGroup/listDesktops.md @@ -77,7 +77,8 @@ The default sorting order is ascending. || ], "users": [ { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } ] } @@ -172,4 +173,7 @@ Required field. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# \ No newline at end of file diff --git a/ru/cloud-desktop/api-ref/grpc/Desktop/create.md b/ru/cloud-desktop/api-ref/grpc/Desktop/create.md index c06cb4bf23b..1a9e8bee5ff 100644 --- a/ru/cloud-desktop/api-ref/grpc/Desktop/create.md +++ b/ru/cloud-desktop/api-ref/grpc/Desktop/create.md @@ -18,7 +18,8 @@ Creates desktop in the specified folder. "desktopGroupId": "string", "users": [ { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } ] } @@ -41,6 +42,9 @@ List of users. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# ## operation.Operation {#yandex.cloud.operation.Operation} @@ -78,7 +82,8 @@ Required field. Identity of the access binding. || ], "users": [ { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } ] } @@ -214,4 +219,7 @@ Required field. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# \ No newline at end of file diff --git a/ru/cloud-desktop/api-ref/grpc/Desktop/get.md b/ru/cloud-desktop/api-ref/grpc/Desktop/get.md index 0470a7b8cc3..47b8a412f48 100644 --- a/ru/cloud-desktop/api-ref/grpc/Desktop/get.md +++ b/ru/cloud-desktop/api-ref/grpc/Desktop/get.md @@ -53,7 +53,8 @@ To get the desktop ID use a [DesktopService.List](/docs/cloud-desktop/api-ref/gr ], "users": [ { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } ] } @@ -121,4 +122,7 @@ Required field. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# \ No newline at end of file diff --git a/ru/cloud-desktop/api-ref/grpc/Desktop/getRdpFile.md b/ru/cloud-desktop/api-ref/grpc/Desktop/getRdpFile.md index 59bc7354ac4..cac0053eb23 100644 --- a/ru/cloud-desktop/api-ref/grpc/Desktop/getRdpFile.md +++ b/ru/cloud-desktop/api-ref/grpc/Desktop/getRdpFile.md @@ -17,7 +17,8 @@ Returns a RDP file for the specified desktop. { "desktopId": "string", "user": { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } } ``` @@ -41,6 +42,9 @@ User of the desktop. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# ## RdpFileResponse {#yandex.cloud.clouddesktop.v1.api.RdpFileResponse} diff --git a/ru/cloud-desktop/api-ref/grpc/Desktop/list.md b/ru/cloud-desktop/api-ref/grpc/Desktop/list.md index 71068d27a04..d9e5b7305bc 100644 --- a/ru/cloud-desktop/api-ref/grpc/Desktop/list.md +++ b/ru/cloud-desktop/api-ref/grpc/Desktop/list.md @@ -79,7 +79,8 @@ The default sorting order is ascending. || ], "users": [ { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } ] } @@ -167,4 +168,7 @@ Required field. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# \ No newline at end of file diff --git a/ru/cloud-desktop/api-ref/grpc/Desktop/resetPassword.md b/ru/cloud-desktop/api-ref/grpc/Desktop/resetPassword.md index 539bfd66c35..a5219df80b9 100644 --- a/ru/cloud-desktop/api-ref/grpc/Desktop/resetPassword.md +++ b/ru/cloud-desktop/api-ref/grpc/Desktop/resetPassword.md @@ -17,7 +17,8 @@ Reset password { "desktopId": "string", "user": { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } } ``` @@ -39,6 +40,9 @@ Required field. User of the desktop. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# ## ResetPasswordResponse {#yandex.cloud.clouddesktop.v1.api.ResetPasswordResponse} diff --git a/ru/cloud-desktop/api-ref/grpc/Desktop/restart.md b/ru/cloud-desktop/api-ref/grpc/Desktop/restart.md index 462df0d3175..57d0d8a60d3 100644 --- a/ru/cloud-desktop/api-ref/grpc/Desktop/restart.md +++ b/ru/cloud-desktop/api-ref/grpc/Desktop/restart.md @@ -61,7 +61,8 @@ Required field. ID of the desktop. || ], "users": [ { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } ] } @@ -197,4 +198,7 @@ Required field. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# \ No newline at end of file diff --git a/ru/cloud-desktop/api-ref/grpc/DesktopGroup/listDesktops.md b/ru/cloud-desktop/api-ref/grpc/DesktopGroup/listDesktops.md index eacc7528919..533c2082fcb 100644 --- a/ru/cloud-desktop/api-ref/grpc/DesktopGroup/listDesktops.md +++ b/ru/cloud-desktop/api-ref/grpc/DesktopGroup/listDesktops.md @@ -77,7 +77,8 @@ The default sorting order is ascending. || ], "users": [ { - "subjectId": "string" + "subjectId": "string", + "subjectType": "string" } ] } @@ -165,4 +166,7 @@ Required field. || || subjectId | **string** Required field. Identity of the access binding. || +|| subjectType | **string** + +Required field. Type of the access binding, e.g. userAccount, serviceAccount, system. || |# \ No newline at end of file diff --git a/ru/cloud-desktop/quickstart.md b/ru/cloud-desktop/quickstart.md index 142f081a944..d6525243c07 100644 --- a/ru/cloud-desktop/quickstart.md +++ b/ru/cloud-desktop/quickstart.md @@ -7,7 +7,7 @@ description: Следуя данной инструкции, вы сможете {% note info %} -Инструкция содержит информацию о создании и настройке [группы рабочих столов](concepts/desktops-and-groups.md). Если вы получили от администратора ссылку на [витрину пользовательских рабочих столов](concepts/showcase.md), перейдите к подразделу [{#T}](#get-credentials). +Инструкция содержит информацию о создании и настройке [группы рабочих столов](concepts/desktops-and-groups.md). Если вы получили от администратора ссылку на [витрину пользовательских рабочих столов](concepts/showcase.md), перейдите к подразделу [Получите данные для подключения](#get-credentials). {% endnote %} diff --git a/ru/code-assistant/qa.md b/ru/code-assistant/qa.md index bf2b522cf78..a8c366a6497 100644 --- a/ru/code-assistant/qa.md +++ b/ru/code-assistant/qa.md @@ -1,7 +1,22 @@ - # Вопросы и ответы про {{ ca-full-name }} -### Ошибка в Visual Studio Code при аутентификации {#crypto-is-not-defined} +## Общие вопросы {#common-questions} + +### Нужен ли для работы с {{ ca-name }} платежный аккаунт? {#billing-account} + +[Платежный аккаунт](../billing/concepts/billing-account.md) **не нужен**. + +### Можно ли использовать плагин без доступа в интернет? {#using-plugin-without-internet} + +Нет. Для работы {{ ca-short-name }} требуется постоянный доступ в интернет. + +### Как изменить пользователя, аутентифицированного в плагине {{ ca-name }} {#change-user} + +Чтобы аутентифицироваться в плагине {{ ca-name }} как другой пользователь {{ yandex-cloud }}, [выйдите](./quickstart.md#logout) из профиля и затем повторно аутентифицируйтесь, как это описано в п. 3 раздела [{#T}](./quickstart.md#install-plugin). + +## Работа в Visual Studio Code {#vs-code-ide} + +### Ошибка при аутентификации {#crypto-is-not-defined} Текст ошибки: @@ -29,17 +44,21 @@ OS: Windows_NT x64 10.0.19045 См. также [Как узнать версию IDE](https://code.visualstudio.com/docs/setup/setup-overview#_how-do-i-know-which-version-im-running). -### Нужен ли для работы с {{ ca-name }} платежный аккаунт? {#billing-account} +## Работа в IDE от JetBrains {#jetbrains-ide} -[Платежный аккаунт](../billing/concepts/billing-account.md) **не нужен**. +### Какие версии IDE поддерживаются? {#ide-versions} + +{{ ca-short-name }} поддерживает работу в IDE от JetBrains версий 2024.1 и 2024.2. + +### Плагин не запускается, сообщение об ошибке 404, не появляются предложения от {{ ca-short-name }} {#plugin-doesnt-start} -### Работа в IDE от JetBrains {#jetbrains-ide} +Попробуйте перезапустить IDE. -#### Плагин устанавливается некорректно {#plugin-installed-incorrectly} +### Плагин устанавливается некорректно {#plugin-installed-incorrectly} {% include [plugin-ide-zip](../_includes/code-assistant/plugin-ide-zip.md) %} -#### Ошибка аутентификации с прокси {#auth-error-proxy} +### Ошибка аутентификации с прокси {#auth-error-proxy} Текст ошибки: @@ -49,7 +68,7 @@ Failed to authenticate with proxy Проверьте, не включен ли прокси-сервер в IDE. Если включен — отключите и попробуйте аутентифицироваться еще раз. -#### Как получить логи работы IDE {#get-logs-ide} +### Как получить логи работы IDE {#get-logs-ide} Если для решения проблем с {{ ca-short-name }} вы хотите обратиться в [техническую поддержку]({{ link-console-support }}), заранее подготовьте файл с логом IDE: diff --git a/ru/code-assistant/quickstart.md b/ru/code-assistant/quickstart.md index 22d93c49ec0..e96345265f5 100644 --- a/ru/code-assistant/quickstart.md +++ b/ru/code-assistant/quickstart.md @@ -1,6 +1,6 @@ --- title: Начало работы с {{ ca-full-name }} -description: Установите плагин {{ ca-name }} для Visual Studio Code. +description: Установите плагин {{ ca-name }} для Visual Studio Code и IDE от JetBrains. --- # Как начать работать с {{ ca-full-name }} @@ -50,11 +50,15 @@ description: Установите плагин {{ ca-name }} для Visual Studi 1. Чтобы начать работать с плагином, аутентифицируйтесь в {{ yandex-cloud }}: 1. Во всплывающем окне **No active session found. Log in please** нажмите кнопку **Go to browser**. + + Чтобы аутентифицироваться в плагине повторно или как другой пользователь {{ yandex-cloud }}, в строке поиска в верхней части экрана введите `>Yandex Code Assistant`. В открывшемся списке выберите **Yandex Code Assistant: Login**. 1. Разрешите Visual Studio Code открыть в браузере страницу аутентификации. - 1. В браузере войдите в [консоль управления]({{ link-console-main }}) {{ yandex-cloud }}. - 1. Вернитесь обратно в Visual Studio Code. + 1. В браузере войдите в [консоль управления]({{ link-console-main }}) {{ yandex-cloud }} и во всплывающем окне нажмите **Открыть приложение**. + 1. Вернитесь обратно в Visual Studio Code. - Плагин включен, готов к работе и отображается на нижней панели редактора в виде кнопки ![image](../_assets/code-assistant/vsc-icon-small.svg). + Если плагин включен и готов к работе, то на нижней панели редактора отобразится значок ![image](../_assets/code-assistant/vsc-icon-small.svg). + + Нажмите на этот значок, чтобы посмотреть имя пользователя {{ yandex-cloud }}, аутентифицированного в плагине. Имя пользователя отобразится в списке в строке **Logged in as <имя_пользователя>**. Если пользователь не аутентифицирован, в списке такой строки не будет. - IDE от JetBrains {#jb} @@ -86,10 +90,14 @@ description: Установите плагин {{ ca-name }} для Visual Studi 1. Чтобы начать работать с плагином, аутентифицируйтесь в {{ yandex-cloud }}: 1. Во всплывающем окне **Yandex Code Assistant OAuth** нажмите **Yandex Code Assist: Login**. + + Чтобы аутентифицироваться в плагине повторно или как другой пользователь {{ yandex-cloud }}, в правом верхнем углу редактора нажмите значок ![magnifier](../_assets/console-icons/magnifier.svg), в открывшемся окне введите `Yandex Code Assistant` и выберите **Yandex Code Assistant: Login**. 1. В браузере войдите в [консоль управления]({{ link-console-main }}) {{ yandex-cloud }}. - 1. Вернитесь обратно в IDE. + 1. Вернитесь обратно в IDE. - Сообщение `Code Assist plugin started` означает, что плагин включен и готов к работе. + Если плагин включен и готов к работе, то на нижней панели редактора отобразится кнопка **Yandex CA**. + + Нажмите эту кнопку, чтобы посмотреть имя пользователя {{ yandex-cloud }}, аутентифицированного в плагине. Имя пользователя отобразится в сообщении в строке **Logged in as: <имя_пользователя>**. Если пользователь не аутентифицирован, в сообщении будет указано **No Auth data**. {% note tip %} @@ -195,6 +203,28 @@ description: Установите плагин {{ ca-name }} для Visual Studi {% endlist %} +### Выйдите из профиля {{ yandex-cloud }} {#logout} + +Чтобы выйти из профиля {{ yandex-cloud }} в плагине {{ ca-name }}: + +{% list tabs group=ide %} + +- Visual Studio Code {#vscode} + + В Visual Studio Code доступны два способа выхода из профиля: + + * На нижней панели редактора нажмите кнопку ![image](../_assets/code-assistant/vsc-icon-small.svg) и в открывшемся списке выберите **Logout**. + + * В строке поиска в верхней части экрана введите `>Yandex Code Assistant` и в открывшемся списке выберите **Yandex Code Assistant: Logout**. + +- IDE от JetBrains {#jb} + + В правом верхнем углу редактора нажмите значок ![magnifier](../_assets/console-icons/magnifier.svg), в открывшемся окне введите `Yandex Code Assistant` и выберите **Yandex Code Assistant: Logout**. + +{% endlist %} + +Чтобы повторно аутентифицироваться в плагине, выполните шаги, описанные в п. 3 раздела [{#T}](#install-plugin). + ### Удалите плагин {#remove-plugin} {% list tabs group=ide %} diff --git a/ru/compute/api-ref/Disk/create.md b/ru/compute/api-ref/Disk/create.md index d562dfac9e7..49cbebcf7da 100644 --- a/ru/compute/api-ref/Disk/create.md +++ b/ru/compute/api-ref/Disk/create.md @@ -46,7 +46,8 @@ POST https://compute.{{ api-host }}/compute/v1/disks }, "generation2Features": "object" // end of the list of possible fields - } + }, + "kmsKeyId": "string" } ``` @@ -101,6 +102,9 @@ List of IDs of the snapshot schedules to attach the disk to. || Specify the overrides to hardware_generation of a source disk, image or snapshot, or to the default values if the source does not define it. || +|| kmsKeyId | **string** + +ID of KMS key for disk encryption. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} @@ -200,6 +204,10 @@ Allows switching to PCI_TOPOLOGY_V2 and back. }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -381,6 +389,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy2} @@ -422,4 +433,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/Disk/get.md b/ru/compute/api-ref/Disk/get.md index 4ad8c8998f4..54b052faf5b 100644 --- a/ru/compute/api-ref/Disk/get.md +++ b/ru/compute/api-ref/Disk/get.md @@ -63,6 +63,10 @@ To get the disk ID use a [DiskService.List](/docs/compute/api-ref/Disk/list#List }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ``` @@ -145,6 +149,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} @@ -186,4 +193,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/Disk/list.md b/ru/compute/api-ref/Disk/list.md index 0a3f1ee43a2..3b2aceaa927 100644 --- a/ru/compute/api-ref/Disk/list.md +++ b/ru/compute/api-ref/Disk/list.md @@ -88,6 +88,10 @@ The default sorting order is ascending || }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ], @@ -190,6 +194,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} @@ -231,4 +238,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/Disk/move.md b/ru/compute/api-ref/Disk/move.md index 571a8cd358b..468880916b7 100644 --- a/ru/compute/api-ref/Disk/move.md +++ b/ru/compute/api-ref/Disk/move.md @@ -99,6 +99,10 @@ To get the folder ID, make a [yandex.cloud.resourcemanager.v1.FolderService.List }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -286,6 +290,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} @@ -327,4 +334,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/Disk/relocate.md b/ru/compute/api-ref/Disk/relocate.md index 642782ac0c6..01c8c9d94c8 100644 --- a/ru/compute/api-ref/Disk/relocate.md +++ b/ru/compute/api-ref/Disk/relocate.md @@ -119,6 +119,10 @@ Placement group ID. || }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -306,6 +310,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy2} @@ -347,4 +354,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/Disk/update.md b/ru/compute/api-ref/Disk/update.md index d220250e11f..c07900e47dd 100644 --- a/ru/compute/api-ref/Disk/update.md +++ b/ru/compute/api-ref/Disk/update.md @@ -136,6 +136,10 @@ Placement group ID. || }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -317,6 +321,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy2} @@ -358,4 +365,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/DiskPlacementGroup/listDisks.md b/ru/compute/api-ref/DiskPlacementGroup/listDisks.md index 12c13825efc..a0d8e207867 100644 --- a/ru/compute/api-ref/DiskPlacementGroup/listDisks.md +++ b/ru/compute/api-ref/DiskPlacementGroup/listDisks.md @@ -80,6 +80,10 @@ returned by a previous list request. || }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ], @@ -182,6 +186,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} @@ -223,4 +230,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/Image/create.md b/ru/compute/api-ref/Image/create.md index 2ea30703a6d..d84d68e61e9 100644 --- a/ru/compute/api-ref/Image/create.md +++ b/ru/compute/api-ref/Image/create.md @@ -214,6 +214,10 @@ Allows switching to PCI_TOPOLOGY_V2 and back. }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -386,6 +390,9 @@ When true, indicates there is an image pool for fast creation disks from the ima If specified, forces the same HardwareGeneration features to be applied to the instance created using this image as a source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## Os {#yandex.cloud.compute.v1.Os2} @@ -432,4 +439,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/Image/get.md b/ru/compute/api-ref/Image/get.md index 9807b2ed8a1..ecbdc4a07ab 100644 --- a/ru/compute/api-ref/Image/get.md +++ b/ru/compute/api-ref/Image/get.md @@ -55,6 +55,10 @@ To get the image ID, use a [ImageService.List](/docs/compute/api-ref/Image/list# }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ``` @@ -128,6 +132,9 @@ When true, indicates there is an image pool for fast creation disks from the ima If specified, forces the same HardwareGeneration features to be applied to the instance created using this image as a source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## Os {#yandex.cloud.compute.v1.Os} @@ -174,4 +181,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/Image/getLatestByFamily.md b/ru/compute/api-ref/Image/getLatestByFamily.md index 60a8b5a449a..ee1c4659591 100644 --- a/ru/compute/api-ref/Image/getLatestByFamily.md +++ b/ru/compute/api-ref/Image/getLatestByFamily.md @@ -56,6 +56,10 @@ Name of the image family to search for. || }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ``` @@ -129,6 +133,9 @@ When true, indicates there is an image pool for fast creation disks from the ima If specified, forces the same HardwareGeneration features to be applied to the instance created using this image as a source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## Os {#yandex.cloud.compute.v1.Os} @@ -175,4 +182,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/Image/list.md b/ru/compute/api-ref/Image/list.md index 74aeba77771..7891c5785b6 100644 --- a/ru/compute/api-ref/Image/list.md +++ b/ru/compute/api-ref/Image/list.md @@ -80,6 +80,10 @@ The default sorting order is ascending || }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ], @@ -173,6 +177,9 @@ When true, indicates there is an image pool for fast creation disks from the ima If specified, forces the same HardwareGeneration features to be applied to the instance created using this image as a source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## Os {#yandex.cloud.compute.v1.Os} @@ -219,4 +226,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/Image/update.md b/ru/compute/api-ref/Image/update.md index 62c81442cde..f06c3ed78c4 100644 --- a/ru/compute/api-ref/Image/update.md +++ b/ru/compute/api-ref/Image/update.md @@ -112,6 +112,10 @@ Existing set of `labels` is completely replaced by the provided set. || }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -284,6 +288,9 @@ When true, indicates there is an image pool for fast creation disks from the ima If specified, forces the same HardwareGeneration features to be applied to the instance created using this image as a source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## Os {#yandex.cloud.compute.v1.Os} @@ -330,4 +337,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/Instance/attachDisk.md b/ru/compute/api-ref/Instance/attachDisk.md index ddbd1205a4c..f969024f1d3 100644 --- a/ru/compute/api-ref/Instance/attachDisk.md +++ b/ru/compute/api-ref/Instance/attachDisk.md @@ -37,15 +37,16 @@ To get the instance ID, use a [InstanceService.List](/docs/compute/api-ref/Insta "description": "string", "typeId": "string", "size": "string", - "blockSize": "string", + // Includes only one of the fields `imageId`, `snapshotId` + "imageId": "string", + "snapshotId": "string", + // end of the list of possible fields "diskPlacementPolicy": { "placementGroupId": "string", "placementGroupPartition": "string" }, - // Includes only one of the fields `imageId`, `snapshotId` - "imageId": "string", - "snapshotId": "string" - // end of the list of possible fields + "blockSize": "string", + "kmsKeyId": "string" }, "diskId": "string" // end of the list of possible fields @@ -110,12 +111,6 @@ To get a list of available disk types, use the [yandex.cloud.compute.v1.DiskType || size | **string** (int64) Required field. Size of the disk, specified in bytes. || -|| blockSize | **string** (int64) - -Block size of the disk, specified in bytes. The default is 4096. || -|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** - -Placement policy configuration. || || imageId | **string** ID of the image to create the disk from. @@ -126,6 +121,15 @@ Includes only one of the fields `imageId`, `snapshotId`. || ID of the snapshot to restore the disk from. Includes only one of the fields `imageId`, `snapshotId`. || +|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** + +Placement policy configuration. || +|| blockSize | **string** (int64) + +Block size of the disk, specified in bytes. The default is 4096. || +|| kmsKeyId | **string** + +ID of KMS key for disk encryption || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} diff --git a/ru/compute/api-ref/Instance/create.md b/ru/compute/api-ref/Instance/create.md index 20c3fe5f4c4..d8fdda4b7d8 100644 --- a/ru/compute/api-ref/Instance/create.md +++ b/ru/compute/api-ref/Instance/create.md @@ -47,15 +47,16 @@ POST https://compute.{{ api-host }}/compute/v1/instances "description": "string", "typeId": "string", "size": "string", - "blockSize": "string", + // Includes only one of the fields `imageId`, `snapshotId` + "imageId": "string", + "snapshotId": "string", + // end of the list of possible fields "diskPlacementPolicy": { "placementGroupId": "string", "placementGroupPartition": "string" }, - // Includes only one of the fields `imageId`, `snapshotId` - "imageId": "string", - "snapshotId": "string" - // end of the list of possible fields + "blockSize": "string", + "kmsKeyId": "string" }, "diskId": "string" // end of the list of possible fields @@ -71,15 +72,16 @@ POST https://compute.{{ api-host }}/compute/v1/instances "description": "string", "typeId": "string", "size": "string", - "blockSize": "string", + // Includes only one of the fields `imageId`, `snapshotId` + "imageId": "string", + "snapshotId": "string", + // end of the list of possible fields "diskPlacementPolicy": { "placementGroupId": "string", "placementGroupPartition": "string" }, - // Includes only one of the fields `imageId`, `snapshotId` - "imageId": "string", - "snapshotId": "string" - // end of the list of possible fields + "blockSize": "string", + "kmsKeyId": "string" }, "diskId": "string" // end of the list of possible fields @@ -393,12 +395,6 @@ To get a list of available disk types, use the [yandex.cloud.compute.v1.DiskType || size | **string** (int64) Required field. Size of the disk, specified in bytes. || -|| blockSize | **string** (int64) - -Block size of the disk, specified in bytes. The default is 4096. || -|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** - -Placement policy configuration. || || imageId | **string** ID of the image to create the disk from. @@ -409,6 +405,15 @@ Includes only one of the fields `imageId`, `snapshotId`. || ID of the snapshot to restore the disk from. Includes only one of the fields `imageId`, `snapshotId`. || +|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** + +Placement policy configuration. || +|| blockSize | **string** (int64) + +Block size of the disk, specified in bytes. The default is 4096. || +|| kmsKeyId | **string** + +ID of KMS key for disk encryption || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} diff --git a/ru/compute/api-ref/Instance/index.md b/ru/compute/api-ref/Instance/index.md index 608d02ce8e8..c38bc32621f 100644 --- a/ru/compute/api-ref/Instance/index.md +++ b/ru/compute/api-ref/Instance/index.md @@ -16,7 +16,7 @@ A set of methods for managing Instance resources. || [Create](create.md) | Creates an instance in the specified folder. || || [Update](update.md) | Updates the specified instance. || || [Delete](delete.md) | Deletes the specified instance. || -|| [UpdateMetadata](updateMetadata.md) | Updates the metadata of the specified instance. || +|| [UpdateMetadata](updateMetadata.md) | Updates the metadata of the specified instance. For more information on metadata, see [VM metadata](/docs/compute/concepts/vm-metadata). || || [GetSerialPortOutput](getSerialPortOutput.md) | Returns the serial port output of the specified Instance resource. || || [Stop](stop.md) | Stops the running instance. || || [Start](start.md) | Starts the stopped instance. || diff --git a/ru/compute/api-ref/Instance/updateMetadata.md b/ru/compute/api-ref/Instance/updateMetadata.md index c07101c0899..58e9f7be1c4 100644 --- a/ru/compute/api-ref/Instance/updateMetadata.md +++ b/ru/compute/api-ref/Instance/updateMetadata.md @@ -5,7 +5,7 @@ sourcePath: en/_api-ref/compute/v1/api-ref/Instance/updateMetadata.md # Compute Cloud API, REST: Instance.UpdateMetadata {#UpdateMetadata} -Updates the metadata of the specified instance. +Updates the metadata of the specified instance. For more information on metadata, see [VM metadata](/docs/compute/concepts/vm-metadata). ## HTTP request diff --git a/ru/compute/api-ref/Snapshot/create.md b/ru/compute/api-ref/Snapshot/create.md index 3ed1eaefe68..469bf549b3b 100644 --- a/ru/compute/api-ref/Snapshot/create.md +++ b/ru/compute/api-ref/Snapshot/create.md @@ -134,6 +134,10 @@ Allows switching to PCI_TOPOLOGY_V2 and back. }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -299,6 +303,9 @@ ID of the source disk used to create this snapshot. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this snapshot as source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## HardwareGeneration {#yandex.cloud.compute.v1.HardwareGeneration2} @@ -330,4 +337,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/Snapshot/get.md b/ru/compute/api-ref/Snapshot/get.md index d1decb6c467..5c2804a96c9 100644 --- a/ru/compute/api-ref/Snapshot/get.md +++ b/ru/compute/api-ref/Snapshot/get.md @@ -51,6 +51,10 @@ To get the snapshot ID, use a [SnapshotService.List](/docs/compute/api-ref/Snaps }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ``` @@ -114,6 +118,9 @@ ID of the source disk used to create this snapshot. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this snapshot as source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## HardwareGeneration {#yandex.cloud.compute.v1.HardwareGeneration} @@ -145,4 +152,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/Snapshot/list.md b/ru/compute/api-ref/Snapshot/list.md index 1803f26a9e8..6d9d049c2f6 100644 --- a/ru/compute/api-ref/Snapshot/list.md +++ b/ru/compute/api-ref/Snapshot/list.md @@ -76,6 +76,10 @@ The default sorting order is ascending || }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ], @@ -159,6 +163,9 @@ ID of the source disk used to create this snapshot. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this snapshot as source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## HardwareGeneration {#yandex.cloud.compute.v1.HardwareGeneration} @@ -190,4 +197,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/Snapshot/update.md b/ru/compute/api-ref/Snapshot/update.md index 3a4e46703c7..6e87efc6cd3 100644 --- a/ru/compute/api-ref/Snapshot/update.md +++ b/ru/compute/api-ref/Snapshot/update.md @@ -105,6 +105,10 @@ Existing set of `labels` is completely replaced by the provided set. || }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -267,6 +271,9 @@ ID of the source disk used to create this snapshot. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this snapshot as source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## HardwareGeneration {#yandex.cloud.compute.v1.HardwareGeneration} @@ -298,4 +305,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/SnapshotSchedule/listDisks.md b/ru/compute/api-ref/SnapshotSchedule/listDisks.md index 1eb64ca4562..c02dd2869d9 100644 --- a/ru/compute/api-ref/SnapshotSchedule/listDisks.md +++ b/ru/compute/api-ref/SnapshotSchedule/listDisks.md @@ -81,6 +81,10 @@ Page token. To get the next page of results, set `pageToken` to the }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ], @@ -182,6 +186,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} @@ -223,4 +230,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/SnapshotSchedule/listSnapshots.md b/ru/compute/api-ref/SnapshotSchedule/listSnapshots.md index 2d6ff57af10..47bd10864e3 100644 --- a/ru/compute/api-ref/SnapshotSchedule/listSnapshots.md +++ b/ru/compute/api-ref/SnapshotSchedule/listSnapshots.md @@ -69,6 +69,10 @@ Page token. To get the next page of results, set `pageToken` to the }, "generation2Features": "object" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ], @@ -151,6 +155,9 @@ ID of the source disk used to create this snapshot. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this snapshot as source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## HardwareGeneration {#yandex.cloud.compute.v1.HardwareGeneration} @@ -182,4 +189,16 @@ Allows switching to PCI_TOPOLOGY_V2 and back. - `PCI_TOPOLOGY_UNSPECIFIED` - `PCI_TOPOLOGY_V1` - `PCI_TOPOLOGY_V2` || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/grpc/Disk/create.md b/ru/compute/api-ref/grpc/Disk/create.md index c9a78d8adf6..3215eeac205 100644 --- a/ru/compute/api-ref/grpc/Disk/create.md +++ b/ru/compute/api-ref/grpc/Disk/create.md @@ -44,7 +44,8 @@ Method starts an asynchronous operation that can be cancelled while it is in pro }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields - } + }, + "kmsKeyId": "string" } ``` @@ -99,6 +100,9 @@ List of IDs of the snapshot schedules to attach the disk to. || Specify the overrides to hardware_generation of a source disk, image or snapshot, or to the default values if the source does not define it. || +|| kmsKeyId | **string** + +ID of KMS key for disk encryption. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} @@ -200,6 +204,10 @@ and UEFI boot (with UEFI related features). }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -343,6 +351,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy2} @@ -394,4 +405,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/grpc/Disk/get.md b/ru/compute/api-ref/grpc/Disk/get.md index fba864cf277..288245c0fd4 100644 --- a/ru/compute/api-ref/grpc/Disk/get.md +++ b/ru/compute/api-ref/grpc/Disk/get.md @@ -65,6 +65,10 @@ To get the disk ID use a [DiskService.List](/docs/compute/api-ref/grpc/Disk/list }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ``` @@ -140,6 +144,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} @@ -191,4 +198,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/grpc/Disk/list.md b/ru/compute/api-ref/grpc/Disk/list.md index 8c826f86312..2a2842ba62e 100644 --- a/ru/compute/api-ref/grpc/Disk/list.md +++ b/ru/compute/api-ref/grpc/Disk/list.md @@ -94,6 +94,10 @@ The default sorting order is ascending || }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ], @@ -189,6 +193,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} @@ -240,4 +247,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/grpc/Disk/move.md b/ru/compute/api-ref/grpc/Disk/move.md index 17b62ce4bcd..2039baa9c8d 100644 --- a/ru/compute/api-ref/grpc/Disk/move.md +++ b/ru/compute/api-ref/grpc/Disk/move.md @@ -84,6 +84,10 @@ To get the folder ID, make a [yandex.cloud.resourcemanager.v1.FolderService.List }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -233,6 +237,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} @@ -284,4 +291,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/grpc/Disk/relocate.md b/ru/compute/api-ref/grpc/Disk/relocate.md index 82f8a5f3aa2..8076865af38 100644 --- a/ru/compute/api-ref/grpc/Disk/relocate.md +++ b/ru/compute/api-ref/grpc/Disk/relocate.md @@ -104,6 +104,10 @@ Placement group ID. || }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -253,6 +257,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy2} @@ -304,4 +311,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/grpc/Disk/update.md b/ru/compute/api-ref/grpc/Disk/update.md index c81aa271447..843d4bdb474 100644 --- a/ru/compute/api-ref/grpc/Disk/update.md +++ b/ru/compute/api-ref/grpc/Disk/update.md @@ -114,6 +114,10 @@ Placement group ID. || }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -257,6 +261,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy2} @@ -308,4 +315,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/grpc/DiskPlacementGroup/listDisks.md b/ru/compute/api-ref/grpc/DiskPlacementGroup/listDisks.md index e0480bef255..602ac51b23a 100644 --- a/ru/compute/api-ref/grpc/DiskPlacementGroup/listDisks.md +++ b/ru/compute/api-ref/grpc/DiskPlacementGroup/listDisks.md @@ -78,6 +78,10 @@ returned by a previous list request. || }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ], @@ -173,6 +177,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} @@ -224,4 +231,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/grpc/Image/create.md b/ru/compute/api-ref/grpc/Image/create.md index 9d889273d41..1fd1da54673 100644 --- a/ru/compute/api-ref/grpc/Image/create.md +++ b/ru/compute/api-ref/grpc/Image/create.md @@ -214,6 +214,10 @@ and UEFI boot (with UEFI related features). }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -348,6 +352,9 @@ When true, indicates there is an image pool for fast creation disks from the ima If specified, forces the same HardwareGeneration features to be applied to the instance created using this image as a source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## Os {#yandex.cloud.compute.v1.Os2} @@ -404,4 +411,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/grpc/Image/get.md b/ru/compute/api-ref/grpc/Image/get.md index 55b19a1a9e4..edf491e1d2d 100644 --- a/ru/compute/api-ref/grpc/Image/get.md +++ b/ru/compute/api-ref/grpc/Image/get.md @@ -57,6 +57,10 @@ To get the image ID, use a [ImageService.List](/docs/compute/api-ref/grpc/Image/ }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ``` @@ -123,6 +127,9 @@ When true, indicates there is an image pool for fast creation disks from the ima If specified, forces the same HardwareGeneration features to be applied to the instance created using this image as a source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## Os {#yandex.cloud.compute.v1.Os} @@ -179,4 +186,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/grpc/Image/getLatestByFamily.md b/ru/compute/api-ref/grpc/Image/getLatestByFamily.md index 302c97a109b..7b9ee390de8 100644 --- a/ru/compute/api-ref/grpc/Image/getLatestByFamily.md +++ b/ru/compute/api-ref/grpc/Image/getLatestByFamily.md @@ -59,6 +59,10 @@ Name of the image family to search for. || }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ``` @@ -125,6 +129,9 @@ When true, indicates there is an image pool for fast creation disks from the ima If specified, forces the same HardwareGeneration features to be applied to the instance created using this image as a source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## Os {#yandex.cloud.compute.v1.Os} @@ -181,4 +188,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/grpc/Image/list.md b/ru/compute/api-ref/grpc/Image/list.md index 15a51f16889..b7e73f9d2eb 100644 --- a/ru/compute/api-ref/grpc/Image/list.md +++ b/ru/compute/api-ref/grpc/Image/list.md @@ -86,6 +86,10 @@ The default sorting order is ascending || }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ], @@ -172,6 +176,9 @@ When true, indicates there is an image pool for fast creation disks from the ima If specified, forces the same HardwareGeneration features to be applied to the instance created using this image as a source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## Os {#yandex.cloud.compute.v1.Os} @@ -228,4 +235,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/grpc/Image/update.md b/ru/compute/api-ref/grpc/Image/update.md index 06e2e268e0a..411aeea5281 100644 --- a/ru/compute/api-ref/grpc/Image/update.md +++ b/ru/compute/api-ref/grpc/Image/update.md @@ -90,6 +90,10 @@ Existing set of `labels` is completely replaced by the provided set. || }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -224,6 +228,9 @@ When true, indicates there is an image pool for fast creation disks from the ima If specified, forces the same HardwareGeneration features to be applied to the instance created using this image as a source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## Os {#yandex.cloud.compute.v1.Os} @@ -280,4 +287,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/grpc/Instance/attachDisk.md b/ru/compute/api-ref/grpc/Instance/attachDisk.md index 384e3bd395e..3b0a0e4de17 100644 --- a/ru/compute/api-ref/grpc/Instance/attachDisk.md +++ b/ru/compute/api-ref/grpc/Instance/attachDisk.md @@ -26,15 +26,16 @@ Attaches the disk to the instance. "description": "string", "typeId": "string", "size": "int64", - "blockSize": "int64", + // Includes only one of the fields `imageId`, `snapshotId` + "imageId": "string", + "snapshotId": "string", + // end of the list of possible fields "diskPlacementPolicy": { "placementGroupId": "string", "placementGroupPartition": "int64" }, - // Includes only one of the fields `imageId`, `snapshotId` - "imageId": "string", - "snapshotId": "string" - // end of the list of possible fields + "blockSize": "int64", + "kmsKeyId": "string" }, "diskId": "string" // end of the list of possible fields @@ -103,12 +104,6 @@ To get a list of available disk types, use the [yandex.cloud.compute.v1.DiskType || size | **int64** Required field. Size of the disk, specified in bytes. || -|| blockSize | **int64** - -Block size of the disk, specified in bytes. The default is 4096. || -|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** - -Placement policy configuration. || || imageId | **string** ID of the image to create the disk from. @@ -119,6 +114,15 @@ Includes only one of the fields `imageId`, `snapshotId`. || ID of the snapshot to restore the disk from. Includes only one of the fields `imageId`, `snapshotId`. || +|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** + +Placement policy configuration. || +|| blockSize | **int64** + +Block size of the disk, specified in bytes. The default is 4096. || +|| kmsKeyId | **string** + +ID of KMS key for disk encryption || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} diff --git a/ru/compute/api-ref/grpc/Instance/create.md b/ru/compute/api-ref/grpc/Instance/create.md index 36888b1e7c9..f365a4c7a42 100644 --- a/ru/compute/api-ref/grpc/Instance/create.md +++ b/ru/compute/api-ref/grpc/Instance/create.md @@ -45,15 +45,16 @@ Method starts an asynchronous operation that can be cancelled while it is in pro "description": "string", "typeId": "string", "size": "int64", - "blockSize": "int64", + // Includes only one of the fields `imageId`, `snapshotId` + "imageId": "string", + "snapshotId": "string", + // end of the list of possible fields "diskPlacementPolicy": { "placementGroupId": "string", "placementGroupPartition": "int64" }, - // Includes only one of the fields `imageId`, `snapshotId` - "imageId": "string", - "snapshotId": "string" - // end of the list of possible fields + "blockSize": "int64", + "kmsKeyId": "string" }, "diskId": "string" // end of the list of possible fields @@ -69,15 +70,16 @@ Method starts an asynchronous operation that can be cancelled while it is in pro "description": "string", "typeId": "string", "size": "int64", - "blockSize": "int64", + // Includes only one of the fields `imageId`, `snapshotId` + "imageId": "string", + "snapshotId": "string", + // end of the list of possible fields "diskPlacementPolicy": { "placementGroupId": "string", "placementGroupPartition": "int64" }, - // Includes only one of the fields `imageId`, `snapshotId` - "imageId": "string", - "snapshotId": "string" - // end of the list of possible fields + "blockSize": "int64", + "kmsKeyId": "string" }, "diskId": "string" // end of the list of possible fields @@ -391,12 +393,6 @@ To get a list of available disk types, use the [yandex.cloud.compute.v1.DiskType || size | **int64** Required field. Size of the disk, specified in bytes. || -|| blockSize | **int64** - -Block size of the disk, specified in bytes. The default is 4096. || -|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** - -Placement policy configuration. || || imageId | **string** ID of the image to create the disk from. @@ -407,6 +403,15 @@ Includes only one of the fields `imageId`, `snapshotId`. || ID of the snapshot to restore the disk from. Includes only one of the fields `imageId`, `snapshotId`. || +|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** + +Placement policy configuration. || +|| blockSize | **int64** + +Block size of the disk, specified in bytes. The default is 4096. || +|| kmsKeyId | **string** + +ID of KMS key for disk encryption || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} diff --git a/ru/compute/api-ref/grpc/Instance/index.md b/ru/compute/api-ref/grpc/Instance/index.md index f2359dcebcd..27c436945da 100644 --- a/ru/compute/api-ref/grpc/Instance/index.md +++ b/ru/compute/api-ref/grpc/Instance/index.md @@ -16,7 +16,7 @@ A set of methods for managing Instance resources. || [Create](create.md) | Creates an instance in the specified folder. || || [Update](update.md) | Updates the specified instance. || || [Delete](delete.md) | Deletes the specified instance. || -|| [UpdateMetadata](updateMetadata.md) | Updates the metadata of the specified instance. || +|| [UpdateMetadata](updateMetadata.md) | Updates the metadata of the specified instance. For more information on metadata, see [VM metadata](/docs/compute/concepts/vm-metadata). || || [GetSerialPortOutput](getSerialPortOutput.md) | Returns the serial port output of the specified Instance resource. || || [Stop](stop.md) | Stops the running instance. || || [Start](start.md) | Starts the stopped instance. || diff --git a/ru/compute/api-ref/grpc/Instance/updateMetadata.md b/ru/compute/api-ref/grpc/Instance/updateMetadata.md index 04cae171e03..15a642fea61 100644 --- a/ru/compute/api-ref/grpc/Instance/updateMetadata.md +++ b/ru/compute/api-ref/grpc/Instance/updateMetadata.md @@ -5,7 +5,7 @@ sourcePath: en/_api-ref-grpc/compute/v1/api-ref/grpc/Instance/updateMetadata.md # Compute Cloud API, gRPC: InstanceService.UpdateMetadata {#UpdateMetadata} -Updates the metadata of the specified instance. +Updates the metadata of the specified instance. For more information on metadata, see [VM metadata](/docs/compute/concepts/vm-metadata). ## gRPC request diff --git a/ru/compute/api-ref/grpc/Snapshot/create.md b/ru/compute/api-ref/grpc/Snapshot/create.md index dd743dcdbff..3866d7c0721 100644 --- a/ru/compute/api-ref/grpc/Snapshot/create.md +++ b/ru/compute/api-ref/grpc/Snapshot/create.md @@ -134,6 +134,10 @@ and UEFI boot (with UEFI related features). }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -261,6 +265,9 @@ ID of the source disk used to create this snapshot. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this snapshot as source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## HardwareGeneration {#yandex.cloud.compute.v1.HardwareGeneration2} @@ -302,4 +309,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/grpc/Snapshot/get.md b/ru/compute/api-ref/grpc/Snapshot/get.md index 19450d879b6..5bbb71f7eb4 100644 --- a/ru/compute/api-ref/grpc/Snapshot/get.md +++ b/ru/compute/api-ref/grpc/Snapshot/get.md @@ -53,6 +53,10 @@ To get the snapshot ID, use a [SnapshotService.List](/docs/compute/api-ref/grpc/ }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ``` @@ -109,6 +113,9 @@ ID of the source disk used to create this snapshot. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this snapshot as source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## HardwareGeneration {#yandex.cloud.compute.v1.HardwareGeneration} @@ -150,4 +157,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/grpc/Snapshot/list.md b/ru/compute/api-ref/grpc/Snapshot/list.md index 34435d12d93..1b6a4084035 100644 --- a/ru/compute/api-ref/grpc/Snapshot/list.md +++ b/ru/compute/api-ref/grpc/Snapshot/list.md @@ -82,6 +82,10 @@ The default sorting order is ascending || }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ], @@ -158,6 +162,9 @@ ID of the source disk used to create this snapshot. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this snapshot as source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## HardwareGeneration {#yandex.cloud.compute.v1.HardwareGeneration} @@ -199,4 +206,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/grpc/Snapshot/update.md b/ru/compute/api-ref/grpc/Snapshot/update.md index 5ea0c25801d..3874c2257a2 100644 --- a/ru/compute/api-ref/grpc/Snapshot/update.md +++ b/ru/compute/api-ref/grpc/Snapshot/update.md @@ -83,6 +83,10 @@ Existing set of `labels` is completely replaced by the provided set. || }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } // end of the list of possible fields @@ -207,6 +211,9 @@ ID of the source disk used to create this snapshot. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this snapshot as source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## HardwareGeneration {#yandex.cloud.compute.v1.HardwareGeneration} @@ -248,4 +255,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/grpc/SnapshotSchedule/listDisks.md b/ru/compute/api-ref/grpc/SnapshotSchedule/listDisks.md index 20e69145828..92ef0bec89b 100644 --- a/ru/compute/api-ref/grpc/SnapshotSchedule/listDisks.md +++ b/ru/compute/api-ref/grpc/SnapshotSchedule/listDisks.md @@ -79,6 +79,10 @@ Page token. To get the next page of results, set `pageToken` to the }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ], @@ -173,6 +177,9 @@ Placement policy configuration. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this disk as a boot one. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} @@ -224,4 +231,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/api-ref/grpc/SnapshotSchedule/listSnapshots.md b/ru/compute/api-ref/grpc/SnapshotSchedule/listSnapshots.md index 81392b480fe..69d044ee556 100644 --- a/ru/compute/api-ref/grpc/SnapshotSchedule/listSnapshots.md +++ b/ru/compute/api-ref/grpc/SnapshotSchedule/listSnapshots.md @@ -67,6 +67,10 @@ Page token. To get the next page of results, set `pageToken` to the }, "generation2Features": "Generation2HardwareFeatures" // end of the list of possible fields + }, + "kmsKey": { + "keyId": "string", + "versionId": "string" } } ], @@ -142,6 +146,9 @@ ID of the source disk used to create this snapshot. || If specified, forces the same HardwareGeneration features to be applied to the instance created using this snapshot as source for the boot disk. Otherwise the current default will be used. || +|| kmsKey | **[KMSKey](#yandex.cloud.compute.v1.KMSKey)** + +Key encryption key info. || |# ## HardwareGeneration {#yandex.cloud.compute.v1.HardwareGeneration} @@ -183,4 +190,16 @@ and UEFI boot (with UEFI related features). #| ||Field | Description || || Empty | > || +|# + +## KMSKey {#yandex.cloud.compute.v1.KMSKey} + +#| +||Field | Description || +|| keyId | **string** + +ID of KMS symmetric key || +|| versionId | **string** + +Version of KMS symmetric key || |# \ No newline at end of file diff --git a/ru/compute/operations/image-create/upload.md b/ru/compute/operations/image-create/upload.md index 34036919d8e..16a007b7bdb 100644 --- a/ru/compute/operations/image-create/upload.md +++ b/ru/compute/operations/image-create/upload.md @@ -145,6 +145,8 @@ keywords: ## Создайте ВМ из подготовленного образа {#create-vm-from-user-image} +Вы можете создать виртуальную машину с дисками, из подготовленного заранее образа. + {% include notitle [Как создать ВМ из своего образа](../../operations/vm-create/create-from-user-image.md#create-vm-from-image) %} О стоимости использования {{ objstorage-name }} читайте в разделе [{#T}](../../../storage/pricing.md). \ No newline at end of file diff --git a/ru/compute/operations/instance-groups/create-with-balancer.md b/ru/compute/operations/instance-groups/create-with-balancer.md index de34a7a64dc..83bbe0228fe 100644 --- a/ru/compute/operations/instance-groups/create-with-balancer.md +++ b/ru/compute/operations/instance-groups/create-with-balancer.md @@ -244,7 +244,7 @@ load_balancer_spec: target_group_spec: name: first-target-group - ``` + ``` 1. Создайте группу ВМ в каталоге по умолчанию: diff --git a/ru/compute/operations/vm-connect/enable-os-login.md b/ru/compute/operations/vm-connect/enable-os-login.md index 6a6e112a8de..176c1b8d7d1 100644 --- a/ru/compute/operations/vm-connect/enable-os-login.md +++ b/ru/compute/operations/vm-connect/enable-os-login.md @@ -7,6 +7,8 @@ description: Следуя данной инструкции, вы сможете Если вам необходимо настроить подключение по OS Login к уже развернутой виртуальной машине, вы можете самостоятельно установить на нее агент OS Login. +{% include [metadata-keys](../../../_includes/compute/os-login-enablement-notice.md) %} + ## Включить доступ по OS Login {#enable-os-login} Чтобы настроить доступ по OS Login к существующей виртуальной машине: @@ -77,7 +79,7 @@ description: Следуя данной инструкции, вы сможете 1. Выберите сервис **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. 1. На панели слева выберите ![image](../../../_assets/console-icons/server.svg) **{{ ui-key.yacloud.compute.switch_instances }}** и нажмите на имя нужной ВМ. 1. В правом верхнем углу экрана нажмите кнопку ![image](../../../_assets/console-icons/pencil.svg) **{{ ui-key.yacloud.compute.instance.overview.button_action-edit }}**. - 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** отключите опцию **Доступ через OS Login**. + 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** выберите вариант **{{ ui-key.yacloud.compute.instance.access-method.label_oslogin-control-ssh-option-title }}**. 1. Нажмите **{{ ui-key.yacloud.compute.instance.edit.button_update }}**. - CLI {#cli} diff --git a/ru/compute/operations/vm-connect/os-login-create-vm.md b/ru/compute/operations/vm-connect/os-login-create-vm.md index 86f78e5aa0c..f14e7340f46 100644 --- a/ru/compute/operations/vm-connect/os-login-create-vm.md +++ b/ru/compute/operations/vm-connect/os-login-create-vm.md @@ -11,6 +11,8 @@ description: Следуя данной инструкции, вы сможете К ВМ с включенным доступом по OS Login можно подключиться как [с помощью YC CLI](os-login.md#connect-with-yc-cli), так и [с помощью стандартного SSH-клиента](os-login.md#connect-with-ssh-client). При подключении можно использовать SSH-сертификат или SSH-ключ, предварительно [добавленный](../../../organization/operations/add-ssh.md) в профиль OS Login пользователя или сервисного аккаунта в {{ org-full-name }}. +{% include [metadata-keys](../../../_includes/compute/os-login-enablement-notice.md) %} + При этом на создаваемой ВМ желательно создать локального пользователя и отдельно передать для него SSH-ключ: так вы сможете [подключаться к ВМ по SSH](./ssh.md#vm-connect), если отключите для нее доступ по OS Login. Создать локального пользователя ВМ и передать SSH-ключ для него можно с помощью [метаданных](../../concepts/vm-metadata.md#how-to-send-metadata). {% include [metadata-keys](../../../_includes/compute/metadata-keys.md) %} @@ -25,9 +27,9 @@ description: Следуя данной инструкции, вы сможете 1. [Создайте ВМ](../images-with-pre-installed-software/create.md) из подготовленного образа с поддержкой доступа по OS Login. Такие образы доступны в [{{ marketplace-full-name }}](/marketplace). - При создании ВМ в блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** включите опцию **Доступ через OS Login**. + При создании ВМ в блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** выберите **Доступ по OS Login**. Если эта опция недоступна, значит выбранный образ не поддерживает доступ по OS Login. - Чтобы получить возможность [подключаться](./ssh.md#vm-connect) к ВМ по SSH без использования OS Login, [измените](../vm-control/vm-update.md) настройки ВМ, отключив эту опцию. + Чтобы получить возможность [подключаться](./ssh.md#vm-connect) к ВМ по SSH без использования OS Login, [измените](../vm-control/vm-update.md) настройки ВМ, выбрав вариант подключения **{{ ui-key.yacloud.compute.instance.access-method.label_oslogin-control-ssh-option-title }}**. - CLI {#cli} diff --git a/ru/compute/operations/vm-control/vm-update.md b/ru/compute/operations/vm-control/vm-update.md index ce5f05d9575..b7660ac0eb1 100644 --- a/ru/compute/operations/vm-control/vm-update.md +++ b/ru/compute/operations/vm-control/vm-update.md @@ -152,7 +152,7 @@ 1. Выберите сервис **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. 1. На панели слева выберите ![image](../../../_assets/console-icons/server.svg) **{{ ui-key.yacloud.compute.switch_instances }}** и нажмите на имя нужной ВМ. 1. В правом верхнем углу экрана нажмите кнопку ![image](../../../_assets/console-icons/pencil.svg) **{{ ui-key.yacloud.compute.instance.overview.button_action-edit }}**. - 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** включите опцию **Доступ через OS Login**. + 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** выберите вариант **Доступ по OS Login**. 1. Нажмите **{{ ui-key.yacloud.compute.instance.edit.button_update }}**. - CLI {#cli} diff --git a/ru/compute/operations/vm-create/create-from-snapshots.md b/ru/compute/operations/vm-create/create-from-snapshots.md index 64b7c1b3c73..92bde075926 100644 --- a/ru/compute/operations/vm-create/create-from-snapshots.md +++ b/ru/compute/operations/vm-create/create-from-snapshots.md @@ -8,4 +8,6 @@ description: Следуя данной инструкции, вы сможете Вы можете создать виртуальную машину с дисками, восстановленными из имеющихся в каталоге снимков. О том, как создать снимок диска, см. раздел [{#T}](../disk-control/create-snapshot.md). +{% include [independent-resources](../../../_includes/compute/independent-resources.md) %} + {% include [create-from-snapshot](../../../_includes/compute/create-from-snapshot.md) %} \ No newline at end of file diff --git a/ru/compute/operations/vm-create/create-from-user-image.md b/ru/compute/operations/vm-create/create-from-user-image.md index c7d150238fd..ce7cfcb7949 100644 --- a/ru/compute/operations/vm-create/create-from-user-image.md +++ b/ru/compute/operations/vm-create/create-from-user-image.md @@ -13,6 +13,8 @@ description: Следуя данной инструкции, вы сможете ## Создайте ВМ из подготовленного образа {#create-vm-from-image} +{% include [independent-resources](../../../_includes/compute/independent-resources.md) %} + {% list tabs group=instructions %} - Консоль управления {#console} diff --git a/ru/compute/release-notes.md b/ru/compute/release-notes.md index 4dc8197626a..9f718ddbc98 100644 --- a/ru/compute/release-notes.md +++ b/ru/compute/release-notes.md @@ -5,6 +5,11 @@ description: В разделе представлена история изме # История изменений в {{ compute-full-name }} +## III квартал 2024 {#q3-2024} + +* Реализована новая PCI-топология. Создать ВМ с новой топологией можно командой `yc instance create` с параметрами `--hardware-generation-id=generation2` и `--hardware-features pci_topology=v2`. +* QEMU обновлен до версии 7. + ## II квартал 2024 {#q2-2024} * Увеличены [лимиты](concepts/limits.md) сетевых соединений. diff --git a/ru/compute/toc.yaml b/ru/compute/toc.yaml index f16dd422f41..2f078c86557 100644 --- a/ru/compute/toc.yaml +++ b/ru/compute/toc.yaml @@ -389,6 +389,8 @@ items: href: tutorials/autoscale-monitoring.md - name: Обновление группы ВМ под нагрузкой href: tutorials/updating-under-load.md + - name: Развертывание Remote Desktop Gateway + href: tutorials/rds-gw.md - name: Начало работы с Packer href: tutorials/packer-quickstart.md - name: Передача логов с ВМ в {{ cloud-logging-full-name }} @@ -473,6 +475,40 @@ items: href: tutorials/alb-with-ddos-protection/console.md - name: '{{ TF }}' href: tutorials/alb-with-ddos-protection/terraform.md + - name: >- + Реализация защищенной высокодоступной сетевой инфраструктуры с + выделением DMZ на основе Check Point NGFW + href: tutorials/high-accessible-dmz.md + - name: >- + Сегментация облачной инфраструктуры с помощью решения Check Point + Next-Generation Firewall + href: tutorials/network-segmentation-checkpoint.md + - name: Настройка защищенного туннеля GRE поверх IPsec + href: tutorials/gre-over-ipsec.md + - name: Создание бастионного хоста + href: tutorials/bastion.md + - name: Реализация отказоустойчивых сценариев для сетевых виртуальных машин + href: tutorials/route-switcher.md + - name: >- + Создание туннеля между двумя подсетями при помощи OpenVPN Access + Server + href: tutorials/site-to-site-openvpn.md + - name: Продукты Microsoft в {{ yandex-cloud }} + items: + - name: Развертывание Active Directory + href: tutorials/secure-password-script.md + - name: Развертывание Active Directory + href: tutorials/active-directory.md + - name: Развертывание Microsoft Exchange + href: tutorials/exchange.md + - name: Развертывание Remote Desktop Services + href: tutorials/rds.md + - name: >- + Развертывание группы доступности Always On с внутренним сетевым + балансировщиком + href: tutorials/mssql-alwayson-lb.md + - name: Развертывание Remote Desktop Gateway + href: tutorials/rds-gw.md - name: Концепции items: - name: Взаимосвязь ресурсов diff --git a/ru/compute/tutorials/active-directory.md b/ru/compute/tutorials/active-directory.md new file mode 100644 index 00000000000..9c8c15f84a6 --- /dev/null +++ b/ru/compute/tutorials/active-directory.md @@ -0,0 +1,16 @@ +--- +title: Установка и развертывание Active Directory (AD) в облаке +description: Пошаговая инструкция процесса установки и развертывания Active Directory (AD) в облаке {{ yandex-cloud }}. Чтобы развернуть инфраструктуру Active Directory (AD) необходимо подготовить облако, создать сеть и подсети, создать виртуальную машину для Active Directory. +canonical: '{{ link-docs }}/tutorials/windows/active-directory' +keywords: + - установка Active Directory + - развертывание Active Directory + - установка AD + - active directory + - active directory как запустить + - планирование active directory + - настройка ad + - настройка active directory +--- + +{% include [active-directory](../../_tutorials/windows/active-directory.md) %} \ No newline at end of file diff --git a/ru/compute/tutorials/bastion.md b/ru/compute/tutorials/bastion.md new file mode 100644 index 00000000000..0d0f3409194 --- /dev/null +++ b/ru/compute/tutorials/bastion.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/routing/bastion' +--- + +{% include [bastion](../../_tutorials/routing/bastion.md) %} \ No newline at end of file diff --git a/ru/compute/tutorials/exchange.md b/ru/compute/tutorials/exchange.md new file mode 100644 index 00000000000..5c598d6e063 --- /dev/null +++ b/ru/compute/tutorials/exchange.md @@ -0,0 +1,7 @@ +--- +title: Развертывание Microsoft Exchange +description: В этом сценарии вы создадите сервера Microsoft Exchange в {{ yandex-cloud }}. +canonical: '{{ link-docs }}/tutorials/windows/exchange' +--- + +{% include [exchange.md](../../_tutorials/windows/exchange.md) %} \ No newline at end of file diff --git a/ru/compute/tutorials/gre-over-ipsec.md b/ru/compute/tutorials/gre-over-ipsec.md new file mode 100644 index 00000000000..20db43c9659 --- /dev/null +++ b/ru/compute/tutorials/gre-over-ipsec.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/routing/gre-over-ipsec' +--- + +{% include [gre-over-ipsec](../../_tutorials/routing/gre-over-ipsec.md) %} diff --git a/ru/compute/tutorials/high-accessible-dmz.md b/ru/compute/tutorials/high-accessible-dmz.md new file mode 100644 index 00000000000..79b30015022 --- /dev/null +++ b/ru/compute/tutorials/high-accessible-dmz.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/routing/high-accessible-dmz' +--- + +{% include [high-accessible-dmz](../../_tutorials/routing/high-accessible-dmz.md) %} \ No newline at end of file diff --git a/ru/compute/tutorials/index.md b/ru/compute/tutorials/index.md index 92fc59bc60c..da4c60e404b 100644 --- a/ru/compute/tutorials/index.md +++ b/ru/compute/tutorials/index.md @@ -7,10 +7,8 @@ description: Различные сценарии использования {{ c * [{#T}](ntp.md) * [{#T}](vm-autoscale/index.md) - * [{#T}](vm-scale-scheduled.md) * [{#T}](autoscale-monitoring.md) - * [{#T}](updating-under-load.md) * [{#T}](vm-fluent-bit-logging.md) * [{#T}](packer-quickstart.md) @@ -20,6 +18,9 @@ description: Различные сценарии использования {{ c * [{#T}](hystax-backup.md) * [{#T}](nodejs-cron-restart-vm.md) * [{#T}](bind-domain-vm.md) +* [{#T}](high-accessible-dmz.md) +* [{#T}](network-segmentation-checkpoint.md) +* [{#T}](gre-over-ipsec.md) * [{#T}](fault-tolerance.md) * [{#T}](nat-instance/index.md) * [{#T}](serverless-trigger-budget-vm.md) @@ -36,4 +37,16 @@ description: Различные сценарии использования {{ c * [{#T}](ha-regional-glusterfs.md) * [{#T}](ha-regional-glusterfs-high-performance.md) * [{#T}](backup-with-bacula.md) -* [{#T}](alb-with-ddos-protection/index.md) \ No newline at end of file +* [{#T}](alb-with-ddos-protection/index.md) +* [{#T}](bastion.md) +* [{#T}](route-switcher.md) +* [{#T}](site-to-site-openvpn.md) + +## Продукты Microsoft в {{ yandex-cloud }} + +* [{#T}](secure-password-script.md) +* [{#T}](active-directory.md) +* [{#T}](exchange.md) +* [{#T}](rds.md) +* [{#T}](mssql-alwayson-lb.md) +* [{#T}](rds-gw.md) diff --git a/ru/compute/tutorials/mssql-alwayson-lb.md b/ru/compute/tutorials/mssql-alwayson-lb.md new file mode 100644 index 00000000000..1f61e62b817 --- /dev/null +++ b/ru/compute/tutorials/mssql-alwayson-lb.md @@ -0,0 +1,7 @@ +--- +title: Развертывание группы доступности Always On с внутренним сетевым балансировщиком +description: В этом сценарии вы создадите в {{ yandex-cloud }} группы доступности Always On с балансировкой нагрузки между узлами с помощью внутреннего сетевого балансировщика. +canonical: '{{ link-docs }}/tutorials/windows/mssql-alwayson-lb' +--- + +{% include [mssql-alwayson-lb](../../_tutorials/windows/mssql-alwayson-lb.md) %} \ No newline at end of file diff --git a/ru/compute/tutorials/network-segmentation-checkpoint.md b/ru/compute/tutorials/network-segmentation-checkpoint.md new file mode 100644 index 00000000000..984b088ba9d --- /dev/null +++ b/ru/compute/tutorials/network-segmentation-checkpoint.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/routing/network-segmentation-checkpoint' +--- + +{% include [network-segmentation-checkpoint](../../_tutorials/routing/network-segmentation-checkpoint.md) %} \ No newline at end of file diff --git a/ru/compute/tutorials/rds-gw.md b/ru/compute/tutorials/rds-gw.md new file mode 100644 index 00000000000..2e5f1968061 --- /dev/null +++ b/ru/compute/tutorials/rds-gw.md @@ -0,0 +1,7 @@ +--- +title: Развертывание Remote Desktop Gateway +description: В этом сценарии вы создадите и настроите инфраструктуру Remote Desktop Gateway. +canonical: '{{ link-docs }}/tutorials/windows/rds-gw' +--- + +{% include [rds-gw](../../_tutorials/windows/rds-gw.md) %} \ No newline at end of file diff --git a/ru/compute/tutorials/rds.md b/ru/compute/tutorials/rds.md new file mode 100644 index 00000000000..5b9edf73411 --- /dev/null +++ b/ru/compute/tutorials/rds.md @@ -0,0 +1,7 @@ +--- +title: Развертывание Microsoft Remote Desktop Services +description: В этом сценарии вы создадите и настроите инфраструктуру Microsoft Windows Server Datacenter с предустановленной службой Remote Desktop Services в {{ yandex-cloud }}. +canonical: '{{ link-docs }}/tutorials/windows/rds' +--- + +{% include [rds.md](../../_tutorials/windows/rds.md) %} \ No newline at end of file diff --git a/ru/compute/tutorials/route-switcher.md b/ru/compute/tutorials/route-switcher.md new file mode 100644 index 00000000000..c99a393b9a3 --- /dev/null +++ b/ru/compute/tutorials/route-switcher.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/routing/route-switcher' +--- + +{% include [route-switcher](../../_tutorials/routing/route-switcher.md) %} \ No newline at end of file diff --git a/ru/compute/tutorials/secure-password-script.md b/ru/compute/tutorials/secure-password-script.md new file mode 100644 index 00000000000..60921ff2788 --- /dev/null +++ b/ru/compute/tutorials/secure-password-script.md @@ -0,0 +1,7 @@ +--- +title: Безопасная передача пароля в скрипт инициализации +description: В этом сценарии вы узнаете как безопасно передать пароль в скрипт инициализации. +canonical: '{{ link-docs }}/tutorials/windows/secure-password-script' +--- + +{% include [secure-password-script](../../_tutorials/windows/secure-password-script.md) %} \ No newline at end of file diff --git a/ru/compute/tutorials/site-to-site-openvpn.md b/ru/compute/tutorials/site-to-site-openvpn.md new file mode 100644 index 00000000000..490fe85db7b --- /dev/null +++ b/ru/compute/tutorials/site-to-site-openvpn.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/routing/site-to-site-openvpn' +--- + +{% include [openvpn](../../_tutorials/routing/site-to-site-openvpn.md) %} \ No newline at end of file diff --git a/ru/container-registry/tutorials/vpc-cr-access.md b/ru/container-registry/tutorials/vpc-cr-access.md index 2fe90b81486..e684154f946 100644 --- a/ru/container-registry/tutorials/vpc-cr-access.md +++ b/ru/container-registry/tutorials/vpc-cr-access.md @@ -1 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/routing/vpc-cr-access' +--- + {% include [vpc-cr-access](../../_tutorials/routing/vpc-cr-access.md) %} \ No newline at end of file diff --git a/ru/data-proc/tutorials/configure-network.md b/ru/data-proc/tutorials/configure-network.md index 970fe71c3ee..2194f0d583b 100644 --- a/ru/data-proc/tutorials/configure-network.md +++ b/ru/data-proc/tutorials/configure-network.md @@ -1,3 +1,7 @@ +--- +canonical: '{{ link-docs }}/tutorials/routing/dataproc-nat-instance' +--- + # Настройка сети для {{ dataproc-name }} {% include notitle [Data Proc network with NAT gateway](../../_tutorials/routing/data-proc-nat-gateway.md) %} diff --git a/ru/data-streams/concepts/topic-table-transactions.md b/ru/data-streams/concepts/topic-table-transactions.md index 19ba7ca1f96..c68095d0215 100644 --- a/ru/data-streams/concepts/topic-table-transactions.md +++ b/ru/data-streams/concepts/topic-table-transactions.md @@ -1,4 +1,4 @@ -# Транзакции с участием потоков данных и таблиц +# Транзакции с участием потоков данных и таблиц {{ yds-name }} поддерживает транзакции с участием потоков данных и таблиц {{ ydb-short-name }}. Участвующие в транзакции потоки данных и таблицы должны быть расположены в одной БД {{ ydb-short-name }}. Таким образом, можно транзакционно перекладывать данные из таблиц в потоки данных и в обратном направлении, а также между потоками данных, чтобы данные не терялись и не дублировались даже в случае непредвиденных обстоятельств. diff --git a/ru/data-transfer/toc.yaml b/ru/data-transfer/toc.yaml index 180ec433eaf..ed9907fe27a 100644 --- a/ru/data-transfer/toc.yaml +++ b/ru/data-transfer/toc.yaml @@ -205,6 +205,8 @@ items: href: tutorials/yds-to-objstorage.md - name: '{{ DS }} в {{ OS }}' href: tutorials/trails-to-os.md + - name: Ввод данных в системы хранения + href: tutorials/data-ingestion.md - name: Загрузка данных в витрины items: - name: '{{ GP }} в {{ CH }}' diff --git a/ru/data-transfer/tutorials/data-ingestion.md b/ru/data-transfer/tutorials/data-ingestion.md new file mode 100644 index 00000000000..daef82382a9 --- /dev/null +++ b/ru/data-transfer/tutorials/data-ingestion.md @@ -0,0 +1,7 @@ +--- +canonical: '{{ link-docs }}/tutorials/serverless/data-ingestion' +--- + +{% include [data-ingestion](../../_tutorials/serverless/data-ingestion.md) %} + +{% include [clickhouse-disclaimer](../../_includes/clickhouse-disclaimer.md) %} \ No newline at end of file diff --git a/ru/data-transfer/tutorials/index.md b/ru/data-transfer/tutorials/index.md index bd3fa5a8646..8418e32647e 100644 --- a/ru/data-transfer/tutorials/index.md +++ b/ru/data-transfer/tutorials/index.md @@ -72,6 +72,7 @@ C помощью {{ data-transfer-name }} вы можете реализоват * [{{ DS }} в {{ CH }}](yds-to-clickhouse.md) * [{{ DS }} в {{ objstorage-name }}](yds-to-objstorage.md) * [{{ DS }} в {{ OS }}](trails-to-os.md) +* [{#T}](data-ingestion.md) ## Загрузка данных в витрины {#upload-to-data-mart} diff --git a/ru/datalens/concepts/chart/dataset-based-charts.md b/ru/datalens/concepts/chart/dataset-based-charts.md index b0fa670ef96..d282d354f59 100644 --- a/ru/datalens/concepts/chart/dataset-based-charts.md +++ b/ru/datalens/concepts/chart/dataset-based-charts.md @@ -1,21 +1,13 @@ # Чарты в визарде -Чарты создаются в визарде на основе данных из одного датасета или нескольких датасетов (см. [{#T}](./multidataset-chart.md)). +Визард — это конструктор, в котором можно создавать чарты на основе данных из одного или нескольких датасетов (см. [{#T}](./multidataset-chart.md)). Вы можете создать неограниченное количество чартов на базе одного датасета. {% include [datalens-db-query-note](../../../_includes/datalens/datalens-db-query-note.md) %} -Вы можете создать неограниченное количество чартов на базе одного датасета. - -Рабочая область в интерфейсе визарда разделена на три основные панели: - -1. Панель датасета, где отображаются доступные поля: **Измерения** и **Показатели**. Вы можете добавить в список [вычисляемое поле](../calculations/index.md). -1. Панель настройки визуализации, где можно выбрать [тип чарта](../../visualization-ref/index.md). Для каждого типа доступен свой набор секций (например, ось X, ось Y, фильтры и т. д.), куда можно перетаскивать поля. Подробнее в разделе [{#T}](settings.md). -1. Панель превью, где отображается визуализация. - Чарт позволяет провести быстрый анализ и проверить гипотезу. Также чарты можно сохранять и добавлять на дашборды в виде виджетов. {% note warning %} @@ -24,11 +16,15 @@ {% endnote %} -При открытии чарта в визарде: +Интерфейс визарда включает следующие элементы: -* Вверху (1) располагается общая информация: расположение, название, а также элементы управления и сохранения, общие для всех чартов. -* Ниже слева (2) можно выбрать [датасет](../../dataset/index.md) для построения виджета. После выбора датасета под ним появится список полей (3), которые доступны для использования в чарте. Поля разделены на группы: [Измерения (4) и Показатели (5)](../../dataset/data-model.md#field). -* Справа расположена кнопка выбора типа чарта (6) и значок ![image](../../../_assets/console-icons/gear.svg) для открытия общих настроек (7). После выбора типа чарта, ниже появится список секций (8), состав которого зависит от выбранного типа чарта. -* Правую часть окна занимает область предпросмотра (9). +1. Вверху располагается общая информация: путь до чарта, а также элементы управления и сохранения, общие для всех чартов. +1. Ниже можно выбрать [датасет](../../dataset/index.md) для построения чарта. После выбора датасета под ним появится список [полей](../../dataset/data-model.md#field), которые доступны для использования в чарте. +1. Измерения датасета, которые можно использовать для построения чарта. Вы можете добавить в список [вычисляемое поле](../calculations/index.md). +1. Показатели датасета, которые можно использовать для построения чарта. +1. Кнопка выбора [типа чарта](../../visualization-ref/index.md) и значок ![image](../../../_assets/console-icons/gear.svg) для открытия [общих настроек](./settings.md#common-settings). +1. Список секций, состав которого зависит от выбранного типа чарта (например, ось X, ось Y, фильтры и т. д.). В секции можно перетаскивать поля. +1. Область предпросмотра, где отображается визуализация. +1. Легенда чарта. Легенда сопоставляет цвета чарта со значениями поля в секции **Цвета**. Нажимая отдельные элементы легенды, можно управлять отображением данных на диаграмме. Можно выбрать несколько элементов легенды с зажатой клавишей `Ctrl`/`Cmd`. Легенда включается и отключается в [настройках чарта](./settings.md). ![image](../../../_assets/datalens/concepts/widget.png) diff --git a/ru/datalens/concepts/chart/settings.md b/ru/datalens/concepts/chart/settings.md index 1b4233cb8b5..cf539adbb44 100644 --- a/ru/datalens/concepts/chart/settings.md +++ b/ru/datalens/concepts/chart/settings.md @@ -25,6 +25,10 @@ * **Скрыть** — скрыть легенду. * **Авто** — отображать легенду, если указано поле в секции **Цвета**. || +|| Тултип | Отображает всплывающие подсказки при наведении на элемент чарта.

    Доступные значения: + +* **Вкл** — отображать тултип. +* **Выкл** — скрыть тултип. || || Сумма в тултипах | Отображает сумму в тултипе при наведении на отображение чарта.

    Доступные значения: * **Вкл** — отображать сумму в тултипе. @@ -134,6 +138,10 @@ * **Линейная** — использовать линейную ось. * **Логарифмическая** — использовать логарифмическую ось. Подходит для чартов с большим разбросом значений. Логарифмическая ось позволяет привести быстрорастущий график к удобному для анализа виду, уменьшая значения на порядок. || +|| Ось на графике | Настройка позволяет скрыть все, что относится к оси — линии, подписи, сетку.

    Доступные значения: + +* **Показать** — отображать все, что относится к оси. +* **Скрыть** — не отображать все, что относится к оси. || || Режим отображения | Позволяет настроить непрерывность отображения графика.

    Доступные значения: * **Дискретный** — отображать график только для непустых значений. diff --git a/ru/datalens/concepts/datalens-usage-analytics.md b/ru/datalens/concepts/datalens-usage-analytics.md new file mode 100644 index 00000000000..cb9e47a328b --- /dev/null +++ b/ru/datalens/concepts/datalens-usage-analytics.md @@ -0,0 +1,131 @@ +# Статистика использования сервиса {{ datalens-short-name }} + + +Подключение к [{{ datalens-short-name }} Usage Analytics](../operations/connection/create-usage-tracking.md) позволит вам анализировать поведение пользователей {{ datalens-short-name }}: просматривать статистику по использованию экземпляра сервиса. + +В зависимости от [тарифного плана](../pricing.md#service-plans) доступны следующие подключения **Usage Analytics**: + +* **Light** — предоставляет агрегированную статистику по использованию экземпляра {{ datalens-short-name }} за ограниченный период времени (60 суток). Подключение доступно в любом тарифном плане. + +* **Detailed** — предоставляет как детальную, так и агрегированную статистику по использованию экземпляра {{ datalens-short-name }} за длительный период времени (180 суток). Позволяет просматривать детальную статистику по запросам в датасеты и просмотрам дашбордов. Подключение доступно в тарифном плане Business. После смены тарифного плана на Community подключение перестанет работать. + + +## Особенности работы с подключением {#ut-connection-dashboard} + + +Статистика использования сервиса формируется с учетом следующих особенностей: + +* Для некоторых подключений не сохраняется текст запроса: + + * [Файлы](../operations/connection/create-file.md) + * [Google Sheets](../operations/connection/create-google-sheets.md) + * [Яндекс Документы](../operations/connection/create-yadocs.md) + * [{{ yq-full-name }}](../operations/connection/create-yandex-query.md) + * [Metrica](../operations/connection/create-metrica-api.md) + * [AppMetrica](../operations/connection/create-appmetrica.md) + * [{{ billing-name }}](../operations/connection/create-cloud-billing.md) + * [{{ monitoring-full-name }}](../operations/connection/create-monitoring.md) + +* При создании нового объекта (подключение, датасет, чарт, дашборд) в статистике некоторое время, но не более суток, вместо названия будет отображаться `__unknown__`. При переименовании объекта некоторое время, но не более суток, будет видно его старое название. +* Агрегированные данные обновляются один раз в день. +* Объекты, к которым не было обращений, и неактивные пользователи не отображаются в статистике. + +### Дашборд DataLens Usage Analytics Light {#light-dash} + +На дашборде можно посмотреть сводную информацию: + +* о количестве активных пользователей — `Users Count`; +* о количестве объектов разного типа — `Dashboards Count`, `Connections Count`, `Datasets Count` и `Charts Count`; +* о количестве выполненных запросов и возникших ошибок — `Requests Count` и `Errors Count`; +* о доле запросов, которые используют данные из кеша — `Cache Hit`; +* о пользователях, которые используют объекты. + +{% cut "Сводная информация" %} + +![analytics-light-dash-1](../../_assets/datalens/operations/connection/analytics-light-dash-1.png) + +{% endcut %} + +В верхней части находятся фильтры по пользователям и объектам — можно выбрать дашборд, вкладку, чарт, датасет или подключение. Используя календарь, можно задать период, за который выводится статистика. Используя селектор `Scale`, можно выбрать группировку по месяцам, неделям или дням для диаграмм ниже. + +С помощью таблицы `Top Users (Requests)` можно оценить активность пользователей: + +* `User Link` — логин и ссылка на страницу пользователя; +* `Requests Count` — количество запросов за указанный период; +* `Requests per day` — среднее количество запросов за день активности; +* `UserDays` — количество дней активности; +* `Dashboards Count` — количество дашбордов, к которым были запросы от пользователя; +* `Charts Count` — количество чартов, к которым были запросы от пользователя; +* `Errors, %` — количество возникших ошибок в процентах. + +Ниже можно выбрать диаграмму для отображения количества пользователей, запросов, дашбордов или ошибок в заданном периоде. + +{% cut "Запросы и ошибки" %} + +![analytics-light-dash-2](../../_assets/datalens/operations/connection/analytics-light-dash-2.png) + +{% endcut %} + +С помощью настраиваемой таблицы с иерархией объектов вы можете оценить, какие дашборды используются больше всего, сколько на каждом дашборде датасетов и чартов, где чаще возникают ошибки. По умолчанию иерархия объектов в таблице выстроена от дашборда к подключению. В `Dimensions` вы можете настроить иерархию объектов по себя — например, в обратном порядке, от подключения к дашборду. Для каждого объекта в иерархии отображается: + +* `Users` — количество пользователей, отправивших запрос к объекту; +* `Datasets` — количество связанных датасетов; +* `Charts` — количество связанных чартов; +* `Requests` — количество запросов; +* `Errors` — количество и процент ошибок; +* `Lvl 1` — ссылка на объект верхнего уровня в иерархии. + +### Дашборд DataLens Usage Analytics Detailed {#detailed-dash} + +Дашборд разбит на три блока: + +* **Objects** — объекты. В этом блоке можно посмотреть сводную информацию по количеству объектов разного типа. В верхней части находятся фильтры по объектам. С помощью настраиваемой таблицы с иерархией объектов вы можете оценить: какие дашборды используются больше всего, какие чарты грузятся в среднем дольше других, где чаще возникают ошибки и другую информацию. + + {% cut "Блок Objects" %} + + ![analytics-detailed-dash-1](../../_assets/datalens/operations/connection/analytics-detailed-dash-1.png) + + {% endcut %} + + По умолчанию иерархия объектов в таблице выстроена от дашборда к подключению. В `Dimensions` вы можете настроить иерархию объектов по себя — например, в обратном порядке, от подключения к дашборду. Для каждого объекта в иерархии отображается: + + * `Users Count` — количество пользователей, отправивших запрос к объекту; + * `Datasets` — количество связанных датасетов; + * `Charts` — количество связанных чартов; + * `Requests` — количество запросов; + * `Avg Time, sec` — среднее время выполнения запроса к объекту; + * `Errors` — количество и процент ошибок; + * `Lvl 1` — ссылка на объект верхнего уровня в иерархии. + +* **Users and Dashboard Views** — пользователи и просмотры дашбордов. В этом блоке можно посмотреть: + + * количество активных пользователей — `Users Count`; + * количество просмотров дашбордов — `Dashboards Views`; + * количество запросов — `Requests Count`; + * доля запросов, которые используют данные из кеша — `Cache Hit`; + * какие дашборды просматривают; + * кто пользуется вашими объектами. + + На вкладках можно смотреть информацию как по просмотрам, так и по запросам. + + {% cut "Блок Users and Dashboard Views" %} + + ![analytics-detailed-dash-2](../../_assets/datalens/operations/connection/analytics-detailed-dash-2.png) + + {% endcut %} + +* **Queries** — запросы. В этом блоке можно посмотреть среднее время выполнения запросов и количество ошибок, а также детальную информацию о конкретных запросах: + + * идентификатор запроса; + * время выполнения; + * дату и время отправки запроса; + * текст запроса, который отправлен в источник; + * код ошибки. +
    + + {% cut "Блок Queries" %} + + ![analytics-detailed-dash-3](../../_assets/datalens/operations/connection/analytics-detailed-dash-3.png) + + {% endcut %} + diff --git a/ru/datalens/dataset/create-dataset.md b/ru/datalens/dataset/create-dataset.md index 181809dbd2d..09b50041e81 100644 --- a/ru/datalens/dataset/create-dataset.md +++ b/ru/datalens/dataset/create-dataset.md @@ -78,7 +78,8 @@ {% note info %} - Чтобы использовать подзапросы в качестве источника, включите опцию **Уровень доступа SQL запросов** → **Разрешить подзапросы в датасетах** при создании или редактировании [подключения](../concepts/connection.md). + * Чтобы использовать подзапросы в качестве источника, включите опцию **Уровень доступа SQL запросов** → **Разрешить подзапросы в датасетах** при создании или редактировании [подключения](../concepts/connection.md). + * При описании датасета через SQL-запрос не поддерживаются параметры. Но вы можете использовать [параметризованные запросы](../operations/chart/create-sql-chart.md#selector-parameters) в [QL-чартах](../concepts/chart/ql-charts.md). {% endnote %} diff --git a/ru/datalens/dataset/index.md b/ru/datalens/dataset/index.md index b4c232860cd..351a241a52a 100644 --- a/ru/datalens/dataset/index.md +++ b/ru/datalens/dataset/index.md @@ -5,7 +5,7 @@ _Датасет_ описывает набор данных и его струк {{ datalens-short-name }} создает датасет на основе источника данных, для которого существует [подключение](../concepts/connection.md). -Датасет работает с источниками в режиме прямого доступа: все запросы к данным {{ datalens-short-name }} выполняет на стороне источника. +Датасет работает с источниками в режиме прямого доступа: все запросы к данным выполняются на стороне источника. При этом изменять данные в самом источнике с помощью {{ datalens-short-name }} нельзя. diff --git a/ru/datalens/operations/chart/create-sql-chart.md b/ru/datalens/operations/chart/create-sql-chart.md index a450fd7ff3e..a9bbf324761 100644 --- a/ru/datalens/operations/chart/create-sql-chart.md +++ b/ru/datalens/operations/chart/create-sql-chart.md @@ -154,7 +154,7 @@ ORDER BY datedate * единичного значения — если выбран один элемент; * кортежа ([tuple](https://docs.python.org/3/library/stdtypes.html#tuples)) — если выбрано несколько элементов. -Если в тексте запроса перед параметром указан оператор `in`, то подставляемое значение всегда преобразовывается в кортеж. Такой запрос отработает корректно, если выбрано одно или несколько значений. +Если в тексте запроса для подключений {{ CH }} или {{ PG }} перед параметром указан оператор `in`, то подставляемое значение всегда преобразовывается в кортеж. Для остальных подключений автоматического преобразования в кортеж не происходит. Запрос с оператором `in` отработает корректно, если выбрано одно или несколько значений. {% cut "Пример запроса с оператором `in`" %} diff --git a/ru/datalens/operations/connection/create-usage-tracking.md b/ru/datalens/operations/connection/create-usage-tracking.md index b09ed344827..7a97d341e07 100644 --- a/ru/datalens/operations/connection/create-usage-tracking.md +++ b/ru/datalens/operations/connection/create-usage-tracking.md @@ -1,8 +1,6 @@ # Создание подключения к {{ datalens-short-name }} Usage Analytics -Это подключение позволит вам анализировать поведение пользователей {{ datalens-short-name }}: просматривать статистику по использованию экземпляра сервиса. - {% note info %} Создать и использовать подключение может только пользователь с [ролью](../../security/roles.md#service-roles) `{{ roles-datalens-instances-admin }}` или `{{ roles-datalens-admin }}`. @@ -45,44 +43,3 @@ Вы можете использовать преднастроенный дашборд или создавать свои чарты и дашборды на указанных датасетах. - -## Особенности работы с подключением {#ut-connection-dashboard} - - -Статистика использования сервиса формируется с учетом следующих особенностей: - -* Для некоторых подключений не сохраняется текст запроса: - - * [Файлы](create-file.md) - * [Google Sheets](create-google-sheets.md) - * [Яндекс Документы](create-yadocs.md) - * [{{ yq-full-name }}](create-yandex-query.md) - * [Metrica](create-metrica-api.md) - * [AppMetrica](create-appmetrica.md) - * [{{ billing-name }}](create-cloud-billing.md) - * [{{ monitoring-full-name }}](create-monitoring.md) - -* При создании нового объекта (подключение, датасет, чарт, дашборд) в статистике некоторое время, но не более суток, вместо названия будет отображаться `__unknown__`. При переименовании объекта некоторое время, но не более суток, будет видно его старое название. -* Агрегированные данные обновляются один раз в день. -* Объекты, к которым не было обращений, и неактивные пользователи не отображаются в статистике. - -### Дашборд DataLens Usage Analytics Light {#light-dash} - -На дашборде можно посмотреть сводную информацию: - -* о количестве объектов разного типа; -* о количестве выполненных запросов и возникших ошибок; -* о пользователях, которые используют объекты. - -В верхней части находятся фильтры по объектам и пользователям. Используя календарь, можно задать период, за который выводится статистика. С помощью настраиваемой таблицы с иерархией объектов вы можете оценить, какие дашборды используются больше всего и где чаще возникают ошибки. - -### Дашборд DataLens Usage Analytics Detailed {#detailed-dash} - -Дашборд разбит на три блока: - -* **Objects** — объекты. В этом блоке можно посмотреть сводную информацию по количеству объектов разного типа. В верхней части находятся фильтры по объектам. С помощью настраиваемой таблицы с иерархией объектов вы можете оценить: какие дашборды используются больше всего, какие чарты грузятся в среднем дольше других, где чаще возникают ошибки и другую информацию. - -* **Users and Dashboard Views** — пользователи и просмотры дашбордов. В этом блоке можно посмотреть, кто пользуется вашими объектами. На вкладках можно смотреть информацию как по просмотрам, так и по запросам. - -* **Queries** — запросы. В этом блоке можно посмотреть конкретные запросы, которые выполняются дольше всего, а также частые ошибки. - diff --git a/ru/datalens/operations/connection/create-ydb.md b/ru/datalens/operations/connection/create-ydb.md index e74b925d6cf..42fb14f1840 100644 --- a/ru/datalens/operations/connection/create-ydb.md +++ b/ru/datalens/operations/connection/create-ydb.md @@ -49,4 +49,22 @@ description: Следуя данной инструкции, вы сможете 1. Выберите [воркбук](../../workbooks-collections/index.md), в котором сохранится подключение, или создайте новый. Если вы пользуетесь старой навигацией по папкам, выберите папку для сохранения подключения. Нажмите кнопку **Создать**. -1. Укажите название подключения и нажмите кнопку **Создать**. \ No newline at end of file +1. Укажите название подключения и нажмите кнопку **Создать**. + + +{% cut "Ошибка RESOURCE_EXHAUSTED" %} + +При превышении [квот и лимитов](../../../ydb/concepts/limits.md) {{ ydb-name }} может появиться сообщение об ошибке [`RESOURCE_EXHAUSTED`](../../../ydb/faq.md#resource-exhausted). Чтобы избежать появления ошибки, придерживайтесь следующих рекомендаций: + +* Снизьте интенсивность запросов. Например, используйте фильтры, указывайте в чартах только необходимые поля для ограничения количества получаемых данных. +* Выполните [рекомендации по оптимизации](../../concepts/optimization_recommendations.md) запросов к базе данных. +* Проанализируйте время загрузки и объем данных с помощью [инспектора чартов](../../concepts/chart/inspector.md) в {{ datalens-short-name }}. +* Проверьте графики мониторинга {{ ydb-name }} на предмет превышения квот и лимитов. При необходимости немного [увеличьте](../../../ydb/operations/manage-databases.md#update-db-serverless) только [пропускную способность](../../../ydb/concepts/serverless-and-dedicated.md#capacity) (Request Units) в блоке **{{ ui-key.yacloud.ydb.overview.label_serverless-limits }}**. + +{% note info %} + +Увеличение пропускной способности в настройках Serverless БД может привести к значительному увеличению стоимости ее использования. Так как ресурсы Serverless БД неопределенно большие, то и максимальное потребление Request Units за промежуток времени также может составить любое значение, приведя к нежелательным начислениям. При изменении повышайте значение на совсем небольшое количество, например, на дополнительные 10 RU/с. + +{% endnote %} + +{% endcut %} diff --git a/ru/datalens/pricing.md b/ru/datalens/pricing.md index 2b3eeb48c75..54085e691b5 100644 --- a/ru/datalens/pricing.md +++ b/ru/datalens/pricing.md @@ -27,7 +27,7 @@ editable: false [Описание модели данных](./dataset/data-model.md) | ![image](../_assets/common/yes.svg) | ![image](../_assets/common/yes.svg) [Аналитические вычисления и SQL](./concepts/calculations/index.md) | ![image](../_assets/common/yes.svg) | ![image](../_assets/common/yes.svg) [Ролевая модель прав доступа](./security/roles.md) | ![image](../_assets/common/yes.svg) | ![image](../_assets/common/yes.svg) -[Аутентификация](./security/add-new-user.md) | Яндекс ID | Яндекс ID, корпоративные учетные записи / SSO¹ +[Аутентификация](./security/add-new-user.md) | Яндекс ID, Яндекс 360 | Яндекс ID, Яндекс 360, корпоративные учетные записи / SSO¹ [Конструктор отчетов](./reports/index.md) | ![image](../_assets/common/no.svg) | ![image](../_assets/common/yes.svg) [Стилизация интерфейса {{ datalens-name }}](./settings/ui-customization.md) | ![image](../_assets/common/no.svg) | ![image](../_assets/common/yes.svg) [Безопасное встраивание чартов и дашбордов](./security/private-embedded-objects.md) | ![image](../_assets/common/no.svg) | ![image](../_assets/common/yes.svg) @@ -52,7 +52,66 @@ editable: false {% endnote %} -Пользователь считается активным и учитывается при тарификации, если его действия привели к запросу данных из источника: например, он открыл или редактировал дашборд, чарт или датасет. Публичные ссылки на дашборды и чарты работают без аутентификации и при подсчете активных пользователей не учитываются. Узнать количество пользователей можно в [статистике использования {{ datalens-name }}](./operations/connection/create-usage-tracking.md). +Пользователь считается активным и учитывается при тарификации, если его действия привели к запросу данных из источника: например, он открыл или редактировал дашборд, чарт или датасет. + +Подсчет пользователей для тарификации ведется в рамках месяца — каждый месяц активные пользователи считаются заново, по факту активности. Публичные ссылки на дашборды и чарты работают без аутентификации и при подсчете активных пользователей не учитываются. Узнать количество пользователей можно в [статистике использования {{ datalens-name }}](./operations/connection/create-usage-tracking.md). + +{% cut "Пример расчета стоимости" %} + +В организации 5 пользователей, которые в течение трех месяцев по-разному пользовались сервисом {{ datalens-name }} с подключенным тарифом Business: + +* В июне активными были `пользователь_1`, `пользователь_2` и `пользователь_3`. Плата за июнь составит: + + + {% list tabs group=pricing %} + + - Расчет в рублях {#prices-rub} + + {% include [rub-example](../_pricing_examples/datalens/rub-users-1.md) %} + + - Расчет в тенге {#prices-kzt} + + {% include [kzt-example](../_pricing_examples/datalens/kzt-users-1.md) %} + + {% endlist %} + + + +* В июле активными были `пользователь_2` и `пользователь_3`. Плата за июль составит: + + + {% list tabs group=pricing %} + + - Расчет в рублях {#prices-rub} + + {% include [rub-example](../_pricing_examples/datalens/rub-users-2.md) %} + + - Расчет в тенге {#prices-kzt} + + {% include [kzt-example](../_pricing_examples/datalens/kzt-users-2.md) %} + + {% endlist %} + + + +* В августе активными были `пользователь_1`, `пользователь_2`, `пользователь_3`, `пользователь_4` и `пользователь_5`. Плата за август составит: + + + {% list tabs group=pricing %} + + - Расчет в рублях {#prices-rub} + + {% include [rub-example](../_pricing_examples/datalens/rub-users-3.md) %} + + - Расчет в тенге {#prices-kzt} + + {% include [kzt-example](../_pricing_examples/datalens/kzt-users-3.md) %} + + {% endlist %} + + + +{% endcut %} {% include [pricing-diff-regions](../_includes/pricing-diff-regions.md) %} @@ -70,3 +129,4 @@ editable: false {% endlist %} + diff --git a/ru/datalens/qa/datasets.md b/ru/datalens/qa/datasets.md index 863fe33b496..9ca7fd8e385 100644 --- a/ru/datalens/qa/datasets.md +++ b/ru/datalens/qa/datasets.md @@ -1,5 +1,7 @@ # Датасеты +{% include [how-to-change-source-data](../../_qa/datalens/change-source-data.md) %} + {% include [incorrectly-identified-date-field](../../_qa/datalens/incorrectly-identified-date-field.md) %} diff --git a/ru/datalens/toc.yaml b/ru/datalens/toc.yaml index d5f13e97e79..5cd7349e4f5 100644 --- a/ru/datalens/toc.yaml +++ b/ru/datalens/toc.yaml @@ -67,6 +67,8 @@ items: href: tutorials/data-from-bitrix24-visualization.md - name: '{{ tracker-full-name }}: экспорт и визуализация данных' href: tutorials/data-from-tracker.md + - name: Анализ логов {{ objstorage-name }} при помощи {{ datalens-name }} + href: tutorials/storage-logs-analysis.md - name: 'Подкасты Яндекс Музыки: статистика' href: tutorials/data-from-podcasts.md - name: Визуализация данных {{ yq-full-name }} @@ -140,7 +142,11 @@ items: - name: Создание подключения к {{ monitoring-full-name }} href: operations/connection/create-monitoring.md - name: Создание подключения к {{ datalens-short-name }} Usage Analytics - href: operations/connection/create-usage-tracking.md + items: + - name: Обзор + href: concepts/datalens-usage-analytics.md + - name: Подключение + href: operations/connection/create-usage-tracking.md - name: Партнерские подключения items: - name: Создание подключения к Экстрактору 1С @@ -887,6 +893,9 @@ items: hidden: true href: >- troubleshooting/errors/ERR-DS_API-DB-CHYT-INVALID_SORTED_JOIN-MORE_THAN_ONE_TABLE.md + - name: Cannot parse + hidden: true + href: troubleshooting/errors/ERR-DS_API-DB-CANNOT_PARSE.md - name: Cannot parse datetime hidden: true href: troubleshooting/errors/ERR-DS_API-DB-CANNOT_PARSE-DATETIME.md diff --git a/ru/datalens/troubleshooting/errors/ERR-DS_API-DB-AUTHENTICATION_FAILED.md b/ru/datalens/troubleshooting/errors/ERR-DS_API-DB-AUTHENTICATION_FAILED.md index 8dca589402a..39777042d19 100644 --- a/ru/datalens/troubleshooting/errors/ERR-DS_API-DB-AUTHENTICATION_FAILED.md +++ b/ru/datalens/troubleshooting/errors/ERR-DS_API-DB-AUTHENTICATION_FAILED.md @@ -6,5 +6,5 @@ Чтобы исправить ошибку: -* Проверьте корректность введенных вами данных (логин и пароль) — возможно, вы ввели их на русском языке, с включенным `Caps Lock`, поставили лишний знак или скопировали эти данные с лишним пробелом. +* Проверьте корректность введенных вами данных (логин и пароль) — возможно, вы ввели их на русском языке, с включенным `Caps Lock`, поставили лишний знак или скопировали эти данные с лишним пробелом. При необходимости уточните логин и пароль у администратора БД. * Проверьте через любой клиент БД, что с введенными вами логином и паролем можно подключиться к источнику. diff --git a/ru/datalens/troubleshooting/errors/ERR-DS_API-DB-CANNOT_PARSE.md b/ru/datalens/troubleshooting/errors/ERR-DS_API-DB-CANNOT_PARSE.md new file mode 100644 index 00000000000..dd4dab13b6c --- /dev/null +++ b/ru/datalens/troubleshooting/errors/ERR-DS_API-DB-CANNOT_PARSE.md @@ -0,0 +1,13 @@ +# Cannot parse + +`ERR.DS_API.DB.CANNOT_PARSE` + +Неправильный формат данных. Ошибка обычно связана с наличием пустых (`null`) значений при переводе данных из одного типа в другой. + +Чтобы исправить ошибку, обработайте пустые значения, например, с помощью формулы: + +``` +FLOAT(IF([field_name]="") THEN "0.0" ELSE [field_name] END) +``` + +Где `field_name` — название поля, в котором возможны пустые (`null`) значения. diff --git a/ru/datalens/troubleshooting/errors/all.md b/ru/datalens/troubleshooting/errors/all.md index 7c98c43861e..fb603b154e6 100644 --- a/ru/datalens/troubleshooting/errors/all.md +++ b/ru/datalens/troubleshooting/errors/all.md @@ -13,6 +13,7 @@ [ERR.DS_API.DATABASE_UNAVAILABLE](ERR-DS_API-DATABASE_UNAVAILABLE.md) | Data source is unavailable | [ERR.DS_API.DB](ERR-DS_API-DB.md) | Ошибка выполнения запроса в источнике данных | [ERR.DS_API.DB.AUTHENTICATION_FAILED](ERR-DS_API-DB-AUTHENTICATION_FAILED.md) | Database authentication failed | +[ERR.DS_API.DB.CANNOT_PARSE](ERR-DS_API-DB-CANNOT_PARSE.md) | Cannot parse | [ERR.DS_API.DB.CANNOT_PARSE.DATETIME](ERR-DS_API-DB-CANNOT_PARSE-DATETIME.md) | Cannot parse datetime | [ERR.DS_API.DB.CANNOT_PARSE.NUMBER](ERR-DS_API-DB-CANNOT_PARSE-NUMBER.md) | Cannot parse number | [ERR.DS_API.DB.CHYT.AUTH_FAILED](ERR-DS_API-DB-CHYT-AUTH_FAILED.md) | Authentication failed | diff --git a/ru/datalens/tutorials/data-from-bitrix24-visualization.md b/ru/datalens/tutorials/data-from-bitrix24-visualization.md index 2cf79ba239b..35846d2ba74 100644 --- a/ru/datalens/tutorials/data-from-bitrix24-visualization.md +++ b/ru/datalens/tutorials/data-from-bitrix24-visualization.md @@ -1 +1,6 @@ +--- +canonical: '{{ link-docs }}/tutorials/data-from-bitrix24-visualization' +--- + + {% include [data-from-bitrix24-visualization](../../_tutorials/datalens/data-from-bitrix24-visualization.md) %} diff --git a/ru/datalens/tutorials/data-from-ch-over-yt.md b/ru/datalens/tutorials/data-from-ch-over-yt.md index c331463f58b..3a56f582408 100644 --- a/ru/datalens/tutorials/data-from-ch-over-yt.md +++ b/ru/datalens/tutorials/data-from-ch-over-yt.md @@ -1,3 +1,7 @@ +--- +canonical: '{{ link-docs }}/tutorials/datalens/data-from-ch-over-yt' +--- + {% include [data-from-ch-over-yt](../../_tutorials/datalens/data-from-ch-over-yt.md) %} {% include [clickhouse-disclaimer](../../_includes/clickhouse-disclaimer.md) %} diff --git a/ru/datalens/tutorials/data-from-ch-with-parameters.md b/ru/datalens/tutorials/data-from-ch-with-parameters.md index ffeff46d5fb..12b975e21da 100644 --- a/ru/datalens/tutorials/data-from-ch-with-parameters.md +++ b/ru/datalens/tutorials/data-from-ch-with-parameters.md @@ -1,3 +1,7 @@ +--- +canonical: '{{ link-docs }}/tutorials/datalens/data-from-ch-with-parameters' +--- + {% include [data-from-ch-with-parameters](../../_tutorials/datalens/data-from-ch-with-parameters.md) %} {% include [clickhouse-disclaimer](../../_includes/clickhouse-disclaimer.md) %} diff --git a/ru/datalens/tutorials/data-from-monitoring-visualization.md b/ru/datalens/tutorials/data-from-monitoring-visualization.md index b5842b5fea5..3bf3a1c8027 100644 --- a/ru/datalens/tutorials/data-from-monitoring-visualization.md +++ b/ru/datalens/tutorials/data-from-monitoring-visualization.md @@ -1 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/datalens/data-from-monitoring-visualization' +--- + {% include [data-from-monitoring-visualization](../../_tutorials/datalens/data-from-monitoring-visualization.md) %} diff --git a/ru/datalens/tutorials/data-from-tracker.md b/ru/datalens/tutorials/data-from-tracker.md index 355fe07d8c9..f6bcd9cf543 100644 --- a/ru/datalens/tutorials/data-from-tracker.md +++ b/ru/datalens/tutorials/data-from-tracker.md @@ -1,3 +1,8 @@ +--- +canonical: '{{ link-docs }}/tutorials/data-from-tracker' +--- + + {% include [visualisation-in-datalens](../../_tutorials/datalens/data-from-tracker.md) %} {% include [clickhouse-disclaimer](../../_includes/clickhouse-disclaimer.md) %} diff --git a/ru/datalens/tutorials/data-from-yandex-query-visualization.md b/ru/datalens/tutorials/data-from-yandex-query-visualization.md index 9e8c6c70ff7..a978e38300e 100644 --- a/ru/datalens/tutorials/data-from-yandex-query-visualization.md +++ b/ru/datalens/tutorials/data-from-yandex-query-visualization.md @@ -1 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/datalens/data-from-yandex-query-visualization' +--- + {% include [data-from-yandex-query-visualization](../../_tutorials/datalens/data-from-yandex-query-visualization.md) %} diff --git a/ru/datalens/tutorials/index.md b/ru/datalens/tutorials/index.md index 02a5bea5267..c138f4029ec 100644 --- a/ru/datalens/tutorials/index.md +++ b/ru/datalens/tutorials/index.md @@ -29,6 +29,7 @@ description: В разделе описаны сценарии использо * [AppMetrica: экспорт, постобработка и визуализация данных](data-from-appmetrica-yc-visualization.md) * [Битрикс24: прямое подключение](data-from-bitrix24-visualization.md) * [{{ tracker-full-name }}: экспорт и визуализация данных](data-from-tracker.md) + * [Анализ логов {{ objstorage-name }}](storage-logs-analysis.md) * [Подкасты Яндекс Музыки: статистика](data-from-podcasts.md) * [Визуализация данных {{ yq-full-name }}](data-from-yandex-query-visualization.md) * [Визуализация данных {{ monitoring-full-name }}](data-from-monitoring-visualization.md) diff --git a/ru/datalens/tutorials/storage-logs-analysis.md b/ru/datalens/tutorials/storage-logs-analysis.md new file mode 100644 index 00000000000..d84f0d21b88 --- /dev/null +++ b/ru/datalens/tutorials/storage-logs-analysis.md @@ -0,0 +1,7 @@ +--- +canonical: '{{ link-docs }}/tutorials/datalens/storage-logs-analysis' +--- + +{% include [storage-logs-analysis](../../_tutorials/datalens/storage-logs-analysis.md) %} + +{% include [clickhouse-disclaimer](../../_includes/clickhouse-disclaimer.md) %} diff --git a/ru/datalens/visualization-ref/combined-chart.md b/ru/datalens/visualization-ref/combined-chart.md index b7d969568a0..798f295e801 100644 --- a/ru/datalens/visualization-ref/combined-chart.md +++ b/ru/datalens/visualization-ref/combined-chart.md @@ -55,7 +55,7 @@ Секция
    в визарде| Описание ----- | ---- X | Измерение. Может быть указано только одно поле. Обычно это измерение бывает датой. В этом случае проверьте, что в датасете для этого поля указан тип данных `Дата`. Это необходимо для корректной сортировки, отображения подписей. Для более наглядной визуализации дату можно группировать в недели, месяцы, годы (подробнее в разделе [{#T}](../concepts/chart/settings.md#field-settings)). Секция **Х** общая для всех слоев. -Секция слоя | Позволяет добавлять, удалять, менять порядок, переименовывать слои. Можно выбрать тип диаграммы для слоя: [линейную](line-chart.md), [столбчатую](column-chart.md) или [диаграмму с областями](area-chart.md). Список остальных секций зависит от типа выбранной диаграммы слоя. +Секция слоя | Позволяет добавлять, удалять, менять порядок, переименовывать слои. Можно выбрать тип диаграммы для слоя: [линейную](line-chart.md), [столбчатую](column-chart.md) или [диаграмму с областями](area-chart.md). Список остальных секций зависит от типа выбранной диаграммы слоя.

    Управлять отображением данных на слоях диаграммы можно с помощью легенды чарта. Для этого нажимайте на отдельные элементы легенды или выбирайте несколько элементов легенды с зажатой клавишей `Ctrl`/`Cmd`. Легенда включается и отключается в настройках чарта (подробнее в разделе [{#T}](../concepts/chart/settings.md#common-settings)). ## Создание комбинированной диаграммы {#create-diagram} diff --git a/ru/datasphere/concepts/jobs/index.md b/ru/datasphere/concepts/jobs/index.md index ae073789452..9699a343a9e 100644 --- a/ru/datasphere/concepts/jobs/index.md +++ b/ru/datasphere/concepts/jobs/index.md @@ -110,6 +110,17 @@ graceful-shutdown: signal: SIGTERM # Сигнал, который будет отправлен процессу задания при нажатии Ctrl + C (cancel), по умолчанию SIGTERM # Доступные значения: SIGTERM, SIGINT, SIGHUP, SIGUSR1, SIGUSR2 timeout: 15s # Таймаут, через который процесс задания получит SIGKILL, если не успевает завершиться + +# Список датасетов, которые будут созданы при успешном завершении задания +output-datasets: + - name: job-test-dataset-1 # Название датасета + var: OUT_DS # Переменная, содержащая путь до датасета. Содержимое указанной директории будет оформлено в виде датасета + description: "Описание" + size: 100Gb # Максимальный объем данных в датасете + labels: # Произвольный список меток, которые будут присвоены датасету + a: b + c: d + ``` Файл конфигурации задания `config.yaml` состоит из нескольких секций. @@ -153,6 +164,15 @@ graceful-shutdown: 1. Секция `graceful-shutdown` определяет параметры плавного завершения работы. Если секция не указана, то при нажатии пользователем **Ctrl** + **C** заданию посылается сигнал `SIGKILL`. В секции можно переопределить сам сигнал, а также время ожидания плавного завершения. +1. Секция `output-dataset` описывает [датасеты](../dataset.md), которые будут созданы при успешном завершении задания. Каждый датасет имеет название, описание, размер и список меток. + + После выполнения задания в [логе](cli.md#logs) `cli` появится сообщение о создании датасета. Например: + + ```text + 2024-09-13 16:22:28,894 - [INFO] - Created datasets: + 2024-09-13 16:22:28,894 - [INFO] - * (dataset name) size: Gb + ``` + #### См. также {#see-also} * [{#T}](../../operations/projects/work-with-jobs.md) diff --git a/ru/datasphere/jobs/api-ref/grpc/ProjectJob/list.md b/ru/datasphere/jobs/api-ref/grpc/ProjectJob/list.md index 2ac97f4ba2a..09f8ebcdf4f 100644 --- a/ru/datasphere/jobs/api-ref/grpc/ProjectJob/list.md +++ b/ru/datasphere/jobs/api-ref/grpc/ProjectJob/list.md @@ -31,12 +31,12 @@ ID of the project. || The maximum number of results per page to return. If the number of available results is larger than `pageSize`, -the service returns a `ListProjectJobResponse.pageToken` +the service returns a [ListProjectJobResponse.page_token] that can be used to get the next page of results in subsequent list requests. || || pageToken | **string** Page token. To get the next page of results, set `pageToken` to the -`ListProjectJobResponse.pageToken` returned by a previous list request. || +[ListProjectJobResponse.page_token] returned by a previous list request. || || filter | **string** restrictions: diff --git a/ru/datasphere/operations/data/spark-connectors.md b/ru/datasphere/operations/data/spark-connectors.md index 53550f30141..c95cf0205e7 100644 --- a/ru/datasphere/operations/data/spark-connectors.md +++ b/ru/datasphere/operations/data/spark-connectors.md @@ -28,7 +28,9 @@ {% note tip %} - Для кластеров {{ dataproc-name }} без включенной опции HDFS задайте дополнительный параметр `spark.hadoop.fs.s3a.fast.upload.buffer=bytebuffer`. + Для кластеров {{ dataproc-name }} без включенной опции HDFS задайте дополнительный параметр `spark.hadoop.fs.s3a.fast.upload.buffer` = `bytebuffer`. + + Для собственных кластеров с типом подключения Spark Connect задайте дополнительный параметр `dataproc:spark-connect` = `enabled`. {% endnote %} diff --git a/ru/datasphere/toc.yaml b/ru/datasphere/toc.yaml index 7bae7c571ad..23be0b8d835 100644 --- a/ru/datasphere/toc.yaml +++ b/ru/datasphere/toc.yaml @@ -239,6 +239,10 @@ items: href: tutorials/regular-launch.md - name: Запуск вычислений с помощью API href: tutorials/batch-code-execution.md + - name: >- + Геокодинг с помощью API Яндекс Карт для визуализации в {{ + datalens-short-name }} + href: tutorials/data-from-ch-geocoder.md - name: Обучение модели на данных из {{ objstorage-full-name }} href: tutorials/s3-to-datasphere.md - name: Создание сервера MLFlow для логирования экспериментов и артефактов @@ -263,6 +267,8 @@ items: items: - name: Веб-аналитика с расчетом воронок и когорт на данных Яндекс Метрики href: tutorials/data-from-metrica-yc-visualization.md + - name: 'AppMetrica: экспорт, постобработка и визуализация данных' + href: tutorials/data-from-appmetrica-yc-visualization.md - name: Анализ данных с помощью {{ yq-full-name }} href: tutorials/yq.md - name: Работа с данными в {{ objstorage-full-name }} diff --git a/ru/datasphere/tutorials/data-from-appmetrica-yc-visualization.md b/ru/datasphere/tutorials/data-from-appmetrica-yc-visualization.md new file mode 100644 index 00000000000..7b9350f159e --- /dev/null +++ b/ru/datasphere/tutorials/data-from-appmetrica-yc-visualization.md @@ -0,0 +1,7 @@ +--- +canonical: '{{ link-docs }}/tutorials/datalens/data-from-appmetrica-yc-visualization' +--- + +{% include [data-from-metrica-yc-visualization](../../_tutorials/datalens/data-from-appmetrica-yc-visualization.md) %} + +{% include [clickhouse-disclaimer](../../_includes/clickhouse-disclaimer.md) %} \ No newline at end of file diff --git a/ru/datasphere/tutorials/data-from-ch-geocoder.md b/ru/datasphere/tutorials/data-from-ch-geocoder.md new file mode 100644 index 00000000000..e743fe9a04e --- /dev/null +++ b/ru/datasphere/tutorials/data-from-ch-geocoder.md @@ -0,0 +1,7 @@ +--- +canonical: '{{ link-docs }}/tutorials/datalens/data-from-ch-geocoder' +--- + +{% include [data-from-ch-geocoder](../../_tutorials/datalens/data-from-ch-geocoder.md) %} + +{% include [clickhouse-disclaimer](../../_includes/clickhouse-disclaimer.md) %} diff --git a/ru/datasphere/tutorials/data-from-metrica-yc-visualization.md b/ru/datasphere/tutorials/data-from-metrica-yc-visualization.md index 5af4d31e2e0..10d833c40bb 100644 --- a/ru/datasphere/tutorials/data-from-metrica-yc-visualization.md +++ b/ru/datasphere/tutorials/data-from-metrica-yc-visualization.md @@ -1,3 +1,7 @@ +--- +canonical: '{{ link-docs }}/tutorials/datalens/data-from-metrica-yc-visualization' +--- + # Веб-аналитика с расчетом воронок и когорт на данных Яндекс Метрики {% include notitle [data-from-metrica-yc-visualization](../../_tutorials/datalens/data-from-metrica-yc-visualization.md) %} diff --git a/ru/datasphere/tutorials/index.md b/ru/datasphere/tutorials/index.md index 0e2e3073824..c5b338f735e 100644 --- a/ru/datasphere/tutorials/index.md +++ b/ru/datasphere/tutorials/index.md @@ -17,6 +17,7 @@ description: 'Различные сценарии использования {{ * [{#T}](video-recognition.md) * [{#T}](regular-launch.md) * [{#T}](batch-code-execution.md) +* [{#T}](data-from-ch-geocoder.md) * [{#T}](s3-to-datasphere.md) * [{#T}](mlflow-datasphere.md) @@ -33,6 +34,7 @@ description: 'Различные сценарии использования {{ ## Аналитика {#analytics} * [{#T}](data-from-metrica-yc-visualization.md) +* [{#T}](data-from-appmetrica-yc-visualization.md) * [{#T}](yq.md) * [{#T}](yq-storage.md) * [{#T}](yq-clickhouse.md) diff --git a/ru/dns/release-notes.md b/ru/dns/release-notes.md index b2590411ad8..95c8727406c 100644 --- a/ru/dns/release-notes.md +++ b/ru/dns/release-notes.md @@ -5,6 +5,10 @@ description: В разделе представлена история изме # История изменений в {{ dns-full-name }} +## III квартал 2024 {#q3-2024} + +Реализована интеграция с {{ vpc-name }} для указания DNS-записей в спецификациях публичных адресов. + ## II квартал 2024 {#q2-2024} К сервису подключены серверы НСДИ. diff --git a/ru/dns/toc.yaml b/ru/dns/toc.yaml index d8134accab4..553c998d0c0 100644 --- a/ru/dns/toc.yaml +++ b/ru/dns/toc.yaml @@ -77,6 +77,10 @@ items: href: tutorials/tls-termination/console.md - name: '{{ TF }}' href: tutorials/tls-termination/terraform.md + - name: Подключение к {{ objstorage-name }} из {{ vpc-name }} + href: tutorials/storage-vpc-access.md + - name: Подключение к {{ container-registry-name }} из {{ vpc-name }} + href: tutorials/vpc-cr-access.md - name: Управление доступом href: security/index.md - name: Правила тарификации diff --git a/ru/dns/tutorials/index.md b/ru/dns/tutorials/index.md index 73513957d61..82bf20c749e 100644 --- a/ru/dns/tutorials/index.md +++ b/ru/dns/tutorials/index.md @@ -12,4 +12,6 @@ description: Различные сценарии использования {{ d * [{#T}](cert-manager-webhook.md) * [{#T}](bind-domain-vm.md) * [{#T}](prefetch.md) -* [{#T}](tls-termination/index.md) \ No newline at end of file +* [{#T}](tls-termination/index.md) +* [{#T}](storage-vpc-access.md) +* [{#T}](vpc-cr-access.md) diff --git a/ru/dns/tutorials/storage-vpc-access.md b/ru/dns/tutorials/storage-vpc-access.md new file mode 100644 index 00000000000..55d0ddd87ec --- /dev/null +++ b/ru/dns/tutorials/storage-vpc-access.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/routing/storage-vpc-access' +--- + +{% include [storage-vpc-access](../../_tutorials/routing/storage-vpc-access.md) %} \ No newline at end of file diff --git a/ru/dns/tutorials/vpc-cr-access.md b/ru/dns/tutorials/vpc-cr-access.md new file mode 100644 index 00000000000..e684154f946 --- /dev/null +++ b/ru/dns/tutorials/vpc-cr-access.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/routing/vpc-cr-access' +--- + +{% include [vpc-cr-access](../../_tutorials/routing/vpc-cr-access.md) %} \ No newline at end of file diff --git a/ru/foundation-models/concepts/yandexart/index.md b/ru/foundation-models/concepts/yandexart/index.md index 89be7b99a12..ddc2475049a 100644 --- a/ru/foundation-models/concepts/yandexart/index.md +++ b/ru/foundation-models/concepts/yandexart/index.md @@ -1,10 +1,8 @@ # Обзор {{ yandexart-name }} -_Функциональность {{ yandexart-name }} находится на стадии [Preview](../../../overview/concepts/launch-stages.md)._ - {{ yandexart-name }} — это генеративная нейросеть, которая создает изображения по текстовому запросу. {{ yandexart-name }} работает по методу каскадной диффузии, итеративно детализируя изображения из шума. -Кроме текстового описания, для генерации необходимо указать специальный параметр _зерно генерации (seed)_. Зерно — это любое число от 0 до 2^64^. Оно служит начальной точкой для генерации изображения из шума и позволяет повторять результат. Так, при одном и том же промте и зерне результат генерации будет одинаковым. Чтобы изменить сгенерированное изображение, измените значение зерна или описание. +Кроме текстового описания, для генерации необходимо указать специальный параметр _зерно генерации (seed)_. Зерно — это любое число от 0 до 2^63^-1. Оно служит начальной точкой для генерации изображения из шума и позволяет повторять результат. Так, при одном и том же промте и зерне результат генерации будет одинаковым. Чтобы изменить сгенерированное изображение, измените значение зерна или описание. Также можно указать формат итогового изображения в параметре `mime_type`. На данный момент поддерживается значение `image/jpeg`. diff --git a/ru/foundation-models/concepts/yandexgpt/models.md b/ru/foundation-models/concepts/yandexgpt/models.md index 5f0672b7bae..e1bc7940ec1 100644 --- a/ru/foundation-models/concepts/yandexgpt/models.md +++ b/ru/foundation-models/concepts/yandexgpt/models.md @@ -26,7 +26,7 @@ `gpt://<идентификатор_каталога>/yandexgpt/latest` `gpt://<идентификатор_каталога>/yandexgpt/rc` | 3
    3
    4 | Асинхронный, синхронный || || **{{ gpt-pro }} 32k** | `gpt://<идентификатор_каталога>/yandexgpt-32k/rc` | 4 | Синхронный^1^ || -|| **Модель, дообученная в {{ ml-platform-full-name }}** | `ds://<идентификатор_дообученной_модели>` | 3 | Асинхронный, синхронный || +|| **Модель, дообученная в {{ ml-platform-full-name }}** | `ds://<идентификатор_каталога>/<идентификатор_дообученной_модели>` | 3 | Асинхронный, синхронный || |# Модифицированные модели делят [квоты](../limits.md#quotas) на использование со своими базовыми моделями. diff --git a/ru/foundation-models/gpt-prompting-guide/introduction/examples.md b/ru/foundation-models/gpt-prompting-guide/introduction/examples.md index 572788b4d3d..4e48649db60 100644 --- a/ru/foundation-models/gpt-prompting-guide/introduction/examples.md +++ b/ru/foundation-models/gpt-prompting-guide/introduction/examples.md @@ -165,8 +165,10 @@ ```text Нечетные числа в этой группе складываются в четное число: 15, 32, 5, 13, 82, 7, 1. +``` **Ответ** + ```text Нет, нечетные числа в этой группе складываются в нечетное число: 119. ``` @@ -194,4 +196,4 @@ #### См. также {#see-also} * [{#T}](./llm-settings.md) -* [{#T}](../../prompts/yandexgpt/index.md) \ No newline at end of file +* [{#T}](../../prompts/yandexgpt/index.md) diff --git a/ru/foundation-models/operations/yandexart/request.md b/ru/foundation-models/operations/yandexart/request.md index 89949d55e12..6378e1a3007 100644 --- a/ru/foundation-models/operations/yandexart/request.md +++ b/ru/foundation-models/operations/yandexart/request.md @@ -1,7 +1,5 @@ # Сгенерировать изображение с помощью {{ yandexart-name }} -{% include notitle [preview-stage](../../../_includes/foundation-models/yandexgpt/preview.md) %} - С помощью нейросети {{ yandexart-name }} вы можете генерировать изображения в [асинхронном режиме](../../concepts/index.md#working-mode). В ответ на асинхронный запрос модель вернет [объект Operation](../../../api-design-guide/concepts/operation.md), содержащий идентификатор операции, по которому можно [отследить ее выполнение](../../../api-design-guide/concepts/operation.md#monitoring) и получить результат после того, как генерация завершится. Генерация результата в асинхронном режиме может занимать от пары минут до нескольких часов. ## Перед началом работы {#before-begin} diff --git a/ru/foundation-models/pricing.md b/ru/foundation-models/pricing.md index 175f6201460..c500584047a 100644 --- a/ru/foundation-models/pricing.md +++ b/ru/foundation-models/pricing.md @@ -47,14 +47,6 @@ editable: false ### Генерация изображений {#rules-image-generation} -На стадии [Preview](../overview/concepts/launch-stages.md) использование {{ yandexart-name }} не тарифицируется. - -{% note warning %} - -Правила тарификации, описанные ниже, начнут действовать 1 ноября 2024 года. - -{% endnote %} - Использование {{ yandexart-name }} тарифицируется за каждый запрос на генерацию. При этом запросы не идемпотентны, поэтому два запроса с идентичными параметрами и промтом генерации считаются двумя самостоятельными запросами. ### Внутренние ошибки сервера {#error-request} diff --git a/ru/foundation-models/quickstart/yandexart.md b/ru/foundation-models/quickstart/yandexart.md index e38f151fb7a..0f4eb50db88 100644 --- a/ru/foundation-models/quickstart/yandexart.md +++ b/ru/foundation-models/quickstart/yandexart.md @@ -1,7 +1,5 @@ # Как начать работать с {{ yandexart-name }} -{% include notitle [preview-stage](../../_includes/foundation-models/yandexgpt/preview.md) %} - В этом разделе вы научитесь использовать нейросеть {{ yandexart-name }} для генерации изображений. В [консоли управления]({{ link-console-main }}/link/foundation-models/yandexart) новым пользователям без [платежного аккаунта](../../billing/concepts/billing-account.md) доступно {{ art-freetier }} бесплатных запросов в сутки. Чтобы использовать API и иметь возможность увеличить [квоты](../concepts/limits.md) на потребление, [привяжите](../../billing/operations/pin-cloud.md) платежный аккаунт к облаку. @@ -92,7 +90,7 @@ --request POST \ --header "Authorization: Bearer <значение_IAM-токена>" \ --data "@prompt.json" \ - "https://llm.{{ api-host }}/foundationModels/v1/imageGenerationAsync" + "https://llm.{{ api-host }}/foundationModels/v1/imageGenerationAsync" ``` Где: @@ -123,7 +121,7 @@ * `<идентификатор_запроса>` — значение поля `id`, полученное в ответе на запрос генерации. - **Результат:** + **Результат**: ![succulent](../../_assets/yandexgpt/succulent.jpeg) diff --git a/ru/foundation-models/quickstart/yandexgpt.md b/ru/foundation-models/quickstart/yandexgpt.md index 260ca3200b5..6f22a04458f 100644 --- a/ru/foundation-models/quickstart/yandexgpt.md +++ b/ru/foundation-models/quickstart/yandexgpt.md @@ -28,14 +28,13 @@ 1. Получите IAM-токен: см. инструкцию для [аккаунта на Яндексе](../../iam/operations/iam-token/create.md) или [федеративного аккаунта](../../iam/operations/iam-token/create-for-federation.md). 1. Получите [идентификатор каталога](../../resource-manager/operations/folder/get-id.md), на который у вашего аккаунта есть роль `{{ roles-yagpt-user }}` или выше. - 1. При обращении к {{ yagpt-full-name }} через API в каждом запросе передавайте полученные параметры: + 1. При обращении к {{ yagpt-full-name }} через API передайте полученные параметры: - * в заголовке `Authorization` указывайте IAM-токен; - * в заголовке `x-folder-id` указывайте идентификатор каталога. + * в файле запроса в параметре `modelUri` указывайте идентификатор каталога; + * в запросе в заголовке `Authorization` указывайте IAM-токен. ```json - Authorization: Bearer - x-folder-id: <идентификатор_каталога> + Authorization: Bearer ``` Другие способы аутентификации в API описаны на странице [{#T}](../api-ref/authentication.md). @@ -101,7 +100,6 @@ --request POST \ --header "Content-Type: application/json" \ --header "Authorization: Bearer ${IAM_TOKEN}" \ - --header "x-folder-id: ${FOLDER_ID}" \ --data "@prompt.json" \ "https://llm.{{ api-host }}/foundationModels/v1/completion" ``` diff --git a/ru/foundation-models/text-generation/api-ref/TextGeneration/completion.md b/ru/foundation-models/text-generation/api-ref/TextGeneration/completion.md index 1719f3b1d5b..ae0b2d5b77e 100644 --- a/ru/foundation-models/text-generation/api-ref/TextGeneration/completion.md +++ b/ru/foundation-models/text-generation/api-ref/TextGeneration/completion.md @@ -26,8 +26,45 @@ POST https://llm.{{ api-host }}/foundationModels/v1/completion "messages": [ { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "object" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } + // end of the list of possible fields + } + ], + "tools": [ + { + // Includes only one of the fields `function` + "function": { + "name": "string", + "description": "string", + "parameters": "object" + } // end of the list of possible fields } ] @@ -47,6 +84,10 @@ Configuration options for completion generation. || || messages[] | **[Message](#yandex.cloud.ai.foundation_models.v1.Message)** A list of messages representing the context for the completion model. || +|| tools[] | **[Tool](#yandex.cloud.ai.foundation_models.v1.Tool)** + +List of tools that are available for the model to invoke during the completion generation. +Note: This parameter is not yet supported and will be ignored if provided. || |# ## CompletionOptions {#yandex.cloud.ai.foundation_models.v1.CompletionOptions} @@ -85,9 +126,134 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **object** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + +## Tool {#yandex.cloud.ai.foundation_models.v1.Tool} + +Represents a tool that can be invoked during completion generation. + +#| +||Field | Description || +|| function | **[FunctionTool](#yandex.cloud.ai.foundation_models.v1.FunctionTool)** + +Represents a function that can be called. + +Includes only one of the fields `function`. || +|# + +## FunctionTool {#yandex.cloud.ai.foundation_models.v1.FunctionTool} + +Represents a function tool that can be invoked during completion generation. + +#| +||Field | Description || +|| name | **string** + +The name of the function. || +|| description | **string** + +A description of the function's purpose or behavior. || +|| parameters | **object** + +A JSON Schema that defines the expected parameters for the function. +The schema should describe the required fields, their types, and any constraints or default values. || |# ## Response {#yandex.cloud.ai.foundation_models.v1.CompletionResponse} @@ -100,8 +266,34 @@ Message content. || { "message": { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "object" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } // end of the list of possible fields }, "status": "string" @@ -149,7 +341,8 @@ The generation status of the alternative - `ALTERNATIVE_STATUS_TRUNCATED_FINAL`: Incomplete final alternative resulting from reaching the maximum allowed number of tokens. - `ALTERNATIVE_STATUS_FINAL`: Final alternative generated without running into any limits. - `ALTERNATIVE_STATUS_CONTENT_FILTER`: Generation was stopped due to the discovery of potentially sensitive content in the prompt or generated response. -To fix, modify the prompt and restart generation. || +To fix, modify the prompt and restart generation. +- `ALTERNATIVE_STATUS_TOOL_CALLS`: Tools were invoked during the completion generation. || |# ## Message {#yandex.cloud.ai.foundation_models.v1.Message2} @@ -168,9 +361,103 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList2)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList2)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList2} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall2)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall2} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall2)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall2} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **object** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList2} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult2)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult2} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult2)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult2} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || |# ## ContentUsage {#yandex.cloud.ai.foundation_models.v1.ContentUsage} diff --git a/ru/foundation-models/text-generation/api-ref/TextGenerationAsync/completion.md b/ru/foundation-models/text-generation/api-ref/TextGenerationAsync/completion.md index 88c5d34ebec..f6f4fa61b0e 100644 --- a/ru/foundation-models/text-generation/api-ref/TextGenerationAsync/completion.md +++ b/ru/foundation-models/text-generation/api-ref/TextGenerationAsync/completion.md @@ -26,8 +26,45 @@ POST https://llm.{{ api-host }}/foundationModels/v1/completionAsync "messages": [ { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "object" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } + // end of the list of possible fields + } + ], + "tools": [ + { + // Includes only one of the fields `function` + "function": { + "name": "string", + "description": "string", + "parameters": "object" + } // end of the list of possible fields } ] @@ -47,6 +84,10 @@ Configuration options for completion generation. || || messages[] | **[Message](#yandex.cloud.ai.foundation_models.v1.Message)** A list of messages representing the context for the completion model. || +|| tools[] | **[Tool](#yandex.cloud.ai.foundation_models.v1.Tool)** + +List of tools that are available for the model to invoke during the completion generation. +Note: This parameter is not yet supported and will be ignored if provided. || |# ## CompletionOptions {#yandex.cloud.ai.foundation_models.v1.CompletionOptions} @@ -85,9 +126,134 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **object** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + +## Tool {#yandex.cloud.ai.foundation_models.v1.Tool} + +Represents a tool that can be invoked during completion generation. + +#| +||Field | Description || +|| function | **[FunctionTool](#yandex.cloud.ai.foundation_models.v1.FunctionTool)** + +Represents a function that can be called. + +Includes only one of the fields `function`. || +|# + +## FunctionTool {#yandex.cloud.ai.foundation_models.v1.FunctionTool} + +Represents a function tool that can be invoked during completion generation. + +#| +||Field | Description || +|| name | **string** + +The name of the function. || +|| description | **string** + +A description of the function's purpose or behavior. || +|| parameters | **object** + +A JSON Schema that defines the expected parameters for the function. +The schema should describe the required fields, their types, and any constraints or default values. || |# ## Response {#yandex.cloud.operation.Operation} @@ -116,8 +282,34 @@ Message content. || { "message": { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "object" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } // end of the list of possible fields }, "status": "string" @@ -255,7 +447,8 @@ The generation status of the alternative - `ALTERNATIVE_STATUS_TRUNCATED_FINAL`: Incomplete final alternative resulting from reaching the maximum allowed number of tokens. - `ALTERNATIVE_STATUS_FINAL`: Final alternative generated without running into any limits. - `ALTERNATIVE_STATUS_CONTENT_FILTER`: Generation was stopped due to the discovery of potentially sensitive content in the prompt or generated response. -To fix, modify the prompt and restart generation. || +To fix, modify the prompt and restart generation. +- `ALTERNATIVE_STATUS_TOOL_CALLS`: Tools were invoked during the completion generation. || |# ## Message {#yandex.cloud.ai.foundation_models.v1.Message2} @@ -274,11 +467,105 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList2)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList2)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || |# +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList2} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall2)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall2} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall2)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall2} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **object** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList2} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult2)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult2} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult2)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult2} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + ## ContentUsage {#yandex.cloud.ai.foundation_models.v1.ContentUsage} An object representing the number of content [tokens](/docs/foundation-models/concepts/yandexgpt/tokens) used by the completion model. diff --git a/ru/foundation-models/text-generation/api-ref/Tokenizer/tokenizeCompletion.md b/ru/foundation-models/text-generation/api-ref/Tokenizer/tokenizeCompletion.md index a1e1261d98f..73a37220d12 100644 --- a/ru/foundation-models/text-generation/api-ref/Tokenizer/tokenizeCompletion.md +++ b/ru/foundation-models/text-generation/api-ref/Tokenizer/tokenizeCompletion.md @@ -26,8 +26,45 @@ POST https://llm.{{ api-host }}/foundationModels/v1/tokenizeCompletion "messages": [ { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "object" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } + // end of the list of possible fields + } + ], + "tools": [ + { + // Includes only one of the fields `function` + "function": { + "name": "string", + "description": "string", + "parameters": "object" + } // end of the list of possible fields } ] @@ -47,6 +84,10 @@ Configuration options for completion generation. || || messages[] | **[Message](#yandex.cloud.ai.foundation_models.v1.Message)** A list of messages representing the context for the completion model. || +|| tools[] | **[Tool](#yandex.cloud.ai.foundation_models.v1.Tool)** + +List of tools that are available for the model to invoke during the completion generation. +Note: This parameter is not yet supported and will be ignored if provided. || |# ## CompletionOptions {#yandex.cloud.ai.foundation_models.v1.CompletionOptions} @@ -85,9 +126,134 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **object** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + +## Tool {#yandex.cloud.ai.foundation_models.v1.Tool} + +Represents a tool that can be invoked during completion generation. + +#| +||Field | Description || +|| function | **[FunctionTool](#yandex.cloud.ai.foundation_models.v1.FunctionTool)** + +Represents a function that can be called. + +Includes only one of the fields `function`. || +|# + +## FunctionTool {#yandex.cloud.ai.foundation_models.v1.FunctionTool} + +Represents a function tool that can be invoked during completion generation. + +#| +||Field | Description || +|| name | **string** + +The name of the function. || +|| description | **string** + +A description of the function's purpose or behavior. || +|| parameters | **object** + +A JSON Schema that defines the expected parameters for the function. +The schema should describe the required fields, their types, and any constraints or default values. || |# ## Response {#yandex.cloud.ai.foundation_models.v1.TokenizeResponse} diff --git a/ru/foundation-models/text-generation/api-ref/grpc/TextGeneration/completion.md b/ru/foundation-models/text-generation/api-ref/grpc/TextGeneration/completion.md index d75fb715107..028f8fdfa46 100644 --- a/ru/foundation-models/text-generation/api-ref/grpc/TextGeneration/completion.md +++ b/ru/foundation-models/text-generation/api-ref/grpc/TextGeneration/completion.md @@ -24,8 +24,45 @@ A method for generating text completions in [synchronous mode](/docs/foundation- "messages": [ { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "google.protobuf.Struct" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } + // end of the list of possible fields + } + ], + "tools": [ + { + // Includes only one of the fields `function` + "function": { + "name": "string", + "description": "string", + "parameters": "google.protobuf.Struct" + } // end of the list of possible fields } ] @@ -45,6 +82,10 @@ Configuration options for completion generation. || || messages[] | **[Message](#yandex.cloud.ai.foundation_models.v1.Message)** A list of messages representing the context for the completion model. || +|| tools[] | **[Tool](#yandex.cloud.ai.foundation_models.v1.Tool)** + +List of tools that are available for the model to invoke during the completion generation. +Note: This parameter is not yet supported and will be ignored if provided. || |# ## CompletionOptions {#yandex.cloud.ai.foundation_models.v1.CompletionOptions} @@ -83,9 +124,134 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + +## Tool {#yandex.cloud.ai.foundation_models.v1.Tool} + +Represents a tool that can be invoked during completion generation. + +#| +||Field | Description || +|| function | **[FunctionTool](#yandex.cloud.ai.foundation_models.v1.FunctionTool)** + +Represents a function that can be called. + +Includes only one of the fields `function`. || +|# + +## FunctionTool {#yandex.cloud.ai.foundation_models.v1.FunctionTool} + +Represents a function tool that can be invoked during completion generation. + +#| +||Field | Description || +|| name | **string** + +The name of the function. || +|| description | **string** + +A description of the function's purpose or behavior. || +|| parameters | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +A JSON Schema that defines the expected parameters for the function. +The schema should describe the required fields, their types, and any constraints or default values. || |# ## CompletionResponse {#yandex.cloud.ai.foundation_models.v1.CompletionResponse} @@ -96,8 +262,34 @@ Message content. || { "message": { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "google.protobuf.Struct" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } // end of the list of possible fields }, "status": "AlternativeStatus" @@ -145,7 +337,8 @@ The generation status of the alternative - `ALTERNATIVE_STATUS_TRUNCATED_FINAL`: Incomplete final alternative resulting from reaching the maximum allowed number of tokens. - `ALTERNATIVE_STATUS_FINAL`: Final alternative generated without running into any limits. - `ALTERNATIVE_STATUS_CONTENT_FILTER`: Generation was stopped due to the discovery of potentially sensitive content in the prompt or generated response. -To fix, modify the prompt and restart generation. || +To fix, modify the prompt and restart generation. +- `ALTERNATIVE_STATUS_TOOL_CALLS`: Tools were invoked during the completion generation. || |# ## Message {#yandex.cloud.ai.foundation_models.v1.Message2} @@ -164,9 +357,103 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList2)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList2)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList2} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall2)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall2} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall2)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall2} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList2} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult2)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult2} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult2)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult2} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || |# ## ContentUsage {#yandex.cloud.ai.foundation_models.v1.ContentUsage} diff --git a/ru/foundation-models/text-generation/api-ref/grpc/TextGenerationAsync/completion.md b/ru/foundation-models/text-generation/api-ref/grpc/TextGenerationAsync/completion.md index 5c0b9687bfd..37d669b9f21 100644 --- a/ru/foundation-models/text-generation/api-ref/grpc/TextGenerationAsync/completion.md +++ b/ru/foundation-models/text-generation/api-ref/grpc/TextGenerationAsync/completion.md @@ -24,8 +24,45 @@ A method for generating text completions in [asynchronous mode](/docs/foundation "messages": [ { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "google.protobuf.Struct" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } + // end of the list of possible fields + } + ], + "tools": [ + { + // Includes only one of the fields `function` + "function": { + "name": "string", + "description": "string", + "parameters": "google.protobuf.Struct" + } // end of the list of possible fields } ] @@ -45,6 +82,10 @@ Configuration options for completion generation. || || messages[] | **[Message](#yandex.cloud.ai.foundation_models.v1.Message)** A list of messages representing the context for the completion model. || +|| tools[] | **[Tool](#yandex.cloud.ai.foundation_models.v1.Tool)** + +List of tools that are available for the model to invoke during the completion generation. +Note: This parameter is not yet supported and will be ignored if provided. || |# ## CompletionOptions {#yandex.cloud.ai.foundation_models.v1.CompletionOptions} @@ -83,9 +124,134 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + +## Tool {#yandex.cloud.ai.foundation_models.v1.Tool} + +Represents a tool that can be invoked during completion generation. + +#| +||Field | Description || +|| function | **[FunctionTool](#yandex.cloud.ai.foundation_models.v1.FunctionTool)** + +Represents a function that can be called. + +Includes only one of the fields `function`. || +|# + +## FunctionTool {#yandex.cloud.ai.foundation_models.v1.FunctionTool} + +Represents a function tool that can be invoked during completion generation. + +#| +||Field | Description || +|| name | **string** + +The name of the function. || +|| description | **string** + +A description of the function's purpose or behavior. || +|| parameters | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +A JSON Schema that defines the expected parameters for the function. +The schema should describe the required fields, their types, and any constraints or default values. || |# ## operation.Operation {#yandex.cloud.operation.Operation} @@ -106,8 +272,34 @@ Message content. || { "message": { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "google.protobuf.Struct" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } // end of the list of possible fields }, "status": "AlternativeStatus" @@ -214,7 +406,8 @@ The generation status of the alternative - `ALTERNATIVE_STATUS_TRUNCATED_FINAL`: Incomplete final alternative resulting from reaching the maximum allowed number of tokens. - `ALTERNATIVE_STATUS_FINAL`: Final alternative generated without running into any limits. - `ALTERNATIVE_STATUS_CONTENT_FILTER`: Generation was stopped due to the discovery of potentially sensitive content in the prompt or generated response. -To fix, modify the prompt and restart generation. || +To fix, modify the prompt and restart generation. +- `ALTERNATIVE_STATUS_TOOL_CALLS`: Tools were invoked during the completion generation. || |# ## Message {#yandex.cloud.ai.foundation_models.v1.Message2} @@ -233,11 +426,105 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList2)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList2)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || |# +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList2} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall2)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall2} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall2)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall2} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList2} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult2)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult2} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult2)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult2} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + ## ContentUsage {#yandex.cloud.ai.foundation_models.v1.ContentUsage} An object representing the number of content [tokens](/docs/foundation-models/concepts/yandexgpt/tokens) used by the completion model. diff --git a/ru/foundation-models/text-generation/api-ref/grpc/Tokenizer/tokenizeCompletion.md b/ru/foundation-models/text-generation/api-ref/grpc/Tokenizer/tokenizeCompletion.md index f7155869ab0..d72df7fd1c9 100644 --- a/ru/foundation-models/text-generation/api-ref/grpc/Tokenizer/tokenizeCompletion.md +++ b/ru/foundation-models/text-generation/api-ref/grpc/Tokenizer/tokenizeCompletion.md @@ -24,8 +24,45 @@ RPC method for tokenizing content of CompletionRequest "messages": [ { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "google.protobuf.Struct" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } + // end of the list of possible fields + } + ], + "tools": [ + { + // Includes only one of the fields `function` + "function": { + "name": "string", + "description": "string", + "parameters": "google.protobuf.Struct" + } // end of the list of possible fields } ] @@ -45,6 +82,10 @@ Configuration options for completion generation. || || messages[] | **[Message](#yandex.cloud.ai.foundation_models.v1.Message)** A list of messages representing the context for the completion model. || +|| tools[] | **[Tool](#yandex.cloud.ai.foundation_models.v1.Tool)** + +List of tools that are available for the model to invoke during the completion generation. +Note: This parameter is not yet supported and will be ignored if provided. || |# ## CompletionOptions {#yandex.cloud.ai.foundation_models.v1.CompletionOptions} @@ -83,9 +124,134 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + +## Tool {#yandex.cloud.ai.foundation_models.v1.Tool} + +Represents a tool that can be invoked during completion generation. + +#| +||Field | Description || +|| function | **[FunctionTool](#yandex.cloud.ai.foundation_models.v1.FunctionTool)** + +Represents a function that can be called. + +Includes only one of the fields `function`. || +|# + +## FunctionTool {#yandex.cloud.ai.foundation_models.v1.FunctionTool} + +Represents a function tool that can be invoked during completion generation. + +#| +||Field | Description || +|| name | **string** + +The name of the function. || +|| description | **string** + +A description of the function's purpose or behavior. || +|| parameters | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +A JSON Schema that defines the expected parameters for the function. +The schema should describe the required fields, their types, and any constraints or default values. || |# ## TokenizeResponse {#yandex.cloud.ai.foundation_models.v1.TokenizeResponse} diff --git a/ru/functions/toc.yaml b/ru/functions/toc.yaml index dcbc1d1fca1..1f65c536815 100644 --- a/ru/functions/toc.yaml +++ b/ru/functions/toc.yaml @@ -476,6 +476,10 @@ items: Передача событий {{ postbox-full-name }} в {{ yds-full-name }} и их анализ с помощью {{ datalens-full-name }} href: tutorials/events-from-postbox-to-yds.md + - name: Сокращатель ссылок + href: tutorials/serverless-url-shortener.md + - name: '{{ tracker-full-name }}: экспорт и визуализация данных' + href: tutorials/data-from-tracker.md - name: Правила тарификации href: pricing.md - name: Управление доступом diff --git a/ru/functions/tutorials/data-from-tracker.md b/ru/functions/tutorials/data-from-tracker.md new file mode 100644 index 00000000000..81cdc4df7e9 --- /dev/null +++ b/ru/functions/tutorials/data-from-tracker.md @@ -0,0 +1,7 @@ +--- +canonical: '{{ link-docs }}/tutorials/datalens/data-from-tracker' +--- + +{% include [visualisation-in-datalens](../../_tutorials/datalens/data-from-tracker.md) %} + +{% include [clickhouse-disclaimer](../../_includes/clickhouse-disclaimer.md) %} \ No newline at end of file diff --git a/ru/functions/tutorials/index.md b/ru/functions/tutorials/index.md index 9c44d62b96f..9b3bc16304e 100644 --- a/ru/functions/tutorials/index.md +++ b/ru/functions/tutorials/index.md @@ -28,3 +28,5 @@ * [{#T}](iot-emulation.md) * [{#T}](./serverless-trigger-budget-queue-vm-tg.md) * [Передача событий {{ postbox-full-name }} в {{ yds-full-name }} и их анализ с помощью {{ datalens-full-name }}](./events-from-postbox-to-yds.md) +* [{#T}](./serverless-url-shortener.md) +* [{#T}](data-from-tracker.md) diff --git a/ru/functions/tutorials/serverless-url-shortener.md b/ru/functions/tutorials/serverless-url-shortener.md new file mode 100644 index 00000000000..08459418247 --- /dev/null +++ b/ru/functions/tutorials/serverless-url-shortener.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/serverless/serverless-url-shortener' +--- + +{% include [serverless-url-shortener](../../_tutorials/serverless/serverless-url-shortener.md) %} \ No newline at end of file diff --git a/ru/getting-started/_includes/quickstart-qa-whats-next.md b/ru/getting-started/_includes/quickstart-qa-whats-next.md index 5e7ff82d67e..6bcb84080e4 100644 --- a/ru/getting-started/_includes/quickstart-qa-whats-next.md +++ b/ru/getting-started/_includes/quickstart-qa-whats-next.md @@ -2,7 +2,6 @@ ### Про платежный аккаунт и платное потребление {#billing-account} - #### Зачем мне нужен платежный аккаунт с привязанной банковской картой? {#linked-bank-card} Платежный аккаунт используется для идентификации пользователя, оплачивающего ресурсы {{ yandex-cloud }}. Даже если вы планируете пользоваться только бесплатными сервисами, вам все равно необходим платежный аккаунт: на него начисляются гранты и промокоды. @@ -11,17 +10,14 @@ Средства с карты для оплаты сервисов и ресурсов {{ yandex-cloud }} мы будем списывать только после того, как вы явно нам разрешите это делать, то есть перейдете на платное потребление. - #### Что произойдет после пробного периода? С меня сразу начнут списывать деньги? {#payment-after-trial} {{ yandex-cloud }} не списывает деньги и не выставляет счета до тех пор, пока вы не перевели аккаунт на платное потребление. Переход на платное потребление никогда не происходит автоматически. Однако если срок действия [гранта](../usage-grant.md) истек, доступ к вашим ресурсам будет заблокирован на 30 дней или до момента перехода на платное потребление. Подробнее о завершении пробного периода см. на странице [{#T}](../free-trial/concepts/trial-ending.md). - Для активации платежного аккаунта мы просим привязать банковскую карту, чтобы убедиться, что вы человек, а не робот. При привязке карты будет списана и сразу вернется небольшая сумма. Так мы будем уверены, что карта настоящая. - ### Про стартовый грант {#grant} #### Я случайно перешел на платное потребление. Мой стартовый грант пропал? Можно все вернуть? {#accidental-switching-trial} @@ -30,14 +26,12 @@ #### Я израсходовал не весь стартовый грант, но мое облако заблокировано. Что делать? {#cloud-blocked-during-trial} - Облако может быть заблокировано по нескольким причинам: 1. Проверьте, что к вашему аккаунту привязана действующая карта. Если вы привязывали карту, а после ее удалили, ваш аккаунт может быть заблокирован. 1. Стартовый грант условно разделен на две части, которые могут использоваться параллельно. Одна часть распространяется на оплату услуг сервиса Compute, другая — на остальные сервисы {{ yandex-cloud }}. Если одна из частей закончилась, вы можете продолжить использовать облако, перейдя на платное потребление. При этом неизрасходованная часть гранта сохранится. Подробнее об использовании стартового гранта и переходе на платный период см. в разделе [{#T}](../free-trial/concepts/upgrade-to-paid.md). - #### Я не успел использовать стартовый грант за 60 дней. Могу ли я пользоваться {{ yandex-cloud }}? {#initial-grant-expiring} Когда срок действия стартового гранта истекает, вся неизрасходованная сумма сгорает, а доступ к вашим ресурсам приостанавливается на 60 дней. Чтобы продолжить использовать {{ yandex-cloud }}, перейдите на платное потребление. diff --git a/ru/getting-started/free-trial/concepts/trial-ending.md b/ru/getting-started/free-trial/concepts/trial-ending.md index f7f53137d03..83912cb7972 100644 --- a/ru/getting-started/free-trial/concepts/trial-ending.md +++ b/ru/getting-started/free-trial/concepts/trial-ending.md @@ -1,6 +1,5 @@ # Завершение пробного периода - Автоматическое завершение пробного периода зависит от способа оплаты, который вы выбрали при [создании платежного аккаунта для юридического лица](../../../billing/quickstart/index.md). Способ оплаты | Условие завершения @@ -8,7 +7,6 @@ Банковский перевод | Использован весь [грант](../../usage-grant.md) или истек срок его действия. Банковская карта | Использован весь [грант](../../usage-grant.md) или одна из частей гранта и / или истек срок его действия. - Если вы не перешли на платную версию после завершения пробного периода, доступ к вашим ресурсам будет приостановлен на срок 60 дней: * Ваши виртуальные машины и кластеры баз данных будут остановлены. * Вы не сможете прочитать или скачать сохраненные данные. diff --git a/ru/getting-started/free-trial/concepts/upgrade-to-paid.md b/ru/getting-started/free-trial/concepts/upgrade-to-paid.md index 94c0b275cb8..f1ea3b32ab7 100644 --- a/ru/getting-started/free-trial/concepts/upgrade-to-paid.md +++ b/ru/getting-started/free-trial/concepts/upgrade-to-paid.md @@ -4,10 +4,8 @@ {% note info %} - При переходе на платную версию со способом оплаты **{{ ui-key.yacloud_billing.billing.account.overview.payment-type_label_card }}** возникает риск отрицательного баланса платежного аккаунта. - Мы рекомендуем вам самостоятельно отслеживать расходование средств лицевого счета и вручную пополнять счет до положительного значения. Если баланс вашего лицевого счета превысит [порог оплаты](../../../billing/concepts/billing-threshold.md) или вы не оплатите возникшую задолженность в установленные договором сроки, {{ yandex-cloud }} оставляет за собой право изменить статус вашего платежного аккаунта на `SUSPENDED`. Чтобы эффективнее контролировать расходы на потребление ресурсов в {{ yandex-cloud }}, рекомендуем подключить [бюджет](../../../billing/concepts/budget.md). @@ -29,12 +27,10 @@ Банковская карта | Остаток одной из [частей](../../usage-grant.md) гранта может использоваться для оплаты услуг только тех сервисов, для которых эта часть предназначена. - ## Оплата услуг В {{ yandex-cloud }} услуги оплачиваются в зависимости от потребленного количества. Подробные инструкции по оплате ресурсов после перехода на платную версию вы найдете в [документации](../../../billing/) сервиса {{ billing-name }}. - ## Примеры {% list tabs group=examples %} @@ -71,4 +67,4 @@ После перехода на платную версию и до окончания срока действия гранта вы можете использовать оставшуюся сумму: - (4000 - 2500) = 1500 ₽ на услуги различных сервисов. -{% endlist %} +{% endlist %} \ No newline at end of file diff --git a/ru/getting-started/legal-entity/payments.md b/ru/getting-started/legal-entity/payments.md index 6fdab0e771c..81a2b2877a3 100644 --- a/ru/getting-started/legal-entity/payments.md +++ b/ru/getting-started/legal-entity/payments.md @@ -22,14 +22,12 @@ {% list tabs group=payments %} - - Банковская карта {#card} Введите сумму платежа и нажмите кнопку **{{ ui-key.yacloud_billing.billing.account.dashboard-overview.popup-refill_button_individual-action }}**. Затем введите данные карты и нажмите кнопку **Оплатить**. К оплате принимаются банковские карты Мир, Visa и MasterCard. Платеж происходит в режиме реального времени и зачисляется в течение 15 минут. - - Банковский перевод {#transfer} Введите сумму платежа и нажмите кнопку **{{ ui-key.yacloud_billing.billing.account.dashboard-overview.popup-refill_button_company-action }}**. @@ -38,7 +36,10 @@ Перед проведением оплаты убедитесь, что в платежном поручении корректно указаны: * сумма платежа; - * банковские реквизиты ООО «Яндекс.Облако» (для РФ), ТОО «Облачные Сервисы Казахстан» (для РК), SAG (для нерезидентов РФ и РК); + * банковские реквизиты ООО «Яндекс.Облако» (для РФ), ТОО «Облачные Сервисы Казахстан» (для РК), Iron Hive doo Beograd (Serbia) или Direct Cursus Technology L.L.C. (Dubai) (для нерезидентов РФ и РК); + + {% include [legal-entity-nonresidents](../../_includes/billing/legal-entity-nonresidents.md) %} + * ИНН вашей организации или ИП; * [номер лицевого счета](../../billing/concepts/personal-account.md#id) в назначении платежа; * [номер договора](../../billing/concepts/contract.md) в назначении платежа. diff --git a/ru/getting-started/legal-entity/registration.md b/ru/getting-started/legal-entity/registration.md index 55b3b951985..3e2f0da5200 100644 --- a/ru/getting-started/legal-entity/registration.md +++ b/ru/getting-started/legal-entity/registration.md @@ -11,10 +11,8 @@ description: 'Из статьи вы узнаете, как создать пл Платежный аккаунт необходим, даже если вы планируете пользоваться только бесплатными сервисами. При создании первого платежного аккаунта, привязанного к пользовательскому аккаунту, вам будет начислен [стартовый грант](../usage-grant.md). - ![quickstart](../../_assets/overview/legal-entity-trial-period.svg) - Предоставьте данные для создания платежного аккаунта. {% include [start-for-legal-entities](../../_includes/billing/billing-account-create-legal-entities.md) %} diff --git a/ru/getting-started/usage-grant.md b/ru/getting-started/usage-grant.md index bd366dc5a79..9a77c448049 100644 --- a/ru/getting-started/usage-grant.md +++ b/ru/getting-started/usage-grant.md @@ -40,12 +40,10 @@ description: При создании первого платежного акк ## Бизнес-аккаунт {#business} - Условия использования гранта зависят: * От страны, в которой вы проживаете. * От способа оплаты, который вы выбрали при регистрации и [создании платежного аккаунта](../billing/quickstart/index.md). - ### Условия использования гранта {#terms-august} @@ -76,5 +74,4 @@ description: При создании первого платежного акк -Подробную информацию о [платежном аккаунте](../billing/concepts/billing-account.md) и [условиях для нерезидентов РФ](../billing/qa/non-resident.md) читайте в документации сервиса {{ billing-name }}. - +Подробную информацию о [платежном аккаунте](../billing/concepts/billing-account.md) и [условиях для нерезидентов РФ](../billing/qa/non-resident.md) читайте в документации сервиса {{ billing-name }}. \ No newline at end of file diff --git a/ru/glossary/ipsec.md b/ru/glossary/ipsec.md index 386ba98b7a4..ae6a459294f 100644 --- a/ru/glossary/ipsec.md +++ b/ru/glossary/ipsec.md @@ -59,7 +59,7 @@ _IP-пакет_ — это блок данных, который передае #### Протокол ESP (Encapsulating Security Payload) {#ipsec-esp} -Протокол ESP, так же как и AH, обеспечивает аутентификацию и целостность IP-пакета. Однако, помимо это он еще применяется для сохранения конфиденциальности передаваемых данных с помощью шифрования. При этом для ESP необязательно задействование всех этих функций одновременно. Однако, алгоритмы обеспечения конфиденциальности данных необходимо использовать в любом случае. +Протокол ESP, так же как и AH, обеспечивает аутентификацию и целостность IP-пакета. Однако, помимо этого он еще применяется для сохранения конфиденциальности передаваемых данных с помощью шифрования. При этом для ESP необязательно задействование всех этих функций одновременно. Однако, алгоритмы обеспечения конфиденциальности данных необходимо использовать в любом случае. Обычно протоколы ESP и AH применяют независимо, хотя их совместное применение также возможно. @@ -85,7 +85,7 @@ _IP-пакет_ — это блок данных, который передае ### Аутентификация в IPsec {#ipsec-authentication} -Аутентификация — это необходимый элемент обеспечения защиты передаваемого IP-паекта. +Аутентификация — это необходимый элемент обеспечения защиты передаваемого IP-пакета. Она нужна, чтобы пользователь был уверен в подлинности: * содержания IP-пакета — исходные данные не изменялись, их целостность не нарушена, они недоступны для повторной передачи. @@ -167,7 +167,7 @@ _Асимметричное шифрование_ — это метод шифр Протоколы безопасности IPSec могут работать в одном из следующих режимов: * **Туннельный режим** -Туннельный режим IPSec используется для создания безопасного соединения WAN и VPN, использующих интернет в качестве среды подключения. В этом режиме протоколы IPSec шифруют заголовок и полезную нагрузку IP-пакеты. Таким образом данные, содержащиеся в этом пакете, инкапсулируются внутри дополнительного пакета, который и будет отправлен. +Туннельный режим IPSec используется для создания безопасного соединения WAN и VPN, использующих интернет в качестве среды подключения. В этом режиме протоколы IPSec шифруют заголовок и полезную нагрузку IP-пакета. Таким образом данные, содержащиеся в этом пакете, инкапсулируются внутри дополнительного пакета, который и будет отправлен.
    ![Туннельный режим шифрования](../_assets/glossary/tunnel-ipsec.svg) @@ -236,7 +236,7 @@ IKEv1 определяет две фазы согласования для со 1. Получатель передает соответствующий пакет для аутентификации сеанса. * **Агрессивный режим** -Агрессивный режим не обеспечивает такой же уровень безопасности и гибкости, как основной режим, из-за тог, что стороны обмениваются информацией до создания защищенного канала. Но при этом он быстрее, потому что инициатор и получатель обмениваются всего тремя сообщениями: +Агрессивный режим не обеспечивает такой же уровень безопасности и гибкости, как основной режим, из-за того, что стороны обмениваются информацией до создания защищенного канала. Но при этом он быстрее, потому что инициатор и получатель обмениваются всего тремя сообщениями: 1. Инициатор предлагает варианты IKE SA и выполняет обмен Диффи-Хеллмана и пакет идентификации. 1. Получатель отправляет инициатору выбранный вариант SA, свой ключ и пакет для аутентификации. 1. Инициатор подтверждает обмен. @@ -411,4 +411,4 @@ _Беспроводные сети_ — это сети, использующи IPsec — один из самых надежных способов защиты данных в сети. {{ yandex-cloud}} предлагает своим клиентам возможность использовать IPsec в своих облачных сервисах. Это позволяет защитить данные, передаваемые через облачные сервисы Yandex, от несанкционированного доступа. Просто [настройте безопасную сетевую конфигурацию c IPSec](../getting-started/individuals/configure-network.md), чтобы защитить свои данные в {{ yandex-cloud}}. -Кроме того, вы можете [создать защищенное соединение](../tutorials/routing/ipsec/ipsec-vpn.md) между облачной инфраструктурой и условным корпоративным дата-центром или [организовать сетевую связность](../tutorials/routing/ipsec/) между облачными и удаленными ресурсами с помощью IPsec. \ No newline at end of file +Кроме того, вы можете [создать защищенное соединение](../tutorials/routing/ipsec/ipsec-vpn.md) между облачной инфраструктурой и условным корпоративным дата-центром или [организовать сетевую связность](../tutorials/routing/ipsec/) между облачными и удаленными ресурсами с помощью IPsec. diff --git a/ru/glossary/relational-databases.md b/ru/glossary/relational-databases.md index 72750cab713..eafa4da0f28 100644 --- a/ru/glossary/relational-databases.md +++ b/ru/glossary/relational-databases.md @@ -89,7 +89,7 @@ _Реляционная база данных_ — это составленна Инженеры поддержки {{ yandex-cloud }} помогают обеспечить бесперебойную работу клиентской базы данных даже в самых сложных и неопределенных условиях. Развернуть базу данных можно в любой инфраструктуре, включая публичные облака и собственные вычислительные среды. -Для сервиса действует [соглашение об уровне обслуживания]( https://yandex.ru/legal/cloud_sla/ ). Уровень обслуживания сервиса определен в документе [Уровень обслуживания {{ ydb-full-name }}]( https://yandex.ru/legal/cloud_sla_ydb/ ). +Для сервиса действует [соглашение об уровне обслуживания]({{ link-sla }}). Уровень обслуживания сервиса определен в документе [Уровень обслуживания {{ ydb-full-name }}]( https://yandex.ru/legal/cloud_sla_ydb/ ). Чтобы начать пользоваться {{ ydb-short-name }}, выберите подходящий режим и [создайте свою базу данных]({{ link-console-main }}/link/ydb/). diff --git a/ru/glossary/vm.md b/ru/glossary/vm.md index 11b2759e0a6..3ac76948c95 100644 --- a/ru/glossary/vm.md +++ b/ru/glossary/vm.md @@ -85,6 +85,6 @@ description: Виртуальная машина (ВМ) — компьютерн Виртуальные машины {{ compute-full-name }} поддерживают работу со снимками дисков пользователя для быстрого развертывания системы. Кроме того, в [Yandex Cloud Marketplace](/marketplace?categories=os) доступны для приобретения диски с образами самых распространенных OC семейства Linux. -Работа сервиса регулируется [соглашением об уровне обслуживания](https://yandex.ru/legal/cloud_sla/). +Работа сервиса регулируется [соглашением об уровне обслуживания]({{ link-sla }}). Подключитесь к [сервису](services/compute/) и познакомьтесь с его основными возможностями и тарифами. diff --git a/ru/iam/concepts/access-control/index.md b/ru/iam/concepts/access-control/index.md index 2e630e71deb..34979e35b60 100644 --- a/ru/iam/concepts/access-control/index.md +++ b/ru/iam/concepts/access-control/index.md @@ -127,6 +127,14 @@ _Имперсонацией_ называется выполнение поль * Вы не можете назначить роли сразу нескольким субъектам, как в API или CLI. В консоли управления вы сначала выбираете субъект (пользователя или сервисный аккаунт), а затем назначаете ему роли. +## Управление доступом сервисов к ресурсам в облаке пользователя {#service-control} + +{{ iam-full-name }} позволяет управлять [доступом сервисов](../service-control.md) к ресурсам в облаке пользователя, при необходимости [включая](../../operations/service-control/enable-disable.md#enable) или [выключая](../../operations/service-control/enable-disable.md#disable) нужные сервисы. + +Доступ сервиса — это совокупность прав доступа, необходимых для создания и функционирования ресурсов этого сервиса в облаке пользователя. Такие права доступа назначаются специальным сервисным аккаунтам — [сервисным агентам](../service-control.md#service-agent), от имени которых сервис осуществляет доступ к ресурсам пользователя в облаке. + +Пользователь не может напрямую создавать или удалять сервисных агентов. Сервисные агенты в необходимом количестве и с нужными правами доступа автоматически создаются при включении сервисов и автоматически удаляются при их выключении. + #### См. также {#see-also} Вы можете найти подробную информацию об управлении доступом для конкретного сервиса {{ yandex-cloud }} в разделе Управление доступом в документации соответствующего сервиса. @@ -139,3 +147,4 @@ _Имперсонацией_ называется выполнение поль * [{#T}](../../operations/sa/set-access-bindings.md) * [{#T}](../../../resource-manager/operations/cloud/set-access-bindings.md) * [{#T}](../../../resource-manager/operations/folder/set-access-bindings.md) +* [{#T}](../../operations/service-control/enable-disable.md) \ No newline at end of file diff --git a/ru/iam/concepts/service-control.md b/ru/iam/concepts/service-control.md new file mode 100644 index 00000000000..3c6343fd630 --- /dev/null +++ b/ru/iam/concepts/service-control.md @@ -0,0 +1,74 @@ +--- +title: Управление доступом сервисов к ресурсам в облаке пользователя +description: Из этой статьи вы узнаете об управлении доступом сервисов к ресурсам пользователя в облаке {{ yandex-cloud }}. +--- + +# Доступ сервисов к ресурсам пользователя + + + +{% include notitle [preview](../../_includes/note-preview.md) %} + + +Платформа {{ yandex-cloud }} включает в себя набор [сервисов](../../overview/concepts/services.md). Некоторым сервисам для выполнения определенных задач необходим доступ к различным ресурсам в [облаке](../../resource-manager/concepts/resources-hierarchy.md#cloud) пользователя. Например, сервису {{ connection-manager-full-name }} для управления подключениями к базам данных требуются права на создание секретов {{ lockbox-full-name }} в облаке пользователя, а также права на управление созданными секретами. + +{{ iam-full-name }} позволяет управлять доступом сервисов к ресурсам в облаке пользователя, при необходимости [включая](../operations/service-control/enable-disable.md#enable) или [выключая](../operations/service-control/enable-disable.md#disable) нужные сервисы. + +_Доступ сервиса_ — это совокупность прав доступа, необходимых для создания и функционирования ресурсов этого сервиса в облаке пользователя. Такие права доступа назначаются специальным сервисным аккаунтам — [сервисным агентам](#service-agent), от имени которых сервис осуществляет доступ к ресурсам пользователя в облаке. + +## Статус сервиса {#access-status} + +Сервисы в облаке {{ yandex-cloud }} могут иметь следующие статусы: + +* `DEFAULT` — статус по умолчанию. + + У сервиса нет [сервисных агентов](#service-agent), но при попытке выполнить в сервисе операцию, требующую доступа к другим ресурсам в облаке пользователя (например, создать [подключение](../../metadata-hub/concepts/connection-manager.md) в сервисе {{ connection-manager-full-name }}), сервисные агенты будут автоматически созданы, а статус сервиса изменится на `ENABLED`. +* `ENABLED` — сервис включен. У сервиса есть сервисные агенты, сервис имеет доступ к ресурсам в облаке пользователя. + + Когда статус сервиса в облаке меняется на `ENABLED`, для этого сервиса в данном облаке автоматически создаются сервисные агенты, обладающие необходимыми правами на действия с ресурсами пользователя в этом облаке. + +* `DISABLED` — сервис выключен. У сервиса нет сервисных агентов, сервис не имеет доступа к ресурсам в облаке пользователя. + + Когда статус сервиса в облаке меняется на `DISABLED`, сервисные агенты этого сервиса в данном облаке автоматически удаляются. + +## Сервисные агенты {#service-agent} + +_Сервисные агенты_ — это специальные системные сервисные аккаунты, принадлежащие определенным сервисам в облаке пользователя и предоставляющие таким сервисам доступ к ресурсам в этом облаке. Количество сервисных агентов и конкретный набор доступов, выданных им, могут различаться в зависимости от сервиса, которому эти сервисные агенты принадлежат. + +{% note info %} + +В настоящее время нельзя просмотреть или изменить набор ролей, назначенных сервисным агентам по умолчанию. В будущем такая возможность появится. + +{% endnote %} + +Сервисные агенты создаются в особом системном каталоге в облаке пользователя. Этот каталог управляется системой и недоступен пользователю даже при наличии у него ролей администратора или владельца облака. + +У сервисного агента есть права на действия с ресурсами только в том облаке, в котором этот сервисный агент создан. + +Пользователь не может напрямую создавать, удалять или назначать роли отдельным сервисным агентам. Сервисные агенты в необходимом количестве и с нужными правами доступа автоматически создаются при [включении сервисов](../operations/service-control/enable-disable.md#enable) и автоматически удаляются при их [выключении](../operations/service-control/enable-disable.md#disable). При повторном включении сервиса для него создаются новые сервисные агенты с новыми идентификаторами. + + +Если у сервиса есть ресурсы, использующие доступ к другим ресурсам в облаке пользователя, выключить этот сервис нельзя. Чтобы выключить такой сервис, предварительно удалите все ресурсы этого сервиса, использующие доступ к другим ресурсам в данном облаке пользователя. + +Если в облаке пользователя выключить сервис, то такой сервис продолжит функционировать, но его ресурсы не смогут получать доступ к другим ресурсам в этом облаке. + +## Доступом каких сервисов можно управлять {#service-list} + +В настоящий момент вы можете управлять доступом следующих сервисов: + +Сервис | Идентификатор +--- | --- +{{ compute-full-name }} — [Шифрование дисков](../../compute/concepts/encryption.md) | `disk-encryption` +[{{ ml-platform-full-name }}](../../datasphere/index.yaml) | `datasphere` +{{ metadata-hub-full-name }} — [{{ connection-manager-name }}](../../metadata-hub/concepts/connection-manager.md) | `connection-manager` +{{ sd-full-name }} — [Контроль данных (DSPM)](../../security-deck/concepts/dspm.md) | `dspm` +[{{ websql-full-name }}](../../websql/index.yaml) | `websql` + +В будущем у администраторов облака появится возможность управлять доступами всех сервисов, требующих прав на действия с ресурсами в облаке {{ yandex-cloud }}. С помощью [CLI](../../cli/cli-ref/managed-services/iam/service-control/list.md) вы можете [получить](../operations/service-control/list-get.md#list) актуальный список сервисов, доступом которых можно управлять. + +{% include [service-control-access](../../_includes/iam/service-control-access.md) %} + +#### См. также {#see-also} + +* [{#T}](../operations/service-control/list-get.md) +* [{#T}](../operations/service-control/enable-disable.md) diff --git a/ru/iam/operations/index.md b/ru/iam/operations/index.md index 68b3be2feb9..9f2f84393fa 100644 --- a/ru/iam/operations/index.md +++ b/ru/iam/operations/index.md @@ -69,3 +69,9 @@ description: Пошаговые инструкции по управлению - [{#T}](authorized-key/create.md) - [{#T}](authorized-key/delete.md) +## Доступ сервисов {#service-control} + +{% include notitle [preview](../../_includes/note-preview.md) %} + +- [{#T}](service-control/list-get.md) +- [{#T}](service-control/enable-disable.md) diff --git a/ru/iam/operations/sa/create-access-key.md b/ru/iam/operations/sa/create-access-key.md index b100bb927e9..911b29594f5 100644 --- a/ru/iam/operations/sa/create-access-key.md +++ b/ru/iam/operations/sa/create-access-key.md @@ -173,6 +173,6 @@ #### См. также {#see-also} -* [Настроить инструменты для работы с {{ objstorage-name }}](../../../storage/tools/). -* [{#T}](assign-role-for-sa.md). +* [Настроить инструменты для работы с {{ objstorage-name }}](../../../storage/tools/) +* [{#T}](assign-role-for-sa.md) * [{#T}](../../tutorials/static-key-in-lockbox.md) \ No newline at end of file diff --git a/ru/iam/operations/service-control/enable-disable.md b/ru/iam/operations/service-control/enable-disable.md new file mode 100644 index 00000000000..dac17293bbe --- /dev/null +++ b/ru/iam/operations/service-control/enable-disable.md @@ -0,0 +1,114 @@ +--- +title: Включение и выключение сервисов {{ yandex-cloud }} +description: С помощью этой инструкции вы научитесь включать и выключать сервисы, чтобы управлять их доступом к ресурсам пользователя в облаке {{ yandex-cloud }}. +--- + +# Включение и выключение сервиса + + + +{% include notitle [preview](../../../_includes/note-preview.md) %} + + +В {{ iam-full-name }} есть возможность включать и выключать [доступ сервисов](../../concepts/service-control.md) к ресурсам пользователя в определенном облаке. + +{% include [service-control-access](../../../_includes/iam/service-control-access.md) %} + +## Включение сервиса {#enable} + +Чтобы выдать сервису доступ к ресурсам в облаке пользователя, включите этот сервис: + +{% list tabs group=instructions %} + +- CLI {#cli} + + {% include [cli-install](../../../_includes/cli-install.md) %} + + {% include [default-cloud](../../../_includes/default-cloud.md) %} + + 1. Посмотрите описание команды CLI для включения сервиса: + + ```bash + yc iam service-control enable --help + ``` + + 1. [Получите](./list-get.md#list) список и информацию о [статусах](../../concepts/service-control.md#access-status) сервисов, которые можно включать и выключать. + + 1. Выполните команду, указав идентификатор сервиса, который требуется включить: + + ```bash + yc iam service-control enable <идентификатор_сервиса> + ``` + + Результат: + + ```text + done (31s) + service_id: dspm + resource: + id: b1gmgc24pte8******** + type: resource-manager.cloud + updated_at: "2024-03-12T13:21:12.331340Z" + status: ENABLED + ``` + +- API {#api} + + Воспользуйтесь методом REST API [enable](../../api-ref/ServiceControl/enable.md) для ресурса [ServiceControl](../../api-ref/ServiceControl/index.md) или вызовом gRPC API [ServiceControlService/Enable](../../api-ref/grpc/ServiceControl/enable.md). + +{% endlist %} + +В результате [статус](../../concepts/service-control.md#access-status) сервиса в облаке изменится на `ENABLED`, и для этого сервиса в данном облаке будут созданы [сервисные агенты](../../concepts/service-control.md#service-agent), обладающие необходимыми правами на действия с ресурсами пользователя в этом облаке. + +## Выключение сервиса {#disable} + +Если у сервиса есть ресурсы, использующие доступ к другим ресурсам пользователя в данном облаке, выключить этот сервис нельзя. Чтобы выключить такой сервис, предварительно удалите все ресурсы этого сервиса, использующие доступ к другим ресурсам пользователя. + +Чтобы отозвать у сервиса доступ к ресурсам пользователя в облаке, выключите сервис: + +{% list tabs group=instructions %} + +- CLI {#cli} + + {% include [cli-install](../../../_includes/cli-install.md) %} + + {% include [default-cloud](../../../_includes/default-cloud.md) %} + + 1. Посмотрите описание команды CLI для выключения сервиса: + + ```bash + yc iam service-control disable --help + ``` + + 1. [Получите](./list-get.md#list) список и информацию о [статусах](../../concepts/service-control.md#access-status) сервисов, которые можно включать и выключать. + + 1. Выполните команду, указав идентификатор сервиса, который требуется выключить: + + ```bash + yc iam service-control disable <идентификатор_сервиса> + ``` + + Результат: + + ```text + done (17s) + service_id: dspm + resource: + id: b1gmgc24pte8******** + type: resource-manager.cloud + updated_at: "2024-03-13T09:40:40.339678Z" + status: DISABLED + ``` + +- API {#api} + + Воспользуйтесь методом REST API [disable](../../api-ref/ServiceControl/disable.md) для ресурса [ServiceControl](../../api-ref/ServiceControl/index.md) или вызовом gRPC API [ServiceControlService/Disable](../../api-ref/grpc/ServiceControl/disable.md). + +{% endlist %} + +В результате [статус](../../concepts/service-control.md#access-status) сервиса в облаке изменится на `DISABLED`, [сервисные агенты](../../concepts/service-control.md#service-agent) этого сервиса в данном облаке будут удалены, а сервис потеряет доступ к ресурсам пользователя в этом облаке. + +#### См. также {#see-also} + +* [{#T}](./list-get.md) +* [{#T}](../../concepts/service-control.md) \ No newline at end of file diff --git a/ru/iam/operations/service-control/list-get.md b/ru/iam/operations/service-control/list-get.md new file mode 100644 index 00000000000..6a6315e8a64 --- /dev/null +++ b/ru/iam/operations/service-control/list-get.md @@ -0,0 +1,108 @@ +--- +title: Получение информации о статусах сервисов {{ yandex-cloud }} +description: С помощью этой инструкции вы научитесь получать информацию о статусах сервисов в облаке {{ yandex-cloud }}. +--- + +# Получение статусов сервисов + + + +{% include notitle [preview](../../../_includes/note-preview.md) %} + + +В {{ iam-full-name }} есть возможность управлять [доступом сервисов](../../concepts/service-control.md) к ресурсам пользователя в определенном облаке. + +## Получение списка сервисов {#list} + +Чтобы получить список сервисов, доступом которых в облаке можно управлять: + +{% list tabs group=instructions %} + +- CLI {#cli} + + {% include [cli-install](../../../_includes/cli-install.md) %} + + {% include [default-cloud](../../../_includes/default-cloud.md) %} + + 1. Посмотрите описание команды CLI для получения списка сервисов, доступом которых можно управлять: + + ```bash + yc iam service-control list --help + ``` + + 1. Выполните команду: + + ```bash + yc iam service-control list \ + --limit <количество_сервисов> + ``` + + Где `--limit` — количество сервисов, которые требуется вывести в списке. Необязательный параметр. + + Результат: + + ```text + +--------------------+----------+ + | SERVICE ID | STATUS | + +--------------------+----------+ + | connection-manager | ENABLED | + | datasphere | DISABLED | + | disk-encryption | DEFAULT | + | dspm | DEFAULT | + | websql | ENABLED | + +--------------------+----------+ + ``` + +- API {#api} + + Воспользуйтесь методом REST API [list](../../api-ref/ServiceControl/list.md) для ресурса [ServiceControl](../../api-ref/ServiceControl/index.md) или вызовом gRPC API [ServiceControlService/List](../../api-ref/grpc/ServiceControl/list.md). + +{% endlist %} + +## Получение информации о статусе сервиса {#get} + +Чтобы получить информацию о [статусе](../../concepts/service-control.md#access-status) сервиса в облаке: + +{% list tabs group=instructions %} + +- CLI {#cli} + + {% include [cli-install](../../../_includes/cli-install.md) %} + + {% include [default-cloud](../../../_includes/default-cloud.md) %} + + 1. Посмотрите описание команды CLI для получения информации о статусе сервиса в облаке: + + ```bash + yc iam service-control get --help + ``` + + 1. [Получите](#list) список сервисов, доступом которых можно управлять. + + 1. Выполните команду, указав идентификатор сервиса, информацию о статусе которого в данном облаке требуется получить: + + ```bash + yc iam service-control get <идентификатор_сервиса> + ``` + + Результат: + + ```text + service_id: connection-manager + resource: + id: aoenvj7ssrvr******** + type: resource-manager.cloud + updated_at: "2024-03-13T07:21:00.808442047Z" + status: DISABLED + ``` + +- API {#api} + + Воспользуйтесь методом REST API [get](../../api-ref/ServiceControl/get.md) для ресурса [ServiceControl](../../api-ref/ServiceControl/index.md) или вызовом gRPC API [ServiceControlService/Get](../../api-ref/grpc/ServiceControl/get.md). + +{% endlist %} + +#### См. также {#see-also} + +* [{#T}](./enable-disable.md) +* [{#T}](../../concepts/service-control.md) \ No newline at end of file diff --git a/ru/iam/toc.yaml b/ru/iam/toc.yaml index 6849ac0ec3c..f8d966a4aa1 100644 --- a/ru/iam/toc.yaml +++ b/ru/iam/toc.yaml @@ -79,6 +79,13 @@ items: href: operations/authorized-key/create.md - name: Удаление авторизованного ключа href: operations/authorized-key/delete.md + - name: Доступ сервисов к ресурсам пользователя + stage: preview + items: + - name: Просмотр статусов сервисов + href: operations/service-control/list-get.md + - name: Включение и выключение сервисов + href: operations/service-control/enable-disable.md - name: Практические руководства items: - name: Все руководства @@ -127,6 +134,9 @@ items: href: concepts/authorization/key.md - name: Статический ключ доступа href: concepts/authorization/access-key.md + - name: Доступ сервисов к ресурсам пользователя + stage: preview + href: concepts/service-control.md - name: Федерации удостоверений href: concepts/federations.md - name: Федерации сервисных аккаунтов diff --git a/ru/interconnect/release-notes.md b/ru/interconnect/release-notes.md index c0ca86884ef..91c6881cc5b 100644 --- a/ru/interconnect/release-notes.md +++ b/ru/interconnect/release-notes.md @@ -5,6 +5,10 @@ description: В разделе представлена история изме # История изменений в {{ interconnect-full-name }} +## III квартал 2024 {#q3-2024} + +В CLI и API добавлены методы `view`. + ## I квартал 2024 {#q1-2024} -* Добавлены [правила тарификации](./pricing.md). +Добавлены [правила тарификации](./pricing.md). diff --git a/ru/kms/toc.yaml b/ru/kms/toc.yaml index 5867d072793..800cb5bae1b 100644 --- a/ru/kms/toc.yaml +++ b/ru/kms/toc.yaml @@ -95,6 +95,8 @@ items: href: tutorials/terraform-secret.md - name: Auto Unseal в HashiCorp Vault href: tutorials/vault-secret.md + - name: Безопасная передача пароля в скрипт инициализации + href: tutorials/secure-password-script.md - name: Управление доступом href: security/index.md - name: Правила тарификации diff --git a/ru/kms/tutorials/index.md b/ru/kms/tutorials/index.md index 948055228cd..b6bdea218be 100644 --- a/ru/kms/tutorials/index.md +++ b/ru/kms/tutorials/index.md @@ -10,4 +10,5 @@ description: Различные сценарии использования {{ k * [{#T}](sign-with-cosign.md) * [{#T}](terraform-key.md) * [{#T}](terraform-secret.md) -* [{#T}](vault-secret.md) \ No newline at end of file +* [{#T}](vault-secret.md) +* [{#T}](secure-password-script.md) \ No newline at end of file diff --git a/ru/kms/tutorials/secure-password-script.md b/ru/kms/tutorials/secure-password-script.md new file mode 100644 index 00000000000..60921ff2788 --- /dev/null +++ b/ru/kms/tutorials/secure-password-script.md @@ -0,0 +1,7 @@ +--- +title: Безопасная передача пароля в скрипт инициализации +description: В этом сценарии вы узнаете как безопасно передать пароль в скрипт инициализации. +canonical: '{{ link-docs }}/tutorials/windows/secure-password-script' +--- + +{% include [secure-password-script](../../_tutorials/windows/secure-password-script.md) %} \ No newline at end of file diff --git a/ru/load-testing/user/api-ref/Agent/create.md b/ru/load-testing/user/api-ref/Agent/create.md index 1d6faabb2a1..30bc0eeeb23 100644 --- a/ru/load-testing/user/api-ref/Agent/create.md +++ b/ru/load-testing/user/api-ref/Agent/create.md @@ -42,15 +42,16 @@ POST https://loadtesting.{{ api-host }}/loadtesting/api/v1/agent "description": "string", "typeId": "string", "size": "string", - "blockSize": "string", + // Includes only one of the fields `imageId`, `snapshotId` + "imageId": "string", + "snapshotId": "string", + // end of the list of possible fields "diskPlacementPolicy": { "placementGroupId": "string", "placementGroupPartition": "string" }, - // Includes only one of the fields `imageId`, `snapshotId` - "imageId": "string", - "snapshotId": "string" - // end of the list of possible fields + "blockSize": "string", + "kmsKeyId": "string" }, "diskId": "string" // end of the list of possible fields @@ -267,12 +268,6 @@ To get a list of available disk types, use the [yandex.cloud.compute.v1.DiskType || size | **string** (int64) Required field. Size of the disk, specified in bytes. || -|| blockSize | **string** (int64) - -Block size of the disk, specified in bytes. The default is 4096. || -|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** - -Placement policy configuration. || || imageId | **string** ID of the image to create the disk from. @@ -283,6 +278,15 @@ Includes only one of the fields `imageId`, `snapshotId`. || ID of the snapshot to restore the disk from. Includes only one of the fields `imageId`, `snapshotId`. || +|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** + +Placement policy configuration. || +|| blockSize | **string** (int64) + +Block size of the disk, specified in bytes. The default is 4096. || +|| kmsKeyId | **string** + +ID of KMS key for disk encryption || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} diff --git a/ru/load-testing/user/api-ref/Agent/update.md b/ru/load-testing/user/api-ref/Agent/update.md index 59c2e54b3eb..3ccfb4e29c6 100644 --- a/ru/load-testing/user/api-ref/Agent/update.md +++ b/ru/load-testing/user/api-ref/Agent/update.md @@ -49,15 +49,16 @@ Required field. ID of the agent to update. || "description": "string", "typeId": "string", "size": "string", - "blockSize": "string", + // Includes only one of the fields `imageId`, `snapshotId` + "imageId": "string", + "snapshotId": "string", + // end of the list of possible fields "diskPlacementPolicy": { "placementGroupId": "string", "placementGroupPartition": "string" }, - // Includes only one of the fields `imageId`, `snapshotId` - "imageId": "string", - "snapshotId": "string" - // end of the list of possible fields + "blockSize": "string", + "kmsKeyId": "string" }, "diskId": "string" // end of the list of possible fields @@ -265,12 +266,6 @@ To get a list of available disk types, use the [yandex.cloud.compute.v1.DiskType || size | **string** (int64) Required field. Size of the disk, specified in bytes. || -|| blockSize | **string** (int64) - -Block size of the disk, specified in bytes. The default is 4096. || -|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** - -Placement policy configuration. || || imageId | **string** ID of the image to create the disk from. @@ -281,6 +276,15 @@ Includes only one of the fields `imageId`, `snapshotId`. || ID of the snapshot to restore the disk from. Includes only one of the fields `imageId`, `snapshotId`. || +|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** + +Placement policy configuration. || +|| blockSize | **string** (int64) + +Block size of the disk, specified in bytes. The default is 4096. || +|| kmsKeyId | **string** + +ID of KMS key for disk encryption || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} diff --git a/ru/load-testing/user/api-ref/grpc/Agent/create.md b/ru/load-testing/user/api-ref/grpc/Agent/create.md index efeabb51928..6fc44940762 100644 --- a/ru/load-testing/user/api-ref/grpc/Agent/create.md +++ b/ru/load-testing/user/api-ref/grpc/Agent/create.md @@ -40,15 +40,16 @@ Also creates a corresponding compute instance. "description": "string", "typeId": "string", "size": "int64", - "blockSize": "int64", + // Includes only one of the fields `imageId`, `snapshotId` + "imageId": "string", + "snapshotId": "string", + // end of the list of possible fields "diskPlacementPolicy": { "placementGroupId": "string", "placementGroupPartition": "int64" }, - // Includes only one of the fields `imageId`, `snapshotId` - "imageId": "string", - "snapshotId": "string" - // end of the list of possible fields + "blockSize": "int64", + "kmsKeyId": "string" }, "diskId": "string" // end of the list of possible fields @@ -265,12 +266,6 @@ To get a list of available disk types, use the [yandex.cloud.compute.v1.DiskType || size | **int64** Required field. Size of the disk, specified in bytes. || -|| blockSize | **int64** - -Block size of the disk, specified in bytes. The default is 4096. || -|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** - -Placement policy configuration. || || imageId | **string** ID of the image to create the disk from. @@ -281,6 +276,15 @@ Includes only one of the fields `imageId`, `snapshotId`. || ID of the snapshot to restore the disk from. Includes only one of the fields `imageId`, `snapshotId`. || +|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** + +Placement policy configuration. || +|| blockSize | **int64** + +Block size of the disk, specified in bytes. The default is 4096. || +|| kmsKeyId | **string** + +ID of KMS key for disk encryption || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} diff --git a/ru/load-testing/user/api-ref/grpc/Agent/update.md b/ru/load-testing/user/api-ref/grpc/Agent/update.md index 1a04e6256e2..12ccbf1b578 100644 --- a/ru/load-testing/user/api-ref/grpc/Agent/update.md +++ b/ru/load-testing/user/api-ref/grpc/Agent/update.md @@ -39,15 +39,16 @@ Updates the specified agent. "description": "string", "typeId": "string", "size": "int64", - "blockSize": "int64", + // Includes only one of the fields `imageId`, `snapshotId` + "imageId": "string", + "snapshotId": "string", + // end of the list of possible fields "diskPlacementPolicy": { "placementGroupId": "string", "placementGroupPartition": "int64" }, - // Includes only one of the fields `imageId`, `snapshotId` - "imageId": "string", - "snapshotId": "string" - // end of the list of possible fields + "blockSize": "int64", + "kmsKeyId": "string" }, "diskId": "string" // end of the list of possible fields @@ -251,12 +252,6 @@ To get a list of available disk types, use the [yandex.cloud.compute.v1.DiskType || size | **int64** Required field. Size of the disk, specified in bytes. || -|| blockSize | **int64** - -Block size of the disk, specified in bytes. The default is 4096. || -|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** - -Placement policy configuration. || || imageId | **string** ID of the image to create the disk from. @@ -267,6 +262,15 @@ Includes only one of the fields `imageId`, `snapshotId`. || ID of the snapshot to restore the disk from. Includes only one of the fields `imageId`, `snapshotId`. || +|| diskPlacementPolicy | **[DiskPlacementPolicy](#yandex.cloud.compute.v1.DiskPlacementPolicy)** + +Placement policy configuration. || +|| blockSize | **int64** + +Block size of the disk, specified in bytes. The default is 4096. || +|| kmsKeyId | **string** + +ID of KMS key for disk encryption || |# ## DiskPlacementPolicy {#yandex.cloud.compute.v1.DiskPlacementPolicy} diff --git a/ru/lockbox/api-ref/Secret/list.md b/ru/lockbox/api-ref/Secret/list.md index cff09ca417c..2328e60faaf 100644 --- a/ru/lockbox/api-ref/Secret/list.md +++ b/ru/lockbox/api-ref/Secret/list.md @@ -23,13 +23,13 @@ Required field. ID of the folder to list secrets in. || || pageSize | **string** (int64) The maximum number of results per page to return. If the number of available -results is larger than `page_size`, the service returns a [ListSecretsRequest.nextPageToken](#yandex.cloud.lockbox.v1.ListSecretsResponse) +results is larger than `page_size`, the service returns a [ListSecretsRequest.next_page_token] that can be used to get the next page of results in subsequent list requests. Default value: 100. || || pageToken | **string** Page token. To get the next page of results, set `page_token` to the -[ListSecretsRequest.nextPageToken](#yandex.cloud.lockbox.v1.ListSecretsResponse) returned by a previous list request. || +[ListSecretsRequest.next_page_token] returned by a previous list request. || |# ## Response {#yandex.cloud.lockbox.v1.ListSecretsResponse} diff --git a/ru/lockbox/api-ref/Secret/listOperations.md b/ru/lockbox/api-ref/Secret/listOperations.md index cea002bf6b9..69a538d99cf 100644 --- a/ru/lockbox/api-ref/Secret/listOperations.md +++ b/ru/lockbox/api-ref/Secret/listOperations.md @@ -29,13 +29,13 @@ Required field. ID of the secret to get operations for. || || pageSize | **string** (int64) The maximum number of results per page that should be returned. If the number of available -results is larger than `page_size`, the service returns a [ListSecretOperationsRequest.nextPageToken](/docs/lockbox/api-ref/Secret/list#yandex.cloud.lockbox.v1.ListSecretsResponse) +results is larger than `page_size`, the service returns a [ListSecretOperationsRequest.next_page_token] that can be used to get the next page of results in subsequent list requests. Default value: 100. || || pageToken | **string** Page token. To get the next page of results, set `page_token` to the -[ListSecretOperationsRequest.nextPageToken](/docs/lockbox/api-ref/Secret/list#yandex.cloud.lockbox.v1.ListSecretsResponse) returned by a previous list request. || +[ListSecretOperationsRequest.next_page_token] returned by a previous list request. || |# ## Response {#yandex.cloud.lockbox.v1.ListSecretOperationsResponse} @@ -77,8 +77,8 @@ List of operations for the specified secret. || || nextPageToken | **string** This token allows you to get the next page of results for list requests. If the number of results -is larger than [ListSecretOperationsResponse.pageSize](/docs/lockbox/api-ref/Secret/list#yandex.cloud.lockbox.v1.ListSecretsRequest), use the `next_page_token` as the value -for the [ListSecretOperationsResponse.pageToken](/docs/lockbox/api-ref/Secret/list#yandex.cloud.lockbox.v1.ListSecretsRequest) query parameter in the next list request. +is larger than [ListSecretOperationsResponse.page_size], use the `next_page_token` as the value +for the [ListSecretOperationsResponse.page_token] query parameter in the next list request. Each subsequent list request will have its own `next_page_token` to continue paging through the results. || |# diff --git a/ru/lockbox/api-ref/Secret/listVersions.md b/ru/lockbox/api-ref/Secret/listVersions.md index aef00417347..f0b2633622d 100644 --- a/ru/lockbox/api-ref/Secret/listVersions.md +++ b/ru/lockbox/api-ref/Secret/listVersions.md @@ -29,13 +29,13 @@ Required field. ID of the secret to list versions for. || || pageSize | **string** (int64) The maximum number of results per page to return. If the number of available -results is larger than `page_size`, the service returns a [ListVersionsRequest.nextPageToken](/docs/lockbox/api-ref/Secret/list#yandex.cloud.lockbox.v1.ListSecretsResponse) +results is larger than `page_size`, the service returns a [ListVersionsRequest.next_page_token] that can be used to get the next page of results in subsequent list requests. Default value: 100. || || pageToken | **string** Page token. To get the next page of results, set `page_token` to the -[ListVersionsRequest.nextPageToken](/docs/lockbox/api-ref/Secret/list#yandex.cloud.lockbox.v1.ListSecretsResponse) returned by a previous list request. || +[ListVersionsRequest.next_page_token] returned by a previous list request. || |# ## Response {#yandex.cloud.lockbox.v1.ListVersionsResponse} diff --git a/ru/lockbox/api-ref/grpc/Secret/list.md b/ru/lockbox/api-ref/grpc/Secret/list.md index dcc71e083f2..843815fe53d 100644 --- a/ru/lockbox/api-ref/grpc/Secret/list.md +++ b/ru/lockbox/api-ref/grpc/Secret/list.md @@ -29,13 +29,13 @@ Required field. ID of the folder to list secrets in. || || pageSize | **int64** The maximum number of results per page to return. If the number of available -results is larger than `page_size`, the service returns a [ListSecretsRequest.nextPageToken](#yandex.cloud.lockbox.v1.ListSecretsResponse) +results is larger than `page_size`, the service returns a [ListSecretsRequest.next_page_token] that can be used to get the next page of results in subsequent list requests. Default value: 100. || || pageToken | **string** Page token. To get the next page of results, set `page_token` to the -[ListSecretsRequest.nextPageToken](#yandex.cloud.lockbox.v1.ListSecretsResponse) returned by a previous list request. || +[ListSecretsRequest.next_page_token] returned by a previous list request. || |# ## ListSecretsResponse {#yandex.cloud.lockbox.v1.ListSecretsResponse} diff --git a/ru/lockbox/api-ref/grpc/Secret/listOperations.md b/ru/lockbox/api-ref/grpc/Secret/listOperations.md index ed28fd71867..d51caa51733 100644 --- a/ru/lockbox/api-ref/grpc/Secret/listOperations.md +++ b/ru/lockbox/api-ref/grpc/Secret/listOperations.md @@ -29,13 +29,13 @@ Required field. ID of the secret to get operations for. || || pageSize | **int64** The maximum number of results per page that should be returned. If the number of available -results is larger than `page_size`, the service returns a [ListSecretOperationsRequest.nextPageToken](/docs/lockbox/api-ref/grpc/Secret/list#yandex.cloud.lockbox.v1.ListSecretsResponse) +results is larger than `page_size`, the service returns a [ListSecretOperationsRequest.next_page_token] that can be used to get the next page of results in subsequent list requests. Default value: 100. || || pageToken | **string** Page token. To get the next page of results, set `page_token` to the -[ListSecretOperationsRequest.nextPageToken](/docs/lockbox/api-ref/grpc/Secret/list#yandex.cloud.lockbox.v1.ListSecretsResponse) returned by a previous list request. || +[ListSecretOperationsRequest.next_page_token] returned by a previous list request. || |# ## ListSecretOperationsResponse {#yandex.cloud.lockbox.v1.ListSecretOperationsResponse} @@ -69,8 +69,8 @@ List of operations for the specified secret. || || nextPageToken | **string** This token allows you to get the next page of results for list requests. If the number of results -is larger than [ListSecretOperationsResponse.pageSize](/docs/lockbox/api-ref/grpc/Secret/list#yandex.cloud.lockbox.v1.ListSecretsRequest), use the `next_page_token` as the value -for the [ListSecretOperationsResponse.pageToken](/docs/lockbox/api-ref/grpc/Secret/list#yandex.cloud.lockbox.v1.ListSecretsRequest) query parameter in the next list request. +is larger than [ListSecretOperationsResponse.page_size], use the `next_page_token` as the value +for the [ListSecretOperationsResponse.page_token] query parameter in the next list request. Each subsequent list request will have its own `next_page_token` to continue paging through the results. || |# diff --git a/ru/lockbox/api-ref/grpc/Secret/listVersions.md b/ru/lockbox/api-ref/grpc/Secret/listVersions.md index 97193592c75..39b1a4b6873 100644 --- a/ru/lockbox/api-ref/grpc/Secret/listVersions.md +++ b/ru/lockbox/api-ref/grpc/Secret/listVersions.md @@ -29,13 +29,13 @@ Required field. ID of the secret to list versions for. || || pageSize | **int64** The maximum number of results per page to return. If the number of available -results is larger than `page_size`, the service returns a [ListVersionsRequest.nextPageToken](/docs/lockbox/api-ref/grpc/Secret/list#yandex.cloud.lockbox.v1.ListSecretsResponse) +results is larger than `page_size`, the service returns a [ListVersionsRequest.next_page_token] that can be used to get the next page of results in subsequent list requests. Default value: 100. || || pageToken | **string** Page token. To get the next page of results, set `page_token` to the -[ListVersionsRequest.nextPageToken](/docs/lockbox/api-ref/grpc/Secret/list#yandex.cloud.lockbox.v1.ListSecretsResponse) returned by a previous list request. || +[ListVersionsRequest.next_page_token] returned by a previous list request. || |# ## ListVersionsResponse {#yandex.cloud.lockbox.v1.ListVersionsResponse} diff --git a/ru/lockbox/toc.yaml b/ru/lockbox/toc.yaml index 8a7d3305d71..d7354714bcc 100644 --- a/ru/lockbox/toc.yaml +++ b/ru/lockbox/toc.yaml @@ -62,6 +62,8 @@ items: href: tutorials/data-transfer-direct-to-mch.md - name: Развертывание отказоустойчивой архитектуры с прерываемыми ВМ href: tutorials/nodejs-cron-restart-vm.md + - name: Безопасная передача пароля в скрипт инициализации + href: tutorials/secure-password-script.md - name: Квоты и лимиты href: concepts/limits.md - name: Управление доступом diff --git a/ru/lockbox/tutorials/index.md b/ru/lockbox/tutorials/index.md index 514ac3e7126..0ce91623f2d 100644 --- a/ru/lockbox/tutorials/index.md +++ b/ru/lockbox/tutorials/index.md @@ -10,5 +10,6 @@ description: Различные сценарии использования {{ l * [{#T}](gitlab-lockbox-integration.md) * [{#T}](static-key-in-lockbox.md) * [{#T}](lockbox-and-airflow.md) -* [{#T}](data-transfer-direct-to-mch.md) -* [{#T}](nodejs-cron-restart-vm.md) \ No newline at end of file +* [{#T}](nodejs-cron-restart-vm.md) +* [{#T}](secure-password-script.md) +* [{#T}](data-transfer-direct-to-mch.md) \ No newline at end of file diff --git a/ru/lockbox/tutorials/secure-password-script.md b/ru/lockbox/tutorials/secure-password-script.md new file mode 100644 index 00000000000..60921ff2788 --- /dev/null +++ b/ru/lockbox/tutorials/secure-password-script.md @@ -0,0 +1,7 @@ +--- +title: Безопасная передача пароля в скрипт инициализации +description: В этом сценарии вы узнаете как безопасно передать пароль в скрипт инициализации. +canonical: '{{ link-docs }}/tutorials/windows/secure-password-script' +--- + +{% include [secure-password-script](../../_tutorials/windows/secure-password-script.md) %} \ No newline at end of file diff --git a/ru/logging/api-ref/grpc/LogReading/read.md b/ru/logging/api-ref/grpc/LogReading/read.md index 1bb6d142600..4579260145c 100644 --- a/ru/logging/api-ref/grpc/LogReading/read.md +++ b/ru/logging/api-ref/grpc/LogReading/read.md @@ -206,7 +206,7 @@ Also may be provided by the user. || Timestamp of the entry. || || ingestedAt | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp)** -Entry ingestion time observed by [LogIngestionService]. || +Entry ingestion time observed by [LogIngestionService](/docs/logging/api-ref/grpc/LogIngestion/). || || savedAt | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp)** Entry save time. diff --git a/ru/managed-airflow/operations/cluster-list.md b/ru/managed-airflow/operations/cluster-list.md index 66fdefb1050..33bd065c8ef 100644 --- a/ru/managed-airflow/operations/cluster-list.md +++ b/ru/managed-airflow/operations/cluster-list.md @@ -57,7 +57,7 @@ description: Вы можете запросить детальную инфор Идентификатор каталога можно запросить со [списком каталогов в облаке](../../resource-manager/operations/folder/get-id.md). - 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Cluster/list.md#yandex.cloud.mdb.mongodb.v1.ListClustersResponse). + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Cluster/list.md#yandex.cloud.airflow.v1.ListClustersResponse). * gRPC API {#grpc-api} @@ -130,7 +130,7 @@ description: Вы можете запросить детальную инфор Идентификатор кластера можно запросить со [списком кластеров в каталоге](#list-clusters). - 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Cluster/get.md#yandex.cloud.mdb.mongodb.v1.Cluster). + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Cluster/get.md#yandex.cloud.airflow.v1.Cluster). * gRPC API {#grpc-api} @@ -162,16 +162,25 @@ description: Вы можете запросить детальную инфор {% endlist %} -## Посмотреть список операций в кластере {#list-operations} +## Посмотреть операции с кластерами {#list-operations} + +Все действия с кластерами {{ maf-name }} сохраняются в виде списка операций. Каждой операции присваивается уникальный идентификатор. + +### Получить список операций {#get-operations} {% list tabs group=instructions %} * Консоль управления {#console} - 1. В [консоли управления]({{ link-console-main }}) перейдите в нужный каталог. - 1. В списке сервисов выберите **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-airflow }}**. - 1. Нажмите на имя нужного кластера. - 1. Перейдите на вкладку **{{ ui-key.yacloud.common.operations-key-value }}**. + Чтобы получить список операций для кластера {{ maf-name }}: + + 1. В [консоли управления]({{ link-console-main }}) откройте каталог, в котором находится кластер. + 1. Выберите сервис **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-airflow }}**. + 1. На панели слева выберите ![image](../../_assets/console-icons/cubes-3.svg) **{{ ui-key.yacloud.mdb.clusters.label_title }}**. + 1. Выберите нужный кластер. + 1. Перейдите на панель ![image](../../_assets/console-icons/list-check.svg) **{{ ui-key.yacloud.common.operations-key-value }}** для выбранного кластера. + + В открывшемся списке отображаются операции с выбранным кластером. * CLI {#cli} @@ -181,7 +190,7 @@ description: Вы можете запросить детальную инфор Чтобы получить список операций, выполните команду: - ``` + ```bash {{ yc-mdb-af }} cluster list-operations <имя_или_идентификатор_кластера> ``` @@ -204,7 +213,7 @@ description: Вы можете запросить детальную инфор Идентификатор кластера можно запросить со [списком кластеров в каталоге](#list-clusters). - 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Cluster/listOperations.md#yandex.cloud.mdb.mongodb.v1.ListClusterOperationsResponse). + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Cluster/listOperations.md#yandex.cloud.airflow.v1.ListClusterOperationsResponse). * gRPC API {#grpc-api} @@ -235,3 +244,60 @@ description: Вы можете запросить детальную инфор 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Cluster/listOperations.md#yandex.cloud.airflow.v1.ListClusterOperationsResponse). {% endlist %} + +### Получить подробную информацию об операции {#get-operations-info} + +1. [Получите список операций](#get-operations) для кластера. +1. Скопируйте идентификатор нужной операции. +1. Получите подробную информацию об операции: + + {% list tabs group=instructions %} + + * REST API {#api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. Воспользуйтесь методом [Operation.get](../api-ref/Operation/get.md) и выполните запрос, например, с помощью {{ api-examples.rest.tool }}: + + ```bash + curl \ + --request GET \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --url 'https://{{ api-host-operation }}/operations/<идентификатор_операции>' + ``` + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Operation/get.md#yandex.cloud.operation.Operation). + + * gRPC API {#grpc-api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} + + 1. Воспользуйтесь вызовом [OperationService/Get](../api-ref/grpc/Operation/get.md) и выполните запрос, например, с помощью {{ api-examples.grpc.tool }}: + + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/operation/operation_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + -d '{ + "operation_id": "<идентификатор_операции>" + }' \ + {{ api-host-operation }}:{{ port-https }} \ + yandex.cloud.operation.OperationService.Get + ``` + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Operation/get.md#yandex.cloud.operation.Operation). + + {% endlist %} + +## См. также {#see-also} + +* [{#T}](../../api-design-guide/concepts/about-async.md) diff --git a/ru/managed-airflow/operations/index.md b/ru/managed-airflow/operations/index.md index 5669d2489e3..4a3e9a7e22f 100644 --- a/ru/managed-airflow/operations/index.md +++ b/ru/managed-airflow/operations/index.md @@ -10,4 +10,3 @@ description: Из статьи вы узнаете, как работать с { * [{#T}](af-interfaces.md) * [Загрузка DAG-файлов в кластер](upload-dags.md) * [Удаление кластера](cluster-delete.md) -* [Просмотр операций с кластерами](operation-logs.md) \ No newline at end of file diff --git a/ru/managed-airflow/operations/operation-logs.md b/ru/managed-airflow/operations/operation-logs.md deleted file mode 100644 index 9529b96d222..00000000000 --- a/ru/managed-airflow/operations/operation-logs.md +++ /dev/null @@ -1,43 +0,0 @@ -# Просмотр операций с кластерами - -Все действия с кластерами {{ maf-name }} сохраняются в виде списка операций. Каждой операции присваивается уникальный идентификатор. - -## Получить список операций {#get-operations} - -{% list tabs group=instructions %} - -- Консоль управления {#console} - - Чтобы получить список операций для кластера {{ maf-name }}: - - 1. В [консоли управления]({{ link-console-main }}) откройте каталог, в котором находится кластер. - 1. Выберите сервис **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-airflow }}**. - 1. На панели слева выберите ![image](../../_assets/console-icons/cubes-3.svg) **{{ ui-key.yacloud.mdb.clusters.label_title }}**. - 1. Выберите нужный кластер. - 1. Перейдите на панель ![image](../../_assets/console-icons/list-check.svg) **{{ ui-key.yacloud.common.operations-key-value }}** для выбранного кластера. - - В открывшемся списке отображаются операции с выбранным кластером. - -- API {#api} - - Воспользуйтесь методом REST API [listOperations](../api-ref/Cluster/listOperations.md) для ресурса [Cluster](../api-ref/Cluster/index.md) или вызовом gRPC API [ClusterService/ListOperations](../api-ref/grpc/Cluster/listOperations.md) и передайте в запросе идентификатор кластера. - -{% endlist %} - -## Получить подробную информацию об операции {#get-operations-info} - -1. [Получите список операций](#get-operations) для кластера. -1. Скопируйте идентификатор нужной операции. -1. Получите подробную информацию об операции: - - {% list tabs group=instructions %} - - - API {#api} - - Воспользуйтесь вызовом gRPC API [OperationService/Get](../api-ref/grpc/Operation/get.md) и передайте в запросе идентификатор операции. - - {% endlist %} - -## См. также {#see-also} - -* [{#T}](../../api-design-guide/concepts/about-async.md) \ No newline at end of file diff --git a/ru/managed-airflow/toc.yaml b/ru/managed-airflow/toc.yaml index 66c3c111228..9a88b530a9b 100644 --- a/ru/managed-airflow/toc.yaml +++ b/ru/managed-airflow/toc.yaml @@ -21,8 +21,6 @@ items: href: operations/upload-dags.md - name: Удаление кластера href: operations/cluster-delete.md - - name: Просмотр операций с кластерами - href: operations/operation-logs.md - name: Практические руководства items: - name: Все руководства diff --git a/ru/managed-clickhouse/operations/cluster-backups.md b/ru/managed-clickhouse/operations/cluster-backups.md index afc90ac4651..340a2f33652 100644 --- a/ru/managed-clickhouse/operations/cluster-backups.md +++ b/ru/managed-clickhouse/operations/cluster-backups.md @@ -50,11 +50,53 @@ description: Вы можете создавать резервные копии Имя и идентификатор кластера можно получить со [списком кластеров в каталоге](cluster-list.md#list-clusters). -- API {#api} +- REST API {#api} - Чтобы создать резервную копию, воспользуйтесь методом REST API [backup](../api-ref/Cluster/backup.md) для ресурса [Cluster](../api-ref/Cluster/index.md) или вызовом gRPC API [ClusterService/Backup](../api-ref/grpc/Cluster/backup.md) и передайте в запросе идентификатор кластера в параметре `clusterId`. + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: - Идентификатор кластера можно получить со [списком кластеров в каталоге](cluster-list.md#list-clusters). + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. Воспользуйтесь методом [Cluster.backup](../api-ref/Cluster/backup.md) и выполните запрос, например, с помощью {{ api-examples.rest.tool }}: + + ```bash + curl \ + --request POST \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --header "Content-Type: application/json" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/clusters/<идентификатор_кластера>:backup' + ``` + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Cluster/backup.md#responses). + +- gRPC API {#grpc-api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} + + 1. Воспользуйтесь вызовом [ClusterService/Backup](../api-ref/grpc/Cluster/backup.md) и выполните запрос, например, с помощью {{ api-examples.grpc.tool }}: + + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + -d '{ + "cluster_id": "<идентификатор_кластера>" + }' \ + {{ api-host-mdb }}:{{ port-https }} \ + yandex.cloud.mdb.clickhouse.v1.ClusterService.Backup + ``` + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Cluster/backup.md#yandex.cloud.operation.Operation). {% endlist %} @@ -178,18 +220,189 @@ description: Вы можете создавать резервные копии ... ``` -- API {#api} +- REST API {#api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. Воспользуйтесь методом [Cluster.restore](../api-ref/Cluster/restore.md) и выполните запрос, например, с помощью {{ api-examples.rest.tool }}: + + 1. Создайте файл `body.json` и добавьте в него следующее содержимое: + + ```json + { + "backupId": "<идентификатор_резервной_копии>", + "additionalBackupIds": [ + <список_дополнительных_идентификаторов_резервных_копий> + ], + "name": "<имя_кластера>", + "environment": "<окружение>", + "configSpec": { <конфигурация_кластера> }, + "hostSpecs": [ + { + "type": "<тип_хоста>", + "zoneId": "<зона_доступности>", + "subnetId": "<идентификатор_подсети>", + "shardName": "<имя_шарда>", + "assignPublicIp": <публичный_доступ_к_хосту> + }, + { <аналогичный_набор_настроек_для_хоста_2> }, + { ... }, + { <аналогичный_набор_настроек_для_хоста_N> } + ], + "folderId": "<идентификатор_каталога>", + "networkId": "<идентификатор_сети>", + "serviceAccountId": "<идентификатор_сервисного аккаунта>", + "securityGroupIds": [ + <список_идентификаторов_групп_безопасности> + ], + "deletionProtection": <защита_от_удаления> + } + ``` + + Где: + + * `backupId` — идентификатор резервной копии. + + Будет восстановлен шард, для которого была создана эта резервная копия. + + * `additionalBackupIds` — массив, содержащий список дополнительных идентификаторов резервных копий. + + Будут восстановлены шарды, для которых были созданы эти резервные копии. Чтобы восстановить весь кластер целиком, передайте идентификаторы резервных копий всех шардов кластера. + + * `name` — имя кластера. + * `environment` — окружение: + + * `PRODUCTION` — для стабильных версий ваших приложений. + * `PRESTABLE` — для тестирования. Prestable-окружение аналогично Production-окружению и на него также распространяется SLA, но при этом на нем раньше появляются новые функциональные возможности, улучшения и исправления ошибок. В Prestable-окружении вы можете протестировать совместимость новых версий с вашим приложением. + + * `configSpec` — конфигурация кластера {{ CH }}. Подробное описание параметров см. в описании метода [Cluster.restore](../api-ref/Cluster/restore.md). + * `hostSpecs` — массив, содержащий настройки создаваемых хостов. Один элемент массива содержит настройки для одного хоста и имеет следующую структуру: + + * `type` — тип хоста. + * `zoneId` — зона доступности. + * `subnetId` — идентификатор подсети. + * `shardName` — имя шарда. + * `assignPublicIp` — доступность хоста из интернета по публичному IP-адресу: `true` или `false`. + + * `folderId` — идентификатор каталога, в котором будет создан кластер. + * `networkId` — идентификатор сети, в которой будет создан кластер. + * `serviceAccountId` — идентификатор сервисного аккаунта. + * `securityGroupIds` — массив, содержащий список идентификаторов групп безопасности. + * `deletionProtection` — опция, которая управляет защитой кластера, его баз данных и пользователей от непреднамеренного удаления. + + Включенная защита от удаления не помешает подключиться вручную и удалить содержимое базы данных. + + Идентификатор резервной копии можно запросить со [списком резервных копий в каталоге](#list-backups). + + 1. Выполните запрос: + + ```bash + curl \ + --request POST \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --header "Content-Type: application/json" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/clusters:restore' \ + --data "@body.json" + ``` + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Cluster/restore.md#responses). + +- gRPC API {#grpc-api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} + + 1. Воспользуйтесь вызовом [ClusterService/Restore](../api-ref/grpc/Cluster/restore.md) и выполните запрос, например, с помощью {{ api-examples.grpc.tool }}: + + 1. Создайте файл `body.json` и добавьте в него следующее содержимое: + + ```json + { + "backup_id": "<идентификатор_резервной_копии>", + "additional_backup_ids": [ + <список_дополнительных_идентификаторов_резервных_копий> + ], + "name": "<имя_кластера>", + "environment": "<окружение>", + "config_spec": { <конфигурация_кластера> }, + "host_specs": [ + { + "type": "<тип_хоста>", + "zone_id": "<зона_доступности>", + "subnet_id": "<идентификатор_подсети>", + "shard_name": "<имя_шарда>", + "assign_public_ip": <публичный_доступ_к_хосту> + }, + { <аналогичный_набор_настроек_для_хоста_2> }, + { ... }, + { <аналогичный_набор_настроек_для_хоста_N> } + ], + "folder_id": "<идентификатор_каталога>", + "network_id": "<идентификатор_сети>", + "service_account_id": "<идентификатор_сервисного аккаунта>", + "security_group_ids": [ + <список_идентификаторов_групп_безопасности> + ], + "deletion_protection": <защита_от_удаления> + } + ``` + + Где: + + * `backup_id` — идентификатор резервной копии. + + Будет восстановлен шард, для которого была создана эта резервная копия. + + * `additional_backup_ids` — массив, содержащий список дополнительных идентификаторов резервных копий. - Чтобы восстановить кластер из резервной копии, воспользуйтесь методом REST API [restore](../api-ref/Cluster/restore.md) для ресурса [Cluster](../api-ref/Cluster/index.md) или вызовом gRPC API [ClusterService/Restore](../api-ref/grpc/Cluster/restore.md) и передайте в запросе: + Будут восстановлены шарды, для которых были созданы эти резервные копии. Чтобы восстановить весь кластер целиком, передайте идентификаторы резервных копий всех шардов кластера. - * Идентификатор резервной копии нужного шарда в параметре `backupId`. Чтобы узнать идентификатор, [получите список резервных копий в кластере](#list-backups). - * Имя нового кластера, который будет содержать восстановленные из резервной копии данные, в параметре `name`. Имя кластера должно быть уникальным в рамках каталога. - * Окружение кластера в параметре `environment`. - * Конфигурацию кластера в параметре `configSpec`. - * Конфигурацию хостов кластера в одном или нескольких параметрах `hostSpecs`. - * Идентификатор сети в параметре `networkId`. + * `name` — имя кластера. + * `environment` — окружение: - Чтобы восстановить весь кластер целиком, передайте идентификаторы резервных копий всех остальных шардов кластера в параметре `additionalBackupIds`. + * `PRODUCTION` — для стабильных версий ваших приложений. + * `PRESTABLE` — для тестирования. Prestable-окружение аналогично Production-окружению и на него также распространяется SLA, но при этом на нем раньше появляются новые функциональные возможности, улучшения и исправления ошибок. В Prestable-окружении вы можете протестировать совместимость новых версий с вашим приложением. + + * `config_spec` — конфигурация кластера {{ CH }}. Подробное описание параметров см. в описании вызова [ClusterService/Restore](../api-ref/grpc/Cluster/restore.md). + * `host_specs` — массив, содержащий настройки создаваемых хостов. Один элемент массива содержит настройки для одного хоста и имеет следующую структуру: + + * `type` — тип хоста. + * `zone_id` — зона доступности. + * `subnet_id` — идентификатор подсети. + * `shard_name` — имя шарда. + * `assign_public_ip` — доступность хоста из интернета по публичному IP-адресу: `true` или `false`. + + * `folder_id` — идентификатор каталога, в котором будет создан кластер. + * `network_id` — идентификатор сети, в которой будет создан кластер. + * `service_account_id` — идентификатор сервисного аккаунта. + * `security_group_ids` — массив, содержащий список идентификаторов групп безопасности. + * `deletion_protection` — опция, которая управляет защитой кластера, его баз данных и пользователей от непреднамеренного удаления. + + Включенная защита от удаления не помешает подключиться вручную и удалить содержимое базы данных. + + Идентификатор резервной копии можно запросить со [списком резервных копий в каталоге](#list-backups). + + 1. Выполните запрос: + + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + -d @ \ + {{ api-host-mdb }}:{{ port-https }} \ + yandex.cloud.mdb.clickhouse.v1.ClusterService.Restore \ + < body.json + ``` + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Cluster/restore.md#yandex.cloud.operation.Operation). {% endlist %} @@ -247,16 +460,100 @@ description: Вы можете создавать резервные копии * Размер резервной копии. * Тип резервной копии: автоматическая (`AUTOMATED`) или ручная (`MANUAL`). -- API {#api} +- REST API {#api} - Чтобы получить список резервных копий кластера, воспользуйтесь методом REST API [listBackups](../api-ref/Cluster/listBackups.md) для ресурса [Cluster](../api-ref/Cluster/index.md) или вызовом gRPC API [ClusterService/ListBackups](../api-ref/grpc/Cluster/listBackups.md) и передайте в запросе идентификатор кластера в параметре `clusterId`. + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: - Чтобы получить список резервных копий всех кластеров {{ mch-name }} в каталоге, воспользуйтесь методом REST API [list](../api-ref/Backup/list.md) для ресурса [Backup](../api-ref/Backup/index.md) или вызовом gRPC API [BackupService/List](../api-ref/grpc/Backup/list.md) и передайте в запросе идентификатор каталога в параметре `folderId`. + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} - Идентификатор кластера можно получить со [списком кластеров в каталоге](cluster-list.md#list-clusters). + 1. Чтобы получить список резервных копий кластера {{ CH }}: -{% endlist %} + 1. Воспользуйтесь методом [Cluster.listBackups](../api-ref/Cluster/listBackups.md) и выполните запрос, например, с помощью {{ api-examples.rest.tool }}: + + ```bash + curl \ + --request GET \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/clusters/<идентификатор_кластера>/backups' + ``` + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Cluster/listBackups.md#responses). + + 1. Чтобы получить список резервных копий всех кластеров {{ CH }} в каталоге: + + 1. Воспользуйтесь методом [Backup.list](../api-ref/Backup/list.md) и выполните запрос, например, с помощью {{ api-examples.rest.tool }}: + + ```bash + curl \ + --request GET \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/backups' \ + --url-query folderId=<идентификатор_каталога> + ``` + + + Идентификатор каталога можно запросить со [списком каталогов в облаке](../../resource-manager/operations/folder/get-id.md). + + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Backup/list.md#responses). + +- gRPC API {#grpc-api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} + + 1. Чтобы получить список резервных копий кластера {{ CH }}: + + 1. Воспользуйтесь вызовом [ClusterService/ListBackups](../api-ref/grpc/Cluster/listBackups.md) и выполните запрос, например, с помощью {{ api-examples.grpc.tool }}: + + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + -d '{ + "cluster_id": "<идентификатор_кластера>" + }' \ + {{ api-host-mdb }}:{{ port-https }} \ + yandex.cloud.mdb.clickhouse.v1.ClusterService.ListBackups + ``` + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Cluster/listBackups.md#yandex.cloud.mdb.clickhouse.v1.ListClusterBackupsResponse). + + 1. Чтобы получить список резервных копий всех кластеров {{ CH }} в каталоге: + + 1. Воспользуйтесь вызовом [BackupService/List](../api-ref/grpc/Backup/list.md) и выполните запрос, например, с помощью {{ api-examples.grpc.tool }}: + + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/backup_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + -d '{ + "folder_id": "<идентификатор_каталога>" + }' \ + {{ api-host-mdb }}:{{ port-https }} \ + yandex.cloud.mdb.clickhouse.v1.BackupService.List + ``` + + + Идентификатор каталога можно запросить со [списком каталогов в облаке](../../resource-manager/operations/folder/get-id.md). + + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Backup/list.md#yandex.cloud.mdb.clickhouse.v1.ListBackupsResponse). + +{% endlist %} ## Получить информацию о резервной копии {#get-backup} @@ -286,11 +583,52 @@ description: Вы можете создавать резервные копии Идентификатор резервной копии можно получить со [списком резервных копий](#list-backups). -- API {#api} +- REST API {#api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. Воспользуйтесь методом [Backup.get](../api-ref/Backup/get.md) и выполните запрос, например, с помощью {{ api-examples.rest.tool }}: + + ```bash + curl \ + --request GET \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/backups/<идентификатор_резервной_копии>' + ``` + + Идентификатор резервной копии можно запросить со [списком резервных копий в каталоге](#list-backups). + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Backup/get.md#responses). + +- gRPC API {#grpc-api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} + + 1. Воспользуйтесь вызовом [BackupService/Get](../api-ref/grpc/Backup/get.md) и выполните запрос, например, с помощью {{ api-examples.grpc.tool }}: + + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/backup_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + -d '{ + "backup_id": "<идентификатор_резервной_копии>" + }' \ + {{ api-host-mdb }}:{{ port-https }} \ + yandex.cloud.mdb.clickhouse.v1.BackupService.Get + ``` - Чтобы получить информацию о резервной копии, воспользуйтесь методом REST API [get](../api-ref/Backup/get.md) для ресурса [Backup](../api-ref/Backup/index.md) или вызовом gRPC API [BackupService/Get](../api-ref/grpc/Backup/get.md) и передайте в запросе идентификатор резервной копии в параметре `backupId`. + Идентификатор резервной копии можно запросить со [списком резервных копий в каталоге](#list-backups). - Чтобы узнать идентификатор, [получите список резервных копий](#list-backups). + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Backup/get.md#yandex.cloud.mdb.clickhouse.v1.Backup). {% endlist %} @@ -317,15 +655,97 @@ description: Вы можете создавать резервные копии Идентификатор и имя кластера можно запросить со [списком кластеров в каталоге](cluster-list.md#list-clusters). -- API {#api} +- REST API {#api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. Воспользуйтесь методом [Cluster.update](../api-ref/Cluster/update.md) и выполните запрос, например, с помощью {{ api-examples.rest.tool }}: + + {% include [note-updatemask](../../_includes/note-api-updatemask.md) %} + + ```bash + curl \ + --request PATCH \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --header "Content-Type: application/json" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/clusters/<идентификатор_кластера>' \ + --data '{ + "updateMask": "configSpec.backupWindowStart", + "configSpec": { + "backupWindowStart": { + "hours": "<часы>", + "minutes": "<минуты>", + "seconds": "<секунды>", + "nanos": "<наносекунды>" + } + } + }' + ``` + + Где: + + * `updateMask` — перечень изменяемых параметров в одну строку через запятую. + + В данном случае указан только один параметр: `configSpec.backupWindowStart`. + + * {% include [backup-windows-start-rest](../../_includes/mdb/api/backup-windows-start-rest.md) %} + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Cluster/update.md#responses). + +- gRPC API {#grpc-api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} + + 1. Воспользуйтесь вызовом [ClusterService/Update](../api-ref/grpc/Cluster/update.md) и выполните запрос, например, с помощью {{ api-examples.grpc.tool }}: + + {% include [note-grpc-updatemask](../../_includes/note-grpc-api-updatemask.md) %} + + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + -d '{ + "cluster_id": "<идентификатор_кластера>", + "update_mask": { + "paths": [ + "config_spec.backup_window_start" + ] + }, + "config_spec": { + "backup_window_start": { + "hours": "<часы>", + "minutes": "<минуты>", + "seconds": "<секунды>", + "nanos": "<наносекунды>" + } + } + }' \ + {{ api-host-mdb }}:{{ port-https }} \ + yandex.cloud.mdb.clickhouse.v1.ClusterService.Update + ``` + + Где: + + * `update_mask` — перечень изменяемых параметров в виде массива строк `paths[]`. + + В данном случае указан только один параметр: `config_spec.backup_window_start`. - Чтобы задать время начала резервного копирования, воспользуйтесь методом REST API [update](../api-ref/Cluster/update.md) для ресурса [Cluster](../api-ref/Cluster/index.md) или вызовом gRPC API [ClusterService/Update](../api-ref/grpc/Cluster/update.md) и передайте в запросе: + * {% include [backup-windows-start-grpc](../../_includes/mdb/api/backup-windows-start-grpc.md) %} - * Идентификатор кластера в параметре `clusterId`. Его можно получить [со списком кластеров в каталоге](cluster-list.md#list-clusters). - * Новое время начала резервного копирования в параметре `configSpec.backupWindowStart`. - * Список изменяемых полей конфигурации кластера в параметре `updateMask` (в данном случае — `configSpec.backupWindowStart`). + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). - {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Cluster/update.md#yandex.cloud.operation.Operation). {% endlist %} diff --git a/ru/managed-clickhouse/operations/cluster-create.md b/ru/managed-clickhouse/operations/cluster-create.md index 0a05a1adc88..796031efb30 100644 --- a/ru/managed-clickhouse/operations/cluster-create.md +++ b/ru/managed-clickhouse/operations/cluster-create.md @@ -426,52 +426,401 @@ description: Следуя данной инструкции, вы сможете {% include [Terraform timeouts](../../_includes/mdb/mch/terraform/timeouts.md) %} -- API {#api} +- REST API {#api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. Воспользуйтесь методом [Cluster.create](../api-ref/Cluster/create.md) и выполните запрос, например, с помощью {{ api-examples.rest.tool }}: + + 1. Создайте файл `body.json` и добавьте в него следующее содержимое: + + {% note info %} + + В примере приведены не все доступные параметры. + + {% endnote %} + + + ```json + { + "folderId": "<идентификатор_каталога>", + "name": "<имя_кластера>", + "environment": "<окружение>", + "networkId": "<идентификатор_сети>", + "securityGroupIds": [ + "<идентификатор_группы_безопасности_1>", + "<идентификатор_группы_безопасности_2>", + ... + "<идентификатор_группы_безопасности_N>" + ], + "configSpec": { + "version": "<версия_{{ CH }}>", + "embeddedKeeper": <использование_{{ CK }}>, + "clickhouse": { + "resources": { + "resourcePresetId": "<класс_хостов_{{ CH }}>", + "diskSize": "<размер_хранилища_в_байтах>", + "diskTypeId": "<тип_диска>" + } + }, + "zookeeper": { + "resources": { + "resourcePresetId": "<класс_хостов_{{ ZK }}>", + "diskSize": "<размер_хранилища_в_байтах>", + "diskTypeId": "<тип_диска>" + } + }, + "access": { + "dataLens": <доступ_из_{{ datalens-name }}>, + "webSql": <выполнение_SQL-запросов_из_консоли_управления>, + "metrika": <доступ_из_Метрики_и_AppMetrika>, + "serverless": <доступ_из_Cloud_Functions>, + "dataTransfer": <доступ_из_Data_Transfer>, + "yandexQuery": <доступ_из_Yandex_Query> + }, + "cloudStorage": { + "enabled": <использование_гибридного_хранилища>, + "moveFactor": "<доля_свободного_места>", + "dataCacheEnabled": <временное_хранение_файлов>, + "dataCacheMaxSize": "<максимальный_объем_памяти_для_хранения_файлов>", + "preferNotToMerge": <отключение_слияния_кусков_данных> + }, + "adminPassword": "<пароль_пользователя_admin>", + "sqlUserManagement": <управление_пользователями_через_SQL>, + "sqlDatabaseManagement": <управление_базами_данных_через_SQL> + }, + "databaseSpecs": [ + { + "name": "<имя_базы_данных>" + }, + { <аналогичный_набор_настроек_для_базы_данных_2> }, + { ... }, + { <аналогичный_набор_настроек_для_базы_данных_N> } + ], + "userSpecs": [ + { + "name": "<имя_пользователя>", + "password": "<пароль_пользователя>", + "permissions": [ + { + "databaseName": "<имя_базы_данных>" + } + ] + }, + { <аналогичный_набор_настроек_для_пользователя_2> }, + { ... }, + { <аналогичный_набор_настроек_для_пользователя_N> } + ], + "hostSpecs": [ + { + "zoneId": "<зона_доступности>", + "type": "<тип_хоста>", + "subnetId": "<идентификатор_подсети>", + "assignPublicIp": <публичный_доступ_к_хосту>, + "shardName": "<имя_шарда>" + }, + { <аналогичный_набор_настроек_для_хоста_2> }, + { ... }, + { <аналогичный_набор_настроек_для_хоста_N> } + ], + "deletionProtection": <защита_от_удаления> + } + ``` + + + Где: + + * `name` — имя кластера. + * `environment` — окружение кластера: `PRODUCTION` или `PRESTABLE`. + * `networkId` — идентификатор [сети](../../vpc/concepts/network.md), в которой будет размещен кластер. + + + * `securityGroupIds` — идентификаторы [групп безопасности](../../vpc/concepts/security-groups.md) в виде массива строк. массив Каждая строка — идентификатор группы безопасности. + + + * `configSpec` — конфигурация кластера: + + * `version` — версия {{ CH }}: {{ versions.api.str }}. + * `embeddedKeeper` — использовать [{{ CK }}](../concepts/replication.md#ck) вместо {{ ZK }}: `true` или `false`. + + {% include [replication-management-details](../../_includes/mdb/mch/api/replication-management-details.md) %} + + * `clickhouse` — конфигурация {{ CH }}: + + * `resources.resourcePresetId` — идентификатор [класса хостов](../concepts/instance-types.md). Список доступных классов хостов с их идентификаторами можно запросить с помощью метода [ResourcePreset.list](../api-ref/ResourcePreset/list.md). + * `resources.diskSize` — размер диска в байтах. + * `resources.diskTypeId` — [тип диска](../concepts/storage.md). + + * `zookeeper` — конфигурация [{{ ZK }}](../concepts/replication.md#zk): + + * `resources.resourcePresetId` — идентификатор класса хостов. Список доступных классов хостов с их идентификаторами можно запросить с помощью метода [ResourcePreset.list](../api-ref/ResourcePreset/list.md). + * `resources.diskSize` — размер диска в байтах. + * `resources.diskTypeId` — тип диска. + + Если вы включили использование {{ CK }} с помощью настройки `embeddedKeeper: true`, то необязательно указывать конфигурацию {{ ZK }} в `configSpec`: эта конфигурация не будет применена. + + * `access` — настройки, которые разрешают доступ к кластеру из других сервисов и [выполнение SQL-запросов из консоли управления](web-sql-query.md) с помощью {{ websql-full-name }}: + + {% include [rest-access-settings](../../_includes/mdb/mch/api/rest-access-settings.md) %} + + * `cloudStorage` — настройки [гибридного хранилища](../concepts/storage.md#hybrid-storage-features): + + {% include [rest-cloud-storage-settings](../../_includes/mdb/mch/api/rest-cloud-storage-settings.md) %} + + * `sql...` и `adminPassword` — группа настроек для управления пользователями и базами данных через SQL: + + * `adminPassword` — пароль пользователя `admin`. + * `sqlUserManagement` — режим [управления пользователями через SQL](./cluster-users.md#sql-user-management): `true` или `false`. + * `sqlDatabaseManagement` — режим [управления базами данных через SQL](./databases.md#sql-database-management): `true` или `false`. Необходимо, чтобы был включен режим управления пользователями через SQL. + + + {% include [SQL-management-can't-be-switched-off](../../_includes/mdb/mch/note-sql-db-and-users-create-cluster.md) %} + + * `databaseSpecs` — настройки баз данных в виде массива параметров элементов `name`. Один параметр содержит имя отдельной БД. + + * `userSpecs` — настройки пользователей в виде массива элементов. Каждый элемент соответствует отдельному пользователю и имеет следующую структуру: + + {% include [rest-user-specs](../../_includes/mdb/mch/api/rest-user-specs.md) %} + + * `hostSpecs` — настройки хостов кластера в виде массива элементов. Каждый элемент соответствует отдельному хосту и имеет следующую структуру: + + * `type` — тип хоста: `CLICKHOUSE` или `ZOOKEEPER`. + + Если вы включили использование {{ CK }} с помощью настройки `embeddedKeeper: true`, то в `hostSpecs` нужно указать только настройки хостов {{ CH }}. + + * `zoneId` — [зона доступности](../../overview/concepts/geo-scope.md). + * `subnetId` — идентификатор [подсети](../../vpc/concepts/network.md#subnet). + * `shardName` — имя [шарда](../concepts/sharding.md). Эта настройка имеет смысл только для хостов типа `CLICKHOUSE`. + * `assignPublicIp` — доступность хоста из интернета по публичному IP-адресу: `true` или `false`. + + + {% include [zk-hosts-details](../../_includes/mdb/mch/api/zk-hosts-details.md) %} + + + * `deletionProtection` — защитить кластер, его базы данных и пользователей от непреднамеренного удаления: `true` или `false`. Значение по умолчанию — `false`. + + {% include [Ограничения защиты от удаления](../../_includes/mdb/deletion-protection-limits-db.md) %} + + + Идентификатор каталога можно запросить со [списком каталогов в облаке](../../resource-manager/operations/folder/get-id.md). + + + 1. Выполните запрос: + + ```bash + curl \ + --request POST \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --header "Content-Type: application/json" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/clusters' \ + --data '@body.json' + ``` + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Cluster/create.md#responses). + +- gRPC API {#grpc-api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} + + 1. Воспользуйтесь вызовом [ClusterService/Create](../api-ref/grpc/Cluster/create.md) и выполните запрос, например, с помощью {{ api-examples.grpc.tool }}: + + 1. Создайте файл `body.json` и добавьте в него следующее содержимое: + + {% note info %} + + В примере приведены не все доступные параметры. + + {% endnote %} + + + ```json + { + "folder_id": "<идентификатор_каталога>", + "name": "<имя_кластера>", + "environment": "<окружение>", + "network_id": "<идентификатор_сети>", + "security_group_ids": [ + "<идентификатор_группы_безопасности_1>", + "<идентификатор_группы_безопасности_2>", + ... + "<идентификатор_группы_безопасности_N>" + ], + "config_spec": { + "version": "<версия_{{ CH }}>", + "embedded_keeper": <использование_{{ CK }}>, + "clickhouse": { + "resources": { + "resource_preset_id": "<класс_хостов_{{ CH }}>", + "disk_size": "<размер_хранилища_в_байтах>", + "disk_type_id": "<тип_диска>" + } + }, + "zookeeper": { + "resources": { + "resource_preset_id": "<класс_хостов_{{ ZK }}>", + "disk_size": "<размер_хранилища_в_байтах>", + "disk_type_id": "<тип_диска>" + } + }, + "access": { + "data_lens": <доступ_из_{{ datalens-name }}>, + "web_sql": <выполнение_SQL-запросов_из_консоли_управления>, + "metrika": <доступ_из_Метрики_и_AppMetrika>, + "serverless": <доступ_из_Cloud_Functions>, + "data_transfer": <доступ_из_Data_Transfer>, + "yandex_query": <доступ_из_Yandex_Query> + }, + "cloud_storage": { + "enabled": <использование_гибридного_хранилища>, + "move_factor": "<доля_свободного_места>", + "data_cache_enabled": <временное_хранение_файлов>, + "data_cache_max_size": "<максимальный_объем_памяти_для_хранения_файлов>", + "prefer_not_to_merge": <отключение_слияния_кусков_данных> + }, + "admin_password": "<пароль_пользователя_admin>", + "sql_user_management": <управление_пользователями_через_SQL>, + "sql_database_management": <управление_базами_данных_через_SQL> + }, + "database_specs": [ + { + "name": "<имя_базы_данных>" + }, + { <аналогичный_набор_настроек_для_базы_данных_2> }, + { ... }, + { <аналогичный_набор_настроек_для_базы_данных_N> } + ], + "user_specs": [ + { + "name": "<имя_пользователя>", + "password": "<пароль_пользователя>", + "permissions": [ + { + "database_name": "<имя_базы_данных>" + } + ] + }, + { <аналогичный_набор_настроек_для_пользователя_2> }, + { ... }, + { <аналогичный_набор_настроек_для_пользователя_N> } + ], + "host_specs": [ + { + "zone_id": "<зона_доступности>", + "type": "<тип_хоста>", + "subnet_id": "<идентификатор_подсети>", + "assign_public_ip": <публичный_доступ_к_хосту>, + "shard_name": "<имя_шарда>" + }, + { <аналогичный_набор_настроек_для_хоста_2> }, + { ... }, + { <аналогичный_набор_настроек_для_хоста_N> } + ], + "deletion_protection": <защита_от_удаления> + } + ``` + + + Где: + + * `name` — имя кластера. + * `environment` — окружение кластера: `PRODUCTION` или `PRESTABLE`. + + * `network_id` — идентификатор [сети](../../vpc/concepts/network.md), в которой будет размещен кластер. + + + * `security_group_ids` — идентификаторы [групп безопасности](../../vpc/concepts/security-groups.md) в виде массива строк. массив Каждая строка — идентификатор группы безопасности. + + + * `config_spec` — конфигурация кластера: + + * `version` — версия {{ CH }}: {{ versions.api.str }}. + + * `embedded_keeper` — использовать [{{ CK }}](../concepts/replication.md#ck) вместо {{ ZK }}: `true` или `false`. + + {% include [replication-management-details](../../_includes/mdb/mch/api/replication-management-details.md) %} + + * `clickhouse` — конфигурация {{ CH }}: + + * `resources.resource_preset_id` — идентификатор [класса хостов](../concepts/instance-types.md). Список доступных классов хостов с их идентификаторами можно запросить с помощью метода [ResourcePreset.list](../api-ref/ResourcePreset/list.md). + * `resources.disk_size` — размер диска в байтах. + * `resources.disk_type_id` — [тип диска](../concepts/storage.md). + + * `zookeeper` — конфигурация [{{ ZK }}](../concepts/replication.md#zk): + + * `resources.resource_preset_id` — идентификатор класса хостов. Список доступных классов хостов с их идентификаторами можно запросить с помощью метода [ResourcePreset.list](../api-ref/ResourcePreset/list.md). + * `resources.disk_size` — размер диска в байтах. + * `resources.disk_type_id` — тип диска. + + Если вы включили использование {{ CK }} с помощью настройки `embedded_keeper: true`, то необязательно указывать конфигурацию {{ ZK }} в `config_spec`: эта конфигурация не будет применена. + + * `access` — настройки, которые разрешают доступ к кластеру из других сервисов и [выполнение SQL-запросов из консоли управления](web-sql-query.md) с помощью {{ websql-full-name }}: + + {% include [grpc-access-settings](../../_includes/mdb/mch/api/grpc-access-settings.md) %} + + * `cloud_storage` — настройки [гибридного хранилища](../concepts/storage.md#hybrid-storage-features): + + {% include [grpc-cloud-storage-settings](../../_includes/mdb/mch/api/grpc-cloud-storage-settings.md) %} + + * `sql...` и `admin_password` — группа настроек для управления пользователями и базами данных через SQL: + + * `admin_password` — пароль пользователя `admin`. + * `sql_user_management` — режим [управления пользователями через SQL](./cluster-users.md#sql-user-management): `true` или `false`. + * `sql_database_management` — режим [управления базами данных через SQL](./databases.md#sql-database-management): `true` или `false`. Необходимо, чтобы был включен режим управления пользователями через SQL. - Чтобы создать кластер {{ mch-name }}, воспользуйтесь методом REST API [create](../api-ref/Cluster/create.md) для ресурса [Cluster](../api-ref/Cluster/index.md) или вызовом gRPC API [ClusterService/Create](../api-ref/grpc/Cluster/create.md) и передайте в запросе: - * Идентификатор каталога, в котором должен быть размещен кластер, в параметре `folderId`. - * Имя кластера в параметре `name`. - * Окружение кластера в параметре `environment`. - * Конфигурацию кластера в параметре `configSpec`. - * Конфигурацию хостов кластера в одном или нескольких параметрах `hostSpecs`. - * Идентификатор сети в параметре `networkId`. + {% include [SQL-management-can't-be-switched-off](../../_includes/mdb/mch/note-sql-db-and-users-create-cluster.md) %} - * Идентификаторы групп безопасности в параметре `securityGroupIds`. + * `database_specs` — настройки баз данных в виде массива параметров элементов `name`. Один параметр содержит имя отдельной БД. + * `user_specs` — настройки пользователей в виде массива элементов. Каждый элемент соответствует отдельному пользователю и имеет следующую структуру: - * Настройки доступа из других сервисов в параметре `configSpec.access`. + {% include [grpc-user-specs](../../_includes/mdb/mch/api/grpc-user-specs.md) %} - Чтобы разрешить [подключение](connect/index.md) к хостам кластера из интернета, передайте значение `true` в параметре `hostSpecs.assignPublicIp`. + * `host_specs` — настройки хостов кластера в виде массива элементов. Каждый элемент соответствует отдельному хосту и имеет следующую структуру: - При необходимости включите управление пользователями и базами данных через SQL: - * `configSpec.sqlUserManagement` — задайте значение `true` для включения режима [управления пользователями через SQL](cluster-users.md#sql-user-management). - * `configSpec.sqlDatabaseManagement` — задайте значение `true` для включения режима [управления базами данных через SQL](databases.md#sql-database-management). Необходимо, чтобы был включен режим управления пользователями через SQL. - * `configSpec.adminPassword` — задайте пароль пользователя `admin`, с помощью которого осуществляется управление. + * `type` — тип хоста: `CLICKHOUSE` или `ZOOKEEPER`. - {% include [SQL-management-can't-be-switched-off](../../_includes/mdb/mch/note-sql-db-and-users-create-cluster.md) %} + Если вы включили использование {{ CK }} с помощью настройки `embedded_keeper: true`, то в `host_specs` нужно указать только настройки хостов {{ CH }}. + * `zone_id` — [зона доступности](../../overview/concepts/geo-scope.md). + * `subnet_id` — идентификатор [подсети](../../vpc/concepts/network.md#subnet). + * `shard_name` — имя [шарда](../concepts/sharding.md). Эта настройка имеет смысл только для хостов типа `CLICKHOUSE`. + * `assign_public_ip` — доступность хоста из интернета по публичному IP-адресу: `true` или `false`. - Чтобы задать [настройки гибридного хранилища](../concepts/storage.md##hybrid-storage-settings): - * Включите гибридное хранилище, передав значение `true` в параметре `configSpec.cloudStorage.enabled`. - * Передайте настройки гибридного хранилища в параметрах `configSpec.cloudStorage`: + {% include [zk-hosts-details](../../_includes/mdb/mch/api/zk-hosts-details.md) %} - {% include [Hybrid Storage settings API](../../_includes/mdb/mch/hybrid-storage-settings-api.md) %} - При создании кластера из нескольких хостов: + * `deletion_protection` — защитить кластер, его базы данных и пользователей от непреднамеренного удаления: `true` или `false`. Значение по умолчанию — `false`. - * Если для параметра `embeddedKeeper` указано значение `true`, для управления репликацией будет использоваться [{{ CK }}](../concepts/replication.md#ck). + {% include [Ограничения защиты от удаления](../../_includes/mdb/deletion-protection-limits-db.md) %} - {% include [ClickHouse Keeper can't turn off](../../_includes/mdb/mch/note-ck-no-turn-off.md) %} - * Если значение параметра `embeddedKeeper` не задано или равно `false`, для управления репликацией и распределением запросов будет использоваться {{ ZK }}. + Идентификатор каталога можно запросить со [списком каталогов в облаке](../../resource-manager/operations/folder/get-id.md). - Если в [облачной сети](../../vpc/concepts/network.md) кластера есть подсети в каждой из [зон доступности](../../overview/concepts/geo-scope.md), а настройки хостов {{ ZK }} не заданы, в каждую подсеть будет автоматически добавлено по одному такому хосту. + 1. Выполните запрос: - Если подсети в сети кластера есть только в некоторых зонах доступности, укажите настройки хостов {{ ZK }} явно. + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + -d @ \ + {{ api-host-mdb }}:{{ port-https }} \ + yandex.cloud.mdb.clickhouse.v1.ClusterService.Create \ + < body.json + ``` + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Cluster/create.md#yandex.cloud.operation.Operation). {% endlist %} diff --git a/ru/managed-clickhouse/operations/cluster-list.md b/ru/managed-clickhouse/operations/cluster-list.md index d1cce2cda49..ab23b9523d3 100644 --- a/ru/managed-clickhouse/operations/cluster-list.md +++ b/ru/managed-clickhouse/operations/cluster-list.md @@ -44,9 +44,10 @@ description: Вы можете запросить детальную инфор ```bash curl \ - --request GET \ - --header "Authorization: Bearer $IAM_TOKEN" \ - --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/clusters?folderId=<идентификатор_каталога>' + --request GET \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/clusters' \ + --url-query folderId=<идентификатор_каталога> ``` @@ -155,7 +156,7 @@ description: Вы можете запросить детальную инфор Идентификатор кластера можно запросить со [списком кластеров в каталоге](#list-clusters). - 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Cluster/create.md#yandex.cloud.mdb.clickhouse.v1.Cluster). + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Cluster/get.md#yandex.cloud.mdb.clickhouse.v1.Cluster). {% endlist %} diff --git a/ru/managed-clickhouse/operations/cluster-logs.md b/ru/managed-clickhouse/operations/cluster-logs.md index 14d2acea10c..e65bb4bbf02 100644 --- a/ru/managed-clickhouse/operations/cluster-logs.md +++ b/ru/managed-clickhouse/operations/cluster-logs.md @@ -58,15 +58,90 @@ Имя и идентификатор кластера можно запросить со [списком кластеров в каталоге](cluster-list.md#list-clusters). -- API {#api} +- REST API {#api} - Чтобы получить логи кластера, воспользуйтесь методом REST API [listLogs](../api-ref/Cluster/listLogs.md) для ресурса [Cluster](../api-ref/Cluster/index.md) или вызовом gRPC API [ClusterService/ListLogs](../api-ref/grpc/Cluster/listLogs.md) и передайте в запросе: + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: - * Идентификатор кластера в параметре `clusterId`. + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} - Чтобы узнать идентификатор кластера, [получите список кластеров в каталоге](cluster-list.md#list-clusters). + 1. Воспользуйтесь методом [Cluster.listLogs](../api-ref/Cluster/listLogs.md) и выполните запрос, например, с помощью {{ api-examples.rest.tool }}: - * Значение `CLICKHOUSE` в параметре `serviceType`. + ```bash + curl \ + --request GET \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/clusters/<идентификатор_кластера>:logs' \ + --url-query serviceType=CLICKHOUSE \ + --url-query columnFilter=<список_колонок_для_вывода_информации> \ + --url-query fromTime=<левая_граница_временного_диапазона> \ + --url-query toTime=<правая_граница_временного_диапазона> + ``` + + Где: + + * `serviceType` — тип сервиса, для которого нужно запросить логи. Допустимо только значение `CLICKHOUSE`. + * `columnFilter` — список колонок для вывода информации: + + {% include [column-filter-list](../../_includes/mdb/api/column-filter-list.md) %} + + {% include [column-filter-rest](../../_includes/mdb/api/column-filter-rest.md) %} + + {% include [from-time-rest](../../_includes/mdb/api/from-time-rest.md) %} + + * `toTime` — правая граница временного диапазона, формат аналогичен `fromTime`. + + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). + + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Cluster/listLogs.md#responses). + +- gRPC API {#grpc-api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} + + 1. Воспользуйтесь вызовом [ClusterService/ListLogs](../api-ref/grpc/Cluster/listLogs.md) и выполните запрос, например, с помощью {{ api-examples.grpc.tool }}: + + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + -d '{ + "cluster_id": "<идентификатор_кластера>", + "service_type" : "CLICKHOUSE", + "column_filter": [<список_колонок_для_вывода_информации>], + "from_time": "<левая_граница_временного_диапазона>" \ + "to_time": "<правая_граница_временного_диапазона>" + }' \ + {{ api-host-mdb }}:{{ port-https }} \ + yandex.cloud.mdb.clickhouse.v1.ClusterService.ListLogs + ``` + + Где: + + * `service_type` — тип сервиса, для которого нужно запросить логи. Допустимо только значение `CLICKHOUSE`. + * `column_filter` — список колонок для вывода информации: + + {% include [column-filter-list](../../_includes/mdb/api/column-filter-list.md) %} + + {% include [column-filter-grpc](../../_includes/mdb/api/column-filter-grpc.md) %} + + {% include [from-time-grpc](../../_includes/mdb/api/from-time-grpc.md) %} + + * `to_time` — правая граница временного диапазона, формат аналогичен `from_time`. + + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). + + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Cluster/listLogs.md#yandex.cloud.mdb.clickhouse.v1.ListClusterLogsResponse). {% endlist %} @@ -90,15 +165,108 @@ Имя и идентификатор кластера можно запросить со [списком кластеров в каталоге](cluster-list.md#list-clusters). -- API {#api} +- REST API {#api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. Воспользуйтесь методом [Cluster.streamLogs](../api-ref/Cluster/streamLogs.md) и выполните запрос, например, с помощью {{ api-examples.rest.tool }}: + + ```bash + curl \ + --request GET \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/clusters/<идентификатор_кластера>:stream_logs' \ + --url-query serviceType=CLICKHOUSE \ + --url-query columnFilter=<список_колонок_для_вывода_информации> \ + --url-query fromTime=<левая_граница_временного_диапазона> \ + --url-query toTime=<правая_граница_временного_диапазона> \ + --url-query filter=<фильтр_логов> + ``` + + Где: + + * `serviceType` — тип сервиса, для которого нужно запросить логи. Допустимо только значение `CLICKHOUSE`. + * `columnFilter` — список колонок для вывода информации: + + {% include [column-filter-list](../../_includes/mdb/api/column-filter-list.md) %} + + {% include [column-filter-rest](../../_includes/mdb/api/column-filter-rest.md) %} + + {% include [from-time-rest](../../_includes/mdb/api/from-time-rest.md) %} + + * `toTime` — правая граница временного диапазона, формат аналогичен `fromTime`. + + {% include [tail-f-semantics](../../_includes/mdb/api/tail-f-semantics.md) %} + + * `filter` — фильтр логов. Можно отфильтровать логи так, чтобы поток логов содержал только нужные логи. + + Подробнее о фильтрах и их синтаксисе см. в [справочнике API](../api-ref/Cluster/streamLogs.md#query_params). + + {% include [stream-logs-filter](../../_includes/mdb/api/stream-logs-filter.md) %} + + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). + + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Cluster/streamLogs.md#responses). + +- gRPC API {#grpc-api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} + + 1. Воспользуйтесь вызовом [ClusterService/StreamLogs](../api-ref/grpc/Cluster/streamLogs.md) и выполните запрос, например, с помощью {{ api-examples.grpc.tool }}: + + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + -d '{ + "cluster_id": "<идентификатор_кластера>", + "service_type" : "CLICKHOUSE", + "column_filter": [<список_колонок_для_вывода_информации>], + "from_time": "<левая_граница_временного_диапазона>", + "to_time": "<правая_граница_временного_диапазона>", + "filter": "<фильтр_логов>" + }' \ + {{ api-host-mdb }}:{{ port-https }} \ + yandex.cloud.mdb.clickhouse.v1.ClusterService.StreamLogs + ``` + + Где: + + * `service_type` — тип сервиса, для которого нужно запросить логи. Допустимо только значение `CLICKHOUSE`. + * `column_filter` — список колонок для вывода информации: + + {% include [column-filter-list](../../_includes/mdb/api/column-filter-list.md) %} + + {% include [column-filter-grpc](../../_includes/mdb/api/column-filter-grpc.md) %} + + {% include [from-time-grpc](../../_includes/mdb/api/from-time-grpc.md) %} + + * `to_time` — правая граница временного диапазона, формат аналогичен `from_time`. + + {% include [tail-f-semantics](../../_includes/mdb/api/tail-f-semantics.md) %} + + * `filter` — фильтр логов. Можно отфильтровать логи так, чтобы поток логов содержал только нужные логи. + + {% include [stream-logs-filter](../../_includes/mdb/api/stream-logs-filter.md) %} + + Подробнее о фильтрах и их синтаксисе см. в [справочнике API](../api-ref/grpc/Cluster/streamLogs.md). - Чтобы получить поток логов кластера, воспользуйтесь методом REST API [streamLogs](../api-ref/Cluster/streamLogs.md) для ресурса [Cluster](../api-ref/Cluster/index.md) или вызовом gRPC API [ClusterService/StreamLogs](../api-ref/grpc/Cluster/streamLogs.md) и передайте в запросе: - * Идентификатор кластера в параметре `clusterId`. + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). - Чтобы узнать идентификатор кластера, [получите список кластеров в каталоге](cluster-list.md#list-clusters). - * Значение `CLICKHOUSE` в параметре `serviceType`. + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Cluster/streamLogs.md#yandex.cloud.mdb.clickhouse.v1.StreamLogRecord). {% endlist %} diff --git a/ru/managed-clickhouse/operations/cluster-users.md b/ru/managed-clickhouse/operations/cluster-users.md index 4410d978e9b..705fd388861 100644 --- a/ru/managed-clickhouse/operations/cluster-users.md +++ b/ru/managed-clickhouse/operations/cluster-users.md @@ -65,11 +65,52 @@ description: Из статьи вы узнаете, как управлять п Имя кластера можно запросить со [списком кластеров в каталоге](cluster-list.md#list-clusters). -- API {#api} +- REST API {#api} - Чтобы получить список пользователей, воспользуйтесь методом REST API [list](../api-ref/User/list.md) для ресурса [User](../api-ref/User/index.md) или вызовом gRPC API [UserService/List](../api-ref/grpc/User/list.md) и передайте в запросе идентификатор кластера в параметре `clusterId`. + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: - Идентификатор кластера можно получить со [списком кластеров в каталоге](#list-clusters). + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. Воспользуйтесь методом [User.list](../api-ref/User/list.md) и выполните запрос, например, с помощью {{ api-examples.rest.tool }}: + + ```bash + curl \ + --request GET \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/clusters/<идентификатор_кластера>/users' + ``` + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/User/list.md#responses). + +- gRPC API {#grpc-api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} + + 1. Воспользуйтесь вызовом [UserService/List](../api-ref/grpc/User/list.md) и выполните запрос, например, с помощью {{ api-examples.grpc.tool }}: + + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/user_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + -d '{ + "cluster_id": "<идентификатор_кластера>" + }' \ + {{ api-host-mdb }}:{{ port-https }} \ + yandex.cloud.mdb.clickhouse.v1.UserService.List + ``` + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/User/list.md#yandex.cloud.mdb.clickhouse.v1.ListUsersResponse). - SQL {#sql} @@ -179,16 +220,152 @@ description: Из статьи вы узнаете, как управлять п {% include [Terraform timeouts](../../_includes/mdb/mch/terraform/timeouts.md) %} -- API {#api} +- REST API {#api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. Воспользуйтесь методом [User.create](../api-ref/User/create.md) и выполните запрос, например, с помощью {{ api-examples.rest.tool }}: + + 1. Создайте файл `body.json` и добавьте в него следующее содержимое: + + ```json + { + "userSpec": { + "name": "<имя_пользователя>", + "password": "<пароль_пользователя>", + "permissions": [ + { + "databaseName": "<имя_БД>" + } + ], + "settings": {<настройки_{{ CH }}>}, + "quotas": [ + { + "intervalDuration": "<интервал_для_квоты>", + "queries": "<суммарное_количество_запросов>", + "errors": "<количество_запросов_с_ошибкой>", + "resultRows": "<количество_строк_результата>", + "readRows": "<количество_исходных_строк>", + "executionTime": "<суммарное_время_выполнения>" + }, + { <аналогичный_набор_настроек_для_квоты_2> }, + { ... }, + { <аналогичный_набор_настроек_для_квоты_N> } + ] + }, + { <аналогичный_набор_настроек_для_создаваемого_пользователя_2> }, + { ... }, + { <аналогичный_набор_настроек_для_создаваемого_пользователя_N> } + } + ``` + + Где `userSpec` — массив, содержащий настройки создаваемых пользователей. Один элемент массива содержит настройки для одного пользователя и имеет следующую структуру: + + {% include [rest-user-specs](../../_includes/mdb/mch/api/rest-user-specs.md) %} + + * `settings` — список [настроек {{ CH }}](../concepts/settings-list.md#user-level-settings) для пользователя. + + Настройки задаются в виде пар `ключ: значение`, разделенных запятыми. + + * `quotas` — массив, содержащий [настройки квот](../concepts/settings-list.md#quota-settings). Один элемент массива содержит настройки для одной квоты. + + 1. Выполните запрос: + + ```bash + curl \ + --request POST \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --header "Content-Type: application/json" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/clusters/<идентификатор_кластера>/users' \ + --data '@body.json' + ``` + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/User/create.md#responses). + + См. также: [пример создания пользователя с правами «только чтение»](#example-create-readonly-user). + +- gRPC API {#grpc-api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} + + 1. Воспользуйтесь вызовом [UserService/Create](../api-ref/grpc/User/create.md) и выполните запрос, например, с помощью {{ api-examples.grpc.tool }}: + + 1. Создайте файл `body.json` и добавьте в него следующее содержимое: + + ```json + { + "cluster_id": "<идентификатор_кластера>", + "user_spec": { + "name": "<имя_пользователя>", + "password": "<пароль_пользователя>", + "permissions": [ + { + "database_name": "<имя_БД>" + } + ], + "settings": {<настройки_{{ CH }}>}, + "quotas": [ + { + "interval_duration": "<интервал_для_квоты>", + "queries": "<суммарное_количество_запросов>", + "errors": "<количество_запросов_с_ошибкой>", + "result_rows": "<количество_строк_результата>", + "read_rows": "<количество_исходных_строк>", + "execution_time": "<суммарное_время_выполнения>" + }, + { <аналогичный_набор_настроек_для_квоты_2> }, + { ... }, + { <аналогичный_набор_настроек_для_квоты_N> } + ] + }, + { <аналогичный_набор_настроек_для_создаваемого_пользователя_2> }, + { ... }, + { <аналогичный_набор_настроек_для_создаваемого_пользователя_N> } + } + ``` + + Где `user_spec` — массив, содержащий настройки создаваемых пользователей. Один элемент массива содержит настройки для одного пользователя и имеет следующую структуру: + + * `name` — имя пользователя. Оно может содержать латинские буквы, цифры, дефис и подчеркивание, но должно начинаться с буквы или подчеркивания. + * `password` — пароль пользователя. Длина пароля от 8 до 128 символов. + * `permissions` — список БД, к которым пользователь должен иметь доступ. + + Список организован в виде массива параметров `database_name`. Один параметр содержит имя отдельной БД. + + * `settings` — список [настроек {{ CH }}](../concepts/settings-list.md#user-level-settings) для пользователя. + + Настройки задаются в виде пар `ключ: значение`, разделенных запятыми. + + * `quotas` — массив, содержащий [настройки квот](../concepts/settings-list.md#quota-settings). Один элемент массива содержит настройки для одной квоты. - Чтобы создать пользователя, воспользуйтесь методом REST API [create](../api-ref/User/create.md) для ресурса [User](../api-ref/User/index.md) или вызовом gRPC API [UserService/Create](../api-ref/grpc/User/create.md) и передайте в запросе: + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). - * Идентификатор кластера в параметре `clusterId`. Идентификатор кластера можно получить со [списком кластеров в каталоге](cluster-list.md#list-clusters). - * Имя нового пользователя в параметре `userSpec.name`. - * Пароль нового пользователя в параметре `userSpec.password`. - * (Опционально) Список баз, к которым пользователь должен иметь доступ, в параметре `userSpec.permissions[]`. - * (Опционально) Список настроек {{ CH }} для пользователя в параметре `userSpec.settings`. - * (Опционально) Список настроек квот для пользователя в параметре `userSpec.quotas[]`. + 1. Выполните запрос: + + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/user_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + -d @ \ + {{ api-host-mdb }}:{{ port-https }} \ + yandex.cloud.mdb.clickhouse.v1.UserService.Create \ + < body.json + ``` + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/User/create.md#yandex.cloud.operation.Operation). + + См. также: [пример создания пользователя с правами «только чтение»](#example-create-readonly-user). - SQL {#sql} @@ -273,18 +450,88 @@ description: Из статьи вы узнаете, как управлять п {% include [Terraform timeouts](../../_includes/mdb/mch/terraform/timeouts.md) %} -- API {#api} +- REST API {#api} - Чтобы изменить пароль, воспользуйтесь методом REST API [update](../api-ref/User/update.md) для ресурса [User](../api-ref/User/index.md) или вызовом gRPC API [UserService/Update](../api-ref/grpc/User/update.md) и передайте в запросе: + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: - * Идентификатор кластера в параметре `clusterId`. Чтобы узнать идентификатор, [получите список кластеров в каталоге](cluster-list.md#list-clusters). - * Новый пароль в параметре `password`. + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} - {% include [password-limits](../../_includes/mdb/mch/note-info-password-limits.md) %} + 1. Воспользуйтесь методом [User.update](../api-ref/User/update.md) и выполните запрос, например, с помощью {{ api-examples.rest.tool }}: + + {% include [note-updatemask](../../_includes/note-api-updatemask.md) %} + + ```bash + curl \ + --request PATCH \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --header "Content-Type: application/json" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/clusters/<идентификатор_кластера>/users/<имя_пользователя>' \ + --data '{ + "updateMask": "password", + "password": "<новый_пароль>" + }' + ``` + + Где: + + * `updateMask` — перечень изменяемых параметров в одну строку через запятую. + + В данном случае указан только один параметр: `password`. + + * `password` — новый пароль пользователя. + + Длина пароля от 8 до 128 символов. + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). Имя пользователя можно запросить со [списком пользователей в кластере](#list-users). + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/User/update.md#responses). + +- gRPC API {#grpc-api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} + + 1. Воспользуйтесь вызовом [UserService/Update](../api-ref/grpc/User/update.md) и выполните запрос, например, с помощью {{ api-examples.grpc.tool }}: - * Список полей конфигурации пользователя, которые необходимо изменить (в данном случае — `password`), в параметре `updateMask`. + {% include [note-grpc-updatemask](../../_includes/note-grpc-api-updatemask.md) %} - {% include [note-updatemask](../../_includes/note-api-updatemask.md) %} + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/user_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + -d '{ + "cluster_id": "<идентификатор_кластера>", + "user_name": "<имя_пользователя>", + "update_mask": { + "paths": [ + "password" + ] + }, + "password": "<новый_пароль>" + }' \ + {{ api-host-mdb }}:{{ port-https }} \ + yandex.cloud.mdb.clickhouse.v1.UserService.Update + ``` + + Где: + + * `update_mask` — перечень изменяемых параметров в виде массива строк `paths[]`. + + В данном случае указан только один параметр: `password`. + + * `password` — новый пароль пользователя. + + Длина пароля от 8 до 128 символов. + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). Имя пользователя можно запросить со [списком пользователей в кластере](#list-users). + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/User/update.md#yandex.cloud.operation.Operation). {% endlist %} @@ -348,18 +595,91 @@ description: Из статьи вы узнаете, как управлять п {% include [Terraform timeouts](../../_includes/mdb/mch/terraform/timeouts.md) %} -- API {#api} +- REST API {#api} - Чтобы изменить пароль пользователя `admin`, воспользуйтесь методом REST API [update](../api-ref/Cluster/update.md) для ресурса [Cluster](../api-ref/Cluster/index.md) или вызовом gRPC API [ClusterService/Update](../api-ref/grpc/Cluster/update.md) и передайте в запросе: + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: - * Идентификатор кластера в параметре `clusterId`. Чтобы узнать идентификатор, [получите список кластеров в каталоге](cluster-list.md#list-clusters). - * Новый пароль в параметре `configSpec.adminPassword`. + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} - {% include [password-limits](../../_includes/mdb/mch/note-info-password-limits.md) %} + 1. Воспользуйтесь методом [Cluster.update](../api-ref/Cluster/update.md) и выполните запрос, например, с помощью {{ api-examples.rest.tool }}: + + {% include [note-updatemask](../../_includes/note-api-updatemask.md) %} + + ```bash + curl \ + --request PATCH \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --header "Content-Type: application/json" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/clusters/<идентификатор_кластера>' \ + --data '{ + "updateMask": "configSpec.adminPassword", + "configSpec": { + "adminPassword": "<новый_пароль>" + } + }' + ``` + + Где: + + * `updateMask` — перечень изменяемых параметров в одну строку через запятую. + + В данном случае указан только один параметр: `configSpec.adminPassword`. + + * `configSpec.adminPassword` — новый пароль пользователя. + + Длина пароля от 8 до 128 символов. + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Cluster/update.md#responses). - * Список полей конфигурации пользователя, которые необходимо изменить (в данном случае — `configSpec.adminPassword`), в параметре `updateMask`. +- gRPC API {#grpc-api} - {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} + + 1. Воспользуйтесь вызовом [ClusterService/Update](../api-ref/grpc/Cluster/update.md) и выполните запрос, например, с помощью {{ api-examples.grpc.tool }}: + + {% include [note-grpc-updatemask](../../_includes/note-grpc-api-updatemask.md) %} + + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + -d '{ + "cluster_id": "<идентификатор_кластера>", + "update_mask": { + "paths": [ + "config_spec.admin_password" + ] + }, + "config_spec": { + "admin_password": "<новый_пароль>" + } + }' \ + {{ api-host-mdb }}:{{ port-https }} \ + yandex.cloud.mdb.clickhouse.v1.ClusterService.Update + ``` + + Где: + + * `update_mask` — перечень изменяемых параметров в виде массива строк `paths[]`. + + В данном случае указан только один параметр: `config_spec.admin_password`. + + * `config_spec.admin_password` — новый пароль пользователя. + + Длина пароля от 8 до 128 символов. + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Cluster/update.md#yandex.cloud.operation.Operation). {% endlist %} @@ -516,18 +836,132 @@ description: Из статьи вы узнаете, как управлять п {% include [Terraform timeouts](../../_includes/mdb/mch/terraform/timeouts.md) %} -- API {#api} +- REST API {#api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. Воспользуйтесь методом [User.update](../api-ref/User/update.md) и выполните запрос, например, с помощью {{ api-examples.rest.tool }}: + + {% include [note-updatemask](../../_includes/note-api-updatemask.md) %} + + ```bash + curl \ + --request PATCH \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --header "Content-Type: application/json" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/clusters/<идентификатор_кластера>/users/<имя_пользователя>' \ + --data '{ + "updateMask": "<перечень_изменяемых_настроек>", + "permissions": [ <обновленный_список_БД> ], + "settings": { <настройки_{{ CH }}> }, + "quotas": [ <обновленный_список_настроек_квот> ] + }' + ``` + + Где `updateMask` — перечень изменяемых параметров в одну строку через запятую. + + Укажите нужные параметры, чтобы изменить отдельные категории настроек: + + * Чтобы изменить список БД, к которым пользователь должен иметь доступ, передайте в параметре `permissions` обновленный список БД. + + Список организован в виде массива параметров `databaseName`. Один параметр содержит имя отдельной БД. + + {% note warning %} + + Существующий в кластере список БД будет полностью перезаписан списком, переданным в параметре `permissions`. + + Перед выполнением запроса убедитесь, что вы включили в этот список все нужные БД, в том числе существующие. + + {% endnote %} + + * Чтобы изменить [настройки {{ CH }}](../concepts/settings-list.md#user-level-settings) для пользователя, передайте в параметре `settings` нужные настройки с новыми значениями. + + * Чтобы изменить [настройки квот](../concepts/settings-list.md#quota-settings), передайте в параметре `quotas` обновленный список с настройками квот. + + Список организован в виде массива. Один элемент массива содержит настройки для одной квоты. + + {% note warning %} + + Существующий в кластере список настроек квот будет полностью перезаписан списком, переданным в параметре `quotas`. + + Перед выполнением запроса убедитесь, что вы включили в этот список все нужные настройки квот, в том числе существующие. + + {% endnote %} + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). Имя пользователя можно запросить со [списком пользователей в кластере](#list-users). + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/User/update.md#responses). + +- gRPC API {#grpc-api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: - Чтобы изменить настройки пользователя, воспользуйтесь методом REST API [update](../api-ref/User/update.md) для ресурса [User](../api-ref/User/index.md) или вызовом gRPC API [UserService/Update](../api-ref/grpc/User/update.md) и передайте в запросе: + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} - * Идентификатор кластера в параметре `clusterId`. Чтобы узнать идентификатор, [получите список кластеров в каталоге](cluster-list.md#list-clusters). - * Имя пользователя, настройки которого будут изменены, в параметре `userName`. Чтобы узнать имя, [получите список пользователей](#list-users). - * (Опционально) Список баз, к которым пользователь должен иметь доступ, в параметре `userSpec.permissions[]`. - * (Опционально) Список настроек {{ CH }} для пользователя в параметре `userSpec.settings`. - * (Опционально) Список настроек квот для пользователя в параметре `userSpec.quotas[]`. - * Список полей конфигурации пользователя, которые необходимо изменить, в параметре `updateMask`. + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} - {% include [note-updatemask](../../_includes/note-api-updatemask.md) %} + 1. Воспользуйтесь вызовом [UserService/Update](../api-ref/grpc/User/update.md) и выполните запрос, например, с помощью {{ api-examples.grpc.tool }}: + + {% include [note-grpc-updatemask](../../_includes/note-grpc-api-updatemask.md) %} + + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/user_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + -d '{ + "cluster_id": "<идентификатор_кластера>", + "user_name": "<имя_пользователя>", + "update_mask": { + "paths": [ + <перечень_изменяемых_настроек> + ] + }, + "permissions": [ <обновленный_список_БД> ], + "settings": { <настройки_{{ CH }}> }, + "quotas": [ <обновленный_список_настроек_квот> ] + }' \ + {{ api-host-mdb }}:{{ port-https }} \ + yandex.cloud.mdb.clickhouse.v1.UserService.Update + ``` + + Где `update_mask` — перечень изменяемых параметров в виде массива строк `paths[]`. + + Укажите нужные параметры, чтобы изменить отдельные категории настроек: + + * Чтобы изменить список БД, к которым пользователь должен иметь доступ, передайте в параметре `permissions` обновленный список БД. + + Список организован в виде массива параметров `database_name`. Один параметр содержит имя отдельной БД. + + {% note warning %} + + Существующий в кластере список БД будет полностью перезаписан списком, переданным в параметре `permissions`. + + Перед выполнением запроса убедитесь, что вы включили в этот список все нужные БД, в том числе существующие. + + {% endnote %} + + * Чтобы изменить [настройки {{ CH }}](../concepts/settings-list.md#user-level-settings) для пользователя, передайте в параметре `settings` нужные настройки с новыми значениями. + + * Чтобы изменить [настройки квот](../concepts/settings-list.md#quota-settings), передайте в параметре `quotas` обновленный список с настройками квот. + + Список организован в виде массива. Один элемент массива содержит настройки для одной квоты. + + {% note warning %} + + Существующий в кластере список настроек квот будет полностью перезаписан списком, переданным в параметре `quotas`. + + Перед выполнением запроса убедитесь, что вы включили в этот список все нужные настройки квот, в том числе существующие. + + {% endnote %} + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). Имя пользователя можно запросить со [списком пользователей в кластере](#list-users). + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/User/update.md#yandex.cloud.operation.Operation). - SQL {#sql} @@ -597,12 +1031,53 @@ description: Из статьи вы узнаете, как управлять п {% include [Terraform timeouts](../../_includes/mdb/mch/terraform/timeouts.md) %} -- API {#api} +- REST API {#api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. Воспользуйтесь методом [User.delete](../api-ref/User/delete.md) и выполните запрос, например, с помощью {{ api-examples.rest.tool }}: + + ```bash + curl \ + --request DELETE \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/clusters/<идентификатор_кластера>/users/<имя_пользователя>' + ``` + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). Имя пользователя можно запросить со [списком пользователей в кластере](#list-users). + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/User/delete.md#responses). + +- gRPC API {#grpc-api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: - Чтобы удалить пользователя, воспользуйтесь методом REST API [delete](../api-ref/User/delete.md) для ресурса [User](../api-ref/User/index.md) или вызовом gRPC API [UserService/Delete](../api-ref/grpc/User/delete.md) и передайте в запросе: + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} - * Идентификатор кластера в параметре `clusterId`. Чтобы узнать идентификатор, [получите список кластеров в каталоге](cluster-list.md#list-clusters). - * Имя пользователя, настройки которого будут изменены, в параметре `userName`. Чтобы узнать имя, [получите список пользователей](#list-users). + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} + + 1. Воспользуйтесь вызовом [UserService/Delete](../api-ref/grpc/User/delete.md) и выполните запрос, например, с помощью {{ api-examples.grpc.tool }}: + + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/user_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + -d '{ + "cluster_id": "<идентификатор_кластера>", + "user_name": "<имя_пользователя>" + }' \ + {{ api-host-mdb }}:{{ port-https }} \ + yandex.cloud.mdb.clickhouse.v1.UserService.Delete + ``` + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). Имя пользователя можно запросить со [списком пользователей в кластере](#list-users). + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/User/delete.md#yandex.cloud.operation.Operation). - SQL {#sql} @@ -621,7 +1096,7 @@ description: Из статьи вы узнаете, как управлять п ### Создание пользователя с настройкой «только чтение» {#example-create-readonly-user} -Допустим, нужно добавить в существующий кластер с именем `mych` нового пользователя `ro-user` с паролем `Passw0rd`, причем: +Допустим, нужно добавить в существующий кластер с именем `mych` и идентификатором `{{ cluster-id }}` нового пользователя `ro-user` с паролем `Passw0rd`, причем: * пользователь должен иметь доступ к базе данных `db1` кластера; * доступ должен осуществляться в режиме «только чтение» (readonly), без возможности изменения настроек. @@ -702,6 +1177,72 @@ description: Из статьи вы узнаете, как управлять п {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} +- REST API {#api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. Выполните запрос c помощью {{ api-examples.rest.tool }}: + + ```bash + curl \ + --request POST \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --header "Content-Type: application/json" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/clusters/{{ cluster-id }}/users' \ + --data '{ + "userSpec": { + "name": "ro-user", + "password": "Passw0rd", + "permissions": [ + { + "databaseName": "db1" + } + ], + "settings": { + "readonly": "1" + } + } + }' + ``` + +- gRPC API {#grpc-api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} + + 1. Выполните запрос с помощью {{ api-examples.grpc.tool }}: + + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/user_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + -d '{ + "cluster_id": "{{ cluster-id }}", + "user_spec": { + "name": "ro-user", + "password": "Passw0rd", + "permissions": [ + { + "database_name": "db1" + } + ], + "settings": { + "readonly": "1" + } + } + }' \ + {{ api-host-mdb }}:{{ port-https }} \ + yandex.cloud.mdb.clickhouse.v1.UserService.Create + ``` + - SQL {#sql} 1. [Подключитесь](connect/clients.md) к кластеру `mych`, используя [учетную запись `admin`](#sql-user-management). diff --git a/ru/managed-clickhouse/operations/cluster-version-update.md b/ru/managed-clickhouse/operations/cluster-version-update.md index f8d60ad6115..900a0d2e7b3 100644 --- a/ru/managed-clickhouse/operations/cluster-version-update.md +++ b/ru/managed-clickhouse/operations/cluster-version-update.md @@ -29,9 +29,45 @@ description: Следуя данной инструкции, вы сможете yc managed-clickhouse version list ``` -- API {#api} +- REST API {#api} - Чтобы посмотреть список доступных версий, воспользуйтесь методом REST API [list](../api-ref/Versions/list.md) для ресурса [Versions](../api-ref/Versions/index.md) или вызовом gRPC API [VersionsService/List](../api-ref/grpc/Versions/list.md). + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. Воспользуйтесь методом [Versions.list](../api-ref/Versions/list.md) и выполните запрос, например, с помощью {{ api-examples.rest.tool }}: + + ```bash + curl \ + --request GET \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/versions' + ``` + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Versions/list.md#responses). + +- gRPC API {#grpc-api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} + + 1. Воспользуйтесь вызовом [VersionsService/List](../api-ref/grpc/Versions/list.md) и выполните запрос, например, с помощью {{ api-examples.grpc.tool }}: + + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/versions_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + {{ api-host-mdb }}:{{ port-https }} \ + yandex.cloud.mdb.clickhouse.v1.VersionsService.List + ``` + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Versions/list.md#yandex.cloud.mdb.clickhouse.v1.ListVersionsResponse). {% endlist %} @@ -114,15 +150,87 @@ description: Следуя данной инструкции, вы сможете {% include [Terraform timeouts](../../_includes/mdb/mch/terraform/timeouts.md) %} -- API {#api} +- REST API {#api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. Воспользуйтесь методом [Cluster.update](../api-ref/Cluster/update.md) и выполните запрос, например, с помощью {{ api-examples.rest.tool }}: + + {% include [note-updatemask](../../_includes/note-api-updatemask.md) %} + + ```bash + curl \ + --request PATCH \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --header "Content-Type: application/json" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/clusters/<идентификатор_кластера>' \ + --data '{ + "updateMask": "configSpec.version", + "configSpec": { + "version": "<версия_{{ CH }}>" + } + }' + ``` + + Где: + + * `updateMask` — перечень изменяемых параметров в одну строку через запятую. + + В данном случае указан только один параметр: `configSpec.version`. + + * `configSpec.version` — версия {{ CH }}, до которой нужно обновиться: {{ versions.api.str }}. + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Cluster/update.md#responses). + +- gRPC API {#grpc-api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} + + 1. Воспользуйтесь вызовом [ClusterService/Update](../api-ref/grpc/Cluster/update.md) и выполните запрос, например, с помощью {{ api-examples.grpc.tool }}: + + {% include [note-grpc-updatemask](../../_includes/note-grpc-api-updatemask.md) %} + + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + -d '{ + "cluster_id": "<идентификатор_кластера>", + "update_mask": { + "paths": [ + "config_spec.version" + ] + }, + "config_spec": { + "version": "<версия_{{ CH }}>" + } + }' \ + {{ api-host-mdb }}:{{ port-https }} \ + yandex.cloud.mdb.clickhouse.v1.ClusterService.Update + ``` + + Где: + + * `update_mask` — перечень изменяемых параметров в виде массива строк `paths[]`. + + В данном случае указан только один параметр: `config_spec.version`. - Чтобы обновить версию, воспользуйтесь методом REST API [update](../api-ref/Cluster/update.md) для ресурса [Cluster](../api-ref/Cluster/index.md) или вызовом gRPC API [ClusterService/Update](../api-ref/grpc/Cluster/update.md) и передайте в запросе: + * `config_spec.version` — версия {{ CH }}, до которой нужно обновиться: {{ versions.api.str }}. - * Идентификатор кластера в параметре `clusterId`. Чтобы узнать идентификатор, [получите список кластеров в каталоге](./cluster-list.md#list-clusters). - * Версию {{ CH }} в параметре `configSpec.version`: {{ versions.api.str }}. - * Список настроек, которые необходимо изменить (в данном случае — `configSpec.version`), в параметре `updateMask`. + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). - {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Cluster/update.md#yandex.cloud.operation.Operation). {% endlist %} diff --git a/ru/managed-clickhouse/operations/dictionaries.md b/ru/managed-clickhouse/operations/dictionaries.md index be63cf7e766..daf26165efc 100644 --- a/ru/managed-clickhouse/operations/dictionaries.md +++ b/ru/managed-clickhouse/operations/dictionaries.md @@ -1075,33 +1075,28 @@ ## Примеры +Пусть существует кластер {{ CH }} `mych` с идентификатором `{{ cluster-id }}`, и в этот кластер нужно подключить словарь с тестовыми характеристиками: + +* имя словаря `mychdict`; +* имя ключевого столбца `id`; +* поля, доступные для запросов к базе данных: + * `id` с типом `UInt64`; + * `field1`с типом `String`; +* фиксированный период между обновлениями словаря 300 секунд; +* способ размещения словаря в памяти `cache` с размером кеша в 1024 ячейки; +* источник {{ PG }}: + * база данных `db1`; + * имя таблицы `table1`; + * порт для подключения `{{ port-mpg }}`; + * имя пользователя базы данных `user1`; + * пароль для доступа к базе данных `user1user1`; + * режим для установки защищенного SSL TCP/IP соединения с базой данных `verify-full`; + * особый FQDN хоста-мастера `c-c9qash3nb1v9********.rw.{{ dns-zone }}`. + {% list tabs group=instructions %} - CLI {#cli} - Подключите словарь с тестовыми характеристиками: - - * кластер `mych`; - * имя `mychdict`; - * имя ключевого столбца `id`; - * поля, доступные для запросов к базе данных: - - * `id` с типом `UInt64`; - * `field1`с типом `String`; - - * фиксированный период между обновлениями словаря 300 секунд; - * способ размещения словаря в памяти `cache`; - * источник {{ PG }}: - - * база данных `db1`; - * имя таблицы `table1`; - * порт для подключения `{{ port-mpg }}`; - * имя пользователя базы данных `user1`; - * пароль для доступа к базе данных `user1user1`; - * режим для установки защищенного SSL TCP/IP соединения с базой данных `verify-full`; - - * особый FQDN хоста-мастера `c-c9qash3nb1v9********.rw.{{ dns-zone }}`. - Выполните следующую команду: ```bash @@ -1115,6 +1110,7 @@ `type=String \ --fixed-lifetime=300 \ --layout-type=cache \ + --layout-size-in-cells 1024 \ --postgresql-source db=db1,` `table=table1,` `port={{ port-mpg }},` @@ -1124,6 +1120,125 @@ --postgresql-source-hosts=c-c9qash3nb1v9********.rw.{{ dns-zone }} ``` +- REST API {#api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. Создайте файл `body.json` и добавьте в него следующее содержимое: + + ```json + { + "externalDictionary": { + "name": "mychdict", + "structure": { + "id": { + "name": "id" + }, + "attributes": [ + { + "name": "id", + "type": "UInt64" + }, + { + "name": "field1", + "type": "String" + } + ] + }, + "layout": { + "type": "CACHE", + "sizeInCells": "1024" + }, + "fixedLifetime": "300", + "postgresqlSource": { + "db": "db1", + "table": "table", + "port": "5432", + "user": "user1", + "password": "user1user1", + "sslMode": "VERIFY_FULL", + "hosts": ["c-c9qash3nb1v9********.rw.{{ dns-zone }}"] + } + } + } + ``` + + 1. Выполните запрос c помощью {{ api-examples.rest.tool }}: + + ```bash + curl \ + --request POST \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --header "Content-Type: application/json" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/clusters/{{ cluster-id }}:createExternalDictionary' \ + --data '@body.json' + ``` + +- gRPC API {#grpc-api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} + + 1. Создайте файл `body.json` и добавьте в него следующее содержимое: + + ```json + { + "cluster_id": "{{ cluster-id }}", + "external_dictionary": { + "name": "mychdict", + "structure": { + "id": { + "name": "id" + }, + "attributes": [ + { + "name": "id", + "type": "UInt64" + }, + { + "name": "field1", + "type": "String" + } + ] + }, + "layout": { + "type": "CACHE", + "size_in_cells": "1024" + }, + "fixed_lifetime": "300", + "postgresql_source": { + "db": "db1", + "table": "table", + "port": "5432", + "user": "user1", + "password": "user1user1", + "ssl_mode": "VERIFY_FULL", + "hosts": ["c-c9qash3nb1v9********.rw.{{ dns-zone }}"] + } + } + } + ``` + + 1. Выполните запрос с помощью {{ api-examples.grpc.tool }}: + + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + -d @ \ + {{ api-host-mdb }}:{{ port-https }} \ + yandex.cloud.mdb.clickhouse.v1.ClusterService.CreateExternalDictionary \ + < body.json + ``` + {% endlist %} {% include [clickhouse-disclaimer](../../_includes/clickhouse-disclaimer.md) %} diff --git a/ru/managed-clickhouse/operations/hosts.md b/ru/managed-clickhouse/operations/hosts.md index 093ae849429..fed9fbc4cd5 100644 --- a/ru/managed-clickhouse/operations/hosts.md +++ b/ru/managed-clickhouse/operations/hosts.md @@ -181,6 +181,7 @@ * `type` — тип хоста, всегда `CLICKHOUSE` для хостов {{ CH }}. * `zoneId` — зона доступности. * `subnetId` — идентификатор подсети. + * `shardName` — имя шарда. * `assignPublicIp` — доступность хоста из интернета по публичному IP-адресу: `true` или `false`. * `copySchema` — параметр, который определяет, копировать ли схему данных со случайной реплики на создаваемые хосты: `true` или `false`. @@ -233,13 +234,14 @@ * `type` — тип хоста, всегда `CLICKHOUSE` для хостов {{ CH }}. * `zone_id` — зона доступности. * `subnet_id` — идентификатор подсети. + * `shard_name` — имя шарда. * `assign_public_ip` — доступность хоста из интернета по публичному IP-адресу: `true` или `false`. * `copy_schema` — параметр, который определяет, копировать ли схему данных со случайной реплики на создаваемые хосты: `true` или `false`. Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). - 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Cluster/create.md#yandex.cloud.operation.Operation). + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Cluster/addHosts.md#yandex.cloud.operation.Operation). {% endlist %} @@ -404,7 +406,7 @@ Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). - 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Cluster/create.md#yandex.cloud.operation.Operation). + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Cluster/updateHosts.md#yandex.cloud.operation.Operation). {% endlist %} @@ -534,7 +536,7 @@ Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). - 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Cluster/create.md#yandex.cloud.operation.Operation). + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Cluster/deleteHosts.md#yandex.cloud.operation.Operation). {% endlist %} diff --git a/ru/managed-clickhouse/operations/update.md b/ru/managed-clickhouse/operations/update.md index 7f4f0f2ba57..81011e68532 100644 --- a/ru/managed-clickhouse/operations/update.md +++ b/ru/managed-clickhouse/operations/update.md @@ -166,18 +166,150 @@ description: Следуя данной инструкции, вы сможете {% include [Terraform timeouts](../../_includes/mdb/mch/terraform/timeouts.md) %} -- API {#api} +- REST API {#api} - Чтобы изменить класс хостов, воспользуйтесь методом REST API [update](../api-ref/Cluster/update.md) для ресурса [Cluster](../api-ref/Cluster/index.md) или вызовом gRPC API [ClusterService/Update](../api-ref/grpc/Cluster/update.md) и передайте в запросе: + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: - * Идентификатор кластера в параметре `clusterId`. Чтобы узнать идентификатор, [получите список кластеров в каталоге](./cluster-list.md#list-clusters). - * Нужные значения в параметре `configSpec.clickhouse.resources.resourcePresetId` (для ZooKeeper — `configSpec.zookeeper.resources.resourcePresetId`). + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} - Список поддерживаемых значений запрашивайте методом [list](../api-ref/ResourcePreset/list.md) для ресурсов `ResourcePreset`. + 1. Запросите список доступных классов хостов: - * Список настроек, которые необходимо изменить, в параметре `updateMask`. + 1. Воспользуйтесь методом [ResourcePreset.list](../api-ref/ResourcePreset/list.md) и выполните запрос, например, с помощью {{ api-examples.rest.tool }}: - {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} + ```bash + curl \ + --request GET \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/resourcePresets' + ``` + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/ResourcePreset/list.md#responses). + + 1. Измените класс хостов на нужный: + + 1. Воспользуйтесь методом [Cluster.update](../api-ref/Cluster/update.md) и выполните запрос, например, с помощью {{ api-examples.rest.tool }}: + + {% include [note-updatemask](../../_includes/note-api-updatemask.md) %} + + ```bash + curl \ + --request PATCH \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --header "Content-Type: application/json" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/clusters/<идентификатор_кластера>' \ + --data '{ + "updateMask": "configSpec.clickhouse.resources.resourcePresetId,configSpec.zookeeper.resources.resourcePresetId", + "configSpec": { + "clickhouse": { + "resources": { + "resourcePresetId": "<идентификатор_класса_хостов_{{ CH }}>" + } + }, + "zookeeper": { + "resources": { + "resourcePresetId": "<идентификатор_класса_хостов_{{ ZK }}>" + } + } + } + }' + ``` + + Где: + + * `updateMask` — перечень изменяемых параметров в одну строку через запятую. + + Укажите нужные параметры: + * `configSpec.clickhouse.resources.resourcePresetId` — если нужно изменить класс хостов {{ CH }}. + * `configSpec.zookeeper.resources.resourcePresetId` — если нужно изменить класс хостов {{ ZK }}. + + В примере запроса изменяется как класс хостов {{ CH }}, так и класс хостов {{ ZK }}. + + * `configSpec.clickhouse.resources.resourcePresetId` — идентификатор класса хостов {{ CH }}. + * `configSpec.zookeeper.resources.resourcePresetId` — идентификатор класса хостов {{ ZK }}. + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). Список доступных классов хостов с их идентификаторами был получен ранее. + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Cluster/update.md#responses). + +- gRPC API {#grpc-api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} + + 1. Запросите список доступных классов хостов: + + 1. Воспользуйтесь вызовом [ResourcePresetService/List](../api-ref/grpc/ResourcePreset/list.md) и выполните запрос, например, с помощью {{ api-examples.grpc.tool }}: + + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/resource_preset_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + {{ api-host-mdb }}:{{ port-https }} \ + yandex.cloud.mdb.clickhouse.v1.ResourcePresetService.List + ``` + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/ResourcePreset/list.md#yandex.cloud.mdb.clickhouse.v1.ListResourcePresetsResponse). + + 1. Измените класс хостов на нужный: + + 1. Воспользуйтесь вызовом [ClusterService/Update](../api-ref/grpc/Cluster/update.md) и выполните запрос, например, с помощью {{ api-examples.grpc.tool }}: + + {% include [note-grpc-updatemask](../../_includes/note-grpc-api-updatemask.md) %} + + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + -d '{ + "cluster_id": "<идентификатор_кластера>", + "update_mask": { + "paths": [ + "config_spec.clickhouse.resources.resource_preset_id", + "config_spec.zookeeper.resources.resource_preset_id" + ] + }, + "config_spec": { + "clickhouse": { + "resources": { + "resource_preset_id": "<идентификатор_класса_хостов_{{ CH }}>" + } + }, + "zookeeper": { + "resources": { + "resource_preset_id": "<идентификатор_класса_хостов_{{ ZK }}>" + } + } + } + }' \ + {{ api-host-mdb }}:{{ port-https }} \ + yandex.cloud.mdb.clickhouse.v1.ClusterService.Update + ``` + + Где: + + * `update_mask` — перечень изменяемых параметров в виде массива строк `paths[]`. + + Укажите нужные параметры: + * `config_spec.clickhouse.resources.resource_preset_id` — если нужно изменить класс хостов {{ CH }}. + * `config_spec.zookeeper.resources.resource_preset_id` — если нужно изменить класс хостов {{ ZK }}. + + В примере запроса изменяется как класс хостов {{ CH }}, так и класс хостов {{ ZK }}. + + * `config_spec.clickhouse.resources.resource_preset_id` — идентификатор класса хостов {{ CH }}. + * `config_spec.zookeeper.resources.resource_preset_id` — идентификатор класса хостов {{ ZK }}. + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). Список доступных классов хостов с их идентификаторами был получен ранее. + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Cluster/update.md#yandex.cloud.operation.Operation). {% endlist %} @@ -265,16 +397,117 @@ description: Следуя данной инструкции, вы сможете {% include [Terraform timeouts](../../_includes/mdb/mch/terraform/timeouts.md) %} -- API {#api} +- REST API {#api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. Воспользуйтесь методом [Cluster.update](../api-ref/Cluster/update.md) и выполните запрос, например, с помощью {{ api-examples.rest.tool }}: + + {% include [note-updatemask](../../_includes/note-api-updatemask.md) %} + + ```bash + curl \ + --request PATCH \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --header "Content-Type: application/json" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/clusters/<идентификатор_кластера>' \ + --data '{ + "updateMask": "configSpec.clickhouse.resources.diskSize,configSpec.zookeeper.resources.diskSize", + "configSpec": { + "clickhouse": { + "resources": { + "diskSize": "<размер_хранилища_в_байтах>" + } + }, + "zookeeper": { + "resources": { + "diskSize": "<размер_хранилища_в_байтах>" + } + } + } + }' + ``` + + Где: + + * `updateMask` — перечень изменяемых параметров в одну строку через запятую. + + Укажите нужные параметры: + + * `configSpec.clickhouse.resources.diskSize` — если нужно увеличить размер хранилища хостов {{ CH }}. + * `configSpec.zookeeper.resources.diskSize` — если нужно увеличить размер хранилища хостов {{ ZK }}. + + В примере запроса размер хранилища увеличивается как для хостов {{ CH }}, так и для хостов {{ ZK }}. + + * `configSpec.clickhouse.resources.diskSize` — размер хранилища хостов {{ CH }} в байтах. + * `configSpec.zookeeper.resources.diskSize` — размер хранилища хостов {{ ZK }} в байтах. + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Cluster/update.md#responses). + +- gRPC API {#grpc-api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} + + 1. Воспользуйтесь вызовом [ClusterService/Update](../api-ref/grpc/Cluster/update.md) и выполните запрос, например, с помощью {{ api-examples.grpc.tool }}: + + {% include [note-grpc-updatemask](../../_includes/note-grpc-api-updatemask.md) %} + + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + -d '{ + "cluster_id": "<идентификатор_кластера>", + "update_mask": { + "paths": [ + "config_spec.clickhouse.resources.disk_size", + "config_spec.zookeeper.resources.disk_size" + ] + }, + "config_spec": { + "clickhouse": { + "resources": { + "disk_size": "<размер_хранилища_в_байтах>" + } + }, + "zookeeper": { + "resources": { + "disk_size": "<размер_хранилища_в_байтах>" + } + } + } + }' \ + {{ api-host-mdb }}:{{ port-https }} \ + yandex.cloud.mdb.clickhouse.v1.ClusterService.Update + ``` + + Где: + * `update_mask` — перечень изменяемых параметров в виде массива строк `paths[]`. + + Укажите нужные параметры: - Чтобы увеличить размер хранилища, воспользуйтесь методом REST API [update](../api-ref/Cluster/update.md) для ресурса [Cluster](../api-ref/Cluster/index.md) или вызовом gRPC API [ClusterService/Update](../api-ref/grpc/Cluster/update.md) и передайте в запросе: + * `config_spec.clickhouse.resources.disk_size` — если нужно увеличить размер хранилища хостов {{ CH }}. + * `config_spec.zookeeper.resources.disk_size` — если нужно увеличить размер хранилища хостов {{ ZK }}. - * Идентификатор кластера в параметре `clusterId`. Чтобы узнать идентификатор, [получите список кластеров в каталоге](./cluster-list.md#list-clusters). - * Нужный размер хранилища хостов {{ CH }} в параметре `configSpec.clickhouse.resources.diskSize`. - * Нужный размер хранилища хостов {{ ZK }} в параметре `configSpec.zookeeper.resources.diskSize`. - * Список полей конфигурации кластера, которые необходимо изменить, в параметре `updateMask`. + В примере запроса размер хранилища увеличивается как для хостов {{ CH }}, так и для хостов {{ ZK }}. - {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} + * `config_spec.clickhouse.resources.disk_size` — размер хранилища хостов {{ CH }} в байтах. + * `config_spec.zookeeper.resources.disk_size` — размер хранилища хостов {{ ZK }} в байтах. + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Cluster/update.md#yandex.cloud.operation.Operation). {% endlist %} @@ -354,13 +587,109 @@ description: Следуя данной инструкции, вы сможете {% include [Terraform timeouts](../../_includes/mdb/mch/terraform/timeouts.md) %} -- API {#api} +- REST API {#api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. Воспользуйтесь методом [Cluster.update](../api-ref/Cluster/update.md) и выполните запрос, например, с помощью {{ api-examples.rest.tool }}: + + {% include [note-updatemask](../../_includes/note-api-updatemask.md) %} + + ```bash + curl \ + --request PATCH \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --header "Content-Type: application/json" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/clusters/<идентификатор_кластера>' \ + --data '{ + "updateMask": "configSpec.adminPassword,configSpec.sqlUserManagement,configSpec.sqlDatabaseManagement", + "configSpec": { + "adminPassword": "<пароль_пользователя_admin>", + "sqlUserManagement": <управление_пользователями_через_SQL>, + "sqlDatabaseManagement": <управление_базами_данных_через_SQL> + } + }' + ``` + + Где: + + * `updateMask` — перечень изменяемых параметров в одну строку через запятую. + + Укажите нужные параметры: + + * `configSpec.adminPassword` — пароль пользователя `admin`, с помощью которого осуществляется управление. + * `configSpec.sqlUserManagement` — если нужно включить управление пользователями через SQL. + * `configSpec.sqlDatabaseManagement` — если нужно включить управление базами данных через SQL. + + В примере запроса включается и управление пользователями, и управление базами данных черех SQL. + + * `configSpec.adminPassword` — пароль пользователя `admin`. + * `configSpec.sqlUserManagement` — режим управления пользователями через SQL: `true` или `false`. + * `configSpec.sqlDatabaseManagement` — режим управления базами данных через SQL: `true` или `false`. Необходимо, чтобы был включен режим управления пользователями через SQL. + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Cluster/update.md#responses). + +- gRPC API {#grpc-api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} - Чтобы включить управление пользователями и базами данных через SQL, воспользуйтесь методом REST API [update](../api-ref/Cluster/update.md) для ресурса [Cluster](../api-ref/Cluster/index.md) или вызовом gRPC API [ClusterService/Update](../api-ref/grpc/Cluster/update.md) и передайте в запросе нужные значения в параметре `configSpec.clickhouse.config`: + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} - * `sqlUserManagement` — задайте значение `true` для включения режима [управления пользователями через SQL](cluster-users.md#sql-user-management). - * `sqlDatabaseManagement` — задайте значение `true` для включения режима [управления базами данных через SQL](databases.md#sql-database-management). Необходимо, чтобы был включен режим управления пользователями через SQL. - * `adminPassword` — задайте пароль пользователя `admin`, с помощью которого осуществляется управление. + 1. Воспользуйтесь вызовом [ClusterService/Update](../api-ref/grpc/Cluster/update.md) и выполните запрос, например, с помощью {{ api-examples.grpc.tool }}: + + {% include [note-grpc-updatemask](../../_includes/note-grpc-api-updatemask.md) %} + + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + -d '{ + "cluster_id": "<идентификатор_кластера>", + "update_mask": { + "paths": [ + "config_spec.admin_password", + "config_spec.sql_user_management", + "config_spec.sql_database_management" + ] + }, + "config_spec": { + "admin_password": "<пароль_пользователя_admin>", + "sql_user_management": <управление_пользователями_через_SQL>, + "sql_database_management": <управление_базами_данных_через_SQL> + } + }' \ + {{ api-host-mdb }}:{{ port-https }} \ + yandex.cloud.mdb.clickhouse.v1.ClusterService.Update + ``` + + Где: + + * `update_mask` — перечень изменяемых параметров в виде массива строк `paths[]`. + + Укажите нужные параметры: + + * `config_spec.admin_password` — пароль пользователя `admin`, с помощью которого осуществляется управление. + * `config_spec.sql_user_management` — если нужно включить управление пользователями через SQL. + * `config_spec.sql_database_management` — если нужно включить управление базами данных через SQL. + + В примере запроса включается и управление пользователями, и управление базами данных черех SQL. + + * `config_spec.admin_password` — пароль пользователя `admin`. + * `config_spec.sql_user_management` — режим управления пользователями через SQL: `true` или `false`. + * `config_spec.sql_database_management` — режим управления базами данных через SQL: `true` или `false`. Необходимо, чтобы был включен режим управления пользователями через SQL. + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Cluster/update.md#yandex.cloud.operation.Operation). {% endlist %} @@ -511,21 +840,176 @@ description: Следуя данной инструкции, вы сможете {% include [Terraform timeouts](../../_includes/mdb/mch/terraform/timeouts.md) %} -- API {#api} +- REST API {#api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. Воспользуйтесь методом [Cluster.update](../api-ref/Cluster/update.md) и выполните запрос, например, с помощью {{ api-examples.rest.tool }}: + + {% include [note-updatemask](../../_includes/note-api-updatemask.md) %} + + 1. Создайте файл `body.json` и добавьте в него следующее содержимое: + + + ```json + { + "updateMask": "<перечень_изменяемых_настроек>", + "configSpec": { + "backupWindowStart": { + "hours": "<часы>", + "minutes": "<минуты>", + "seconds": "<секунды>", + "nanos": "<наносекунды>" + }, + "access": { + "dataLens": <доступ_из_{{ datalens-name }}>, + "webSql": <выполнение_SQL-запросов>, + "metrika": <импорт_данных_из_AppMetrica>, + "serverless": <доступ_из_{{ sf-full-name }}>, + "dataTransfer": <доступ_из_{{ data-transfer-full-name }}>, + "yandexQuery": <доступ_из_{{ yq-full-name }}> + } + }, + "maintenanceWindow": { + "anytime": {}, + "weeklyMaintenanceWindow": { + "day": "<день_недели>", + "hour": "<час_дня_по_UTC>" + } + }, + "deletionProtection": <защита_от_удаления> + } + ``` + + + Где: + + * `updateMask` — перечень изменяемых параметров в одну строку через запятую. + + * {% include [backup-windows-start-rest](../../_includes/mdb/api/backup-windows-start-rest.md) %} + + * `configSpec.access` — настройки, которые разрешают доступ к кластеру из других сервисов и [выполнение SQL-запросов из консоли управления](web-sql-query.md) с помощью {{ websql-full-name }}: + + {% include [rest-access-settings](../../_includes/mdb/mch/api/rest-access-settings.md) %} + + * `maintenanceWindow` — настройки времени [технического обслуживания](../concepts/maintenance.md) (в т. ч. для выключенных кластеров). Выберите один из вариантов: + + * `anytime` — (по умолчанию) — в любое время. + * `weeklyMaintenanceWindow` — по расписанию: + * `day` — день недели в формате `DDD`: `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT` или `SUN`. + * `hour` — час дня по UTC в формате `HH`: от `1` до `24`. + + * `deletionProtection` — защитить кластер, его базы данных и пользователей от непреднамеренного удаления: `true` или `false`. Значение по умолчанию — `false`. + + {% include [Ограничения защиты от удаления](../../_includes/mdb/deletion-protection-limits-db.md) %} - Чтобы изменить дополнительные настройки кластера, воспользуйтесь методом REST API [update](../api-ref/Cluster/update.md) для ресурса [Cluster](../api-ref/Cluster/index.md) или вызовом gRPC API [ClusterService/Update](../api-ref/grpc/Cluster/update.md) и передайте в запросе: + 1. Выполните запрос: - * Идентификатор кластера в параметре `clusterId`. Чтобы узнать идентификатор, [получите список кластеров в каталоге](./cluster-list.md#list-clusters). - * Настройки доступа из других сервисов и к SQL-запросам из консоли управления с помощью сервиса {{ websql-full-name }} в параметре `configSpec.access`. - * Настройки окна резервного копирования в параметре `configSpec.backupWindowStart`. - * Настройки времени [технического обслуживания](../concepts/maintenance.md) (в т. ч. для выключенных кластеров) в параметре `maintenanceWindow`. - * Настройки защиты от удаления кластера в параметре `deletionProtection`. + ```bash + curl \ + --request PATCH \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --header "Content-Type: application/json" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/clusters/<идентификатор_кластера>' \ + --data '@body.json' + ``` - {% include [Ограничения защиты от удаления кластера](../../_includes/mdb/deletion-protection-limits-db.md) %} + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). - * Список изменяемых полей конфигурации кластера в параметре `updateMask`. + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Cluster/update.md#responses). - {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} +- gRPC API {#grpc-api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} + + 1. Воспользуйтесь вызовом [ClusterService/Update](../api-ref/grpc/Cluster/update.md) и выполните запрос, например, с помощью {{ api-examples.grpc.tool }}: + + {% include [note-grpc-updatemask](../../_includes/note-grpc-api-updatemask.md) %} + + 1. Создайте файл `body.json` и добавьте в него следующее содержимое: + + + ```json + { + "cluster_id": "<идентификатор_кластера>", + "update_mask": { + "paths": [ + <перечень_изменяемых_настроек> + ] + }, + "config_spec": { + "backup_window_start": { + "hours": "<часы>", + "minutes": "<минуты>", + "seconds": "<секунды>", + "nanos": "<наносекунды>" + }, + "access": { + "data_lens": <доступ_из_{{ datalens-name }}>, + "web_sql": <выполнение_SQL-запросов>, + "metrika": <импорт_данных_из_AppMetrica>, + "serverless": <доступ_из_{{ sf-full-name }}>, + "data_transfer": <доступ_из_{{ data-transfer-full-name }}>, + "yandex_query": <доступ_из_{{ yq-full-name }}> + } + }, + "maintenance_window": { + "anytime": {}, + "weekly_maintenance_window": { + "day": "<день_недели>", + "hour": "<час_дня_по_UTC>" + } + }, + "deletion_protection": <защита_от_удаления> + } + ``` + + + Где: + + * `update_mask` — перечень изменяемых параметров в виде массива строк `paths[]`. + + * {% include [backup-windows-start-grpc](../../_includes/mdb/api/backup-windows-start-grpc.md) %} + + * `config_spec.access` — настройки, которые разрешают доступ к кластеру из других сервисов и [выполнение SQL-запросов из консоли управления](web-sql-query.md) с помощью {{ websql-full-name }}: + + {% include [grpc-access-settings](../../_includes/mdb/mch/api/grpc-access-settings.md) %} + + * `maintenance_window` — настройки времени [технического обслуживания](../concepts/maintenance.md) (в т. ч. для выключенных кластеров). Выберите один из вариантов: + + * `anytime` — (по умолчанию) — в любое время. + * `weekly_maintenance_window` — по расписанию: + * `day` — день недели в формате `DDD`: `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT` или `SUN`. + * `hour` — час дня по UTC в формате `HH`: от `1` до `24`. + + * `deletion_protection` — защитить кластер, его базы данных и пользователей от непреднамеренного удаления: `true` или `false`. Значение по умолчанию — `false`. + + {% include [Ограничения защиты от удаления](../../_includes/mdb/deletion-protection-limits-db.md) %} + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). + + 1. Выполните запрос: + + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + -d @ \ + {{ api-host-mdb }}:{{ port-https }} \ + yandex.cloud.mdb.clickhouse.v1.ClusterService.Update \ + < body.json + ``` + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Cluster/update.md#yandex.cloud.operation.Operation). {% endlist %} @@ -564,12 +1048,61 @@ description: Следуя данной инструкции, вы сможете Идентификатор кластера можно получить со [списком кластеров в каталоге](cluster-list.md#list-clusters). -- API {#api} +- REST API {#api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: - Чтобы переместить кластер, воспользуйтесь методом REST API [move](../api-ref/Cluster/move.md) для ресурса [Cluster](../api-ref/Cluster/index.md) или вызовом gRPC API [ClusterService/Move](../api-ref/grpc/Cluster/move.md) и передайте в запросе: + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} - * Идентификатор кластера в параметре `clusterId`. Чтобы узнать идентификатор, [получите список кластеров в каталоге](cluster-list.md#list-clusters). - * Идентификатор каталога назначения в параметре `destinationFolderId`. + 1. Воспользуйтесь методом [Cluster.move](../api-ref/Cluster/move.md) и выполните запрос, например, с помощью {{ api-examples.rest.tool }}: + + ```bash + curl \ + --request POST \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --header "Content-Type: application/json" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/clusters/<идентификатор_кластера>:move' \ + --data '{ + "destinationFolderId": "<идентификатор_каталога_назначения>" + }' + ``` + + Где `destinationFolderId` — идентификатор каталога назначения, в который нужно переместить кластер. Этот идентификатор можно запросить со [списком каталогов в облаке](../../resource-manager/operations/folder/get-id.md). + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Cluster/move.md#responses). + +- gRPC API {#grpc-api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} + + 1. Воспользуйтесь вызовом [ClusterService/Move](../api-ref/grpc/Cluster/move.md) и выполните запрос, например, с помощью {{ api-examples.grpc.tool }}: + + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + -d '{ + "cluster_id": "<идентификатор_кластера>", + "destination_folder_id": "<идентификатор_каталога_назначения>" + }' \ + {{ api-host-mdb }}:{{ port-https }} \ + yandex.cloud.mdb.clickhouse.v1.ClusterService.Move + ``` + + Где `destination_folder_id` — идентификатор каталога назначения, в который нужно переместить кластер. Этот идентификатор можно запросить со [списком каталогов в облаке](../../resource-manager/operations/folder/get-id.md). + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Cluster/move.md#yandex.cloud.operation.Operation). {% endlist %} @@ -632,15 +1165,102 @@ description: Следуя данной инструкции, вы сможете {% include [Terraform timeouts](../../_includes/mdb/mch/terraform/timeouts.md) %} -- API {#api} +- REST API {#api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} - Чтобы изменить группы безопасности, воспользуйтесь методом REST API [update](../api-ref/Cluster/update.md) для ресурса [Cluster](../api-ref/Cluster/index.md) или вызовом gRPC API [ClusterService/Update](../api-ref/grpc/Cluster/update.md) и передайте в запросе: + 1. Воспользуйтесь методом [Cluster.update](../api-ref/Cluster/update.md) и выполните запрос, например, с помощью {{ api-examples.rest.tool }}: + + {% include [note-updatemask](../../_includes/note-api-updatemask.md) %} + + ```bash + curl \ + --request PATCH \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --header "Content-Type: application/json" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/clusters/<идентификатор_кластера>' \ + --data '{ + "updateMask": "securityGroupIds", + "securityGroupIds": [ + <список_идентификаторов_групп_безопасности> + ] + }' + ``` + + Где: - * Идентификатор кластера в параметре `clusterId`. Чтобы узнать идентификатор, [получите список кластеров в каталоге](cluster-list.md#list-clusters). - * Список идентификаторов групп безопасности в параметре `securityGroupIds`. - * Список настроек, которые необходимо изменить, в параметре `updateMask`. + * `updateMask` — перечень изменяемых параметров в одну строку через запятую. - {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} + В данном случае указан только один параметр: `securityGroupIds`. + + * `securityGroupIds` — массив строк. Каждая строка — идентификатор группы безопасности. + + {% note warning %} + + Список назначенных кластеру групп безопасности будет полностью перезаписан списком, переданным в параметре `securityGroupIds`. + + Перед выполнением запроса убедитесь, что вы включили в этот список все нужные идентификаторы групп безопасности, в том числе существующие. + + {% endnote %} + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Cluster/update.md#responses). + +- gRPC API {#grpc-api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} + + 1. Воспользуйтесь вызовом [ClusterService/Update](../api-ref/grpc/Cluster/update.md) и выполните запрос, например, с помощью {{ api-examples.grpc.tool }}: + + {% include [note-grpc-updatemask](../../_includes/note-grpc-api-updatemask.md) %} + + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + -d '{ + "cluster_id": "<идентификатор_кластера>", + "update_mask": { + "paths": [ + "security_group_ids" + ] + }, + "security_group_ids": [ + <список_идентификаторов_групп_безопасности> + ] + }' \ + {{ api-host-mdb }}:{{ port-https }} \ + yandex.cloud.mdb.clickhouse.v1.ClusterService.Update + ``` + + Где: + * `update_mask` — перечень изменяемых параметров в виде массива строк `paths[]`. + + В данном случае указан только один параметр: `security_group_ids`. + + * `security_group_ids` — массив строк. Каждая строка — идентификатор группы безопасности. + + {% note warning %} + + Список назначенных кластеру групп безопасности будет полностью перезаписан списком, переданным в параметре `security_group_ids`. + + Перед выполнением запроса убедитесь, что вы включили в этот список все нужные идентификаторы групп безопасности, в том числе существующие. + + {% endnote %} + + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Cluster/update.md#yandex.cloud.operation.Operation). {% endlist %} @@ -692,22 +1312,98 @@ description: Следуя данной инструкции, вы сможете {% include [Hybrid Storage settings CLI](../../_includes/mdb/mch/hybrid-storage-settings-cli.md) %} -- API {#api} +- REST API {#api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. Воспользуйтесь методом [Cluster.update](../api-ref/Cluster/update.md) и выполните запрос, например, с помощью {{ api-examples.rest.tool }}: + + {% include [note-updatemask](../../_includes/note-api-updatemask.md) %} + + ```bash + curl \ + --request PATCH \ + --header "Authorization: Bearer $IAM_TOKEN" \ + --header "Content-Type: application/json" \ + --url 'https://{{ api-host-mdb }}/managed-clickhouse/v1/clusters/<идентификатор_кластера>' \ + --data '{ + "updateMask": "<перечень_изменяемых_настроек>", + "configSpec": { + "cloudStorage": { + "enabled": <использование_гибридного_хранилища>, + "moveFactor": "<доля_свободного_места>", + "dataCacheEnabled": <временное_хранение_файлов>, + "dataCacheMaxSize": "<максимальный_объем_памяти_для_хранения_файлов>", + "preferNotToMerge": <отключение_слияния_кусков_данных> + } + } + }' + ``` + + Где: + + * `updateMask` — перечень изменяемых параметров в одну строку через запятую. - Чтобы изменить настройки гибридного хранилища, воспользуйтесь методом REST API [update](../api-ref/Cluster/update.md) для ресурса [Cluster](../api-ref/Cluster/index.md) или вызовом gRPC API [ClusterService/Update](../api-ref/grpc/Cluster/update.md) и передайте в запросе: + * `configSpec.cloudStorage` — настройки гибридного хранилища: - * Идентификатор кластера в параметре `clusterId`. Чтобы узнать идентификатор, [получите список кластеров в каталоге](cluster-list.md#list-clusters). - * Значение `true` в параметре `configSpec.cloudStorage.enabled`, если гибридное хранилище еще не включено. + {% include [rest-cloud-storage-settings](../../_includes/mdb/mch/api/rest-cloud-storage-settings.md) %} - {% include [Hybrid Storage cannot be switched off](../../_includes/mdb/mch/hybrid-storage-cannot-be-switched-off.md) %} + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). + + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Cluster/update.md#responses). + +- gRPC API {#grpc-api} + + 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: + + {% include [api-auth-token](../../_includes/mdb/api-auth-token.md) %} + + 1. {% include [grpc-api-setup-repo](../../_includes/mdb/grpc-api-setup-repo.md) %} + + 1. Воспользуйтесь вызовом [ClusterService/Update](../api-ref/grpc/Cluster/update.md) и выполните запрос, например, с помощью {{ api-examples.grpc.tool }}: + + {% include [note-grpc-updatemask](../../_includes/note-grpc-api-updatemask.md) %} + + ```bash + grpcurl \ + -format json \ + -import-path ~/cloudapi/ \ + -import-path ~/cloudapi/third_party/googleapis/ \ + -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \ + -rpc-header "Authorization: Bearer $IAM_TOKEN" \ + -d '{ + "cluster_id": "<идентификатор_кластера>", + "update_mask": { + "paths": [ + <перечень_изменяемых_настроек> + ] + }, + "config_spec": { + "cloud_storage": { + "enabled": <использование_гибридного_хранилища>, + "move_factor": "<доля_свободного_места>", + "data_cache_enabled": <временное_хранение_файлов>, + "data_cache_max_size": "<максимальный_объем_памяти_для_хранения_файлов>", + "prefer_not_to_merge": <отключение_слияния_кусков_данных> + } + } + }' \ + {{ api-host-mdb }}:{{ port-https }} \ + yandex.cloud.mdb.clickhouse.v1.ClusterService.Update + ``` + + Где: + * `update_mask` — перечень изменяемых параметров в виде массива строк `paths[]`. - * [Настройки гибридного хранилища](../concepts/storage.md#hybrid-storage-settings) в параметрах `configSpec.cloudStorage`: + * `config_spec.cloud_storage` — настройки гибридного хранилища: - {% include [Hybrid Storage settings API](../../_includes/mdb/mch/hybrid-storage-settings-api.md) %} + {% include [grpc-cloud-storage-settings](../../_includes/mdb/mch/api/grpc-cloud-storage-settings.md) %} - * Список настроек, которые необходимо изменить, в параметре `updateMask`. + Идентификатор кластера можно запросить со [списком кластеров в каталоге](./cluster-list.md#list-clusters). - {% include [Note API updateMask](../../_includes/note-api-updatemask.md) %} + 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Cluster/update.md#yandex.cloud.operation.Operation). {% endlist %} diff --git a/ru/managed-clickhouse/toc.yaml b/ru/managed-clickhouse/toc.yaml index 3bdfb7d58d8..2fe239c11fa 100644 --- a/ru/managed-clickhouse/toc.yaml +++ b/ru/managed-clickhouse/toc.yaml @@ -144,6 +144,30 @@ items: Копирование данных из {{ mos-name }} в {{ mch-name }} с помощью {{ data-transfer-full-name }} href: tutorials/opensearch-to-clickhouse.md + - name: Ввод данных в системы хранения + href: tutorials/data-ingestion.md + - name: Использование параметров + href: tutorials/data-from-ch-with-parameters.md + - name: Примеры создания QL-чартов + href: tutorials/data-from-ch-to-sql-chart.md + - name: Веб-аналитика с расчетом воронок и когорт на данных Яндекс Метрики + href: tutorials/data-from-metrica-yc-visualization.md + - name: 'AppMetrica: прямое подключение' + href: tutorials/data-from-appmetrica-visualization.md + - name: 'AppMetrica: экспорт, постобработка и визуализация данных' + href: tutorials/data-from-appmetrica-yc-visualization.md + - name: '{{ tracker-full-name }}: экспорт и визуализация данных' + href: tutorials/data-from-tracker.md + - name: Дашборд сети магазинов из БД {{ CH }} + href: tutorials/data-from-ch-visualization.md + - name: >- + Анализ продаж и локаций пиццерий на данных из БД {{ CH }} и + Marketplace + href: tutorials/data-from-ch-to-geolayers-visualization.md + - name: >- + Геокодинг с помощью API Яндекс Карт для визуализации в {{ + datalens-short-name }} + href: tutorials/data-from-ch-geocoder.md - name: Концепции items: - name: Взаимосвязь ресурсов сервиса diff --git a/ru/managed-clickhouse/tutorials/data-from-appmetrica-visualization.md b/ru/managed-clickhouse/tutorials/data-from-appmetrica-visualization.md new file mode 100644 index 00000000000..6720a4cd44d --- /dev/null +++ b/ru/managed-clickhouse/tutorials/data-from-appmetrica-visualization.md @@ -0,0 +1,7 @@ +--- +canonical: '{{ link-docs }}/tutorials/datalens/data-from-appmetrica-visualization' +--- + +{% include [data-from-appmetrica-visualization](../../_tutorials/datalens/data-from-appmetrica-visualization.md) %} + +{% include [clickhouse-disclaimer](../../_includes/clickhouse-disclaimer.md) %} diff --git a/ru/managed-clickhouse/tutorials/data-from-appmetrica-yc-visualization.md b/ru/managed-clickhouse/tutorials/data-from-appmetrica-yc-visualization.md new file mode 100644 index 00000000000..7b9350f159e --- /dev/null +++ b/ru/managed-clickhouse/tutorials/data-from-appmetrica-yc-visualization.md @@ -0,0 +1,7 @@ +--- +canonical: '{{ link-docs }}/tutorials/datalens/data-from-appmetrica-yc-visualization' +--- + +{% include [data-from-metrica-yc-visualization](../../_tutorials/datalens/data-from-appmetrica-yc-visualization.md) %} + +{% include [clickhouse-disclaimer](../../_includes/clickhouse-disclaimer.md) %} \ No newline at end of file diff --git a/ru/managed-clickhouse/tutorials/data-from-ch-geocoder.md b/ru/managed-clickhouse/tutorials/data-from-ch-geocoder.md new file mode 100644 index 00000000000..e743fe9a04e --- /dev/null +++ b/ru/managed-clickhouse/tutorials/data-from-ch-geocoder.md @@ -0,0 +1,7 @@ +--- +canonical: '{{ link-docs }}/tutorials/datalens/data-from-ch-geocoder' +--- + +{% include [data-from-ch-geocoder](../../_tutorials/datalens/data-from-ch-geocoder.md) %} + +{% include [clickhouse-disclaimer](../../_includes/clickhouse-disclaimer.md) %} diff --git a/ru/managed-clickhouse/tutorials/data-from-ch-to-geolayers-visualization.md b/ru/managed-clickhouse/tutorials/data-from-ch-to-geolayers-visualization.md new file mode 100644 index 00000000000..1ba9034d3f1 --- /dev/null +++ b/ru/managed-clickhouse/tutorials/data-from-ch-to-geolayers-visualization.md @@ -0,0 +1,7 @@ +--- +canonical: '{{ link-docs }}/tutorials/datalens/data-from-ch-to-geolayers-visualization' +--- + +{% include [data-from-ch-to-geolayers-visualization](../../_tutorials/datalens/data-from-ch-to-geolayers-visualization.md) %} + +{% include [clickhouse-disclaimer](../../_includes/clickhouse-disclaimer.md) %} diff --git a/ru/managed-clickhouse/tutorials/data-from-ch-to-sql-chart.md b/ru/managed-clickhouse/tutorials/data-from-ch-to-sql-chart.md new file mode 100644 index 00000000000..8a5b7842276 --- /dev/null +++ b/ru/managed-clickhouse/tutorials/data-from-ch-to-sql-chart.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/datalens/data-from-ch-to-sql-chart' +--- + +{% include [data-from-ch-to-sql-chart](../../_tutorials/datalens/data-from-ch-to-sql-chart.md) %} diff --git a/ru/managed-clickhouse/tutorials/data-from-ch-visualization.md b/ru/managed-clickhouse/tutorials/data-from-ch-visualization.md new file mode 100644 index 00000000000..f7899273a07 --- /dev/null +++ b/ru/managed-clickhouse/tutorials/data-from-ch-visualization.md @@ -0,0 +1,7 @@ +--- +canonical: '{{ link-docs }}/tutorials/datalens/data-from-ch-visualization' +--- + +{% include [data-from-ch-visualization](../../_tutorials/datalens/data-from-ch-visualization.md) %} + +{% include [clickhouse-disclaimer](../../_includes/clickhouse-disclaimer.md) %} diff --git a/ru/managed-clickhouse/tutorials/data-from-ch-with-parameters.md b/ru/managed-clickhouse/tutorials/data-from-ch-with-parameters.md new file mode 100644 index 00000000000..12b975e21da --- /dev/null +++ b/ru/managed-clickhouse/tutorials/data-from-ch-with-parameters.md @@ -0,0 +1,7 @@ +--- +canonical: '{{ link-docs }}/tutorials/datalens/data-from-ch-with-parameters' +--- + +{% include [data-from-ch-with-parameters](../../_tutorials/datalens/data-from-ch-with-parameters.md) %} + +{% include [clickhouse-disclaimer](../../_includes/clickhouse-disclaimer.md) %} diff --git a/ru/managed-clickhouse/tutorials/data-from-metrica-yc-visualization.md b/ru/managed-clickhouse/tutorials/data-from-metrica-yc-visualization.md new file mode 100644 index 00000000000..10d833c40bb --- /dev/null +++ b/ru/managed-clickhouse/tutorials/data-from-metrica-yc-visualization.md @@ -0,0 +1,9 @@ +--- +canonical: '{{ link-docs }}/tutorials/datalens/data-from-metrica-yc-visualization' +--- + +# Веб-аналитика с расчетом воронок и когорт на данных Яндекс Метрики + +{% include notitle [data-from-metrica-yc-visualization](../../_tutorials/datalens/data-from-metrica-yc-visualization.md) %} + +{% include [clickhouse-disclaimer](../../_includes/clickhouse-disclaimer.md) %} diff --git a/ru/managed-clickhouse/tutorials/data-from-tracker.md b/ru/managed-clickhouse/tutorials/data-from-tracker.md new file mode 100644 index 00000000000..81cdc4df7e9 --- /dev/null +++ b/ru/managed-clickhouse/tutorials/data-from-tracker.md @@ -0,0 +1,7 @@ +--- +canonical: '{{ link-docs }}/tutorials/datalens/data-from-tracker' +--- + +{% include [visualisation-in-datalens](../../_tutorials/datalens/data-from-tracker.md) %} + +{% include [clickhouse-disclaimer](../../_includes/clickhouse-disclaimer.md) %} \ No newline at end of file diff --git a/ru/managed-clickhouse/tutorials/data-ingestion.md b/ru/managed-clickhouse/tutorials/data-ingestion.md new file mode 100644 index 00000000000..daef82382a9 --- /dev/null +++ b/ru/managed-clickhouse/tutorials/data-ingestion.md @@ -0,0 +1,7 @@ +--- +canonical: '{{ link-docs }}/tutorials/serverless/data-ingestion' +--- + +{% include [data-ingestion](../../_tutorials/serverless/data-ingestion.md) %} + +{% include [clickhouse-disclaimer](../../_includes/clickhouse-disclaimer.md) %} \ No newline at end of file diff --git a/ru/managed-clickhouse/tutorials/index.md b/ru/managed-clickhouse/tutorials/index.md index 979a170c311..7027722006c 100644 --- a/ru/managed-clickhouse/tutorials/index.md +++ b/ru/managed-clickhouse/tutorials/index.md @@ -25,7 +25,17 @@ description: Различные сценарии использования {{ m * [{#T}](rdbms-to-clickhouse.md) * [{#T}](opensearch-to-clickhouse.md) * [{#T}](ydb-to-clickhouse.md) +* [Использование параметров](data-from-ch-with-parameters.md) +* [Примеры создания QL-чартов](data-from-ch-to-sql-chart.md) +* [{#T}](data-from-metrica-yc-visualization.md) +* [{#T}](data-from-appmetrica-visualization.md) +* [{#T}](data-from-appmetrica-yc-visualization.md) +* [{#T}](data-from-tracker.md) +* [{#T}](data-from-ch-visualization.md) +* [{#T}](data-from-ch-to-geolayers-visualization.md) +* [{#T}](data-from-ch-geocoder.md) * [{#T}](greenplum-to-clickhouse.md) +* [{#T}](data-ingestion.md) О миграции хостов кластера {{ mch-name }} в другую зону доступности читайте в [инструкции](../operations/host-migration.md). diff --git a/ru/managed-greenplum/api-ref/Cluster/streamLogs.md b/ru/managed-greenplum/api-ref/Cluster/streamLogs.md index 896fd2792e2..ab652200f46 100644 --- a/ru/managed-greenplum/api-ref/Cluster/streamLogs.md +++ b/ru/managed-greenplum/api-ref/Cluster/streamLogs.md @@ -64,7 +64,7 @@ To work with values in this field, use the APIs described in the In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || || recordToken | **string** -Record token. Set `recordToken` to the [StreamLogs.nextRecordToken](#yandex.cloud.mdb.greenplum.v1.StreamLogRecord) returned by the previous [StreamLogs](#StreamLogs) request to start streaming from the next log record. || +Record token. Set `recordToken` to the [StreamLogs.next_record_token] returned by the previous [StreamLogs](#StreamLogs) request to start streaming from the next log record. || || filter | **string** A filter expression that filters resources listed in the response. @@ -106,9 +106,9 @@ One of the requested log records. || This token allows you to continue streaming logs starting from the exact same record. -To do that, specify value of `nextRecordToken` as the value for [StreamLogs.recordToken](#yandex.cloud.mdb.greenplum.v1.StreamClusterLogsRequest) parameter in the next [StreamLogs](#StreamLogs) request. +To do that, specify value of `nextRecordToken` as the value for [StreamLogs.record_token] parameter in the next [StreamLogs](#StreamLogs) request. -This value is interchangeable with [ListLogs.nextPageToken](/docs/managed-greenplum/api-ref/Backup/list#yandex.cloud.mdb.greenplum.v1.ListBackupsResponse) from [ListLogs](/docs/managed-greenplum/api-ref/Cluster/listLogs#ListLogs) method. || +This value is interchangeable with [ListLogs.next_page_token] from [ListLogs](/docs/managed-greenplum/api-ref/Cluster/listLogs#ListLogs) method. || |# ## LogRecord {#yandex.cloud.mdb.greenplum.v1.LogRecord} diff --git a/ru/managed-greenplum/api-ref/grpc/Cluster/streamLogs.md b/ru/managed-greenplum/api-ref/grpc/Cluster/streamLogs.md index f36d8e44700..8fb16f4b1c9 100644 --- a/ru/managed-greenplum/api-ref/grpc/Cluster/streamLogs.md +++ b/ru/managed-greenplum/api-ref/grpc/Cluster/streamLogs.md @@ -56,7 +56,7 @@ If this field is not set, all existing logs are sent as well as the new ones as In essence it has `tail -f` semantics. || || recordToken | **string** -Record token. Set `recordToken` to the [StreamLogs.nextRecordToken](#yandex.cloud.mdb.greenplum.v1.StreamLogRecord) returned by the previous [StreamLogs](#StreamLogs) request to start streaming from the next log record. || +Record token. Set `recordToken` to the [StreamLogs.next_record_token] returned by the previous [StreamLogs](#StreamLogs) request to start streaming from the next log record. || || filter | **string** A filter expression that filters resources listed in the response. @@ -96,9 +96,9 @@ One of the requested log records. || This token allows you to continue streaming logs starting from the exact same record. -To do that, specify value of `nextRecordToken` as the value for [StreamLogs.recordToken](#yandex.cloud.mdb.greenplum.v1.StreamClusterLogsRequest) parameter in the next [StreamLogs](#StreamLogs) request. +To do that, specify value of `nextRecordToken` as the value for [StreamLogs.record_token] parameter in the next [StreamLogs](#StreamLogs) request. -This value is interchangeable with [ListLogs.nextPageToken](/docs/managed-greenplum/api-ref/grpc/Backup/list#yandex.cloud.mdb.greenplum.v1.ListBackupsResponse) from [ListLogs](/docs/managed-greenplum/api-ref/grpc/Cluster/listLogs#ListLogs) method. || +This value is interchangeable with [ListLogs.next_page_token] from [ListLogs](/docs/managed-greenplum/api-ref/grpc/Cluster/listLogs#ListLogs) method. || |# ## LogRecord {#yandex.cloud.mdb.greenplum.v1.LogRecord} diff --git a/ru/managed-greenplum/operations/cluster-create.md b/ru/managed-greenplum/operations/cluster-create.md index 8ccd3ab9932..3c6b8a93b6c 100644 --- a/ru/managed-greenplum/operations/cluster-create.md +++ b/ru/managed-greenplum/operations/cluster-create.md @@ -53,11 +53,7 @@ Эту опцию нельзя отключить после сохранения настроек кластера. - {% note info %} - - Функциональность находится на стадии [Preview](../../overview/concepts/launch-stages.md) и не тарифицируется. - - {% endnote %} + {% include [Cloud storage Preview](../../_includes/mdb/mgp/cloud-storage-preview.md) %} 1. Укажите настройки пользователя-администратора. Это специальный пользователь, который необходим для управления кластером и не может быть удален. Подробнее см. в разделе [Пользователи и роли](../concepts/cluster-users.md). diff --git a/ru/managed-greenplum/operations/update.md b/ru/managed-greenplum/operations/update.md index f12dd19b89e..91acc906935 100644 --- a/ru/managed-greenplum/operations/update.md +++ b/ru/managed-greenplum/operations/update.md @@ -65,6 +65,42 @@ description: Следуя данной инструкции, вы сможете --description <новое_описание_кластера> ``` +- {{ TF }} {#tf} + + {% note alert %} + + Не изменяйте имя кластера с помощью {{ TF }}. Это приведет к удалению существующего кластера и созданию нового. + + {% endnote %} + + Чтобы изменить описание кластера: + + 1. Откройте актуальный конфигурационный файл {{ TF }} с планом инфраструктуры. + + Как создать такой файл, см. в разделе [Создание кластера](cluster-create.md). + + Полный список доступных для изменения полей конфигурации кластера {{ mgp-name }} см. в [документации провайдера {{ TF }}]({{ tf-provider-mgp }}). + + 1. Измените в описании кластера {{ mgp-name }} значение атрибута `description`: + + ```hcl + resource "yandex_mdb_greenplum_cluster" "<имя_кластера>" { + name = "<имя_кластера>" + description = "<новое_описание_кластера>" + ... + } + ``` + + 1. Проверьте корректность настроек. + + {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} + + 1. Подтвердите изменение ресурсов. + + {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} + + {% include [Terraform timeouts](../../_includes/mdb/mgp/terraform-timeouts.md) %} + - API {#api} Чтобы изменить имя и описание кластера, воспользуйтесь методом REST API [update](../api-ref/Cluster/update.md) для ресурса [Cluster](../api-ref/Cluster/index.md) или вызовом gRPC API [ClusterService/Update](../api-ref/grpc/Cluster/update.md) и передайте в запросе: @@ -158,16 +194,12 @@ description: Следуя данной инструкции, вы сможете {% include [Ограничения защиты от удаления](../../_includes/mdb/deletion-protection-limits-db.md) %} - * **{{ ui-key.yacloud.greenplum.section_cloud-storage }}** — включает [расширение {{ YZ }}](https://github.com/yezzey-gp/yezzey/) от {{ yandex-cloud }}. Оно применяется, чтобы [выгрузить таблицы AO и AOCO](../tutorials/yezzey.md) с дисков кластера {{ mgp-name }} в холодное хранилище {{ objstorage-full-name }}. Так данные хранятся в служебном бакете в сжатом и зашифрованном виде. Это [более экономичный способ хранения](../../storage/pricing.md). + * **{{ ui-key.yacloud.greenplum.section_cloud-storage }}** — в кластерах с версией {{ GP }} 6.25 и выше включает [расширение {{ YZ }}](https://github.com/yezzey-gp/yezzey/) от {{ yandex-cloud }}. Оно применяется, чтобы [выгрузить таблицы AO и AOCO](../tutorials/yezzey.md) с дисков кластера {{ mgp-name }} в холодное хранилище {{ objstorage-full-name }}. Так данные хранятся в служебном бакете в сжатом и зашифрованном виде. Это [более экономичный способ хранения](../../storage/pricing.md). Эту опцию нельзя отключить после сохранения настроек кластера. - {% note info %} - - Функциональность находится на стадии [Preview](../../overview/concepts/launch-stages.md) и не тарифицируется. - - {% endnote %} + {% include [Cloud storage Preview](../../_includes/mdb/mgp/cloud-storage-preview.md) %} * **{{ ui-key.yacloud.mdb.forms.section_pooler }}** — режим работы и параметры [менеджера подключений](../concepts/pooling.md): @@ -201,7 +233,6 @@ description: Следуя данной инструкции, вы сможете --maintenance-window type=<тип_технического_обслуживания>,` `day=<день_недели>,` `hour=<час_дня> \ - --assign-public-ip=<публичный_доступ_к_кластеру> \ --deletion-protection ``` @@ -223,14 +254,105 @@ description: Следуя данной инструкции, вы сможете {% include [maintenance-window](../../_includes/mdb/cli/maintenance-window-description.md) %} - * `--assign-public-ip` — доступность кластера из интернета. - * {% include [Deletion protection](../../_includes/mdb/cli/deletion-protection.md) %} {% include [Ограничения защиты от удаления кластера](../../_includes/mdb/deletion-protection-limits-db.md) %} Имя кластера можно [получить со списком кластеров в каталоге](cluster-list.md#list-clusters). +- {{ TF }} {#tf} + + 1. Откройте актуальный конфигурационный файл {{ TF }} с планом инфраструктуры. + + Как создать такой файл, см. в разделе [Создание кластера](cluster-create.md). + + Полный список доступных для изменения полей конфигурации кластера {{ mgp-name }} см. в [документации провайдера {{ TF }}]({{ tf-provider-mgp }}). + + 1. Измените в описании кластера {{ mgp-name }} значения нужных дополнительных настроек: + + + ```hcl + resource "yandex_mdb_greenplum_cluster" "<имя_кластера>" { + ... + backup_window_start { + hours = <начало_периода_резервного_копирования> + } + + maintenance_window { + type = <тип_технического_обслуживания> + day = <день_недели> + hour = <час_дня> + } + + access { + data_lens = <доступ_из_{{ datalens-name }}> + yandex_query = <доступ_из_Yandex_Query> + } + + deletion_protection = <защита_от_удаления> + + cloud_storage { + enable = <использование_гибридного_хранилища> + } + + pooler_config { + pooling_mode = <режим_работы> + pool_size = <размер> + pool_client_idle_timeout = <время_ожидания_клиента> + } + } + ``` + + + + + Вы можете изменить следующие настройки: + + * `backup_window_start.hours` — начало периода, в течение которого начинается [резервное копирование](../concepts/backup.md) кластера. Задается по UTC в формате `HH`: от `0` до `23`. + + * `maintenance_window` — настройки времени [технического обслуживания](../concepts/maintenance.md) (в т. ч. для выключенных кластеров): + + * `type` — тип технического обслуживания. Принимает значения: + * `ANYTIME` — в любое время. + * `WEEKLY` — по расписанию. + * `day` — день недели для типа `WEEKLY` в формате `DDD`. Например, `MON`. + * `hour` — час дня по UTC для типа `WEEKLY` в формате `HH`. Например, `21`. + + + * `access.data_lens` — доступ к кластеру из сервиса [{{ datalens-full-name }}](../../datalens/concepts/index.md): `true` или `false`. + + * `access.yandex_query` — доступ к кластеру из сервиса [{{ yq-full-name }}](../../query/concepts/index.md): `true` или `false`. + + + + * `deletion_protection` — защита от удаления кластера, его баз данных и пользователей: `true` или `false`. + + {% include [Ограничения защиты от удаления кластера](../../_includes/mdb/deletion-protection-limits-data.md) %} + + * `cloud_storage.enable` — использование гибридного хранилища в кластерах с версией {{ GP }} 6.25 и выше. Установите значение `true`, чтобы включить в кластере [расширение {{ YZ }}](https://github.com/yezzey-gp/yezzey/) от {{ yandex-cloud }}. Оно применяется, чтобы [выгрузить таблицы AO и AOCO](../tutorials/yezzey.md) с дисков кластера {{ mgp-name }} в холодное хранилище {{ objstorage-full-name }}. Так данные хранятся в служебном бакете в сжатом и зашифрованном виде. Это [более экономичный способ хранения](../../storage/pricing.md). + + Гибридное хранилище нельзя отключить после сохранения настроек кластера. + + + {% include [Cloud storage Preview](../../_includes/mdb/mgp/cloud-storage-preview.md) %} + + + * `pooler_config` — настройки [менеджера подключений](../concepts/pooling.md): + + * `pooling_mode` — режим работы: `SESSION` или `TRANSACTION`. + * `pool_size` — количество клиентских соединений. + * `pool_client_idle_timeout` — время неактивности клиентского соединения (в миллисекундах), после которого соединение разрывается. + + 1. Проверьте корректность настроек. + + {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} + + 1. Подтвердите изменение ресурсов. + + {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} + + {% include [Terraform timeouts](../../_includes/mdb/mgp/terraform-timeouts.md) %} + - API {#api} Чтобы изменить дополнительные настройки кластера, воспользуйтесь методом REST API [update](../api-ref/Cluster/update.md) для ресурса [Cluster](../api-ref/Cluster/index.md) или вызовом gRPC API [ClusterService/Update](../api-ref/grpc/Cluster/update.md) и передайте в запросе: @@ -335,6 +457,37 @@ description: Следуя данной инструкции, вы сможете {{ mgp-short-name }} запустит операцию по изменению настроек кластера. +- {{ TF }} {#tf} + + 1. Откройте актуальный конфигурационный файл {{ TF }} с планом инфраструктуры. + + Как создать такой файл, см. в разделе [Создание кластера](cluster-create.md). + + Полный список доступных для изменения полей конфигурации кластера {{ mgp-name }} см. в [документации провайдера {{ TF }}]({{ tf-provider-mgp }}). + + 1. Измените в описании кластера [настройки {{ GP }}](../concepts/settings-list.md) в блоке `greenplum_config`: + + ```hcl + resource "yandex_mdb_greenplum_cluster" "<имя_кластера>" { + ... + greenplum_config = { + max_connections = <максимальное_количество_соединений> + gp_workfile_compression = + ... + } + } + ``` + + 1. Проверьте корректность настроек. + + {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} + + 1. Подтвердите изменение ресурсов. + + {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} + + {% include [Terraform timeouts](../../_includes/mdb/mgp/terraform-timeouts.md) %} + - API {#api} Чтобы изменить настройки {{ GP }}, воспользуйтесь методом REST API [update](../api-ref/Cluster/update.md) для ресурса [Cluster](../api-ref/Cluster/index.md) или вызовом gRPC API [ClusterService/Update](../api-ref/grpc/Cluster/update.md) и передайте в запросе: @@ -417,7 +570,7 @@ description: Следуя данной инструкции, вы сможете 1. Откройте актуальный конфигурационный файл {{ TF }} с планом инфраструктуры. - О том, как создать такой файл, см. в разделе [Создание кластера](cluster-create.md). + Как создать такой файл, см. в разделе [Создание кластера](cluster-create.md). Полный список доступных для изменения полей конфигурации кластера {{ mgp-name }} см. в [документации провайдера {{ TF }}]({{ tf-provider-mgp }}). @@ -431,6 +584,7 @@ description: Следуя данной инструкции, вы сможете resource_preset_id = "<класс_хоста>" ... } + } segment_subcluster { resources { resource_preset_id = "<класс_хоста>" @@ -479,6 +633,44 @@ description: Следуя данной инструкции, вы сможете 1. Измените настройки в блоке **{{ ui-key.yacloud.mdb.forms.section_storage }}**. 1. Нажмите кнопку **{{ ui-key.yacloud.common.save }}**. +- {{ TF }} {#tf} + + 1. Откройте актуальный конфигурационный файл {{ TF }} с планом инфраструктуры. + + Как создать такой файл, см. в разделе [Создание кластера](cluster-create.md). + + Полный список доступных для изменения полей конфигурации кластера {{ mgp-name }} см. в [документации провайдера {{ TF }}]({{ tf-provider-mgp }}). + + 1. Измените в описании кластера {{ mgp-name }} значение атрибута `disk_size` в блоке `master_subcluster.resources` или `segment_subcluster.resources`: + + ```hcl + resource "yandex_mdb_greenplum_cluster" "<имя_кластера>" { + ... + master_subcluster { + resources { + disk_size = <размер_хранилища_в_гигабайтах> + ... + } + } + segment_subcluster { + resources { + disk_size = <размер_хранилища_в_гигабайтах> + ... + } + } + } + ``` + + 1. Проверьте корректность настроек. + + {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} + + 1. Подтвердите изменение ресурсов. + + {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} + + {% include [Terraform timeouts](../../_includes/mdb/mgp/terraform-timeouts.md) %} + - API {#api} Чтобы увеличить размер хранилища для кластера, воспользуйтесь методом REST API [update](../api-ref/Cluster/update.md) для ресурса [Cluster](../api-ref/Cluster/index.md) или вызовом gRPC API [ClusterService/Update](../api-ref/grpc/Cluster/update.md) и передайте в запросе: diff --git a/ru/managed-kafka/operations/cluster-create.md b/ru/managed-kafka/operations/cluster-create.md index 41725ecf8e4..4e2ba362331 100644 --- a/ru/managed-kafka/operations/cluster-create.md +++ b/ru/managed-kafka/operations/cluster-create.md @@ -12,7 +12,19 @@ {% endnote %} -{% include [mkf-zk-hosts](../../_includes/mdb/mkf-zk-hosts.md) %} +## Различия в конфигурации кластеров с {{ ZK }} и протоколом {{ kraft-name }} {#zk-vs-kraft} + +Если вы создаете кластер с версией {{ KF }} 3.5 или ниже, в котором больше одного хоста, то в кластер будут добавлены три выделенных хоста {{ ZK }}. + +В кластерах с версией {{ KF }} 3.6 и выше поддержан протокол [{{ kraft-name }}](../concepts/kraft.md) (сокращенно {{ kraft-short-name }}). Он используется для хранения метаданных вместо {{ ZK }}. + +При создании кластера с протоколом {{ kraft-short-name }} действуют ограничения на конфигурацию: + * Можно создать кластер только с одной или тремя [зонами доступности](../../overview/concepts/geo-scope.md). + * Ограничено количество хостов-брокеров: + * Если выбрана одна зона доступности, можно создать один или три хоста-брокера. + * Если выбраны три зоны доступности, можно создать только один хост-брокер. + +Подробнее о различиях в конфигурации кластеров с {{ ZK }} и {{ kraft-short-name }} см. в разделе [Взаимосвязь ресурсов в {{ mkf-name }}](../../managed-kafka/concepts/index.md). ## Перед началом работы {#before-you-begin} @@ -23,24 +35,26 @@ Если вы указываете идентификаторы групп безопасности при создании кластера {{ mkf-name }}, для подключения к нему может понадобиться дополнительная [настройка групп безопасности](connect/index.md#configuring-security-groups). -## Создать кластер с версией {{ KF }} 3.5 или ниже {#create-cluster} +## Создать кластер {#create-cluster} {% list tabs group=instructions %} - Консоль управления {#console} + Чтобы создать кластер {{ mkf-name }}: + 1. В [консоли управления]({{ link-console-main }}) перейдите в нужный [каталог](../../resource-manager/concepts/resources-hierarchy.md#folder). 1. В списке сервисов выберите **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-kafka }}**. 1. Нажмите кнопку **{{ ui-key.yacloud.mdb.clusters.button_create }}**. 1. В блоке **{{ ui-key.yacloud.mdb.forms.section_base }}**: 1. Введите имя кластера {{ mkf-name }} и его описание. Имя кластера {{ mkf-name }} должно быть уникальным в рамках каталога. - 1. Выберите окружение, в котором нужно создать кластер {{ mkf-name }} (после создания кластера окружение изменить невозможно): + 1. Выберите окружение, в котором нужно создать кластер {{ mkf-name }} (после создания кластера изменить окружение невозможно): * `PRODUCTION` — для стабильных версий приложений. * `PRESTABLE` — для тестирования. Prestable-окружение аналогично Production-окружению и на него также распространяется SLA, но при этом на нем раньше появляются новые функциональные возможности, улучшения и исправления ошибок. В Prestable-окружении вы можете протестировать совместимость новых версий с вашим приложением. - 1. Выберите версию {{ KF }} 3.5 или ниже. + 1. Выберите версию {{ KF }}. 1. В блоке **{{ ui-key.yacloud.mdb.forms.section_resource }}** выберите [платформу](../../compute/concepts/vm-platforms.md), тип хостов и класс хостов. - Класс хостов определяет технические характеристики [виртуальных машин](../../compute/concepts/vm.md), на которых будут развернуты брокеры {{ KF }}. Все доступные варианты перечислены в разделе [Классы хостов](../concepts/instance-types.md). + Класс хостов определяет технические характеристики [виртуальных машин](../../compute/concepts/vm.md), на которых будут развернуты хосты-брокеры {{ KF }}. Все доступные варианты перечислены в разделе [Классы хостов](../concepts/instance-types.md). При [изменении класса хостов](cluster-update.md#change-brokers) для кластера {{ mkf-name }} меняются характеристики всех уже созданных экземпляров. 1. В блоке **{{ ui-key.yacloud.mdb.forms.section_storage }}**: @@ -56,18 +70,20 @@ * Выберите объем хранилища, который будет использоваться для данных. - 1. В блоке **{{ ui-key.yacloud.mdb.cluster.section_disk-scaling }}** задайте [пороги заполненности](../concepts/storage.md#auto-rescale) хранилища, при достижении которых его размер будет увеличиваться: + 1. В блоке **{{ ui-key.yacloud.mdb.cluster.section_disk-scaling }}** задайте [пороги заполненности](../concepts/storage.md#auto-rescale) хранилища, при достижении которых его размер будет увеличиваться: {% include [autoscale-settings](../../_includes/mdb/mkf/autoscale-settings.md) %} - + 1. В блоке **{{ ui-key.yacloud.mdb.forms.section_network-settings }}**: - 1. Выберите одну или несколько [зон доступности](../../overview/concepts/geo-scope.md), в которых нужно разместить брокеры {{ KF }}. Если создать кластер {{ mkf-name }} с одной зоной доступности, в дальнейшем увеличить количество зон и брокеров будет невозможно. + 1. Выберите одну или несколько зон доступности, в которых нужно разместить хосты-брокеры {{ KF }}. + Если создать кластер {{ mkf-name }} с одной зоной доступности, в дальнейшем увеличить количество зон и хостов-брокеров будет невозможно. + Для кластеров с версией {{ KF }} 3.6 и выше можно выбрать только одну или три зоны доступности. 1. Выберите [сеть](../../vpc/concepts/network.md#network). 1. Выберите [подсети](../../vpc/concepts/network.md#subnet) в каждой зоне доступности для этой сети. Чтобы [создать новую подсеть](../../vpc/operations/subnet-create.md), нажмите на кнопку **{{ ui-key.yacloud.common.label_create-new_female }}** рядом с нужной зоной доступности. {% note info %} - Для кластера {{ mkf-name }} из нескольких хостов-брокеров нужно указать подсети в каждой зоне доступности, даже если вы планируете разместить брокеры только в некоторых из них. Эти подсети понадобятся для размещения трех [хостов {{ ZK }}](../concepts/index.md) — по одному в каждой зоне доступности. Подробнее см. в разделе [Взаимосвязь ресурсов сервиса](../concepts/index.md). + Для кластера с версией {{ KF }} 3.5 или ниже, в котором несколько хостов-брокеров, укажите подсети в каждой зоне доступности, даже если вы планируете разместить хосты-брокеры только в некоторых из них. Эти подсети понадобятся для размещения трех [хостов {{ ZK }}](../concepts/index.md) — по одному в каждой зоне доступности. Подробнее см. в разделе [Взаимосвязь ресурсов сервиса](../concepts/index.md). {% endnote %} @@ -79,6 +95,13 @@ 1. Укажите количество хостов-брокеров {{ KF }} для размещения в каждой выбранной зоне доступности. При выборе количества хостов учтите следующие особенности: + * В версиях {{ KF }} 3.6 и выше [количество хостов-брокеров зависит](#zk-vs-kraft) от выбранных зон доступности: + + * Одна зона доступности — один или три хоста-брокера. Чтобы использовать три хоста-брокера, включите настройку **{{ ui-key.yacloud.kafka.field_kraft-combined-mode }}**. + * Три зоны доступности — один хост-брокер. + + Задать количество хостов-брокеров вручную нельзя. + * Репликация возможна при наличии как минимум двух хостов в кластере {{ mkf-name }}. @@ -86,7 +109,7 @@ * Для отказоустойчивости кластера {{ mkf-name }} должны выполняться [определенные условия](../concepts/index.md#fault-tolerance). - * Добавление в кластер {{ mkf-name }} более одного хоста приведет к автоматическому добавлению трех хостов {{ ZK }}. + * Добавление в кластер с версией {{ KF }} 3.5 или ниже более одного хоста приведет к автоматическому добавлению трех хостов {{ ZK }}. 1. (Опционально) Выберите группы [выделенных хостов](../../compute/concepts/dedicated-host.md), на которых будет размещен кластер {{ mkf-name }}. @@ -94,7 +117,7 @@ {% include [Dedicated hosts note](../../_includes/mdb/mkf/note-dedicated-hosts.md) %} - 1. Если вы указали более одного хоста-брокера, то в блоке **{{ ui-key.yacloud.kafka.section_zookeeper-resources }}** укажите характеристики [хостов {{ ZK }}](../concepts/index.md) для размещения в каждой выбранной зоне доступности. + 1. Если вы создаете кластер с версией {{ KF }} 3.5 или ниже и указали более одного хоста-брокера, то в блоке **{{ ui-key.yacloud.kafka.section_zookeeper-resources }}** укажите характеристики [хостов {{ ZK }}](../concepts/index.md) для размещения в каждой выбранной зоне доступности. 1. При необходимости задайте дополнительные настройки кластера {{ mkf-name }}: {% include [extra-settings](../../_includes/mdb/mkf/extra-settings.md) %} @@ -109,6 +132,12 @@ {% include [default-catalogue](../../_includes/default-catalogue.md) %} + {% note warning %} + + При создании кластера с {{ kraft-short-name }} не указывайте настройки {{ ZK }}. + + {% endnote %} + Чтобы создать кластер {{ mkf-name }}: 1. Посмотрите описание команды CLI для создания кластера {{ mkf-name }}: @@ -127,7 +156,8 @@ --version <версия> \ --network-name <имя_сети> \ --subnet-ids <идентификаторы_подсетей> \ - --brokers-count <количество_брокеров_в_зоне> \ + --zone-ids <зоны_доступности> \ + --brokers-count <количество_хостов-брокеров_в_зоне> \ --resource-preset <класс_хоста> \ --disk-type \ --disk-size <размер_хранилища_ГБ> \ @@ -140,10 +170,18 @@ Где: * `--environment` — окружение кластера: `prestable` или `production`. - * `--version` — версия {{ KF }}: {{ versions.cli.str-without-latest }}. + * `--version` — версия {{ KF }}: 2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5 или 3.6. + * `--zone-ids` и `--brokers-count` — зоны доступности и число хостов-брокеров в каждой зоне. + + Для [кластеров с версией {{ KF }} 3.6 и выше](#zk-vs-kraft) доступны только следующие конфигурации: + + * `--zone-ids={{ region-id }}-a,{{ region-id }}-b,{{ region-id }}-d --brokers-count=1`; + * `--zone-ids=<одна_зона_доступности> --brokers-count=1`; + * `--zone-ids=<одна_зона_доступности> --brokers-count=3`. + * `--resource-preset` — [класс хостов](../concepts/instance-types.md). * `--disk-type` — [тип диска](../concepts/storage.md). - + {% include [storages-type-no-change](../../_includes/mdb/storages-type-no-change.md) %} * {% include [deletion-protection](../../_includes/mdb/cli/deletion-protection.md) %} @@ -203,6 +241,12 @@ {% include [terraform-install](../../_includes/terraform-install.md) %} + {% note warning %} + + При создании кластера с {{ kraft-short-name }} не указывайте настройки {{ ZK }}. + + {% endnote %} + Чтобы создать кластер {{ mkf-name }}: 1. Опишите в конфигурационном файле создаваемые ресурсы: * Кластер {{ mkf-name }} — описание кластера и его хостов. При необходимости здесь же можно задать [настройки {{ KF }}](../concepts/settings-list.md#cluster-settings). @@ -225,9 +269,10 @@ deletion_protection = <защита_от_удаления> config { - assign_public_ip = "<публичный_доступ>" - brokers_count = <количество_брокеров> version = "<версия>" + zones = ["<зоны_доступности>"] + brokers_count = <количество_хостов-брокеров> + assign_public_ip = "<публичный_доступ>" schema_registry = "<управление_схемами_данных>" kafka { resources { @@ -237,10 +282,6 @@ } kafka_config {} } - - zones = [ - "<зоны_доступности>" - ] } } @@ -262,13 +303,20 @@ Где: * `environment` — окружение кластера: `PRESTABLE` или `PRODUCTION`. + * `version` — версия {{ KF }}: 2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5 или 3.6. + * `zones` и `brokers_count` — зоны доступности и число хостов-брокеров в каждой зоне. + + Если вы создаете [кластер с версией {{ KF }} 3.6 и выше](#zk-vs-kraft), укажите одну из доступных конфигураций: + + * `zones = ["{{ region-id }}-a","{{ region-id }}-b","{{ region-id }}-d"] brokers_count = 1`; + * `zones = ["<одна_зона_доступности>"] brokers_count = 1`; + * `zones = ["<одна_зона_доступности>"] brokers_count = 3`. + * `deletion_protection` — защита от удаления кластера: `true` или `false`. * `assign_public_ip` — публичный доступ к кластеру: `true` или `false`. - * `version` — версия {{ KF }}: {{ versions.tf.str-without-latest }}. * `schema_registry` — управление схемами данных: `true` или `false`. - {% include [deletion-protection-limits-data](../../_includes/mdb/deletion-protection-limits-data.md) %} {% include [Maintenance window](../../_includes/mdb/mkf/terraform/maintenance-window.md) %} @@ -289,10 +337,24 @@ - API {#api} + {% note warning %} + + При создании кластера с {{ kraft-short-name }} не указывайте настройки {{ ZK }}. + + {% endnote %} + Чтобы создать кластер {{ mkf-name }}, воспользуйтесь методом REST API [create](../api-ref/Cluster/create.md) для ресурса [Cluster](../api-ref/Cluster/index.md) или вызовом gRPC API [ClusterService/Create](../api-ref/grpc/Cluster/create.md) и передайте в запросе: + * Идентификатор [каталога](../../resource-manager/concepts/resources-hierarchy.md#folder), в котором должен быть размещен кластер {{ mkf-name }}, в параметре `folderId`. * Имя кластера {{ mkf-name }} в параметре `name`. - * Версию {{ KF }}: {{ versions.cli.str-without-latest }} — в параметре `configSpec.version`. + * Окружение: `PRESTABLE` или `PRODUCTION` — в параметре `environment`. + * Версию {{ KF }}: 2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5 или 3.6. — в параметре `configSpec.version`. + * Зоны доступности в параметре `configSpec.zoneId`. + При создании [кластера с версией {{ KF }} 3.6 и выше](#zk-vs-kraft) можно указать только одну или три зоны доступности. + * Количество хостов-брокеров в параметре `configSpec.brokersCount`. + При создании [кластера с версией {{ KF }} 3.6 и выше](#zk-vs-kraft) можно указать только один или три хоста-брокера: + * Если в параметре `configSpec.zoneId` указаны три зоны доступности, укажите количество хостов-брокеров `1`. + * Если в параметре `configSpec.zoneId` указана одна зона доступности, укажите количество хостов-брокеров `1` или `3`. * Идентификаторы [групп безопасности](../../vpc/concepts/security-groups.md) в параметре `securityGroupIds`. @@ -320,252 +382,41 @@ {% endlist %} -## Создать кластер с версией {{ KF }} 3.6 или выше {#higher-version} +Чтобы убедиться, что созданный кластер с версией {{ KF }} 3.6 или выше использует протокол {{ kraft-short-name }}, получите информацию о хостах кластера: -В кластерах {{ mkf-name }} с версией {{ KF }} 3.6 и выше поддержан протокол [{{ kraft-name }}](../concepts/kraft.md) (сокращенно {{ kraft-short-name }}). Он используется для хранения метаданных вместо {{ ZK }}. - -Создать кластер с {{ kraft-short-name }} можно только с определенной конфигурацией и не во всех интерфейсах {{ yandex-cloud }}. Поэтому процесс создания кластера отличается для версий {{ KF }} 3.6 и выше. - -{% note warning %} - -При создании кластера с {{ kraft-short-name }} не указывайте настройки {{ ZK }}. +{% list tabs group=instructions %} -{% endnote %} +- Консоль управления {#console} -{% list tabs group=instructions %} + 1. В [консоли управления]({{ link-console-main }}) перейдите в нужный каталог. + 1. В списке сервисов выберите **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-kafka }}**. + 1. Нажмите на имя созданного кластера. + 1. На панели слева выберите **{{ ui-key.yacloud.mdb.cluster.hosts.label_title }}**. -* CLI {#cli} +- CLI {#cli} {% include [cli-install](../../_includes/cli-install.md) %} {% include [default-catalogue](../../_includes/default-catalogue.md) %} - Чтобы создать кластер {{ mkf-name }}: + Чтобы получить список хостов кластера {{ mkf-name }}: - 1. Посмотрите описание команды CLI для создания кластера {{ mkf-name }}: + 1. Посмотрите описание команды CLI для получения списка хостов кластера {{ mkf-name }}: ```bash - {{ yc-mdb-kf }} cluster create --help + {{ yc-mdb-kf }} cluster list-hosts --help ``` - - 1. Укажите параметры кластера {{ mkf-name }} в команде создания (в примере приведены не все параметры): + 1. Получите список хостов кластера: ```bash - {{ yc-mdb-kf }} cluster create \ - --name <имя_кластера> \ - --environment prestable \ - --version 3.6 \ - --network-name <имя_сети> \ - --subnet-ids <идентификаторы_подсетей> \ - --zone-ids <зоны_доступности> \ - --brokers-count <количество_брокеров_в_зоне> \ - --resource-preset <класс_хоста> \ - --disk-type \ - --disk-size <размер_хранилища_ГБ> \ - --assign-public-ip <публичный_доступ> \ - --security-group-ids <список_идентификаторов_групп_безопасности> \ - --deletion-protection - ``` - - Где: - - * `--environment` — окружение кластера `prestable`. Только в этом окружении поддержана версия {{ KF }} 3.6. - * `--version` — версия {{ KF }} {{ versions.cli.latest }}. - * `--zone-ids` и `--brokers-count` — зоны доступности и число брокеров в каждой зоне. Укажите одну из доступных конфигураций: - - * `--zone-ids={{ region-id }}-a,{{ region-id }}-b,{{ region-id }}-d --brokers-count=1`; - * `--zone-ids=<одна_зона_доступности> --brokers-count=3`. - - * `--resource-preset` — [класс хостов](../concepts/instance-types.md). - * `--disk-type` — [тип диска](../concepts/storage.md). - - {% include [storages-type-no-change](../../_includes/mdb/storages-type-no-change.md) %} - - * {% include [deletion-protection](../../_includes/mdb/cli/deletion-protection.md) %} - - {% include [deletion-protection-limits-data](../../_includes/mdb/deletion-protection-limits-data.md) %} - - {% note tip %} - - При необходимости здесь же можно задать [настройки {{ KF }}](../concepts/settings-list.md#cluster-settings). - - {% endnote %} - - 1. Чтобы настроить время [технического обслуживания](../concepts/maintenance.md) (в т. ч. для выключенных кластеров {{ mkf-name }}), передайте нужное значение в параметре `--maintenance-window` при создании кластера: - - ```bash - {{ yc-mdb-kf }} cluster create \ - ... - --maintenance-window type=<тип_технического_обслуживания>,` - `day=<день_недели>,` - `hour=<час_дня> - ``` - - Где `type` — тип технического обслуживания: - - {% include [maintenance-window](../../_includes/mdb/cli/maintenance-window-description.md) %} - - 1. Чтобы в кластере не заканчивалось место на диске, создайте кластер с [автоматическим увеличением размера хранилища](../concepts/storage.md#auto-rescale): - - ```bash - {{ yc-mdb-kf }} cluster create \ - ... - --disk-size-autoscaling disk-size-limit=<максимальный_размер_хранилища_в_байтах>,` - `planned-usage-threshold=<процент_для_планового_увеличения>,` - `emergency-usage-threshold=<процент_для_незамедлительного_увеличения> - ``` - - {% include [description-of-parameters](../../_includes/mdb/mkf/disk-auto-scaling.md) %} - - {% include [warn-storage-resize](../../_includes/mdb/mpg/warn-storage-resize.md) %} - - - - 1. Чтобы создать кластер {{ mkf-name }}, размещенный на группах [выделенных хостов](../../compute/concepts/dedicated-host.md), укажите через запятую их идентификаторы в параметре `--host-group-ids` при создании кластера: - - ```bash - {{ yc-mdb-kf }} cluster create \ - ... - --host-group-ids <идентификаторы_групп_выделенных_хостов> - ``` - - {% include [Dedicated hosts note](../../_includes/mdb/mkf/note-dedicated-hosts.md) %} - - -* {{ TF }} {#tf} - - {% include [terraform-definition](../../_tutorials/_tutorials_includes/terraform-definition.md) %} - - {% include [terraform-install](../../_includes/terraform-install.md) %} - - Чтобы создать кластер {{ mkf-name }}: - - 1. Опишите в конфигурационном файле создаваемые ресурсы: - - * Кластер {{ mkf-name }} — описание кластера и его хостов. При необходимости здесь же можно задать [настройки {{ KF }}](../concepts/settings-list.md#cluster-settings). - - * {% include [Terraform network description](../../_includes/mdb/terraform/network.md) %} - - * {% include [Terraform subnet description](../../_includes/mdb/terraform/subnet.md) %} - - Пример структуры конфигурационного файла: - - ```hcl - resource "yandex_mdb_kafka_cluster" "<имя_кластера>" { - environment = "PRESTABLE" - name = "<имя_кластера>" - network_id = "<идентификатор_сети>" - subnet_ids = ["<идентификаторы_подсетей>"] - security_group_ids = ["<идентификаторы_групп_безопасности>"] - deletion_protection = <защита_от_удаления> - - config { - version = "3.6" - zones = ["<зоны_доступности>"] - brokers_count = <количество_брокеров> - assign_public_ip = "<публичный_доступ>" - schema_registry = "<управление_схемами_данных>" - kafka { - resources { - disk_size = <размер_хранилища_ГБ> - disk_type_id = "<тип_диска>" - resource_preset_id = "<класс_хоста>" - } - kafka_config {} - } - } - } - - resource "yandex_vpc_network" "<имя_сети>" { - name = "<имя_сети>" - } - - resource "yandex_vpc_subnet" "<имя_подсети>" { - name = "<имя_подсети>" - zone = "<зона_доступности>" - network_id = "<идентификатор_сети>" - v4_cidr_blocks = ["<диапазон>"] - } + {{ yc-mdb-kf }} cluster list-hosts <имя_или_идентификатор_кластера> ``` - Где: - - * `environment` — окружение кластера `PRESTABLE`. Только в этом окружении поддержана версия {{ KF }} 3.6. - * `deletion_protection` — защита от удаления кластера: `true` или `false`. - * `version` — версия {{ KF }} {{ versions.tf.latest }}. - * `zones` и `brokers_count` — зоны доступности и число брокеров в каждой зоне. Укажите одну из доступных конфигураций: - - * `zones = ["{{ region-id }}-a","{{ region-id }}-b","{{ region-id }}-d"] brokers_count = 1`; - * `zones = ["<одна_зона_доступности>"] brokers_count = 3`. - - * `assign_public_ip` — публичный доступ к кластеру: `true` или `false`. - * `schema_registry` — управление схемами данных: `true` или `false`. - - {% include [deletion-protection-limits-data](../../_includes/mdb/deletion-protection-limits-data.md) %} - - {% include [Maintenance window](../../_includes/mdb/mkf/terraform/maintenance-window.md) %} - - 1. Проверьте корректность настроек. - - {% include [terraform-validate](../../_includes/mdb/terraform/validate.md) %} - - 1. Создайте кластер {{ mkf-name }}. - - {% include [terraform-apply](../../_includes/mdb/terraform/apply.md) %} - - После этого в указанном каталоге будут созданы все требуемые ресурсы, а в терминале отобразятся [FQDN хостов кластера {{ mkf-name }}](../concepts/network.md#hostname). Проверить появление ресурсов и их настройки можно в [консоли управления]({{ link-console-main }}). - - Подробнее см. в [документации провайдера {{ TF }}]({{ tf-provider-resources-link }}/mdb_kafka_cluster). - - {% include [Terraform timeouts](../../_includes/mdb/mkf/terraform/cluster-timeouts.md) %} - -* API {#api} - - Чтобы создать кластер {{ mkf-name }}, воспользуйтесь методом REST API [create](../api-ref/Cluster/create.md) для ресурса [Cluster](../api-ref/Cluster/index.md) или вызовом gRPC API [ClusterService/Create](../api-ref/grpc/Cluster/create.md) и передайте в запросе: - - * Идентификатор [каталога](../../resource-manager/concepts/resources-hierarchy.md#folder), в котором должен быть размещен кластер {{ mkf-name }}, в параметре `folderId`. - * Имя кластера {{ mkf-name }} в параметре `name`. - * Окружение `PRESTABLE` в параметре `environment`. - * Версию {{ KF }} 3.6 в параметре `configSpec.version`. - * Зоны доступности в параметре `configSpec.zoneId`. Можно указать одну или три зоны доступности. - * Количество хостов-брокеров в параметре `configSpec.brokersCount`. Если указана одна зона доступности, передайте количество брокеров 3. В случае трех зон доступности укажите количество брокеров 1. - - - * Идентификаторы [групп безопасности](../../vpc/concepts/security-groups.md) в параметре `securityGroupIds`. - - - * Настройки времени [технического обслуживания](../concepts/maintenance.md) (в т. ч. для выключенных кластеров {{ mkf-name }}) в параметре `maintenanceWindow`. - * Настройки защиты от удаления кластера {{ mkf-name }} в параметре `deletionProtection`. - - {% include [deletion-protection-limits](../../_includes/mdb/deletion-protection-limits-data.md) %} - - Чтобы управлять схемами данных с помощью [{{ mkf-msr }}](../concepts/managed-schema-registry.md), передайте значение `true` для параметра `configSpec.schemaRegistry`. Эту настройку невозможно изменить после создания кластера {{ mkf-name }}. - - - - Чтобы создать кластер {{ mkf-name }}, размещенный на группах [выделенных хостов](../../compute/concepts/dedicated-host.md), передайте список их идентификаторов в параметре `hostGroupIds`. - - {% include [Dedicated hosts note](../../_includes/mdb/mkf/note-dedicated-hosts.md) %} - - - Чтобы в кластере не заканчивалось место на диске, создайте кластер с [автоматическим увеличением размера хранилища](../concepts/storage.md#auto-rescale). Для этого передайте в запросе: - - {% include [api-storage-resize](../../_includes/mdb/mpg/api-storage-resize.md) %} - - {% include [warn-storage-resize](../../_includes/mdb/mpg/warn-storage-resize.md) %} - -{% endlist %} - -Чтобы убедиться, что созданный кластер использует протокол {{ kraft-short-name }}, получите информацию о хостах кластера: - -{% list tabs group=instructions %} +- API {#api} -* Консоль управления {#console} + Чтобы получить список хостов кластера {{ mkf-name }}, воспользуйтесь методом REST API [listHosts](../api-ref/Cluster/listHosts.md) для ресурса [Cluster](../api-ref/Cluster/index.md) или вызовом gRPC API [ClusterService/ListHosts](../api-ref/grpc/Cluster/listHosts.md) и передайте в запросе идентификатор кластера. - 1. В [консоли управления]({{ link-console-main }}) перейдите в нужный каталог. - 1. В списке сервисов выберите **{{ ui-key.yacloud.iam.folder.dashboard.label_managed-kafka }}**. - 1. Нажмите на имя созданного кластера. - 1. На панели слева выберите **{{ ui-key.yacloud.mdb.cluster.hosts.label_title }}**. + Чтобы узнать идентификатор кластера, [получите список кластеров в каталоге](./cluster-list.md#list-clusters). {% endlist %} @@ -664,7 +515,7 @@ * В подсети с идентификатором `{{ subnet-id }}`. * В группе безопасности `{{ security-group }}`. * С одним хостом класса `{{ host-class }}`, в зоне доступности `{{ region-id }}-a`. - * С одним брокером. + * С одним хостом-брокером. * С хранилищем на сетевых SSD-дисках (`{{ disk-type-example }}`) объемом 10 ГБ. * С публичным доступом. * С защитой от случайного удаления кластера {{ mkf-name }}. @@ -706,7 +557,7 @@ * С одним хостом класса `{{ host-class }}`, в зоне доступности `{{ region-id }}-a`. - * С одним брокером. + * С одним хостом-брокером. * С хранилищем на сетевых SSD-дисках (`{{ disk-type-example }}`) объемом 10 ГБ. * С публичным доступом. * С защитой от случайного удаления кластера {{ mkf-name }}. diff --git a/ru/managed-kafka/operations/cluster-version-update.md b/ru/managed-kafka/operations/cluster-version-update.md index 9e4d059875c..4e9454a0cd5 100644 --- a/ru/managed-kafka/operations/cluster-version-update.md +++ b/ru/managed-kafka/operations/cluster-version-update.md @@ -1,6 +1,6 @@ # Обновление версии {{ KF }} -Вы можете обновить кластер {{ mkf-name }} до версии 3.5 или ниже. Обновление до версии 3.6 и выше не поддерживается, но можно [создать кластер](cluster-create.md#higher-version) с одной из таких версий. +Вы можете обновить кластер {{ mkf-name }} до версии 3.5 или ниже. Обновление до версии 3.6 и выше не поддерживается, но можно [создать кластер](cluster-create.md#create-cluster) с одной из таких версий. Рекомендуется обновлять версию {{ KF }} поэтапно, без пропуска версий. Например, обновление версии с 2.8 до 3.1 выполняется в такой последовательности: 2.8 → 3.0 → 3.1. diff --git a/ru/managed-kafka/operations/connect/clients.md b/ru/managed-kafka/operations/connect/clients.md index e93f2bdbcce..7612e3242ae 100644 --- a/ru/managed-kafka/operations/connect/clients.md +++ b/ru/managed-kafka/operations/connect/clients.md @@ -19,6 +19,7 @@ description: Следуя этой инструкции, вы сможете п Примеры для Linux проверялись в следующем окружении: * Виртуальная машина в {{ yandex-cloud }} с Ubuntu 20.04 LTS. +* OpenJDK: `11.0.24`. * Bash: `5.0.16`. Примеры для Windows проверялись в следующем окружении: @@ -31,9 +32,9 @@ description: Следуя этой инструкции, вы сможете п {% include [see-fqdn-in-console](../../../_includes/mdb/see-fqdn-in-console.md) %} -### Linux (Bash)/macOS (Zsh) {#bash-zsh} +### kafkacat {#bash-zsh} -Для подключения к кластеру {{ KF }} из командной строки используйте утилиту `kafkacat` — приложение с открытым исходным кодом, которое может работать как универсальный производитель или потребитель данных. Подробнее читайте в [документации](https://github.com/edenhill/kafkacat). +Утилита [kafkacat](https://github.com/edenhill/kcat) (второе название `kcat`) — приложение с открытым исходным кодом, которое может работать как универсальный производитель или потребитель данных и не требует установки Java Runtime Environment. Перед подключением установите зависимости: @@ -90,7 +91,114 @@ sudo apt update && sudo apt install -y kafkacat {% include [shell-howto](../../../_includes/mdb/mkf/connstr-shell-howto.md) %} -### Windows (PowerShell) {#powershell} +### Инструменты {{ KF }} для Linux (Bash)/macOS (Zsh) {#kafka-sh} + +{% include [kafka-cli-tools-intro](../../../_includes/mdb/mkf/kafka-cli-tools-intro.md) %} + +Перед подключением: + +1. Установите OpenJDK: + + ```bash + sudo apt update && sudo apt install --yes default-jdk + ``` + +1. Загрузите [архив с бинарными файлами](https://kafka.apache.org/downloads) для версии {{ KF }}, которая используется в кластере. Версия Scala неважна. + +1. Распакуйте архив. + +{% list tabs group=connection %} + +- Подключение без SSL {#without-ssl} + + 1. {% include [connect-properties-no-ssl](../../../_includes/mdb/mkf/connect-properties-no-ssl.md) %} + + 1. Запустите команду получения сообщений из топика: + + ```bash + <путь_к_директории_с_файлами_Apache_Kafka>/bin/kafka-console-consumer.sh \ + --consumer.config <путь_к_файлу_с_параметрами_для_потребителя> \ + --bootstrap-server :9092 \ + --topic <имя_топика> \ + --property print.key=true \ + --property key.separator=":" + ``` + + Команда будет непрерывно считывать новые сообщения из топика. + + 1. В отдельном терминале запустите команду отправки сообщения в топик: + + ```bash + echo "key:test message" | <путь_к_директории_с_файлами_Apache_Kafka>/bin/kafka-console-producer.sh \ + --producer.config <путь_к_файлу_с_параметрами_для_производителя> \ + --bootstrap-server :9092 \ + --topic <имя_топика> \ + --property parse.key=true \ + --property key.separator=":" + ``` + +- Подключение с SSL {#with-ssl} + + 1. Перейдите в каталог, где будет располагаться хранилище сертификатов Java: + + ```bash + cd /etc/security + ``` + + 1. {% include [keytool-importcert](../../../_includes/mdb/keytool-importcert.md) %} + + 1. Создайте файлы с параметрами для подключения к кластеру: файл для производителя и файл для потребителя. + + Эти файлы имеют одинаковое содержимое, различаются только реквизиты пользователя: + + ```ini + sasl.mechanism=SCRAM-SHA-512 + sasl.jaas.config=org.apache.kafka.common.security.scram.ScramLoginModule required \ + username="<логин_производителя_или_потребителя>" \ + password="<пароль_производителя_или_потребителя>"; + security.protocol=SASL_SSL + ssl.truststore.location=/etc/security/ssl + ssl.truststore.password=<пароль_хранилища_сертификатов> + ``` + + 1. Запустите команду получения сообщений из топика: + + ```bash + <путь_к_директории_с_файлами_Apache_Kafka>/bin/kafka-console-consumer.sh \ + --consumer.config <путь_к_файлу_с_параметрами_для_потребителя> \ + --bootstrap-server :9091 \ + --topic <имя_топика> \ + --property print.key=true \ + --property key.separator=":" + ``` + + Команда будет непрерывно считывать новые сообщения из топика. + + 1. В отдельном терминале запустите команду отправки сообщения в топик: + + ```bash + echo "key:test message" | <путь_к_директории_с_файлами_Apache_Kafka>/bin/kafka-console-producer.sh \ + --producer.config <путь_к_файлу_с_параметрами_для_производителя> \ + --bootstrap-server :9091 \ + --topic <имя_топика> \ + --property parse.key=true \ + --property key.separator=":" + ``` + +{% endlist %} + +{% include [fqdn](../../../_includes/mdb/mkf/fqdn-host.md) %} + +{% include [shell-howto](../../../_includes/mdb/mkf/connstr-shell-howto.md) %} + +### Инструменты {{ KF }} для Windows (PowerShell) {#powershell} + +{% include [kafka-cli-tools-intro](../../../_includes/mdb/mkf/kafka-cli-tools-intro.md) %} + +Хотя документация по инструментам содержит упоминание скриптов `.sh`, она актуальна и при работе в Windows. Сами инструменты одинаковы для любой платформы, различаются лишь скрипты, которые запускают их, например: + +* `bin/kafka-console-producer.sh` для Linux (Bash)/macOS (Zsh). +* `bin\windows\kafka-console-producer.bat` для Windows (PowerShell). Перед подключением: @@ -112,17 +220,17 @@ sudo apt update && sudo apt install -y kafkacat - Подключение без SSL {#without-ssl} + 1. {% include [connect-properties-no-ssl](../../../_includes/mdb/mkf/connect-properties-no-ssl.md) %} + 1. Запустите команду получения сообщений из топика: ```powershell <путь_к_директории_с_файлами_Apache_Kafka>\bin\windows\kafka-console-consumer.bat ` + --consumer.config <путь_к_файлу_с_параметрами_для_потребителя> ` --bootstrap-server :9092 ` --topic <имя_топика> ` --property print.key=true ` - --property key.separator=":" ` - --consumer-property security.protocol=SASL_PLAINTEXT ` - --consumer-property sasl.mechanism=SCRAM-SHA-512 ` - --consumer-property sasl.jaas.config="org.apache.kafka.common.security.scram.ScramLoginModule required username='<логин_потребителя>' password='<пароль_потребителя>';" + --property key.separator=":" ``` Команда будет непрерывно считывать новые сообщения из топика. @@ -131,14 +239,11 @@ sudo apt update && sudo apt install -y kafkacat ```powershell echo "key:test message" | <путь_к_директории_с_файлами_Apache_Kafka>\bin\windows\kafka-console-producer.bat ` + --producer.config <путь_к_файлу_с_параметрами_для_производителя> ` --bootstrap-server :9092 ` --topic <имя_топика> ` --property parse.key=true ` - --property key.separator=":" ` - --producer-property acks=all ` - --producer-property security.protocol=SASL_PLAINTEXT ` - --producer-property sasl.mechanism=SCRAM-SHA-512 ` - --producer-property sasl.jaas.config="org.apache.kafka.common.security.scram.ScramLoginModule required username='<логин_производителя>' password='<пароль_производителя>';" + --property key.separator=":" ``` - Подключение с SSL {#with-ssl} @@ -153,19 +258,47 @@ sudo apt update && sudo apt install -y kafkacat --noprompt ``` + 1. Создайте файлы с параметрами для подключения к кластеру: файл для производителя и файл для потребителя. + + Эти файлы имеют одинаковое содержимое, различаются только реквизиты пользователя: + + ```ini + sasl.mechanism=SCRAM-SHA-512 + sasl.jaas.config=org.apache.kafka.common.security.scram.ScramLoginModule required \ + username="<логин_производителя_или_потребителя>" \ + password="<пароль_производителя_или_потребителя>"; + security.protocol=SASL_SSL + ssl.truststore.location=<значение_переменной_$HOME>\\.kafka\\ssl + ssl.truststore.password=<пароль_хранилища_сертификатов> + ``` + + В качестве значения параметра `ssl.truststore.location` укажите полный путь к хранилищу сертификатов, например: + + ```ini + ssl.truststore.location=C:\\Users\\Administrator\\.kafka\\ssl + ``` + + Хранилище сертификатов расположено по пути `$HOME\.kafka\ssl`, но в значении нельзя использовать переменные среды окружения. Чтобы раскрыть переменную, выполните команду: + + ```powershell + echo $HOME + ``` + + {% note warning %} + + Используйте `\\` вместо `\` при указании значения параметра `ssl.truststore.location`, иначе при запуске команд не удастся получить доступ к хранилищу сертификатов. + + {% endnote %} + 1. Запустите команду получения сообщений из топика: ```powershell <путь_к_директории_с_файлами_Apache_Kafka>\bin\windows\kafka-console-consumer.bat ` + --consumer.config <путь_к_файлу_с_параметрами_для_потребителя> ` --bootstrap-server :9091 ` --topic <имя_топика> ` --property print.key=true ` - --property key.separator=":" ` - --consumer-property security.protocol=SASL_SSL ` - --consumer-property sasl.mechanism=SCRAM-SHA-512 ` - --consumer-property ssl.truststore.location=$HOME\.kafka\ssl ` - --consumer-property ssl.truststore.password=<пароль_хранилища_сертификатов> ` - --consumer-property sasl.jaas.config="org.apache.kafka.common.security.scram.ScramLoginModule required username='<логин_потребителя>' password='<пароль_потребителя>';" + --property key.separator=":" ``` Команда будет непрерывно считывать новые сообщения из топика. @@ -174,16 +307,11 @@ sudo apt update && sudo apt install -y kafkacat ```powershell echo "key:test message" | <путь_к_директории_с_файлами_Apache_Kafka>\bin\windows\kafka-console-producer.bat ` + --producer.config <путь_к_файлу_с_параметрами_для_производителя> ` --bootstrap-server :9091 ` --topic <имя_топика> ` --property parse.key=true ` - --property key.separator=":" ` - --producer-property acks=all ` - --producer-property security.protocol=SASL_SSL ` - --producer-property sasl.mechanism=SCRAM-SHA-512 ` - --producer-property ssl.truststore.location=$HOME\.kafka\ssl ` - --producer-property ssl.truststore.password=<пароль_хранилища_сертификатов> ` - --producer-property sasl.jaas.config="org.apache.kafka.common.security.scram.ScramLoginModule required username='<логин_производителя>' password='<пароль_производителя>';" + --property key.separator=":" ``` {% endlist %} diff --git a/ru/managed-kubernetes/index.yaml b/ru/managed-kubernetes/index.yaml index 4775db59677..6877520eea0 100644 --- a/ru/managed-kubernetes/index.yaml +++ b/ru/managed-kubernetes/index.yaml @@ -42,7 +42,7 @@ links: href: concepts/ - title: Справочник API (англ.) description: Описание методов HTTP API - href: api-ref/ + href: managed-kubernetes/api-ref/ - title: Квоты и лимиты description: Технические и организационные ограничения сервиса href: concepts/limits diff --git a/ru/managed-kubernetes/operations/applications/crossplane.md b/ru/managed-kubernetes/operations/applications/crossplane.md index ac732af2476..64d3109d731 100644 --- a/ru/managed-kubernetes/operations/applications/crossplane.md +++ b/ru/managed-kubernetes/operations/applications/crossplane.md @@ -27,7 +27,7 @@ 1. Задайте настройки приложения: * **Пространство имен** — выберите [пространство имен](../../concepts/index.md#namespace) для Crossplane или создайте новое. * **Название приложения** — укажите название приложения. - * **Ключ сервисной учетной записи** — вставьте содержимое файла [ключа сервисной учетной записи](../../../iam/concepts/authorization/access-key.md), [полученного ранее](#before-you-begin), или создайте новый. + * **Ключ сервисного аккаунта** — вставьте содержимое файла [ключа сервисного аккаунта](../../../iam/concepts/authorization/access-key.md), [полученного ранее](#before-you-begin), или создайте новый. 1. Нажмите кнопку **{{ ui-key.yacloud.k8s.cluster.marketplace.button_install }}**. 1. Дождитесь перехода приложения в статус `Deployed`. @@ -45,7 +45,7 @@ helm install \ --namespace <пространство_имен> \ --create-namespace \ - --set-file providerJetYC.creds=key.json \ + --set-file providerJetYc.creds=key.json \ crossplane ./crossplane/ ``` diff --git a/ru/managed-kubernetes/operations/applications/loki.md b/ru/managed-kubernetes/operations/applications/loki.md index e15d5655e48..2d091b06535 100644 --- a/ru/managed-kubernetes/operations/applications/loki.md +++ b/ru/managed-kubernetes/operations/applications/loki.md @@ -16,22 +16,13 @@ 1. Подготовьтесь к установке Loki: 1. [Создайте сервисный аккаунт](../../../iam/operations/sa/create.md) с [ролями](../../../iam/concepts/access-control/roles.md) `storage.uploader` и `storage.viewer`. Он необходим для доступа к [{{ objstorage-full-name }}](../../../storage/). - 1. [Создайте статический ключ доступа](../../../iam/operations/sa/create-access-key.md) для [сервисного аккаунта](../../../iam/concepts/users/service-accounts.md): + 1. [Создайте статический ключ доступа](../../../iam/operations/sa/create-access-key.md) для [сервисного аккаунта](../../../iam/concepts/users/service-accounts.md) в формате JSON: - * Если установка Loki будет выполняться с помощью [{{ marketplace-full-name }}](#marketplace-install), создайте статический ключ в формате JSON и сохраните его в файл `sa-key.json`: - - ```bash - yc iam access-key create \ - --service-account-name=<имя_сервисного_аккаунта> \ - --format=json > sa-key.json - ``` - - * Если установка Loki будет выполняться с помощью [Helm-чарта](#helm-install), выполните команду и сохраните полученные идентификатор ключа (`key_id`) и секретный ключ (`secret`): - - ```bash - yc iam access-key create \ - --service-account-name=<имя_сервисного_аккаунта> - ``` + ```bash + yc iam access-key create \ + --service-account-name=<имя_сервисного_аккаунта> \ + --format=json > sa-key.json + ``` 1. [Создайте бакет](../../../storage/operations/buckets/create.md) с ограниченным доступом в {{ objstorage-name }}. @@ -50,7 +41,6 @@ 1. Нажмите кнопку **{{ ui-key.yacloud.k8s.cluster.marketplace.button_install }}**. 1. Дождитесь перехода приложения в статус `Deployed`. -1. После развертывания Loki будет доступен по адресу внутри кластера {{ managed-k8s-name }}: `http://loki-gateway.<пространство_имен>.svc.cluster.local`. ## Установка с помощью Helm-чарта {#helm-install} @@ -67,14 +57,39 @@ helm install \ --namespace <пространство_имен> \ --create-namespace \ - --set loki-distributed.loki.storageConfig.aws.bucketnames=<имя_бакета_Object_Storage> \ - --set loki-distributed.serviceaccountawskeyvalue_generated.accessKeyID=<идентификатор_ключа_сервисного_аккаунта> \ - --set loki-distributed.serviceaccountawskeyvalue_generated.secretAccessKey=<секретный_ключ_сервисного_аккаунта> \ + --set global.bucketname=<имя_бакета> \ + --set-file global.serviceaccountawskeyvalue=<путь_к_файлу_sa-key.json> \ loki ./loki/ ``` {% include [Support OCI](../../../_includes/managed-kubernetes/note-helm-experimental-oci.md) %} +1. Убедитесь, что все поды Loki перешли в состояние `Running`: + + ```bash + kubectl get pods -A -l "app.kubernetes.io/instance=loki" + ``` + +## Подключение к Loki {#loki-connect} + +После развертывания Loki будет доступен внутри кластера {{ managed-k8s-name }} по следующему адресу: + +```text +http://<имя_сервиса_Loki_gateway>.<пространство_имен>.svc.cluster.local +``` + +Чтобы узнать пространство имен и имя сервиса Loki gateway выполните команду: + +```bash +kubectl get service -A | grep distributed-gateway +``` + +Результат: + +```text +test-namespace loki-loki-distributed-gateway ClusterIP 10.96.168.88 80/TCP 15m +``` + ## См. также {#see-also} * [Документация Grafana Loki](https://grafana.com/docs/loki/latest/). diff --git a/ru/managed-kubernetes/operations/calico.md b/ru/managed-kubernetes/operations/calico.md index ba885c43fb9..8cce625efe6 100644 --- a/ru/managed-kubernetes/operations/calico.md +++ b/ru/managed-kubernetes/operations/calico.md @@ -12,9 +12,9 @@ description: Следуя данной инструкции, вы сможете * Регулировать прохождение трафика с помощью настроек DNAT и политик проброса трафика. Чтобы настроить контроллер сетевых политик Calico: -1. [{#T}](#create-pod). -1. [{#T}](#enable-isolation). -1. [{#T}](#create-policy). +1. [Создайте сервис nginx](#create-pod). +1. [Изолируйте поды с помощью сетевых политик](#enable-isolation). +1. [Создайте сетевые политики, разрешающие доступ к сервису](#create-policy). Если созданные ресурсы вам больше не нужны, [удалите их](#clear-out). diff --git a/ru/managed-kubernetes/operations/connect/create-static-conf.md b/ru/managed-kubernetes/operations/connect/create-static-conf.md index 08c8d00b84f..abf20ec40aa 100644 --- a/ru/managed-kubernetes/operations/connect/create-static-conf.md +++ b/ru/managed-kubernetes/operations/connect/create-static-conf.md @@ -279,6 +279,7 @@ ```bash kubectl config set-cluster sa-test2 \ --certificate-authority=ca.pem \ + --embed-certs \ --server=$MASTER_ENDPOINT \ --kubeconfig=test.kubeconfig ``` @@ -290,6 +291,7 @@ ```bash kubectl config set-cluster sa-test2 ` --certificate-authority=ca.pem ` + --embed-certs ` --server=$MASTER_ENDPOINT ` --kubeconfig=test.kubeconfig ``` diff --git a/ru/managed-kubernetes/operations/create-load-balancer.md b/ru/managed-kubernetes/operations/create-load-balancer.md index f337eb2ac99..68b8349ac4c 100644 --- a/ru/managed-kubernetes/operations/create-load-balancer.md +++ b/ru/managed-kubernetes/operations/create-load-balancer.md @@ -34,7 +34,7 @@ title: Обеспечение доступа к приложению, запущ 1. [Создайте сервис типа LoadBalancer с внутренним IP-адресом](#lb-int-create). 1. [Укажите дополнительные параметры сервиса](#advanced). 1. [Укажите параметры проверки состояния узлов](#healthcheck). -1. (Опционально) [{#T}](#network-policy). +1. (Опционально) [Создайте объект NetworkPolicy](#network-policy). {% cut "Как обеспечить доступ к приложению с помощью HTTPS?" %} diff --git a/ru/managed-kubernetes/operations/volumes/mode-block.md b/ru/managed-kubernetes/operations/volumes/mode-block.md index 807ed5cbc15..2b7ed3771a5 100644 --- a/ru/managed-kubernetes/operations/volumes/mode-block.md +++ b/ru/managed-kubernetes/operations/volumes/mode-block.md @@ -2,8 +2,8 @@ Чтобы подключить [том в режиме](../../concepts/volume.md#block) `volumeMode: Block`: -1. [{#T}](#create-pvc). -1. [{#T}](#create-pod). +1. [Создайте объект PersistentVolumeClaim](#create-pvc). +1. [Создайте под с подключенным томом](#create-pod). {% include [Перед началом установите kubectl](../../../_includes/managed-kubernetes/kubectl-before-you-begin.md) %} diff --git a/ru/managed-kubernetes/operations/volumes/s3-csi-integration.md b/ru/managed-kubernetes/operations/volumes/s3-csi-integration.md index 6dee57995ba..c41fd4d30b9 100644 --- a/ru/managed-kubernetes/operations/volumes/s3-csi-integration.md +++ b/ru/managed-kubernetes/operations/volumes/s3-csi-integration.md @@ -287,7 +287,7 @@ accessModes: - ReadWriteMany claimRef: - namespace: defalt + namespace: default name: csi-s3-pvc-static csi: driver: ru.yandex.s3.csi diff --git a/ru/managed-kubernetes/operations/volumes/statefulset-pvc-expansion.md b/ru/managed-kubernetes/operations/volumes/statefulset-pvc-expansion.md index 4ea02042bd4..268b9767262 100644 --- a/ru/managed-kubernetes/operations/volumes/statefulset-pvc-expansion.md +++ b/ru/managed-kubernetes/operations/volumes/statefulset-pvc-expansion.md @@ -7,8 +7,8 @@ description: Следуя данной инструкции, вы сможете Чтобы увеличить размер [тома](../../concepts/volume.md) для контроллера StatefulSet без остановки сервиса: -1. [{#T}](#create-sts). -1. [{#T}](#upgrade-sts). +1. [Создайте контроллер StatefulSet](#create-sts). +1. [Внесите изменения в настройки контроллера](#upgrade-sts). {% include [Перед началом установите kubectl](../../../_includes/managed-kubernetes/kubectl-before-you-begin.md) %} diff --git a/ru/managed-kubernetes/operations/volumes/volume-expansion.md b/ru/managed-kubernetes/operations/volumes/volume-expansion.md index eea2989d700..be3a784cd73 100644 --- a/ru/managed-kubernetes/operations/volumes/volume-expansion.md +++ b/ru/managed-kubernetes/operations/volumes/volume-expansion.md @@ -2,12 +2,12 @@ Чтобы увеличить размер [тома](../../concepts/volume.md): -1. [{#T}](#enabling-expansion). -1. [{#T}](#create-pvc). -1. [{#T}](#create-pod). -1. [{#T}](#restart-pod). -1. [{#T}](#volume-expansion). -1. [{#T}](#restart-pod1). +1. [Включите механизм увеличения размера тома](#enabling-expansion). +1. [Создайте объект PersistentVolumeClaim](#create-pvc). +1. [Создайте под с динамически подготовленным томом](#create-pod). +1. [Удалите под с томом](#restart-pod). +1. [Запросите увеличение размера тома](#volume-expansion). +1. [Удалите под с томом](#delete-pod). {% include [Перед началом установите kubectl](../../../_includes/managed-kubernetes/kubectl-before-you-begin.md) %} @@ -105,7 +105,7 @@ reclaimPolicy: Delete pod/pod created ``` -## Удалите под с томом {#restart-pod} +## Удалите под с томом {#delete-pod} Чтобы запросить увеличение размера тома, необходимо удалить под. 1. Удалите под: diff --git a/ru/managed-kubernetes/release-notes.md b/ru/managed-kubernetes/release-notes.md index 201eaa25ac9..f294986ca9b 100644 --- a/ru/managed-kubernetes/release-notes.md +++ b/ru/managed-kubernetes/release-notes.md @@ -2,6 +2,18 @@ Изменения появляются в [релизных каналах](./concepts/release-channels-and-updates.md) сервиса последовательно. Сначала обновления, содержащие новую функциональность и улучшения, появляются на канале `rapid`, через некоторое время они попадают в `regular` и уже после этого добавляются в `stable`. +## III квартал 2024 {#q3-2024} + +### Новые возможности {#q3-2024-new-features} + +Добавлена поддержка миграции [мастеров](./concepts/index.md#master) между [подсетями](../vpc/concepts/network.md#subnet) внутри одной [зоны доступности](../overview/concepts/geo-scope.md). + +### Исправления и улучшения {#q3-2024-problems-solved} + +* Исправлена ошибка, в результате которой не сохранялись файлы аудитных логов кластера с записями размером более 128 КБ. Включена обрезка записей. +* Проведена ревизия [кластерных ролей](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles) (ClusterRole) контроллера сетевых политик [Cilium](./concepts/network-policy.md#cilium). Оставлены только минимально необходимые права. +* Добавлена проверка полей `subnet-id` при обновлении [группы узлов](./concepts/index.md#node-group) с помощью CLI, {{ TF }} и API. Теперь если в запросе на обновление одновременно указаны параметры `network-interface` и `locations`, требуется, чтобы поля `subnet-id` в `locations` либо были все пустыми, либо полностью совпадали с набором `subnet-id` в `network-interface` (последовательность указания `subnet-id` может быть любой). Если в запросе больше одного элемента в массиве `network-interface`, поля `subnet-id` в `locations` должны быть пустыми. + ## I полугодие 2024 {#h1-2024} ### Новые возможности {#h1-2024-new-features} diff --git a/ru/managed-kubernetes/tutorials/autoscaling.md b/ru/managed-kubernetes/tutorials/autoscaling.md index 61a4434f78c..78db2118fa9 100644 --- a/ru/managed-kubernetes/tutorials/autoscaling.md +++ b/ru/managed-kubernetes/tutorials/autoscaling.md @@ -2,8 +2,11 @@ {{ managed-k8s-name }} поддерживает несколько видов [автоматического масштабирования](../concepts/autoscale.md). Из этой статьи вы узнаете, как настроить автоматическое масштабирование [кластера](../concepts/index.md#kubernetes-cluster) с помощью комбинации {{ k8s-ca }} и {{ k8s-hpa }}. -* [{#T}](#cpu-autoscaling). -* [{#T}](#rps-autoscaling). + +* [Масштабирование от утилизации CPU](#cpu-autoscaling). +* [Масштабирование от количества запросов к приложению](#rps-autoscaling). + +Если созданные ресурсы вам больше не нужны, [удалите их](#clear-out). {% note warning %} diff --git a/ru/managed-kubernetes/tutorials/custom-dns.md b/ru/managed-kubernetes/tutorials/custom-dns.md index 2a5dc3578a8..eb47fb1b623 100644 --- a/ru/managed-kubernetes/tutorials/custom-dns.md +++ b/ru/managed-kubernetes/tutorials/custom-dns.md @@ -7,9 +7,11 @@ description: Следуя данному руководству, вы сможе Чтобы интегрировать [кластер {{ managed-k8s-name }}](../concepts/index.md#kubernetes-cluster) с приватной корпоративной [зоной](../../dns/concepts/dns-zone.md) [DNS](../../glossary/dns.md): -1. [{#T}](#setup-zone). -1. [{#T}](#create-pod). -1. [{#T}](#verify-dns). + +1. [Настройте DNS-сервер](#setup-dns). +1. [Укажите корпоративную зону DNS](#setup-zone). +1. [Создайте под dns-utils](#create-pod). +1. [Проверьте интеграцию DNS](#verify-dns). Если созданные ресурсы вам больше не нужны, [удалите их](#clear-out). diff --git a/ru/managed-kubernetes/tutorials/dns-autoscaler.md b/ru/managed-kubernetes/tutorials/dns-autoscaler.md index 8b3d49d4947..8433b46f8b3 100644 --- a/ru/managed-kubernetes/tutorials/dns-autoscaler.md +++ b/ru/managed-kubernetes/tutorials/dns-autoscaler.md @@ -13,8 +13,9 @@ description: Следуя данному руководству, вы сможе Количество реплик рассчитывается [с помощью формул](#parameters). Чтобы автоматизировать масштабирование DNS: -1. [{#T}](#configure-autoscaler). -1. [{#T}](#test-autoscaler). + +1. [Настройте kube-dns-autoscaler](#configure-autoscaler). +1. [Проверьте масштабирование](#test-autoscaler). Если автоматическое масштабирование потеряло актуальность, [отключите его](#disable-autoscaler). diff --git a/ru/managed-kubernetes/tutorials/dnschallenge.md b/ru/managed-kubernetes/tutorials/dnschallenge.md index e3d17f153c8..0fbcb48cd54 100644 --- a/ru/managed-kubernetes/tutorials/dnschallenge.md +++ b/ru/managed-kubernetes/tutorials/dnschallenge.md @@ -7,8 +7,9 @@ description: Следуя данному руководству, вы сможе Чтобы добавить возможность пройти проверку DNS Challenge при выписывании [сертификатов Let's Encrypt®](../../certificate-manager/concepts/managed-certificate.md): -1. [{#T}](#create-cert). -1. [{#T}](#check-result). + +1. [Создайте сертификат](#create-cert). +1. [Проверьте результат](#check-result). Если созданные ресурсы вам больше не нужны, [удалите их](#clear-out). diff --git a/ru/managed-kubernetes/tutorials/driverless-gpu.md b/ru/managed-kubernetes/tutorials/driverless-gpu.md index 0c987afdd45..0bb66a2023f 100644 --- a/ru/managed-kubernetes/tutorials/driverless-gpu.md +++ b/ru/managed-kubernetes/tutorials/driverless-gpu.md @@ -5,8 +5,8 @@ Чтобы подготовить кластер и группу узлов {{ managed-k8s-name }} без предустановленных драйверов к запуску рабочих нагрузок: -1. [{#T}](#install-gpu-operator). -1. [{#T}](#check-install). +1. [Установите GPU Operator](#install-gpu-operator). +1. [Проверьте правильность установки драйверов](#check-install). Если созданные ресурсы вам больше не нужны, [удалите их](#clear-out). diff --git a/ru/managed-kubernetes/tutorials/filebeat-oss-monitoring.md b/ru/managed-kubernetes/tutorials/filebeat-oss-monitoring.md index d129cb0f7a1..74f2de268cf 100644 --- a/ru/managed-kubernetes/tutorials/filebeat-oss-monitoring.md +++ b/ru/managed-kubernetes/tutorials/filebeat-oss-monitoring.md @@ -4,8 +4,9 @@ [Filebeat OSS](https://www.elastic.co/beats/filebeat) — плагин, который позволяет собирать и передавать логи в экосистему {{ OS }}. Filebeat устанавливается в [кластер {{ managed-k8s-name }}](../concepts/index.md#kubernetes-cluster), собирает логи кластера и [подов](../concepts/index.md#pod), а затем отправляет их в сервис [{{ mos-full-name }}](../../managed-opensearch/). Чтобы настроить мониторинг кластера {{ managed-k8s-name }} с помощью Filebeat OSS: -1. [{#T}](#filebeat-oss-install). -1. [{#T}](#check-result). + +1. [Установите Filebeat OSS](#filebeat-oss-install). +1. [Проверьте результат](#check-result). Если созданные ресурсы вам больше не нужны, [удалите их](#clear-out). diff --git a/ru/managed-kubernetes/tutorials/ingress-cert-manager.md b/ru/managed-kubernetes/tutorials/ingress-cert-manager.md index 09f65a2ddcd..c166c85c07e 100644 --- a/ru/managed-kubernetes/tutorials/ingress-cert-manager.md +++ b/ru/managed-kubernetes/tutorials/ingress-cert-manager.md @@ -7,12 +7,12 @@ description: Следуя данному руководству, вы сможе Чтобы с помощью [{{ k8s }}](https://kubernetes.io/ru/) создать [Ingress-контроллер NGINX](https://kubernetes.github.io/ingress-nginx/) и защитить его сертификатом: -1. [{#T}](#install-controller). -1. [{#T}](#connecting-certs-manager). -1. [{#T}](#install-certs-manager). -1. [{#T}](#create-issuer). -1. [{#T}](#install-objects). -1. [{#T}](#test-controller). +1. [Установите Ingress-контроллер NGINX](#install-controller). +1. [Настройте DNS-запись для Ingress-контроллера](#connecting-certs-manager). +1. [Установите менеджер сертификатов](#install-certs-manager). +1. [Создайте ClusterIssuer](#create-issuer). +1. [Создайте объекты для проверки работы cert-manager](#install-objects). +1. [Проверьте работоспособность TLS](#test-controller). Если созданные ресурсы вам больше не нужны, [удалите их](#clear-out). diff --git a/ru/managed-kubernetes/tutorials/k8s-cluster-with-no-internet.md b/ru/managed-kubernetes/tutorials/k8s-cluster-with-no-internet.md index b304f5fd9b0..47a46b5ad63 100644 --- a/ru/managed-kubernetes/tutorials/k8s-cluster-with-no-internet.md +++ b/ru/managed-kubernetes/tutorials/k8s-cluster-with-no-internet.md @@ -10,10 +10,10 @@ Чтобы создать кластер {{ managed-k8s-name }} без доступа в интернет: -1. [{#T}](#infra). -1. [{#T}](#vm). -1. [{#T}](#check). -1. [{#T}](#cert). +1. [Подготовьте инфраструктуру для {{ managed-k8s-name }}](#infra). +1. [Подготовьте виртуальную машину](#vm). +1. [Проверьте доступность кластера](#check). +1. (Опционально) [Подключите приватный реестр Docker-образов](#cert). Если созданные ресурсы вам больше не нужны, [удалите их](#clear-out). diff --git a/ru/managed-kubernetes/tutorials/marketplace/argo-cd.md b/ru/managed-kubernetes/tutorials/marketplace/argo-cd.md index c8b67756306..b9f4daed92c 100644 --- a/ru/managed-kubernetes/tutorials/marketplace/argo-cd.md +++ b/ru/managed-kubernetes/tutorials/marketplace/argo-cd.md @@ -6,11 +6,12 @@ В этом руководстве описана интеграция [инстанса {{ mgl-full-name }}](../../../managed-gitlab/concepts/index.md#instance), [кластера {{ managed-k8s-name }}](../../concepts/index.md#kubernetes-cluster) и установленных в кластере [Argo CD](/marketplace/products/yc/argo-cd) и [{{ GLR }}](/marketplace/products/yc/gitlab-runner), который выполняет сборку [Docker-контейнеров](/blog/posts/2022/03/docker-containers) с помощью инструмента [Kaniko](https://github.com/GoogleContainerTools/kaniko). Чтобы интегрировать Argo CD с {{ managed-k8s-name }} и {{ mgl-name }}: -1. [{#T}](#create-gitlab). -1. [{#T}](#configure-gitlab). -1. [{#T}](#runners). -1. [{#T}](#setup-repo). -1. [{#T}](#deploy-argo). + +1. [Создайте инстанс {{ GL }}](#create-gitlab). +1. [Настройте {{ GL }}](#configure-gitlab). +1. [Создайте {{ GLR }}](#runners). +1. [Подготовьте репозиторий приложения для развертывания](#setup-repo). +1. [Разверните приложение с помощью Argo CD](#deploy-argo). Если созданные ресурсы вам больше не нужны, [удалите их](#clear-out). diff --git a/ru/managed-kubernetes/tutorials/marketplace/crossplane.md b/ru/managed-kubernetes/tutorials/marketplace/crossplane.md index 2342949725f..8f5f58dcb31 100644 --- a/ru/managed-kubernetes/tutorials/marketplace/crossplane.md +++ b/ru/managed-kubernetes/tutorials/marketplace/crossplane.md @@ -3,8 +3,9 @@ [Crossplane](https://crossplane.io/) — надстройка для {{ k8s }} с открытым исходным кодом, которая позволяет собрать решения от разных поставщиков в единую инфраструктуру и предоставить разработчикам приложений доступ к ней через высокоуровневые [API](../../../glossary/rest-api.md). С помощью Crossplane пользователи могут управлять сторонними сервисами так же, как ресурсами {{ k8s }}. Чтобы создать [виртуальную машину](../../../compute/concepts/vm.md) {{ compute-full-name }} с помощью [приложения Crossplane](/marketplace/products/yc/crossplane), установленного в [кластере {{ k8s }}](../../concepts/index.md#kubernetes-cluster): -1. [{#T}](#k8s-create). -1. [{#T}](#create-crossplane-res). + +1. [Создайте ресурсы {{ managed-k8s-name }}](#k8s-create). +1. [Создайте ресурсы с помощью Crossplane](#create-crossplane-res). Если созданные ресурсы вам больше не нужны, [удалите их](#clear-out). diff --git a/ru/managed-kubernetes/tutorials/marketplace/istio.md b/ru/managed-kubernetes/tutorials/marketplace/istio.md index f413769dc98..89b96428e41 100644 --- a/ru/managed-kubernetes/tutorials/marketplace/istio.md +++ b/ru/managed-kubernetes/tutorials/marketplace/istio.md @@ -5,15 +5,15 @@ Чтобы посмотреть варианты использования Istio: -1. [{#T}](#istio-install). -1. [{#T}](#test-application). -1. [{#T}](#visualization-service-network). -1. [{#T}](#request-routing). -1. [{#T}](#injection-failures). -1. [{#T}](#traffic-redistribution). -1. [{#T}](#mutual-tls). -1. [{#T}](#viewing-metrics-prometheus). -1. [{#T}](#viewing-metrics-grafana). +1. [Установите Istio](#istio-install). +1. [Установите тестовое приложение](#test-application). +1. [Посмотрите схему сервисной сети на дашборде Kiali](#visualization-service-network). +1. [Маршрутизируйте запросы](#request-routing). +1. [Внедрите сбой в работу сервиса](#injection-failures). +1. [Перераспределите трафик](#traffic-redistribution). +1. [Установите режим аутентификации с помощью mutual TLS](#mutual-tls). +1. [Посмотрите метрики Istio на дашборде {{ prometheus-name }}](#viewing-metrics-prometheus). +1. [Посмотрите метрики Istio на дашборде {{ grafana-name }}](#viewing-metrics-grafana). Если созданные ресурсы вам больше не нужны, [удалите их](#clear-out). @@ -92,7 +92,7 @@ 1. [Установите](../../operations/applications/istio.md#marketplace-install) продукт [Istio](/marketplace/products/yc/istio) из каталога приложений {{ marketplace-full-name }}. При установке приложения: 1. Создайте новое [пространство имен](../../concepts/index.md#namespace) `istio-system`. - 1. Установите дополнения для Istio (Kiali, Prometheus, Grafana, Loki, Jaeger). + 1. Установите дополнения для Istio (Kiali, {{ prometheus-name }}, {{ grafana-name }}, Loki, Jaeger). 1. Убедитесь, что все [поды](../../concepts/index.md#pod) Istio и его дополнений перешли в статус `Running`: @@ -467,7 +467,7 @@ virtualservice.networking.istio.io "recommender-vs" deleted ... ``` -## Посмотрите метрики Istio на дашборде Prometheus {#viewing-metrics-prometheus} +## Посмотрите метрики Istio на дашборде {{ prometheus-name }} {#viewing-metrics-prometheus} 1. Убедитесь, что сервис `prometheus` установлен и доступен в кластере {{ managed-k8s-name }}: @@ -488,7 +488,7 @@ virtualservice.networking.istio.io "recommender-vs" deleted kubectl port-forward service/prometheus 9090:9090 -n istio-system ``` -1. Чтобы открыть дашборд Prometheus, вставьте в адресную строку браузера `http://localhost:9090`. +1. Чтобы открыть дашборд {{ prometheus-name }}, вставьте в адресную строку браузера `http://localhost:9090`. 1. Введите в поле **Expression** запрос: @@ -498,7 +498,7 @@ virtualservice.networking.istio.io "recommender-vs" deleted 1. Перейдите на вкладку **Graph**. Она показывает метрики Istio. -## Посмотрите метрики Istio на дашборде Grafana {#viewing-metrics-grafana} +## Посмотрите метрики Istio на дашборде {{ grafana-name }} {#viewing-metrics-grafana} 1. Убедитесь, что сервис `grafana` установлен и доступен в кластере {{ managed-k8s-name }}: @@ -519,7 +519,7 @@ virtualservice.networking.istio.io "recommender-vs" deleted kubectl port-forward service/grafana 3000:3000 -n istio-system ``` -1. Чтобы открыть дашборд Grafana, вставьте в адресную строку браузера `http://localhost:3000`. +1. Чтобы открыть дашборд {{ grafana-name }}, вставьте в адресную строку браузера `http://localhost:3000`. 1. В списке дашбордов найдите и откройте **Istio Mesh Dashboard**. Он показывает метрики запросов к сервисам тестового приложения. diff --git a/ru/managed-kubernetes/tutorials/marketplace/kyverno.md b/ru/managed-kubernetes/tutorials/marketplace/kyverno.md index 0e76d415066..bc82eebad4e 100644 --- a/ru/managed-kubernetes/tutorials/marketplace/kyverno.md +++ b/ru/managed-kubernetes/tutorials/marketplace/kyverno.md @@ -4,9 +4,9 @@ Чтобы интегрировать [Kyverno & Kyverno Policies](/marketplace/products/yc/kyverno) в {{ managed-k8s-name }}: -1. [{#T}](#install-kyverno). -1. [{#T}](#check-baseline). -1. [{#T}](#create-check-policies). +1. [Установите приложение Kyverno & Kyverno Policies](#install-kyverno). +1. [Проверьте работу политики для профиля baseline](#check-baseline). +1. [Создайте собственную политику Kyverno policies и проверьте ее работу](#create-check-policies). Если созданные ресурсы вам больше не нужны, [удалите их](#clear-out). diff --git a/ru/managed-kubernetes/tutorials/marketplace/metrics-provider.md b/ru/managed-kubernetes/tutorials/marketplace/metrics-provider.md index a7ee72a23ed..ce3596b0e8b 100644 --- a/ru/managed-kubernetes/tutorials/marketplace/metrics-provider.md +++ b/ru/managed-kubernetes/tutorials/marketplace/metrics-provider.md @@ -5,10 +5,12 @@ Из этой статьи вы узнаете, как настроить передачу внешних метрик в {{ k8s-hpa }} с помощью {{ MP }}. Чтобы настроить передачу метрик: -1. [{#T}](#create-files). -1. [{#T}](#install). -1. [{#T}](#validate). -1. [{#T}](#clear-out). + +1. [Подготовьте рабочее окружение](#create-files). +1. [Установите {{ MP }} и рабочее окружение](#install). +1. [Проверьте работу {{ MP }}](#validate). + +Если созданные ресурсы вам больше не нужны, [удалите их](#clear-out). ## Перед началом работы {#before-you-begin} diff --git a/ru/managed-kubernetes/tutorials/metrics-server.md b/ru/managed-kubernetes/tutorials/metrics-server.md index 9b0beafa3e6..5bc6ff547fb 100644 --- a/ru/managed-kubernetes/tutorials/metrics-server.md +++ b/ru/managed-kubernetes/tutorials/metrics-server.md @@ -7,9 +7,9 @@ В некоторых случаях компонент `metrics-server-nanny` может работать некорректно. Например, если при малом количестве узлов в кластере {{ managed-k8s-name }} создано большое количество подов. В этом случае под сервера метрик превысит свои лимиты, что может вызвать снижение производительности сервера метрик. Чтобы избежать этого, измените параметры сервера метрик вручную: -1. [{#T}](#get-resources). -1. [{#T}](#update-parameters). -1. [{#T}](#check-result). +1. [Посмотрите количество ресурсов, выделенных для пода сервера метрик](#get-resources). +1. [Измените параметры сервера метрик](#update-parameters). +1. [Проверьте результат](#check-result). Чтобы вернуть параметры сервера метрик до значений по умолчанию, [сбросьте их](#reset). diff --git a/ru/managed-kubernetes/tutorials/new-kubernetes-project.md b/ru/managed-kubernetes/tutorials/new-kubernetes-project.md index 784dd389efe..c68064265c3 100644 --- a/ru/managed-kubernetes/tutorials/new-kubernetes-project.md +++ b/ru/managed-kubernetes/tutorials/new-kubernetes-project.md @@ -6,13 +6,14 @@ Если вам нужно создать кластер {{ managed-k8s-name }} без доступа в интернет, обратитесь к разделу [{#T}](k8s-cluster-with-no-internet.md). Чтобы запустить приложение: -1. [{#T}](#create-sa). -1. [{#T}](#create-sg). -1. [{#T}](#create-k8s-res). -1. [{#T}](#cluster-connect). -1. [{#T}](#create-cr-res). -1. [{#T}](#setup-alb). -1. [{#T}](#create-ingress). + +1. [Создайте сервисные аккаунты](#create-sa). +1. [Создайте группы безопасности](#create-sg). +1. [Подготовьте ресурсы {{ k8s }}](#create-k8s-res). +1. [Подключитесь к кластеру {{ managed-k8s-name }}](#cluster-connect). +1. [Подготовьте ресурсы {{ container-registry-name }}](#create-cr-res). +1. [Установите {{ alb-name }}](#setup-alb). +1. [Создайте балансировщик нагрузки](#create-ingress). Если созданные ресурсы вам больше не нужны, [удалите их](#clear-out). diff --git a/ru/managed-kubernetes/tutorials/node-local-dns.md b/ru/managed-kubernetes/tutorials/node-local-dns.md index c5008087cbc..aec73ac4b77 100644 --- a/ru/managed-kubernetes/tutorials/node-local-dns.md +++ b/ru/managed-kubernetes/tutorials/node-local-dns.md @@ -18,11 +18,13 @@ Чтобы настроить кеширование запросов DNS: -1. [{#T}](#install). -1. [{#T}](#configure). -1. [{#T}](#dns-queries). -1. [{#T}](#dns-traffic). -1. [{#T}](#check-logs). +1. [Установите NodeLocal DNS](#install). +1. [Измените конфигурацию NodeLocal DNS Cache](#configure). +1. [Выполните DNS-запросы](#dns-queries). +1. [Настройте трафик через NodeLocal DNS](#dns-traffic). +1. [Проверьте логи](#check-logs). + +Если созданные ресурсы вам больше не нужны, [удалите их](#clear-out). ## Перед началом работы {#before-you-begin} diff --git a/ru/managed-kubernetes/tutorials/prometheus-grafana-monitoring.md b/ru/managed-kubernetes/tutorials/prometheus-grafana-monitoring.md index 10f739d83cf..860529a1c7f 100644 --- a/ru/managed-kubernetes/tutorials/prometheus-grafana-monitoring.md +++ b/ru/managed-kubernetes/tutorials/prometheus-grafana-monitoring.md @@ -5,10 +5,13 @@ Из этой статьи вы узнаете, как настроить систему сбора метрик [{{ prometheus-name }}](https://prometheus.io/) и систему визуализации [{{ grafana-name }}](https://grafana.com/) в [кластере {{ managed-k8s-name }}](../concepts/index.md#kubernetes-cluster). Для ускорения передачи метрик будет установлен [кеширующий прокси trickster](https://github.com/trickstercache/trickster). Чтобы настроить систему мониторинга кластера {{ managed-k8s-name }}: -* [{#T}](#install-prometheus). -* [{#T}](#install-trickster). -* [{#T}](#install-grafana). -* [{#T}](#configure-grafana). + +* [Установите {{ prometheus-name }}](#install-prometheus). +* [Установите кеширующий прокси trickster](#install-trickster). +* [Установите {{ grafana-name }}](#install-grafana). +* [Настройте и проверьте работу {{ grafana-name }}](#configure-grafana). + +Если созданные ресурсы вам больше не нужны, [удалите их](#clear-out). ## Перед началом работы {#before-you-begin} diff --git a/ru/managed-kubernetes/tutorials/pvc-snapshot-restore.md b/ru/managed-kubernetes/tutorials/pvc-snapshot-restore.md index 33a1e6b143f..4d0377de02e 100644 --- a/ru/managed-kubernetes/tutorials/pvc-snapshot-restore.md +++ b/ru/managed-kubernetes/tutorials/pvc-snapshot-restore.md @@ -4,9 +4,10 @@ В {{ managed-k8s-name }} доступны [снапшоты](../../glossary/snapshot.md) — копии дисков [PersistentVolume](../concepts/volume.md#provisioning-volumes) на определенный момент времени. Подробнее о механизме снапшотов см. в [документации Kubernetes](https://kubernetes.io/docs/concepts/storage/volume-snapshots/). Чтобы создать снапшот, а потом восстановить его: -1. [{#T}](#create-pvc-pod). -1. [{#T}](#create-snapshot). -1. [{#T}](#restore-from-snapshot). + +1. [Подготовьте тестовое окружение](#create-pvc-pod). +1. [Создайте снапшот](#create-snapshot). +1. [Восстановите объекты из снапшота](#restore-from-snapshot). Если созданные ресурсы вам больше не нужны, [удалите их](#clear-out). diff --git a/ru/managed-kubernetes/tutorials/running-pod-gpu.md b/ru/managed-kubernetes/tutorials/running-pod-gpu.md index f9386ebd145..f8924380787 100644 --- a/ru/managed-kubernetes/tutorials/running-pod-gpu.md +++ b/ru/managed-kubernetes/tutorials/running-pod-gpu.md @@ -4,8 +4,9 @@ [Кластер {{ managed-k8s-name }}](../concepts/index.md#kubernetes-cluster) позволяет запускать рабочие нагрузки на [видеопроцессорах](../../compute/concepts/gpus.md) ([GPU](.././../glossary/gpu.md)), что может быть полезно для задач с особыми вычислительными требованиями. Чтобы запустить рабочие нагрузки с GPU на [подах](../concepts/index.md#pod) кластера {{ managed-k8s-name }}: -1. [{#T}](#create-pod-gpu). -1. [{#T}](#check-pod). + +1. [Создайте под с GPU](#create-pod-gpu). +1. [Проверьте работу пода](#check-pod). Если созданные ресурсы вам больше не нужны, [удалите их](#delete-resources). diff --git a/ru/managed-kubernetes/tutorials/time-slicing-gpu.md b/ru/managed-kubernetes/tutorials/time-slicing-gpu.md index 8c990940059..c9d0af85d22 100644 --- a/ru/managed-kubernetes/tutorials/time-slicing-gpu.md +++ b/ru/managed-kubernetes/tutorials/time-slicing-gpu.md @@ -4,8 +4,9 @@ Плагин [Time-Slicing GPUs в {{ k8s }}](https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/gpu-sharing.html) используется для чередования рабочих нагрузок, которые выполняются на одном [GPU](../../compute/concepts/gpus.md) с избыточной подпиской. Чтобы установить плагин Time-Slicing GPUs в {{ managed-k8s-name }}: -1. [{#T}](#configure-time-slicing). -1. [{#T}](#check-time-slicing). + +1. [Настройте Time-Slicing GPUs](#configure-time-slicing). +1. [Проверьте работу Time-Slicing GPUs](#check-time-slicing). Если созданные ресурсы вам больше не нужны, [удалите их](#clear-out). diff --git a/ru/managed-kubernetes/tutorials/vpa-autoscaling.md b/ru/managed-kubernetes/tutorials/vpa-autoscaling.md index 9bf5d738879..b7230434d74 100644 --- a/ru/managed-kubernetes/tutorials/vpa-autoscaling.md +++ b/ru/managed-kubernetes/tutorials/vpa-autoscaling.md @@ -6,8 +6,11 @@ description: Следуя данному руководству, вы сможе # Вертикальное масштабирование приложения в кластере {{ managed-k8s-name }} поддерживает несколько видов автоматического масштабирования. Из этой статьи вы узнаете, как настроить автоматическое управление ресурсами [пода](../concepts/index.md#pod) с помощью [{{ k8s-vpa }}](../concepts/autoscale.md#vpa): -* [{#T}](#create-vpa-workload). -* [{#T}](#test-vpa). + +* [Создайте {{ k8s-vpa }} и тестовое приложение](#create-vpa-workload). +* [Проверьте работу {{ k8s-vpa }}](#test-vpa). + +Если созданные ресурсы вам больше не нужны, [удалите их](#clear-out). ## Перед началом работы {#before-you-begin} diff --git a/ru/managed-mongodb/security/index.md b/ru/managed-mongodb/security/index.md index c27c7af2c42..a937198317c 100644 --- a/ru/managed-mongodb/security/index.md +++ b/ru/managed-mongodb/security/index.md @@ -64,7 +64,6 @@ description: Управление доступом в сервисе по соз {% include [vpc-publicadmin](../../_roles/vpc/publicAdmin.md) %} - ### Примитивные роли {#primitive-roles} {% include [roles-primitive](../../_includes/roles-primitive.md) %} diff --git a/ru/managed-mysql/api-ref/Cluster/streamLogs.md b/ru/managed-mysql/api-ref/Cluster/streamLogs.md index 7ea18154787..74f7b8718e1 100644 --- a/ru/managed-mysql/api-ref/Cluster/streamLogs.md +++ b/ru/managed-mysql/api-ref/Cluster/streamLogs.md @@ -76,7 +76,7 @@ Set `recordToken` to the [StreamLogRecord.nextRecordToken](#yandex.cloud.mdb.mys A filter expression that selects clusters logs listed in the response. The expression must specify: -1. The field name. Currently filtering can be applied to the [LogRecord.logs.hostname](/docs/compute/api-ref/Instance/create#yandex.cloud.compute.v1.CreateInstanceRequest) field. +1. The field name. Currently filtering can be applied to the [LogRecord.logs.hostname] field. 2. An `=` operator. 3. The value in double quotes (`"`). Must be 3-63 characters long and match the regular expression `[a-z][-a-z0-9]{1,61}[a-z0-9]`. Examples of a filter: `message.hostname='node1.db.cloud.yandex.net'` || diff --git a/ru/managed-mysql/api-ref/grpc/Cluster/streamLogs.md b/ru/managed-mysql/api-ref/grpc/Cluster/streamLogs.md index 4b9387ac376..29a6105ea7d 100644 --- a/ru/managed-mysql/api-ref/grpc/Cluster/streamLogs.md +++ b/ru/managed-mysql/api-ref/grpc/Cluster/streamLogs.md @@ -68,7 +68,7 @@ Set `recordToken` to the [StreamLogRecord.nextRecordToken](#yandex.cloud.mdb.mys A filter expression that selects clusters logs listed in the response. The expression must specify: -1. The field name. Currently filtering can be applied to the [LogRecord.logs.hostname](/docs/compute/api-ref/grpc/Instance/create#yandex.cloud.compute.v1.CreateInstanceRequest) field. +1. The field name. Currently filtering can be applied to the [LogRecord.logs.hostname] field. 2. An `=` operator. 3. The value in double quotes (`"`). Must be 3-63 characters long and match the regular expression `[a-z][-a-z0-9]{1,61}[a-z0-9]`. Examples of a filter: `message.hostname='node1.db.cloud.yandex.net'` || diff --git a/ru/managed-mysql/pricing.md b/ru/managed-mysql/pricing.md index 8385b54f6aa..ce7a56d6f80 100644 --- a/ru/managed-mysql/pricing.md +++ b/ru/managed-mysql/pricing.md @@ -64,6 +64,49 @@ editable: false Цена указывается за 1 месяц использования и формируется из расчета 720 часов в месяц. Минимальная единица тарификации — 1 ГБ в минуту (например, стоимость хранения 1 ГБ в течение 1,5 минут равна стоимости хранения в течение 2 минут). +### Пример расчета стоимости кластера {#example} + +Стоимость использования кластера со следующими параметрами в течение 30 дней: + +* **Хосты {{ MY }}**: 3 хоста класса `s3-c2-m8`: Intel Ice Lake, 2 × 100% vCPU, 8 ГБ RAM. +* **{{ ui-key.yacloud.mdb.forms.section_storage }}**: 100 ГБ на сетевых HDD-дисках. + +Расчет стоимости для хостов {{ MY }}: + + +{% list tabs group=pricing %} + +- Расчет в рублях {#prices-rub} + + {% include [rub-mysql-host](../_pricing_examples/managed-mysql/rub-host.md) %} + +- Расчет в тенге {#prices-kzt} + + {% include [kzt-mysql-host](../_pricing_examples/managed-mysql/kzt-host.md) %} + +{% endlist %} + + + + +Расчет стоимости хранилища и итоговой стоимости: + + +{% list tabs group=pricing %} + +- Расчет в рублях {#prices-rub} + + {% include [rub-mysql-storage](../_pricing_examples/managed-mysql/rub-storage.md) %} + +- Расчет в тенге {#prices-kzt} + + {% include [kzt-mysql-storage](../_pricing_examples/managed-mysql/kzt-storage.md) %} + +{% endlist %} + + + + ## Скидка за резервируемый объем ресурсов (CVoS) {#cvos} diff --git a/ru/managed-opensearch/api-ref/Cluster/deleteBackup.md b/ru/managed-opensearch/api-ref/Cluster/deleteBackup.md new file mode 100644 index 00000000000..551efae4529 --- /dev/null +++ b/ru/managed-opensearch/api-ref/Cluster/deleteBackup.md @@ -0,0 +1,137 @@ +--- +editable: false +sourcePath: en/_api-ref/mdb/opensearch/v1/api-ref/Cluster/deleteBackup.md +--- + +# Managed Service for OpenSearch API, REST: Cluster.DeleteBackup {#DeleteBackup} + +Delete backup for the specified OpenSearch cluster. + +## HTTP request + +``` +DELETE https://{{ api-host-mdb }}/managed-opensearch/v1/clusters/{clusterId}/backups/{backupId} +``` + +## Path parameters + +#| +||Field | Description || +|| clusterId | **string** + +Required field. Required. ID of the OpenSearch cluster. || +|| backupId | **string** + +Required field. Required. ID of the backup to delete. || +|# + +## Response {#yandex.cloud.operation.Operation} + +**HTTP Code: 200 - OK** + +```json +{ + "id": "string", + "description": "string", + "createdAt": "string", + "createdBy": "string", + "modifiedAt": "string", + "done": "boolean", + "metadata": { + "clusterId": "string", + "backupId": "string" + }, + // Includes only one of the fields `error` + "error": { + "code": "integer", + "message": "string", + "details": [ + "object" + ] + } + // end of the list of possible fields +} +``` + +An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). + +#| +||Field | Description || +|| id | **string** + +ID of the operation. || +|| description | **string** + +Description of the operation. 0-256 characters long. || +|| createdAt | **string** (date-time) + +Creation timestamp. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| createdBy | **string** + +ID of the user or service account who initiated the operation. || +|| modifiedAt | **string** (date-time) + +The time when the Operation resource was last modified. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| done | **boolean** + +If the value is `false`, it means the operation is still in progress. +If `true`, the operation is completed, and either `error` or `response` is available. || +|| metadata | **[DeleteBackupMetadata](#yandex.cloud.mdb.opensearch.v1.DeleteBackupMetadata)** + +Service-specific metadata associated with the operation. +It typically contains the ID of the target resource that the operation is performed on. +Any method that returns a long-running operation should document the metadata type, if any. || +|| error | **[Status](#google.rpc.Status)** + +The error result of the operation in case of failure or cancellation. + +Includes only one of the fields `error`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|# + +## DeleteBackupMetadata {#yandex.cloud.mdb.opensearch.v1.DeleteBackupMetadata} + +#| +||Field | Description || +|| clusterId | **string** + +ID of the OpenSearch cluster. || +|| backupId | **string** + +ID of the backup to delete. || +|# + +## Status {#google.rpc.Status} + +The error result of the operation in case of failure or cancellation. + +#| +||Field | Description || +|| code | **integer** (int32) + +Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || +|| message | **string** + +An error message. || +|| details[] | **object** + +A list of messages that carry the error details. || +|# \ No newline at end of file diff --git a/ru/managed-opensearch/api-ref/Cluster/index.md b/ru/managed-opensearch/api-ref/Cluster/index.md index 3b10a84835a..a353e1a7f7b 100644 --- a/ru/managed-opensearch/api-ref/Cluster/index.md +++ b/ru/managed-opensearch/api-ref/Cluster/index.md @@ -17,6 +17,7 @@ A set of methods for managing OpenSearch clusters. || [Update](update.md) | Updates the specified OpenSearch cluster. || || [Delete](delete.md) | Deletes the specified OpenSearch cluster. || || [Backup](backup.md) | Creates a backup for the specified OpenSearch cluster. || +|| [DeleteBackup](deleteBackup.md) | Delete backup for the specified OpenSearch cluster. || || [Restore](restore.md) | Creates a new OpenSearch cluster using the specified backup. || || [RescheduleMaintenance](rescheduleMaintenance.md) | Reschedules a planned maintenance operation. || || [ListBackups](listBackups.md) | Returns a list of available backups for the specified OpenSearch cluster. || diff --git a/ru/managed-opensearch/api-ref/Cluster/streamLogs.md b/ru/managed-opensearch/api-ref/Cluster/streamLogs.md index dc0efef7afd..30d990c85c7 100644 --- a/ru/managed-opensearch/api-ref/Cluster/streamLogs.md +++ b/ru/managed-opensearch/api-ref/Cluster/streamLogs.md @@ -105,9 +105,9 @@ One of the requested log records. || This token allows you to continue streaming logs starting from the exact same record. -To do that, specify value of `nextRecordToken` as the value for [StreamLogs.recordToken](#yandex.cloud.mdb.opensearch.v1.StreamClusterLogsRequest) parameter in the next [StreamLogs](#StreamLogs) request. +To do that, specify value of `nextRecordToken` as the value for [StreamLogs.record_token] parameter in the next [StreamLogs](#StreamLogs) request. -This value is interchangeable with [ListLogs.nextPageToken](/docs/managed-opensearch/api-ref/Backup/list#yandex.cloud.mdb.opensearch.v1.ListBackupsResponse) from [ListLogs](/docs/managed-opensearch/api-ref/Cluster/listLogs#ListLogs) method. || +This value is interchangeable with [ListLogs.next_page_token] from [ListLogs](/docs/managed-opensearch/api-ref/Cluster/listLogs#ListLogs) method. || |# ## LogRecord {#yandex.cloud.mdb.opensearch.v1.LogRecord} diff --git a/ru/managed-opensearch/api-ref/grpc/Cluster/deleteBackup.md b/ru/managed-opensearch/api-ref/grpc/Cluster/deleteBackup.md new file mode 100644 index 00000000000..6fee8312910 --- /dev/null +++ b/ru/managed-opensearch/api-ref/grpc/Cluster/deleteBackup.md @@ -0,0 +1,119 @@ +--- +editable: false +sourcePath: en/_api-ref-grpc/mdb/opensearch/v1/api-ref/grpc/Cluster/deleteBackup.md +--- + +# Managed Service for OpenSearch API, gRPC: ClusterService.DeleteBackup {#DeleteBackup} + +Delete backup for the specified OpenSearch cluster. + +## gRPC request + +**rpc DeleteBackup ([DeleteBackupRequest](#yandex.cloud.mdb.opensearch.v1.DeleteBackupRequest)) returns ([operation.Operation](#yandex.cloud.operation.Operation))** + +## DeleteBackupRequest {#yandex.cloud.mdb.opensearch.v1.DeleteBackupRequest} + +```json +{ + "clusterId": "string", + "backupId": "string" +} +``` + +#| +||Field | Description || +|| clusterId | **string** + +Required field. Required. ID of the OpenSearch cluster. || +|| backupId | **string** + +Required field. Required. ID of the backup to delete. || +|# + +## operation.Operation {#yandex.cloud.operation.Operation} + +```json +{ + "id": "string", + "description": "string", + "createdAt": "google.protobuf.Timestamp", + "createdBy": "string", + "modifiedAt": "google.protobuf.Timestamp", + "done": "bool", + "metadata": { + "clusterId": "string", + "backupId": "string" + }, + // Includes only one of the fields `error`, `response` + "error": "google.rpc.Status", + "response": "google.protobuf.Empty" + // end of the list of possible fields +} +``` + +An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). + +#| +||Field | Description || +|| id | **string** + +ID of the operation. || +|| description | **string** + +Description of the operation. 0-256 characters long. || +|| createdAt | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp)** + +Creation timestamp. || +|| createdBy | **string** + +ID of the user or service account who initiated the operation. || +|| modifiedAt | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp)** + +The time when the Operation resource was last modified. || +|| done | **bool** + +If the value is `false`, it means the operation is still in progress. +If `true`, the operation is completed, and either `error` or `response` is available. || +|| metadata | **[DeleteBackupMetadata](#yandex.cloud.mdb.opensearch.v1.DeleteBackupMetadata)** + +Service-specific metadata associated with the operation. +It typically contains the ID of the target resource that the operation is performed on. +Any method that returns a long-running operation should document the metadata type, if any. || +|| error | **[google.rpc.Status](https://cloud.google.com/tasks/docs/reference/rpc/google.rpc#status)** + +The error result of the operation in case of failure or cancellation. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|| response | **[google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty)** + +The normal response of the operation in case of success. +If the original method returns no data on success, such as Delete, +the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). +If the original method is the standard Create/Update, +the response should be the target resource of the operation. +Any method that returns a long-running operation should document the response type, if any. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|# + +## DeleteBackupMetadata {#yandex.cloud.mdb.opensearch.v1.DeleteBackupMetadata} + +#| +||Field | Description || +|| clusterId | **string** + +ID of the OpenSearch cluster. || +|| backupId | **string** + +ID of the backup to delete. || +|# \ No newline at end of file diff --git a/ru/managed-opensearch/api-ref/grpc/Cluster/index.md b/ru/managed-opensearch/api-ref/grpc/Cluster/index.md index e6385f95217..76166fd2202 100644 --- a/ru/managed-opensearch/api-ref/grpc/Cluster/index.md +++ b/ru/managed-opensearch/api-ref/grpc/Cluster/index.md @@ -17,6 +17,7 @@ A set of methods for managing OpenSearch clusters. || [Update](update.md) | Updates the specified OpenSearch cluster. || || [Delete](delete.md) | Deletes the specified OpenSearch cluster. || || [Backup](backup.md) | Creates a backup for the specified OpenSearch cluster. || +|| [DeleteBackup](deleteBackup.md) | Delete backup for the specified OpenSearch cluster. || || [Restore](restore.md) | Creates a new OpenSearch cluster using the specified backup. || || [RescheduleMaintenance](rescheduleMaintenance.md) | Reschedules a planned maintenance operation. || || [ListBackups](listBackups.md) | Returns a list of available backups for the specified OpenSearch cluster. || diff --git a/ru/managed-opensearch/api-ref/grpc/Cluster/streamLogs.md b/ru/managed-opensearch/api-ref/grpc/Cluster/streamLogs.md index c8a0a180550..11a75d5125f 100644 --- a/ru/managed-opensearch/api-ref/grpc/Cluster/streamLogs.md +++ b/ru/managed-opensearch/api-ref/grpc/Cluster/streamLogs.md @@ -95,9 +95,9 @@ One of the requested log records. || This token allows you to continue streaming logs starting from the exact same record. -To do that, specify value of `nextRecordToken` as the value for [StreamLogs.recordToken](#yandex.cloud.mdb.opensearch.v1.StreamClusterLogsRequest) parameter in the next [StreamLogs](#StreamLogs) request. +To do that, specify value of `nextRecordToken` as the value for [StreamLogs.record_token] parameter in the next [StreamLogs](#StreamLogs) request. -This value is interchangeable with [ListLogs.nextPageToken](/docs/managed-opensearch/api-ref/grpc/Backup/list#yandex.cloud.mdb.opensearch.v1.ListBackupsResponse) from [ListLogs](/docs/managed-opensearch/api-ref/grpc/Cluster/listLogs#ListLogs) method. || +This value is interchangeable with [ListLogs.next_page_token] from [ListLogs](/docs/managed-opensearch/api-ref/grpc/Cluster/listLogs#ListLogs) method. || |# ## LogRecord {#yandex.cloud.mdb.opensearch.v1.LogRecord} diff --git a/ru/managed-opensearch/operations/saml-authentication.md b/ru/managed-opensearch/operations/saml-authentication.md index 6d9f3a0ca41..0f14a696e84 100644 --- a/ru/managed-opensearch/operations/saml-authentication.md +++ b/ru/managed-opensearch/operations/saml-authentication.md @@ -76,6 +76,10 @@ SAML (Security Assertion Markup Language) — это язык разметки * **{{ ui-key.yacloud.opensearch.auth.field_subject-key }}** — параметр в ответе SAML, в котором хранится тема. Если параметр не настроен, используется параметр `NameID`. + * **{{ ui-key.yacloud.opensearch.auth.field_jwt-default-expiration-timeout }}** — срок жизни сессии в минутах. Укажите его, если провайдер идентификации не установил свой таймаут. + + Если значение отсутствует или указан `0`, срок жизни сессии не ограничен (значение по умолчанию). + * **{{ ui-key.yacloud.opensearch.auth.field_enabled }}** — активировать ли источник аутентификации после создания. 1. Нажмите кнопку **{{ ui-key.yacloud.opensearch.auth.button_save }}**. @@ -96,6 +100,9 @@ SAML (Security Assertion Markup Language) — это язык разметки * URL хоста {{ OS }} с ролью `DASHBOARDS` в параметре `dashboardsUrl`. * (Опционально) Параметр в ответе SAML, в котором хранятся роли, в параметре `rolesKey`. * (Опционально) Параметр в ответе SAML, в котором хранится тема, в параметре `subjectKey`. + * (Опционально) Срок жизни сессии в минутах в параметре `jwtDefaultExpirationTimeout`. Укажите его, если провайдер идентификации не установил свой таймаут. + + Если значение отсутствует или указан `0`, срок жизни сессии не ограничен (значение по умолчанию). {% endlist %} diff --git a/ru/managed-opensearch/toc.yaml b/ru/managed-opensearch/toc.yaml index 73e85464f32..8011935146d 100644 --- a/ru/managed-opensearch/toc.yaml +++ b/ru/managed-opensearch/toc.yaml @@ -153,6 +153,8 @@ items: href: api-ref/grpc/Cluster/delete.md - name: Backup href: api-ref/grpc/Cluster/backup.md + - name: DeleteBackup + href: api-ref/grpc/Cluster/deleteBackup.md - name: Restore href: api-ref/grpc/Cluster/restore.md - name: RescheduleMaintenance @@ -233,6 +235,8 @@ items: href: api-ref/Cluster/delete.md - name: Backup href: api-ref/Cluster/backup.md + - name: DeleteBackup + href: api-ref/Cluster/deleteBackup.md - name: Restore href: api-ref/Cluster/restore.md - name: RescheduleMaintenance diff --git a/ru/managed-postgresql/api-ref/Cluster/addHosts.md b/ru/managed-postgresql/api-ref/Cluster/addHosts.md index 4a03c06a88f..659dc70c592 100644 --- a/ru/managed-postgresql/api-ref/Cluster/addHosts.md +++ b/ru/managed-postgresql/api-ref/Cluster/addHosts.md @@ -35,7 +35,7 @@ To get the PostgreSQL cluster ID, use a [ClusterService.List](/docs/managed-post "replicationSource": "string", "priority": "string", "configSpec": { - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", @@ -1054,6 +1054,140 @@ To get the PostgreSQL cluster ID, use a [ClusterService.List](/docs/managed-post "timezone": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" + }, + "postgresqlConfig_17": { + "recoveryMinApplyDelay": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "workMem": "string", + "tempFileLimit": "string", + "backendFlushAfter": "string", + "maxStandbyStreamingDelay": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + }, + "postgresqlConfig_17_1c": { + "recoveryMinApplyDelay": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "workMem": "string", + "tempFileLimit": "string", + "backendFlushAfter": "string", + "maxStandbyStreamingDelay": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" } // end of the list of possible fields } @@ -1116,77 +1250,87 @@ Configuration of a PostgreSQL server for the host. || Configuration for a host with PostgreSQL 9.6 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_10_1c | **[PostgresqlHostConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C)** Configuration for a host with PostgreSQL 10 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_10 | **[PostgresqlHostConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10)** Configuration for a host with PostgreSQL 10 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_11 | **[PostgresqlHostConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11)** Configuration for a host with PostgreSQL 11 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_11_1c | **[PostgresqlHostConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C)** Configuration for a host with PostgreSQL 11 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_12 | **[PostgresqlHostConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12)** Configuration for a host with PostgreSQL 12 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_12_1c | **[PostgresqlHostConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C)** Configuration for a host with PostgreSQL 12 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_13 | **[PostgresqlHostConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13)** Configuration for a host with PostgreSQL 13 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_13_1c | **[PostgresqlHostConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C)** Configuration for a host with PostgreSQL 13 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_14 | **[PostgresqlHostConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14)** Configuration for a host with PostgreSQL 14 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_14_1c | **[PostgresqlHostConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C)** Configuration for a host with PostgreSQL 14 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_15 | **[PostgresqlHostConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15)** Configuration for a host with PostgreSQL 15 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_15_1c | **[PostgresqlHostConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C)** Configuration for a host with PostgreSQL 15 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_16 | **[PostgresqlHostConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16)** Configuration for a host with PostgreSQL 16 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_16_1c | **[PostgresqlHostConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C)** Configuration for a host with PostgreSQL 16 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17 | **[PostgresqlHostConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17_1c | **[PostgresqlHostConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || |# ## PostgresqlHostConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6} @@ -3962,6 +4106,378 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# +## PostgresqlHostConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). + +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| workMem | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| debugParallelQuery | **enum** (DebugParallelQuery) + +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# + +## PostgresqlHostConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). + +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| workMem | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| debugParallelQuery | **enum** (DebugParallelQuery) + +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# + ## Response {#yandex.cloud.operation.Operation} **HTTP Code: 200 - OK** diff --git a/ru/managed-postgresql/api-ref/Cluster/backup.md b/ru/managed-postgresql/api-ref/Cluster/backup.md index e18b055f098..e47387ca034 100644 --- a/ru/managed-postgresql/api-ref/Cluster/backup.md +++ b/ru/managed-postgresql/api-ref/Cluster/backup.md @@ -64,7 +64,7 @@ To get the PostgreSQL cluster ID, use a [ClusterService.List](/docs/managed-post ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "effectiveConfig": { "maxConnections": "string", @@ -6812,6 +6812,1024 @@ To get the PostgreSQL cluster ID, use a [ClusterService.List](/docs/managed-post "passwordEncryption": "string" } }, + "postgresqlConfig_17": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, + "postgresqlConfig_17_1c": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, // end of the list of possible fields "poolerConfig": { "poolingMode": "string", @@ -6876,370 +7894,993 @@ To get the PostgreSQL cluster ID, use a [ClusterService.List](/docs/managed-post } ``` -An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). +An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). + +#| +||Field | Description || +|| id | **string** + +ID of the operation. || +|| description | **string** + +Description of the operation. 0-256 characters long. || +|| createdAt | **string** (date-time) + +Creation timestamp. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| createdBy | **string** + +ID of the user or service account who initiated the operation. || +|| modifiedAt | **string** (date-time) + +The time when the Operation resource was last modified. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| done | **boolean** + +If the value is `false`, it means the operation is still in progress. +If `true`, the operation is completed, and either `error` or `response` is available. || +|| metadata | **[BackupClusterMetadata](#yandex.cloud.mdb.postgresql.v1.BackupClusterMetadata)** + +Service-specific metadata associated with the operation. +It typically contains the ID of the target resource that the operation is performed on. +Any method that returns a long-running operation should document the metadata type, if any. || +|| error | **[Status](#google.rpc.Status)** + +The error result of the operation in case of failure or cancellation. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** + +The normal response of the operation in case of success. +If the original method returns no data on success, such as Delete, +the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). +If the original method is the standard Create/Update, +the response should be the target resource of the operation. +Any method that returns a long-running operation should document the response type, if any. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|# + +## BackupClusterMetadata {#yandex.cloud.mdb.postgresql.v1.BackupClusterMetadata} + +#| +||Field | Description || +|| clusterId | **string** + +ID of the PostgreSQL cluster that is being backed up. || +|| backupId | **string** + +ID of the PostgreSQL backup that is being created. || +|# + +## Status {#google.rpc.Status} + +The error result of the operation in case of failure or cancellation. + +#| +||Field | Description || +|| code | **integer** (int32) + +Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || +|| message | **string** + +An error message. || +|| details[] | **object** + +A list of messages that carry the error details. || +|# + +## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} + +A PostgreSQL Cluster resource. For more information, see +the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. + +#| +||Field | Description || +|| id | **string** + +ID of the PostgreSQL cluster. +This ID is assigned by MDB at creation time. || +|| folderId | **string** + +ID of the folder that the PostgreSQL cluster belongs to. || +|| createdAt | **string** (date-time) + +Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| name | **string** + +Name of the PostgreSQL cluster. +The name is unique within the folder. 1-63 characters long. || +|| description | **string** + +Description of the PostgreSQL cluster. 0-256 characters long. || +|| labels | **string** + +Custom labels for the PostgreSQL cluster as `` key:value `` pairs. +Maximum 64 per resource. || +|| environment | **enum** (Environment) + +Deployment environment of the PostgreSQL cluster. + +- `ENVIRONMENT_UNSPECIFIED` +- `PRODUCTION`: Stable environment with a conservative update policy: +only hotfixes are applied during regular maintenance. +- `PRESTABLE`: Environment with more aggressive update policy: new versions +are rolled out irrespective of backward compatibility. || +|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** + +Description of monitoring systems relevant to the PostgreSQL cluster. || +|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** + +Configuration of the PostgreSQL cluster. || +|| networkId | **string** + +ID of the network that the cluster belongs to. || +|| health | **enum** (Health) + +Aggregated cluster health. + +- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). +- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). +- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). +- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || +|| status | **enum** (Status) + +Current state of the cluster. + +- `STATUS_UNKNOWN`: Cluster state is unknown. +- `CREATING`: Cluster is being created. +- `RUNNING`: Cluster is running normally. +- `ERROR`: Cluster encountered a problem and cannot operate. +- `UPDATING`: Cluster is being updated. +- `STOPPING`: Cluster is stopping. +- `STOPPED`: Cluster stopped. +- `STARTING`: Cluster is starting. || +|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** + +Maintenance window for the cluster. || +|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** + +Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || +|| securityGroupIds[] | **string** + +User security groups || +|| deletionProtection | **boolean** + +Deletion Protection inhibits deletion of the cluster || +|| hostGroupIds[] | **string** + +Host groups hosting VMs of the cluster. || +|# + +## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} + +Monitoring system. + +#| +||Field | Description || +|| name | **string** + +Name of the monitoring system. || +|| description | **string** + +Description of the monitoring system. || +|| link | **string** + +Link to the monitoring system charts for the PostgreSQL cluster. || +|# + +## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} + +#| +||Field | Description || +|| version | **string** + +Version of PostgreSQL server software. || +|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** + +Configuration of a PostgreSQL 9.6 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** + +Configuration of a PostgreSQL 10 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** + +Configuration of a PostgreSQL 10 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** + +Configuration of a PostgreSQL 11 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** + +Configuration of a PostgreSQL 11 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** + +Configuration of a PostgreSQL 12 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** + +Configuration of a PostgreSQL 12 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** + +Configuration of a PostgreSQL 13 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** + +Configuration of a PostgreSQL 13 1C server. -#| -||Field | Description || -|| id | **string** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -ID of the operation. || -|| description | **string** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** -Description of the operation. 0-256 characters long. || -|| createdAt | **string** (date-time) +Configuration of a PostgreSQL 14 server. -Creation timestamp. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| createdBy | **string** +Configuration of a PostgreSQL 14 1C server. -ID of the user or service account who initiated the operation. || -|| modifiedAt | **string** (date-time) +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The time when the Operation resource was last modified. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Configuration of a PostgreSQL 15 server. -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| done | **boolean** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -If the value is `false`, it means the operation is still in progress. -If `true`, the operation is completed, and either `error` or `response` is available. || -|| metadata | **[BackupClusterMetadata](#yandex.cloud.mdb.postgresql.v1.BackupClusterMetadata)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** -Service-specific metadata associated with the operation. -It typically contains the ID of the target resource that the operation is performed on. -Any method that returns a long-running operation should document the metadata type, if any. || -|| error | **[Status](#google.rpc.Status)** +Configuration of a PostgreSQL 15 1C server. -The error result of the operation in case of failure or cancellation. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Includes only one of the fields `error`, `response`. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || -|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** +Configuration of a PostgreSQL 16 server. -The normal response of the operation in case of success. -If the original method returns no data on success, such as Delete, -the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). -If the original method is the standard Create/Update, -the response should be the target resource of the operation. -Any method that returns a long-running operation should document the response type, if any. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Includes only one of the fields `error`, `response`. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || +Configuration of a PostgreSQL 16 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfigSet17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfigSet17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** + +Configuration of the connection pooler. || +|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** + +Resources allocated to PostgreSQL hosts. || +|| autofailover | **boolean** + +Configuration setting which enables/disables autofailover in cluster. || +|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** + +Time to start the daily backup, in the UTC timezone. || +|| backupRetainPeriodDays | **string** (int64) + +Retention policy of automated backups. || +|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** + +Access policy to DB || +|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** + +Configuration of the performance diagnostics service. || +|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** + +Disk size autoscaling || |# -## BackupClusterMetadata {#yandex.cloud.mdb.postgresql.v1.BackupClusterMetadata} +## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} #| ||Field | Description || -|| clusterId | **string** +|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -ID of the PostgreSQL cluster that is being backed up. || -|| backupId | **string** +Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -ID of the PostgreSQL backup that is being created. || +User-defined settings for a PostgreSQL 9.6 cluster. || +|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** + +Default configuration for a PostgreSQL 9.6 cluster. || |# -## Status {#google.rpc.Status} +## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} -The error result of the operation in case of failure or cancellation. +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). #| ||Field | Description || -|| code | **integer** (int32) +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || -|| message | **string** +in bytes. || +|| tempBuffers | **string** (int64) -An error message. || -|| details[] | **object** +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -A list of messages that carry the error details. || -|# +in bytes. || +|| maintenanceWorkMem | **string** (int64) -## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -A PostgreSQL Cluster resource. For more information, see -the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. +in bytes. || +|| tempFileLimit | **string** (int64) -#| -||Field | Description || -|| id | **string** +in bytes. || +|| vacuumCostDelay | **string** (int64) -ID of the PostgreSQL cluster. -This ID is assigned by MDB at creation time. || -|| folderId | **string** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -ID of the folder that the PostgreSQL cluster belongs to. || -|| createdAt | **string** (date-time) +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. +in bytes || +|| backendFlushAfter | **string** (int64) -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| name | **string** +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Name of the PostgreSQL cluster. -The name is unique within the folder. 1-63 characters long. || -|| description | **string** +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) + +Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Description of the PostgreSQL cluster. 0-256 characters long. || -|| labels | **string** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Custom labels for the PostgreSQL cluster as `` key:value `` pairs. -Maximum 64 per resource. || -|| environment | **enum** (Environment) +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Deployment environment of the PostgreSQL cluster. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -- `ENVIRONMENT_UNSPECIFIED` -- `PRODUCTION`: Stable environment with a conservative update policy: -only hotfixes are applied during regular maintenance. -- `PRESTABLE`: Environment with more aggressive update policy: new versions -are rolled out irrespective of backward compatibility. || -|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Description of monitoring systems relevant to the PostgreSQL cluster. || -|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Configuration of the PostgreSQL cluster. || -|| networkId | **string** +in milliseconds. || +|| lockTimeout | **string** (int64) -ID of the network that the cluster belongs to. || -|| health | **enum** (Health) +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Aggregated cluster health. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). -- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). -- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). -- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || -|| status | **enum** (Status) +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Current state of the cluster. +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -- `STATUS_UNKNOWN`: Cluster state is unknown. -- `CREATING`: Cluster is being created. -- `RUNNING`: Cluster is running normally. -- `ERROR`: Cluster encountered a problem and cannot operate. -- `UPDATING`: Cluster is being updated. -- `STOPPING`: Cluster is stopping. -- `STOPPED`: Cluster stopped. -- `STARTING`: Cluster is starting. || -|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Maintenance window for the cluster. || -|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** +in bytes. || +|| deadlockTimeout | **string** (int64) -Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || -|| securityGroupIds[] | **string** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -User security groups || -|| deletionProtection | **boolean** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| sqlInheritance | **boolean** -Deletion Protection inhibits deletion of the cluster || -|| hostGroupIds[] | **string** +This option has been removed in PostgreSQL 10. || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Host groups hosting VMs of the cluster. || -|# +in milliseconds. || +|| archiveTimeout | **string** (int64) -## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# -Monitoring system. +## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} #| ||Field | Description || -|| name | **string** +|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Name of the monitoring system. || -|| description | **string** +Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Description of the monitoring system. || -|| link | **string** +User-defined settings for a PostgreSQL 10 1C cluster. || +|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Link to the monitoring system charts for the PostgreSQL cluster. || +Default configuration for a PostgreSQL 10 1C cluster. || |# -## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} +## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || -|| version | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Version of PostgreSQL server software. || -|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** +in bytes. || +|| tempBuffers | **string** (int64) -Configuration of a PostgreSQL 9.6 server. +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -Configuration of a PostgreSQL 10 1C server. +in bytes. || +|| tempFileLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| vacuumCostDelay | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Configuration of a PostgreSQL 10 server. +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes || +|| backendFlushAfter | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -Configuration of a PostgreSQL 11 server. +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -Configuration of a PostgreSQL 11 1C server. +in bytes || +|| maxWalSize | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| minWalSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) -Configuration of a PostgreSQL 12 server. +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Configuration of a PostgreSQL 12 1C server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Configuration of a PostgreSQL 13 server. +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Configuration of a PostgreSQL 13 1C server. +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| lockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Configuration of a PostgreSQL 14 server. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -Configuration of a PostgreSQL 14 1C server. +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| deadlockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -Configuration of a PostgreSQL 15 server. +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| archiveTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -Configuration of a PostgreSQL 15 1C server. +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) -Configuration of a PostgreSQL 16 server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| onlineAnalyzeEnable | **boolean** || +|| plantunerFixEmptyTable | **boolean** || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| geqo | **boolean** -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -Configuration of a PostgreSQL 16 1C server. +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) -Configuration of the connection pooler. || -|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) -Resources allocated to PostgreSQL hosts. || -|| autofailover | **boolean** +selective pressure within the population || +|| geqoSeed | **number** (double) -Configuration setting which enables/disables autofailover in cluster. || -|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) -Time to start the daily backup, in the UTC timezone. || -|| backupRetainPeriodDays | **string** (int64) +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) -Retention policy of automated backups. || -|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -Access policy to DB || -|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -Configuration of the performance diagnostics service. || -|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. -Disk size autoscaling || +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} +## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** - -User-defined settings for a PostgreSQL 9.6 cluster. || -|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Default configuration for a PostgreSQL 9.6 cluster. || +User-defined settings for a PostgreSQL 10 cluster. || +|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** + +Default configuration for a PostgreSQL 10 cluster. || |# -## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} +## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -7299,9 +8940,7 @@ in bytes || || checkpointTimeout | **string** (int64) in milliseconds. || -|| checkpointCompletionTarget | **number** (double) - -Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointCompletionTarget | **number** (double) || || checkpointFlushAfter | **string** (int64) in bytes || @@ -7454,9 +9093,6 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** - -This option has been removed in PostgreSQL 10. || || autovacuumMaxWorkers | **string** (int64) || || autovacuumVacuumCostDelay | **string** (int64) || || autovacuumVacuumCostLimit | **string** (int64) || @@ -7467,31 +9103,139 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) + +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} +## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -User-defined settings for a PostgreSQL 10 1C cluster. || -|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +User-defined settings for a PostgreSQL 11 cluster. || +|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Default configuration for a PostgreSQL 10 1C cluster. || +Default configuration for a PostgreSQL 11 cluster. || |# -## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} +## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7509,7 +9253,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -7732,6 +9475,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -7778,8 +9530,6 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || -|| onlineAnalyzeEnable | **boolean** || -|| plantunerFixEmptyTable | **boolean** || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -7809,6 +9559,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -7828,27 +9581,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} +## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -User-defined settings for a PostgreSQL 10 cluster. || -|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +User-defined settings for a PostgreSQL 11 1C cluster. || +|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Default configuration for a PostgreSQL 10 cluster. || +Default configuration for a PostgreSQL 11 1C cluster. || |# -## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} +## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7866,7 +9619,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -8071,6 +9823,7 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || || enableBitmapscan | **boolean** || || enableHashagg | **boolean** || || enableHashjoin | **boolean** || @@ -8089,6 +9842,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8140,6 +9902,7 @@ in milliseconds. || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || || maxStackDepth | **string** (int64) in bytes. || @@ -8164,6 +9927,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -8183,23 +9949,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} +## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Effective settings for a PostgreSQL 11 cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -User-defined settings for a PostgreSQL 11 cluster. || -|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +User-defined settings for a PostgreSQL 12 cluster. || +|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Default configuration for a PostgreSQL 11 cluster. || +Default configuration for a PostgreSQL 12 cluster. || |# -## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} +## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8452,6 +10218,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8549,23 +10322,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} +## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -User-defined settings for a PostgreSQL 11 1C cluster. || -|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +User-defined settings for a PostgreSQL 12 1C cluster. || +|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Default configuration for a PostgreSQL 11 1C cluster. || +Default configuration for a PostgreSQL 12 1C cluster. || |# -## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} +## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8819,6 +10592,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8917,23 +10697,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} +## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Effective settings for a PostgreSQL 12 cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -User-defined settings for a PostgreSQL 12 cluster. || -|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +User-defined settings for a PostgreSQL 13 cluster. || +|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Default configuration for a PostgreSQL 12 cluster. || +Default configuration for a PostgreSQL 13 cluster. || |# -## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} +## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9239,6 +11019,30 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -9290,23 +11094,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} +## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -User-defined settings for a PostgreSQL 12 1C cluster. || -|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +User-defined settings for a PostgreSQL 13 1C cluster. || +|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Default configuration for a PostgreSQL 12 1C cluster. || +Default configuration for a PostgreSQL 13 1C cluster. || |# -## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} +## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9613,15 +11417,36 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || -|| maxStackDepth | **string** (int64) - -in bytes. || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -9665,23 +11490,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} +## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Effective settings for a PostgreSQL 13 cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -User-defined settings for a PostgreSQL 13 cluster. || -|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +User-defined settings for a PostgreSQL 14 cluster. || +|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Default configuration for a PostgreSQL 13 cluster. || +Default configuration for a PostgreSQL 14 cluster. || |# -## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} +## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9889,7 +11714,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -9933,7 +11757,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10011,6 +11834,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10062,23 +11900,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} +## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -User-defined settings for a PostgreSQL 13 1C cluster. || -|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +User-defined settings for a PostgreSQL 14 1C cluster. || +|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Default configuration for a PostgreSQL 13 1C cluster. || +Default configuration for a PostgreSQL 14 1C cluster. || |# -## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} +## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10286,7 +12124,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -10331,7 +12168,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10409,6 +12245,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10458,23 +12309,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} +## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Effective settings for a PostgreSQL 14 cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -User-defined settings for a PostgreSQL 14 cluster. || -|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +User-defined settings for a PostgreSQL 15 cluster. || +|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Default configuration for a PostgreSQL 14 cluster. || +Default configuration for a PostgreSQL 15 cluster. || |# -## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} +## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10744,7 +12595,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -10825,6 +12677,7 @@ in milliseconds. || || maxStackDepth | **string** (int64) in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -10868,23 +12721,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} +## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -User-defined settings for a PostgreSQL 14 1C cluster. || -|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +User-defined settings for a PostgreSQL 15 1C cluster. || +|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Default configuration for a PostgreSQL 14 1C cluster. || +Default configuration for a PostgreSQL 15 1C cluster. || |# -## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} +## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11155,7 +13008,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -11234,6 +13088,10 @@ in milliseconds. || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -11277,23 +13135,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} +## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Effective settings for a PostgreSQL 15 cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -User-defined settings for a PostgreSQL 15 cluster. || -|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +User-defined settings for a PostgreSQL 16 cluster. || +|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Default configuration for a PostgreSQL 15 cluster. || +Default configuration for a PostgreSQL 16 cluster. || |# -## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} +## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11379,12 +13237,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11393,6 +13251,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11407,6 +13266,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11421,6 +13281,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11592,6 +13453,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11689,23 +13551,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} +## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -User-defined settings for a PostgreSQL 15 1C cluster. || -|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +User-defined settings for a PostgreSQL 16 1C cluster. || +|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Default configuration for a PostgreSQL 15 1C cluster. || +Default configuration for a PostgreSQL 16 1C cluster. || |# -## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} +## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11791,12 +13653,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11805,6 +13667,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11819,6 +13682,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11833,6 +13697,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12005,6 +13870,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12103,27 +13969,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} +## PostgresqlConfigSet17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| effectiveConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Effective settings for a PostgreSQL 16 cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| userConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -User-defined settings for a PostgreSQL 16 cluster. || -|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Default configuration for a PostgreSQL 16 cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12165,7 +14031,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12517,29 +14382,42 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# -## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} +## PostgresqlConfigSet17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| effectiveConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| userConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -User-defined settings for a PostgreSQL 16 1C cluster. || -|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Default configuration for a PostgreSQL 16 1C cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12581,7 +14459,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12935,6 +14812,19 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# ## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig} diff --git a/ru/managed-postgresql/api-ref/Cluster/create.md b/ru/managed-postgresql/api-ref/Cluster/create.md index ae91fe2b3e3..01f39795a39 100644 --- a/ru/managed-postgresql/api-ref/Cluster/create.md +++ b/ru/managed-postgresql/api-ref/Cluster/create.md @@ -24,7 +24,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "environment": "string", "configSpec": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "maxConnections": "string", "sharedBuffers": "string", @@ -2264,162 +2264,570 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "logAutovacuumMinDuration": "string", "passwordEncryption": "string" }, - // end of the list of possible fields - "poolerConfig": { - "poolingMode": "string", - "poolDiscard": "boolean" - }, - "resources": { - "resourcePresetId": "string", - "diskSize": "string", - "diskTypeId": "string" - }, - "autofailover": "boolean", - "backupWindowStart": { - "hours": "integer", - "minutes": "integer", - "seconds": "integer", - "nanos": "integer" - }, - "backupRetainPeriodDays": "string", - "access": { - "dataLens": "boolean", - "webSql": "boolean", - "serverless": "boolean", - "dataTransfer": "boolean", - "yandexQuery": "boolean" - }, - "performanceDiagnostics": { - "enabled": "boolean", - "sessionsSamplingInterval": "string", - "statementsSamplingInterval": "string" - }, - "diskSizeAutoscaling": { - "plannedUsageThreshold": "string", - "emergencyUsageThreshold": "string", - "diskSizeLimit": "string" - } - }, - "databaseSpecs": [ - { - "name": "string", - "owner": "string", - "lcCollate": "string", - "lcCtype": "string", - "extensions": [ - { - "name": "string", - "version": "string" - } - ], - "templateDb": "string", - "deletionProtection": "boolean" - } - ], - "userSpecs": [ - { - "name": "string", - "password": "string", - "permissions": [ - { - "databaseName": "string" - } - ], - "connLimit": "string", - "settings": { - "defaultTransactionIsolation": "string", - "lockTimeout": "string", - "logMinDurationStatement": "string", - "synchronousCommit": "string", - "tempFileLimit": "string", - "logStatement": "string", - "poolMode": "string", - "preparedStatementsPooling": "boolean", - "catchupTimeout": "string", - "walSenderTimeout": "string", - "idleInTransactionSessionTimeout": "string", - "statementTimeout": "string", - "pgaudit": { - "log": [ - "string" - ] - } - }, - "login": "boolean", - "grants": [ + "postgresqlConfig_17": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ "string" ], - "deletionProtection": "boolean", - "userPasswordEncryption": "string" - } - ], - "hostSpecs": [ - { - "zoneId": "string", - "subnetId": "string", - "assignPublicIp": "boolean", - "replicationSource": "string", - "priority": "string", - "configSpec": { - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` - "postgresqlConfig_9_6": { - "recoveryMinApplyDelay": "string", - "sharedBuffers": "string", - "tempBuffers": "string", - "workMem": "string", - "replacementSortTuples": "string", - "tempFileLimit": "string", - "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", - "maxStandbyStreamingDelay": "string", - "constraintExclusion": "string", - "cursorTupleFraction": "number", - "fromCollapseLimit": "string", - "joinCollapseLimit": "string", - "forceParallelMode": "string", - "clientMinMessages": "string", - "logMinMessages": "string", - "logMinErrorStatement": "string", - "logMinDurationStatement": "string", - "logCheckpoints": "boolean", - "logConnections": "boolean", - "logDisconnections": "boolean", - "logDuration": "boolean", - "logErrorVerbosity": "string", - "logLockWaits": "boolean", - "logStatement": "string", - "logTempFiles": "string", - "searchPath": "string", - "rowSecurity": "boolean", - "defaultTransactionIsolation": "string", - "statementTimeout": "string", - "lockTimeout": "string", - "idleInTransactionSessionTimeout": "string", - "byteaOutput": "string", - "xmlbinary": "string", - "xmloption": "string", - "ginPendingListLimit": "string", - "deadlockTimeout": "string", - "maxLocksPerTransaction": "string", - "maxPredLocksPerTransaction": "string", - "arrayNulls": "boolean", - "backslashQuote": "string", - "defaultWithOids": "boolean", - "escapeStringWarning": "boolean", - "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", - "quoteAllIdentifiers": "boolean", - "standardConformingStrings": "boolean", - "synchronizeSeqscans": "boolean", - "transformNullEquals": "boolean", - "exitOnError": "boolean", - "seqPageCost": "number", - "randomPageCost": "number", - "sqlInheritance": "boolean", - "effectiveIoConcurrency": "string", + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "postgresqlConfig_17_1c": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + // end of the list of possible fields + "poolerConfig": { + "poolingMode": "string", + "poolDiscard": "boolean" + }, + "resources": { + "resourcePresetId": "string", + "diskSize": "string", + "diskTypeId": "string" + }, + "autofailover": "boolean", + "backupWindowStart": { + "hours": "integer", + "minutes": "integer", + "seconds": "integer", + "nanos": "integer" + }, + "backupRetainPeriodDays": "string", + "access": { + "dataLens": "boolean", + "webSql": "boolean", + "serverless": "boolean", + "dataTransfer": "boolean", + "yandexQuery": "boolean" + }, + "performanceDiagnostics": { + "enabled": "boolean", + "sessionsSamplingInterval": "string", + "statementsSamplingInterval": "string" + }, + "diskSizeAutoscaling": { + "plannedUsageThreshold": "string", + "emergencyUsageThreshold": "string", + "diskSizeLimit": "string" + } + }, + "databaseSpecs": [ + { + "name": "string", + "owner": "string", + "lcCollate": "string", + "lcCtype": "string", + "extensions": [ + { + "name": "string", + "version": "string" + } + ], + "templateDb": "string", + "deletionProtection": "boolean" + } + ], + "userSpecs": [ + { + "name": "string", + "password": "string", + "permissions": [ + { + "databaseName": "string" + } + ], + "connLimit": "string", + "settings": { + "defaultTransactionIsolation": "string", + "lockTimeout": "string", + "logMinDurationStatement": "string", + "synchronousCommit": "string", + "tempFileLimit": "string", + "logStatement": "string", + "poolMode": "string", + "preparedStatementsPooling": "boolean", + "catchupTimeout": "string", + "walSenderTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "statementTimeout": "string", + "pgaudit": { + "log": [ + "string" + ] + } + }, + "login": "boolean", + "grants": [ + "string" + ], + "deletionProtection": "boolean", + "userPasswordEncryption": "string" + } + ], + "hostSpecs": [ + { + "zoneId": "string", + "subnetId": "string", + "assignPublicIp": "boolean", + "replicationSource": "string", + "priority": "string", + "configSpec": { + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` + "postgresqlConfig_9_6": { + "recoveryMinApplyDelay": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "workMem": "string", + "replacementSortTuples": "string", + "tempFileLimit": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "maxStandbyStreamingDelay": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "sqlInheritance": "boolean", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + }, + "postgresqlConfig_10_1c": { + "recoveryMinApplyDelay": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "workMem": "string", + "replacementSortTuples": "string", + "tempFileLimit": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "maxStandbyStreamingDelay": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "timezone": "string", + "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_10_1c": { + "postgresqlConfig_10": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2489,12 +2897,11 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_10": { + "postgresqlConfig_11": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", "workMem": "string", - "replacementSortTuples": "string", "tempFileLimit": "string", "backendFlushAfter": "string", "oldSnapshotThreshold": "string", @@ -2559,7 +2966,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_11": { + "postgresqlConfig_11_1c": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2628,7 +3035,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_11_1c": { + "postgresqlConfig_12": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2697,7 +3104,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_12": { + "postgresqlConfig_12_1c": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2766,7 +3173,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_12_1c": { + "postgresqlConfig_13": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2835,7 +3242,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_13": { + "postgresqlConfig_13_1c": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2904,7 +3311,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_13_1c": { + "postgresqlConfig_14": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2948,7 +3355,6 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -2973,7 +3379,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_14": { + "postgresqlConfig_14_1c": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -3041,7 +3447,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_14_1c": { + "postgresqlConfig_15": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -3109,7 +3515,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_15": { + "postgresqlConfig_15_1c": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -3177,7 +3583,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_15_1c": { + "postgresqlConfig_16": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -3190,7 +3596,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -3245,7 +3651,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_16": { + "postgresqlConfig_16_1c": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -3313,14 +3719,80 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_16_1c": { + "postgresqlConfig_17": { + "recoveryMinApplyDelay": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "workMem": "string", + "tempFileLimit": "string", + "backendFlushAfter": "string", + "maxStandbyStreamingDelay": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + }, + "postgresqlConfig_17_1c": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", "workMem": "string", "tempFileLimit": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "maxStandbyStreamingDelay": "string", "constraintExclusion": "string", "cursorTupleFraction": "number", @@ -3398,198 +3870,789 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters #| ||Field | Description || -|| folderId | **string** +|| folderId | **string** + +Required field. ID of the folder to create the PostgreSQL cluster in. || +|| name | **string** + +Required field. Name of the PostgreSQL cluster. The name must be unique within the folder. || +|| description | **string** + +Description of the PostgreSQL cluster. || +|| labels | **string** + +Custom labels for the PostgreSQL cluster as `` key:value `` pairs. Maximum 64 per resource. +For example, "project": "mvp" or "source": "dictionary". || +|| environment | **enum** (Environment) + +Required field. Deployment environment of the PostgreSQL cluster. + +- `ENVIRONMENT_UNSPECIFIED` +- `PRODUCTION`: Stable environment with a conservative update policy: +only hotfixes are applied during regular maintenance. +- `PRESTABLE`: Environment with more aggressive update policy: new versions +are rolled out irrespective of backward compatibility. || +|| configSpec | **[ConfigSpec](#yandex.cloud.mdb.postgresql.v1.ConfigSpec)** + +Required field. Configuration and resources for hosts that should be created for the PostgreSQL cluster. || +|| databaseSpecs[] | **[DatabaseSpec](#yandex.cloud.mdb.postgresql.v1.DatabaseSpec)** + +Required field. Descriptions of databases to be created in the PostgreSQL cluster. || +|| userSpecs[] | **[UserSpec](#yandex.cloud.mdb.postgresql.v1.UserSpec)** + +Required field. Descriptions of database users to be created in the PostgreSQL cluster. || +|| hostSpecs[] | **[HostSpec](#yandex.cloud.mdb.postgresql.v1.HostSpec)** + +Required field. Individual configurations for hosts that should be created for the PostgreSQL cluster. || +|| networkId | **string** + +Required field. ID of the network to create the cluster in. || +|| securityGroupIds[] | **string** + +User security groups || +|| deletionProtection | **boolean** + +Deletion Protection inhibits deletion of the cluster || +|| hostGroupIds[] | **string** + +Host groups hosting VMs of the cluster. || +|# + +## ConfigSpec {#yandex.cloud.mdb.postgresql.v1.ConfigSpec} + +#| +||Field | Description || +|| version | **string** + +Version of PostgreSQL used in the cluster. +Possible values: `9.6`, `10`, `10_1c`, `11`, `12`, `13`, `14`, `15`, `16`, `17` || +|| postgresqlConfig_9_6 | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** + +Configuration for a PostgreSQL 9.6 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_10_1c | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** + +Configuration for a PostgreSQL 10 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_10 | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** + +Configuration for a PostgreSQL 10 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_11 | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** + +Configuration for a PostgreSQL 11 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_11_1c | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** + +Configuration for a PostgreSQL 11 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_12 | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** + +Configuration for a PostgreSQL 12 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_12_1c | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** + +Configuration for a PostgreSQL 12 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_13 | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** + +Configuration for a PostgreSQL 13 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_13_1c | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** + +Configuration for a PostgreSQL 13 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_14 | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** + +Configuration for a PostgreSQL 14 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_14_1c | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** + +Configuration for a PostgreSQL 14 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_15 | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** + +Configuration for a PostgreSQL 15 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_15_1c | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** + +Configuration for a PostgreSQL 15 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_16 | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** + +Configuration for a PostgreSQL 16 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_16_1c | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** + +Configuration for a PostgreSQL 16 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** + +Configuration for a PostgreSQL 17 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** + +Configuration for a PostgreSQL 17 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** + +Configuration of the connection pooler. || +|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** + +Resources allocated to PostgreSQL hosts. || +|| autofailover | **boolean** + +Configuration setting which enables/disables autofailover in cluster. || +|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** + +Time to start the daily backup, in the UTC timezone. || +|| backupRetainPeriodDays | **string** (int64) + +Retention policy of automated backups. || +|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** + +Access policy to DB || +|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** + +Configuration of the performance diagnostics service. || +|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** + +Disk size autoscaling || +|# + +## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). + +#| +||Field | Description || +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Required field. ID of the folder to create the PostgreSQL cluster in. || -|| name | **string** +in bytes. || +|| tempBuffers | **string** (int64) -Required field. Name of the PostgreSQL cluster. The name must be unique within the folder. || -|| description | **string** +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Description of the PostgreSQL cluster. || -|| labels | **string** +in bytes. || +|| maintenanceWorkMem | **string** (int64) -Custom labels for the PostgreSQL cluster as `` key:value `` pairs. Maximum 64 per resource. -For example, "project": "mvp" or "source": "dictionary". || -|| environment | **enum** (Environment) +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -Required field. Deployment environment of the PostgreSQL cluster. +in bytes. || +|| tempFileLimit | **string** (int64) -- `ENVIRONMENT_UNSPECIFIED` -- `PRODUCTION`: Stable environment with a conservative update policy: -only hotfixes are applied during regular maintenance. -- `PRESTABLE`: Environment with more aggressive update policy: new versions -are rolled out irrespective of backward compatibility. || -|| configSpec | **[ConfigSpec](#yandex.cloud.mdb.postgresql.v1.ConfigSpec)** +in bytes. || +|| vacuumCostDelay | **string** (int64) -Required field. Configuration and resources for hosts that should be created for the PostgreSQL cluster. || -|| databaseSpecs[] | **[DatabaseSpec](#yandex.cloud.mdb.postgresql.v1.DatabaseSpec)** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Required field. Descriptions of databases to be created in the PostgreSQL cluster. || -|| userSpecs[] | **[UserSpec](#yandex.cloud.mdb.postgresql.v1.UserSpec)** +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Required field. Descriptions of database users to be created in the PostgreSQL cluster. || -|| hostSpecs[] | **[HostSpec](#yandex.cloud.mdb.postgresql.v1.HostSpec)** +in bytes || +|| backendFlushAfter | **string** (int64) -Required field. Individual configurations for hosts that should be created for the PostgreSQL cluster. || -|| networkId | **string** +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) + +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) + +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) + +Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) -Required field. ID of the network to create the cluster in. || -|| securityGroupIds[] | **string** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -User security groups || -|| deletionProtection | **boolean** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| sqlInheritance | **boolean** -Deletion Protection inhibits deletion of the cluster || -|| hostGroupIds[] | **string** +This option has been removed in PostgreSQL 10. || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Host groups hosting VMs of the cluster. || +in milliseconds. || +|| archiveTimeout | **string** (int64) + +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || |# -## ConfigSpec {#yandex.cloud.mdb.postgresql.v1.ConfigSpec} +## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || -|| version | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Version of PostgreSQL used in the cluster. -Possible values: `9.6`, `10`, `10_1c`, `11`, `12`, `13`, `14`, `15` || -|| postgresqlConfig_9_6 | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +in bytes. || +|| tempBuffers | **string** (int64) -Configuration for a PostgreSQL 9.6 cluster. +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_10_1c | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -Configuration for a PostgreSQL 10 1C cluster. +in bytes. || +|| tempFileLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| vacuumCostDelay | **string** (int64) -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_10 | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Configuration for a PostgreSQL 10 cluster. +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes || +|| backendFlushAfter | **string** (int64) -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_11 | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -Configuration for a PostgreSQL 11 cluster. +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_11_1c | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -Configuration for a PostgreSQL 11 1C cluster. +in bytes || +|| maxWalSize | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| minWalSize | **string** (int64) -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_12 | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) -Configuration for a PostgreSQL 12 cluster. +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_12_1c | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Configuration for a PostgreSQL 12 1C cluster. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_13 | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Configuration for a PostgreSQL 13 cluster. +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_13_1c | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Configuration for a PostgreSQL 13 1C cluster. +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| lockTimeout | **string** (int64) -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_14 | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Configuration for a PostgreSQL 14 cluster. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_14_1c | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -Configuration for a PostgreSQL 14 1C cluster. +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| deadlockTimeout | **string** (int64) -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_15 | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -Configuration for a PostgreSQL 15 cluster. +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| archiveTimeout | **string** (int64) -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_15_1c | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -Configuration for a PostgreSQL 15 1C cluster. +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_16 | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) -Configuration for a PostgreSQL 16 cluster. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| onlineAnalyzeEnable | **boolean** || +|| plantunerFixEmptyTable | **boolean** || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| geqo | **boolean** -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_16_1c | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -Configuration for a PostgreSQL 16 1C cluster. +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) -Configuration of a PostgreSQL cluster. || -|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) -Configuration of the connection pooler. || -|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) -Resources allocated to PostgreSQL hosts. || -|| autofailover | **boolean** +selective pressure within the population || +|| geqoSeed | **number** (double) -Configuration setting which enables/disables autofailover in cluster. || -|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) -Time to start the daily backup, in the UTC timezone. || -|| backupRetainPeriodDays | **string** (int64) +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) -Retention policy of automated backups. || -|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -Access policy to DB || -|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -Configuration of the performance diagnostics service. || -|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. -Disk size autoscaling || +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} +## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -3649,9 +4712,7 @@ in bytes || || checkpointTimeout | **string** (int64) in milliseconds. || -|| checkpointCompletionTarget | **number** (double) - -Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointCompletionTarget | **number** (double) || || checkpointFlushAfter | **string** (int64) in bytes || @@ -3748,84 +4809,189 @@ in milliseconds. || || rowSecurity | **boolean** || || defaultTransactionIsolation | **enum** (TransactionIsolation) -- `TRANSACTION_ISOLATION_UNSPECIFIED` -- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` -- `TRANSACTION_ISOLATION_READ_COMMITTED` -- `TRANSACTION_ISOLATION_REPEATABLE_READ` -- `TRANSACTION_ISOLATION_SERIALIZABLE` || -|| statementTimeout | **string** (int64) +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) + +in milliseconds. || +|| archiveTimeout | **string** (int64) + +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) -in milliseconds. || -|| lockTimeout | **string** (int64) +in bytes. || +|| geqo | **boolean** -in milliseconds. || -|| idleInTransactionSessionTimeout | **string** (int64) +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -in milliseconds. || -|| byteaOutput | **enum** (ByteaOutput) +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -- `BYTEA_OUTPUT_UNSPECIFIED` -- `BYTEA_OUTPUT_HEX` -- `BYTEA_OUTPUT_ESCAPED` || -|| xmlbinary | **enum** (XmlBinary) +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) -- `XML_BINARY_UNSPECIFIED` -- `XML_BINARY_BASE64` -- `XML_BINARY_HEX` || -|| xmloption | **enum** (XmlOption) +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) -- `XML_OPTION_UNSPECIFIED` -- `XML_OPTION_DOCUMENT` -- `XML_OPTION_CONTENT` || -|| ginPendingListLimit | **string** (int64) +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) -in bytes. || -|| deadlockTimeout | **string** (int64) +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) in milliseconds. || -|| maxLocksPerTransaction | **string** (int64) || -|| maxPredLocksPerTransaction | **string** (int64) || -|| arrayNulls | **boolean** || -|| backslashQuote | **enum** (BackslashQuote) +|| sessionDurationTimeout | **string** (int64) -- `BACKSLASH_QUOTE_UNSPECIFIED` -- `BACKSLASH_QUOTE` -- `BACKSLASH_QUOTE_ON` -- `BACKSLASH_QUOTE_OFF` -- `BACKSLASH_QUOTE_SAFE_ENCODING` || -|| defaultWithOids | **boolean** || -|| escapeStringWarning | **boolean** || -|| loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || -|| quoteAllIdentifiers | **boolean** || -|| standardConformingStrings | **boolean** || -|| synchronizeSeqscans | **boolean** || -|| transformNullEquals | **boolean** || -|| exitOnError | **boolean** || -|| seqPageCost | **number** (double) || -|| randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -This option has been removed in PostgreSQL 10. || -|| autovacuumMaxWorkers | **string** (int64) || -|| autovacuumVacuumCostDelay | **string** (int64) || -|| autovacuumVacuumCostLimit | **string** (int64) || -|| autovacuumNaptime | **string** (int64) +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -in milliseconds. || -|| archiveTimeout | **string** (int64) +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. -in milliseconds. || -|| trackActivityQuerySize | **string** (int64) || -|| effectiveIoConcurrency | **string** (int64) || -|| effectiveCacheSize | **string** (int64) || +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} +## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -3843,7 +5009,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -4066,6 +5231,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -4112,8 +5286,6 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || -|| onlineAnalyzeEnable | **boolean** || -|| plantunerFixEmptyTable | **boolean** || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -4143,6 +5315,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -4162,11 +5337,11 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} +## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -4184,7 +5359,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -4389,6 +5563,7 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || || enableBitmapscan | **boolean** || || enableHashagg | **boolean** || || enableHashjoin | **boolean** || @@ -4407,6 +5582,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -4458,6 +5642,7 @@ in milliseconds. || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || || maxStackDepth | **string** (int64) in bytes. || @@ -4482,6 +5667,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -4501,7 +5689,7 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} +## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -4754,6 +5942,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -4851,7 +6046,7 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} +## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -5105,6 +6300,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -5203,7 +6405,7 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} +## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -5509,6 +6711,30 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -5560,7 +6786,7 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} +## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -5867,15 +7093,36 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || -|| maxStackDepth | **string** (int64) - -in bytes. || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -5919,7 +7166,7 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} +## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -6127,7 +7374,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -6171,7 +7417,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -6249,6 +7494,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -6300,7 +7560,7 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} +## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -6508,7 +7768,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -6553,7 +7812,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -6631,6 +7889,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -6680,7 +7953,7 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} +## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -6950,7 +8223,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -7031,6 +8305,7 @@ in milliseconds. || || maxStackDepth | **string** (int64) in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -7074,7 +8349,7 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} +## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -7345,7 +8620,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -7424,6 +8700,10 @@ in milliseconds. || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -7467,7 +8747,7 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} +## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -7553,12 +8833,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -7567,6 +8847,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -7581,6 +8862,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -7595,6 +8877,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -7766,6 +9049,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -7863,7 +9147,7 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} +## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -7949,12 +9233,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -7963,6 +9247,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -7977,6 +9262,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -7991,6 +9277,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -8163,6 +9450,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -8261,11 +9549,11 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -8307,7 +9595,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -8659,13 +9946,26 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# -## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -8707,7 +10007,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -9061,6 +10360,19 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# ## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig} @@ -9423,151 +10735,526 @@ Defines which user queries will be written to the audit log. Corresponds to the The possible values are the following: -* PG_AUDIT_SETTINGS_LOG_READ: `SELECT` and `COPY` queries are logged if the data source is a relation or query. -* PG_AUDIT_SETTINGS_LOG_WRITE: `INSERT`, `UPDATE`, `DELETE`, `TRUNCATE`, and `COPY` queries are logged if the data target is a relation. -* PG_AUDIT_SETTINGS_LOG_FUNCTION: Function invocations and `DO` sections are logged. -* PG_AUDIT_SETTINGS_LOG_ROLE: Statements related to role and privilege management, such as `GRANT`, `REVOKE`, or `CREATE/ALTER/DROP ROLE`, are logged. -* PG_AUDIT_SETTINGS_LOG_DDL: Any `DDL` statements that do not belong to the `ROLE` class are logged. -* PG_AUDIT_SETTINGS_LOG_MISC: Miscellaneous commands, such as `DISCARD`, `FETCH`, `CHECKPOINT`, `VACUUM`, and `SET`, are logged. -* PG_AUDIT_SETTINGS_LOG_MISC_SET: Miscellaneous `SET` commands, e.g., `SET ROLE`, are logged. +* PG_AUDIT_SETTINGS_LOG_READ: `SELECT` and `COPY` queries are logged if the data source is a relation or query. +* PG_AUDIT_SETTINGS_LOG_WRITE: `INSERT`, `UPDATE`, `DELETE`, `TRUNCATE`, and `COPY` queries are logged if the data target is a relation. +* PG_AUDIT_SETTINGS_LOG_FUNCTION: Function invocations and `DO` sections are logged. +* PG_AUDIT_SETTINGS_LOG_ROLE: Statements related to role and privilege management, such as `GRANT`, `REVOKE`, or `CREATE/ALTER/DROP ROLE`, are logged. +* PG_AUDIT_SETTINGS_LOG_DDL: Any `DDL` statements that do not belong to the `ROLE` class are logged. +* PG_AUDIT_SETTINGS_LOG_MISC: Miscellaneous commands, such as `DISCARD`, `FETCH`, `CHECKPOINT`, `VACUUM`, and `SET`, are logged. +* PG_AUDIT_SETTINGS_LOG_MISC_SET: Miscellaneous `SET` commands, e.g., `SET ROLE`, are logged. + +The default value is PG_AUDIT_SETTINGS_LOG_UNSPECIFIED. In this case, the parameter is not configured. + +- `PG_AUDIT_SETTINGS_LOG_UNSPECIFIED` +- `PG_AUDIT_SETTINGS_LOG_READ` +- `PG_AUDIT_SETTINGS_LOG_WRITE` +- `PG_AUDIT_SETTINGS_LOG_FUNCTION` +- `PG_AUDIT_SETTINGS_LOG_ROLE` +- `PG_AUDIT_SETTINGS_LOG_DDL` +- `PG_AUDIT_SETTINGS_LOG_MISC` +- `PG_AUDIT_SETTINGS_LOG_MISC_SET` || +|# + +## HostSpec {#yandex.cloud.mdb.postgresql.v1.HostSpec} + +#| +||Field | Description || +|| zoneId | **string** + +ID of the availability zone where the host resides. +To get a list of available zones, use the [yandex.cloud.compute.v1.ZoneService.List](/docs/compute/api-ref/Zone/list#List) request. || +|| subnetId | **string** + +ID of the subnet that the host should belong to. This subnet should be a part +of the network that the cluster belongs to. +The ID of the network is set in the field [Cluster.networkId](#yandex.cloud.mdb.postgresql.v1.Cluster). || +|| assignPublicIp | **boolean** + +Whether the host should get a public IP address on creation. + +After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign +a public IP to a host without one, recreate the host with `assignPublicIp` set as needed. + +Possible values: +* false - don't assign a public IP to the host. +* true - the host should have a public IP address. || +|| replicationSource | **string** + +[Host.name](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) of the host to be used as the replication source (for cascading replication). || +|| priority | **string** (int64) + +Priority of the host as a replica. A higher value corresponds to higher priority. + +The host with the highest priority is the synchronous replica. All others are asynchronous. +The synchronous replica replaces the master when needed. + +When a replica becomes the master, its priority is ignored. || +|| configSpec | **[ConfigHostSpec](#yandex.cloud.mdb.postgresql.v1.ConfigHostSpec)** + +Configuration of a PostgreSQL server for the host. || +|# + +## ConfigHostSpec {#yandex.cloud.mdb.postgresql.v1.ConfigHostSpec} + +#| +||Field | Description || +|| postgresqlConfig_9_6 | **[PostgresqlHostConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6)** + +Configuration for a host with PostgreSQL 9.6 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_10_1c | **[PostgresqlHostConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C)** + +Configuration for a host with PostgreSQL 10 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_10 | **[PostgresqlHostConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10)** + +Configuration for a host with PostgreSQL 10 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_11 | **[PostgresqlHostConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11)** + +Configuration for a host with PostgreSQL 11 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_11_1c | **[PostgresqlHostConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C)** + +Configuration for a host with PostgreSQL 11 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_12 | **[PostgresqlHostConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12)** + +Configuration for a host with PostgreSQL 12 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_12_1c | **[PostgresqlHostConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C)** + +Configuration for a host with PostgreSQL 12 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_13 | **[PostgresqlHostConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13)** + +Configuration for a host with PostgreSQL 13 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_13_1c | **[PostgresqlHostConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C)** + +Configuration for a host with PostgreSQL 13 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_14 | **[PostgresqlHostConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14)** + +Configuration for a host with PostgreSQL 14 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_14_1c | **[PostgresqlHostConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C)** + +Configuration for a host with PostgreSQL 14 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_15 | **[PostgresqlHostConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15)** + +Configuration for a host with PostgreSQL 15 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_15_1c | **[PostgresqlHostConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C)** + +Configuration for a host with PostgreSQL 15 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_16 | **[PostgresqlHostConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16)** + +Configuration for a host with PostgreSQL 16 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_16_1c | **[PostgresqlHostConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C)** + +Configuration for a host with PostgreSQL 16 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17 | **[PostgresqlHostConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17_1c | **[PostgresqlHostConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|# + +## PostgresqlHostConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6} + +Options and structure of `PostgresqlHostConfig` reflects parameters of a PostgreSQL +configuration file. Detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/runtime-config.html). + +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| workMem | **string** (int64) + +in bytes. || +|| replacementSortTuples | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| oldSnapshotThreshold | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -The default value is PG_AUDIT_SETTINGS_LOG_UNSPECIFIED. In this case, the parameter is not configured. +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -- `PG_AUDIT_SETTINGS_LOG_UNSPECIFIED` -- `PG_AUDIT_SETTINGS_LOG_READ` -- `PG_AUDIT_SETTINGS_LOG_WRITE` -- `PG_AUDIT_SETTINGS_LOG_FUNCTION` -- `PG_AUDIT_SETTINGS_LOG_ROLE` -- `PG_AUDIT_SETTINGS_LOG_DDL` -- `PG_AUDIT_SETTINGS_LOG_MISC` -- `PG_AUDIT_SETTINGS_LOG_MISC_SET` || -|# +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -## HostSpec {#yandex.cloud.mdb.postgresql.v1.HostSpec} +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -#| -||Field | Description || -|| zoneId | **string** +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -ID of the availability zone where the host resides. -To get a list of available zones, use the [yandex.cloud.compute.v1.ZoneService.List](/docs/compute/api-ref/Zone/list#List) request. || -|| subnetId | **string** +in milliseconds. || +|| lockTimeout | **string** (int64) -ID of the subnet that the host should belong to. This subnet should be a part -of the network that the cluster belongs to. -The ID of the network is set in the field [Cluster.networkId](#yandex.cloud.mdb.postgresql.v1.Cluster). || -|| assignPublicIp | **boolean** +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Whether the host should get a public IP address on creation. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign -a public IP to a host without one, recreate the host with `assignPublicIp` set as needed. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Possible values: -* false - don't assign a public IP to the host. -* true - the host should have a public IP address. || -|| replicationSource | **string** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -[Host.name](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) of the host to be used as the replication source (for cascading replication). || -|| priority | **string** (int64) +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Priority of the host as a replica. A higher value corresponds to higher priority. +in bytes. || +|| deadlockTimeout | **string** (int64) -The host with the highest priority is the synchronous replica. All others are asynchronous. -The synchronous replica replaces the master when needed. +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -When a replica becomes the master, its priority is ignored. || -|| configSpec | **[ConfigHostSpec](#yandex.cloud.mdb.postgresql.v1.ConfigHostSpec)** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| sqlInheritance | **boolean** -Configuration of a PostgreSQL server for the host. || +This option has been removed in PostgreSQL 10. || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || |# -## ConfigHostSpec {#yandex.cloud.mdb.postgresql.v1.ConfigHostSpec} +## PostgresqlHostConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C} + +Options and structure of `PostgresqlHostConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || -|| postgresqlConfig_9_6 | **[PostgresqlHostConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6)** - -Configuration for a host with PostgreSQL 9.6 server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_10_1c | **[PostgresqlHostConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C)** - -Configuration for a host with PostgreSQL 10 1C server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_10 | **[PostgresqlHostConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10)** - -Configuration for a host with PostgreSQL 10 server deployed. +|| recoveryMinApplyDelay | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_11 | **[PostgresqlHostConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11)** +in milliseconds. || +|| sharedBuffers | **string** (int64) -Configuration for a host with PostgreSQL 11 server deployed. +in bytes. || +|| tempBuffers | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_11_1c | **[PostgresqlHostConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C)** +in bytes. || +|| workMem | **string** (int64) -Configuration for a host with PostgreSQL 11 1C server deployed. +in bytes. || +|| replacementSortTuples | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_12 | **[PostgresqlHostConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12)** +in bytes. || +|| tempFileLimit | **string** (int64) -Configuration for a host with PostgreSQL 12 server deployed. +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| oldSnapshotThreshold | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_12_1c | **[PostgresqlHostConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C)** +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) -Configuration for a host with PostgreSQL 12 1C server deployed. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_13 | **[PostgresqlHostConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13)** +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Configuration for a host with PostgreSQL 13 server deployed. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_13_1c | **[PostgresqlHostConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C)** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Configuration for a host with PostgreSQL 13 1C server deployed. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_14 | **[PostgresqlHostConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14)** +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Configuration for a host with PostgreSQL 14 server deployed. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_14_1c | **[PostgresqlHostConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Configuration for a host with PostgreSQL 14 1C server deployed. +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_15 | **[PostgresqlHostConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15)** +in milliseconds. || +|| lockTimeout | **string** (int64) -Configuration for a host with PostgreSQL 15 server deployed. +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_15_1c | **[PostgresqlHostConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C)** +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Configuration for a host with PostgreSQL 15 1C server deployed. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_16 | **[PostgresqlHostConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16)** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -Configuration for a host with PostgreSQL 16 server deployed. +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_16_1c | **[PostgresqlHostConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C)** +in bytes. || +|| deadlockTimeout | **string** (int64) -Configuration for a host with PostgreSQL 16 1C server deployed. +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6} +## PostgresqlHostConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10} -Options and structure of `PostgresqlHostConfig` reflects parameters of a PostgreSQL -configuration file. Detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/runtime-config.html). +Options and structure of `PostgresqlHostConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -9733,18 +11420,29 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** - -This option has been removed in PostgreSQL 10. || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C} +## PostgresqlHostConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11} -Options and structure of `PostgresqlHostConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -9759,9 +11457,6 @@ in bytes. || in bytes. || || workMem | **string** (int64) -in bytes. || -|| replacementSortTuples | **string** (int64) - in bytes. || || tempFileLimit | **string** (int64) @@ -9928,11 +11623,11 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10} +## PostgresqlHostConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C} -Options and structure of `PostgresqlHostConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -9947,9 +11642,6 @@ in bytes. || in bytes. || || workMem | **string** (int64) -in bytes. || -|| replacementSortTuples | **string** (int64) - in bytes. || || tempFileLimit | **string** (int64) @@ -10116,7 +11808,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11} +## PostgresqlHostConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10301,7 +11993,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C} +## PostgresqlHostConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10486,7 +12178,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12} +## PostgresqlHostConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10671,7 +12363,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C} +## PostgresqlHostConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10856,7 +12548,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13} +## PostgresqlHostConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11015,7 +12707,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -11041,7 +12732,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C} +## PostgresqlHostConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11200,7 +12891,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -11226,7 +12916,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14} +## PostgresqlHostConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11410,7 +13100,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C} +## PostgresqlHostConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11594,7 +13284,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15} +## PostgresqlHostConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11631,12 +13321,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11645,6 +13335,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11659,6 +13350,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11673,6 +13365,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11778,7 +13471,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C} +## PostgresqlHostConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11815,12 +13508,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11829,6 +13522,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11843,6 +13537,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11857,6 +13552,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11962,11 +13658,11 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16} +## PostgresqlHostConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -11986,7 +13682,6 @@ in bytes. || in bytes. || || backendFlushAfter | **string** (int64) || -|| oldSnapshotThreshold | **string** (int64) || || maxStandbyStreamingDelay | **string** (int64) in milliseconds. || @@ -12149,11 +13844,11 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C} +## PostgresqlHostConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12173,7 +13868,6 @@ in bytes. || in bytes. || || backendFlushAfter | **string** (int64) || -|| oldSnapshotThreshold | **string** (int64) || || maxStandbyStreamingDelay | **string** (int64) in milliseconds. || @@ -12376,7 +14070,7 @@ in milliseconds. || ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "effectiveConfig": { "maxConnections": "string", @@ -12451,15 +14145,723 @@ in milliseconds. || "exitOnError": "boolean", "seqPageCost": "number", "randomPageCost": "number", - "sqlInheritance": "boolean", + "sqlInheritance": "boolean", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "sqlInheritance": "boolean", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "sqlInheritance": "boolean", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + } + }, + "postgresqlConfig_10_1c": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "onlineAnalyzeEnable": "boolean", + "plantunerFixEmptyTable": "boolean", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "onlineAnalyzeEnable": "boolean", + "plantunerFixEmptyTable": "boolean", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "onlineAnalyzeEnable": "boolean", + "plantunerFixEmptyTable": "boolean", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" + } + }, + "postgresqlConfig_10": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", "autovacuumMaxWorkers": "string", "autovacuumVacuumCostDelay": "string", "autovacuumVacuumCostLimit": "string", "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", "effectiveIoConcurrency": "string", - "effectiveCacheSize": "string" + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" }, "userConfig": { "maxConnections": "string", @@ -12534,15 +14936,65 @@ in milliseconds. || "exitOnError": "boolean", "seqPageCost": "number", "randomPageCost": "number", - "sqlInheritance": "boolean", "autovacuumMaxWorkers": "string", "autovacuumVacuumCostDelay": "string", "autovacuumVacuumCostLimit": "string", "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", "effectiveIoConcurrency": "string", - "effectiveCacheSize": "string" + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" }, "defaultConfig": { "maxConnections": "string", @@ -12617,18 +15069,68 @@ in milliseconds. || "exitOnError": "boolean", "seqPageCost": "number", "randomPageCost": "number", - "sqlInheritance": "boolean", "autovacuumMaxWorkers": "string", "autovacuumVacuumCostDelay": "string", "autovacuumVacuumCostLimit": "string", "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", "effectiveIoConcurrency": "string", - "effectiveCacheSize": "string" + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" } }, - "postgresqlConfig_10_1c": { + "postgresqlConfig_11": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -12636,7 +15138,6 @@ in milliseconds. || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -12726,6 +15227,15 @@ in milliseconds. || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -12743,8 +15253,6 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", - "onlineAnalyzeEnable": "boolean", - "plantunerFixEmptyTable": "boolean", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -12758,6 +15266,9 @@ in milliseconds. || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -12771,7 +15282,6 @@ in milliseconds. || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -12861,6 +15371,15 @@ in milliseconds. || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -12878,8 +15397,6 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", - "onlineAnalyzeEnable": "boolean", - "plantunerFixEmptyTable": "boolean", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -12893,6 +15410,9 @@ in milliseconds. || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -12906,7 +15426,6 @@ in milliseconds. || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -12996,6 +15515,15 @@ in milliseconds. || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -13013,8 +15541,6 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", - "onlineAnalyzeEnable": "boolean", - "plantunerFixEmptyTable": "boolean", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -13028,6 +15554,9 @@ in milliseconds. || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -13035,7 +15564,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_10": { + "postgresqlConfig_11_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -13043,7 +15572,6 @@ in milliseconds. || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -13115,6 +15643,7 @@ in milliseconds. || "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", "enableBitmapscan": "boolean", "enableHashagg": "boolean", "enableHashjoin": "boolean", @@ -13133,6 +15662,15 @@ in milliseconds. || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -13155,6 +15693,7 @@ in milliseconds. || "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", @@ -13163,6 +15702,9 @@ in milliseconds. || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -13176,7 +15718,6 @@ in milliseconds. || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -13248,6 +15789,7 @@ in milliseconds. || "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", "enableBitmapscan": "boolean", "enableHashagg": "boolean", "enableHashjoin": "boolean", @@ -13266,6 +15808,15 @@ in milliseconds. || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -13288,6 +15839,7 @@ in milliseconds. || "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", @@ -13296,6 +15848,9 @@ in milliseconds. || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -13309,7 +15864,6 @@ in milliseconds. || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -13381,6 +15935,7 @@ in milliseconds. || "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", "enableBitmapscan": "boolean", "enableHashagg": "boolean", "enableHashjoin": "boolean", @@ -13399,6 +15954,15 @@ in milliseconds. || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -13421,6 +15985,7 @@ in milliseconds. || "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", @@ -13429,6 +15994,9 @@ in milliseconds. || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -13436,7 +16004,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_11": { + "postgresqlConfig_12": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -13542,6 +16110,8 @@ in milliseconds. || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -13686,6 +16256,8 @@ in milliseconds. || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -13830,6 +16402,8 @@ in milliseconds. || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -13870,7 +16444,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_11_1c": { + "postgresqlConfig_12_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -13977,6 +16551,8 @@ in milliseconds. || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -14123,6 +16699,8 @@ in milliseconds. || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -14269,6 +16847,8 @@ in milliseconds. || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -14310,7 +16890,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_12": { + "postgresqlConfig_13": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -14435,6 +17015,18 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -14581,6 +17173,18 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -14727,6 +17331,18 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -14750,7 +17366,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_12_1c": { + "postgresqlConfig_13_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -14876,13 +17492,24 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", - "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -15024,13 +17651,24 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", - "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -15172,13 +17810,24 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", - "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -15196,7 +17845,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_13": { + "postgresqlConfig_14": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -15261,7 +17910,6 @@ in milliseconds. || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -15301,7 +17949,6 @@ in milliseconds. || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -15333,6 +17980,13 @@ in milliseconds. || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -15419,7 +18073,6 @@ in milliseconds. || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -15459,7 +18112,6 @@ in milliseconds. || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -15491,6 +18143,13 @@ in milliseconds. || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -15577,7 +18236,6 @@ in milliseconds. || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -15617,7 +18275,6 @@ in milliseconds. || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -15649,6 +18306,13 @@ in milliseconds. || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -15672,7 +18336,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_13_1c": { + "postgresqlConfig_14_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -15737,7 +18401,6 @@ in milliseconds. || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -15778,7 +18441,6 @@ in milliseconds. || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -15810,6 +18472,13 @@ in milliseconds. || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -15896,7 +18565,6 @@ in milliseconds. || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -15937,7 +18605,6 @@ in milliseconds. || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -15969,6 +18636,13 @@ in milliseconds. || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -16055,7 +18729,6 @@ in milliseconds. || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -16096,7 +18769,6 @@ in milliseconds. || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -16128,6 +18800,13 @@ in milliseconds. || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -16151,7 +18830,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_14": { + "postgresqlConfig_15": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -16299,6 +18978,7 @@ in milliseconds. || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -16462,6 +19142,7 @@ in milliseconds. || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -16625,6 +19306,7 @@ in milliseconds. || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -16642,7 +19324,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_14_1c": { + "postgresqlConfig_15_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -16791,6 +19473,8 @@ in milliseconds. || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -16955,6 +19639,8 @@ in milliseconds. || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -17119,6 +19805,8 @@ in milliseconds. || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -17136,7 +19824,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_15": { + "postgresqlConfig_16": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -17170,7 +19858,7 @@ in milliseconds. || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -17334,7 +20022,7 @@ in milliseconds. || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -17498,7 +20186,7 @@ in milliseconds. || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -17630,7 +20318,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_15_1c": { + "postgresqlConfig_16_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -17664,7 +20352,7 @@ in milliseconds. || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -17830,7 +20518,7 @@ in milliseconds. || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -17996,7 +20684,7 @@ in milliseconds. || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -18130,7 +20818,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_16": { + "postgresqlConfig_17": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -18150,7 +20838,6 @@ in milliseconds. || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -18293,7 +20980,12 @@ in milliseconds. || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, "userConfig": { "maxConnections": "string", @@ -18314,7 +21006,6 @@ in milliseconds. || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -18457,7 +21148,12 @@ in milliseconds. || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, "defaultConfig": { "maxConnections": "string", @@ -18478,7 +21174,6 @@ in milliseconds. || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -18621,10 +21316,15 @@ in milliseconds. || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" } }, - "postgresqlConfig_16_1c": { + "postgresqlConfig_17_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -18644,7 +21344,6 @@ in milliseconds. || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -18789,7 +21488,12 @@ in milliseconds. || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, "userConfig": { "maxConnections": "string", @@ -18810,7 +21514,6 @@ in milliseconds. || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -18955,7 +21658,12 @@ in milliseconds. || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, "defaultConfig": { "maxConnections": "string", @@ -18976,7 +21684,6 @@ in milliseconds. || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -19121,7 +21828,12 @@ in milliseconds. || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" } }, // end of the list of possible fields @@ -19188,367 +21900,990 @@ in milliseconds. || } ``` -An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). +An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). + +#| +||Field | Description || +|| id | **string** + +ID of the operation. || +|| description | **string** + +Description of the operation. 0-256 characters long. || +|| createdAt | **string** (date-time) + +Creation timestamp. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| createdBy | **string** + +ID of the user or service account who initiated the operation. || +|| modifiedAt | **string** (date-time) + +The time when the Operation resource was last modified. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| done | **boolean** + +If the value is `false`, it means the operation is still in progress. +If `true`, the operation is completed, and either `error` or `response` is available. || +|| metadata | **[CreateClusterMetadata](#yandex.cloud.mdb.postgresql.v1.CreateClusterMetadata)** + +Service-specific metadata associated with the operation. +It typically contains the ID of the target resource that the operation is performed on. +Any method that returns a long-running operation should document the metadata type, if any. || +|| error | **[Status](#google.rpc.Status)** + +The error result of the operation in case of failure or cancellation. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** + +The normal response of the operation in case of success. +If the original method returns no data on success, such as Delete, +the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). +If the original method is the standard Create/Update, +the response should be the target resource of the operation. +Any method that returns a long-running operation should document the response type, if any. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|# + +## CreateClusterMetadata {#yandex.cloud.mdb.postgresql.v1.CreateClusterMetadata} + +#| +||Field | Description || +|| clusterId | **string** + +ID of the PostgreSQL cluster that is being created. || +|# + +## Status {#google.rpc.Status} + +The error result of the operation in case of failure or cancellation. + +#| +||Field | Description || +|| code | **integer** (int32) + +Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || +|| message | **string** + +An error message. || +|| details[] | **object** + +A list of messages that carry the error details. || +|# + +## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} + +A PostgreSQL Cluster resource. For more information, see +the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. + +#| +||Field | Description || +|| id | **string** + +ID of the PostgreSQL cluster. +This ID is assigned by MDB at creation time. || +|| folderId | **string** + +ID of the folder that the PostgreSQL cluster belongs to. || +|| createdAt | **string** (date-time) + +Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| name | **string** + +Name of the PostgreSQL cluster. +The name is unique within the folder. 1-63 characters long. || +|| description | **string** + +Description of the PostgreSQL cluster. 0-256 characters long. || +|| labels | **string** + +Custom labels for the PostgreSQL cluster as `` key:value `` pairs. +Maximum 64 per resource. || +|| environment | **enum** (Environment) + +Deployment environment of the PostgreSQL cluster. + +- `ENVIRONMENT_UNSPECIFIED` +- `PRODUCTION`: Stable environment with a conservative update policy: +only hotfixes are applied during regular maintenance. +- `PRESTABLE`: Environment with more aggressive update policy: new versions +are rolled out irrespective of backward compatibility. || +|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** + +Description of monitoring systems relevant to the PostgreSQL cluster. || +|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** + +Configuration of the PostgreSQL cluster. || +|| networkId | **string** + +ID of the network that the cluster belongs to. || +|| health | **enum** (Health) + +Aggregated cluster health. + +- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). +- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). +- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). +- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || +|| status | **enum** (Status) + +Current state of the cluster. + +- `STATUS_UNKNOWN`: Cluster state is unknown. +- `CREATING`: Cluster is being created. +- `RUNNING`: Cluster is running normally. +- `ERROR`: Cluster encountered a problem and cannot operate. +- `UPDATING`: Cluster is being updated. +- `STOPPING`: Cluster is stopping. +- `STOPPED`: Cluster stopped. +- `STARTING`: Cluster is starting. || +|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** + +Maintenance window for the cluster. || +|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** + +Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || +|| securityGroupIds[] | **string** + +User security groups || +|| deletionProtection | **boolean** + +Deletion Protection inhibits deletion of the cluster || +|| hostGroupIds[] | **string** + +Host groups hosting VMs of the cluster. || +|# + +## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} + +Monitoring system. + +#| +||Field | Description || +|| name | **string** + +Name of the monitoring system. || +|| description | **string** + +Description of the monitoring system. || +|| link | **string** + +Link to the monitoring system charts for the PostgreSQL cluster. || +|# + +## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} + +#| +||Field | Description || +|| version | **string** + +Version of PostgreSQL server software. || +|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** + +Configuration of a PostgreSQL 9.6 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** + +Configuration of a PostgreSQL 10 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** + +Configuration of a PostgreSQL 10 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** + +Configuration of a PostgreSQL 11 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** + +Configuration of a PostgreSQL 11 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** + +Configuration of a PostgreSQL 12 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** + +Configuration of a PostgreSQL 12 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** + +Configuration of a PostgreSQL 13 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** -#| -||Field | Description || -|| id | **string** +Configuration of a PostgreSQL 13 1C server. -ID of the operation. || -|| description | **string** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Description of the operation. 0-256 characters long. || -|| createdAt | **string** (date-time) +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** -Creation timestamp. +Configuration of a PostgreSQL 14 server. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| createdBy | **string** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** -ID of the user or service account who initiated the operation. || -|| modifiedAt | **string** (date-time) +Configuration of a PostgreSQL 14 1C server. -The time when the Operation resource was last modified. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| done | **boolean** +Configuration of a PostgreSQL 15 server. -If the value is `false`, it means the operation is still in progress. -If `true`, the operation is completed, and either `error` or `response` is available. || -|| metadata | **[CreateClusterMetadata](#yandex.cloud.mdb.postgresql.v1.CreateClusterMetadata)** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Service-specific metadata associated with the operation. -It typically contains the ID of the target resource that the operation is performed on. -Any method that returns a long-running operation should document the metadata type, if any. || -|| error | **[Status](#google.rpc.Status)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** -The error result of the operation in case of failure or cancellation. +Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `error`, `response`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || -|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** -The normal response of the operation in case of success. -If the original method returns no data on success, such as Delete, -the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). -If the original method is the standard Create/Update, -the response should be the target resource of the operation. -Any method that returns a long-running operation should document the response type, if any. +Configuration of a PostgreSQL 16 server. -Includes only one of the fields `error`, `response`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** + +Configuration of a PostgreSQL 16 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfigSet17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfigSet17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig2)** + +Configuration of the connection pooler. || +|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources2)** + +Resources allocated to PostgreSQL hosts. || +|| autofailover | **boolean** + +Configuration setting which enables/disables autofailover in cluster. || +|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay2)** + +Time to start the daily backup, in the UTC timezone. || +|| backupRetainPeriodDays | **string** (int64) + +Retention policy of automated backups. || +|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access2)** + +Access policy to DB || +|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics2)** + +Configuration of the performance diagnostics service. || +|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling2)** + +Disk size autoscaling || |# -## CreateClusterMetadata {#yandex.cloud.mdb.postgresql.v1.CreateClusterMetadata} +## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} #| ||Field | Description || -|| clusterId | **string** +|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** -ID of the PostgreSQL cluster that is being created. || +Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** + +User-defined settings for a PostgreSQL 9.6 cluster. || +|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** + +Default configuration for a PostgreSQL 9.6 cluster. || |# -## Status {#google.rpc.Status} +## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62} -The error result of the operation in case of failure or cancellation. +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). #| ||Field | Description || -|| code | **integer** (int32) +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || -|| message | **string** +in bytes. || +|| tempBuffers | **string** (int64) -An error message. || -|| details[] | **object** +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -A list of messages that carry the error details. || -|# +in bytes. || +|| maintenanceWorkMem | **string** (int64) -## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -A PostgreSQL Cluster resource. For more information, see -the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. +in bytes. || +|| tempFileLimit | **string** (int64) -#| -||Field | Description || -|| id | **string** +in bytes. || +|| vacuumCostDelay | **string** (int64) -ID of the PostgreSQL cluster. -This ID is assigned by MDB at creation time. || -|| folderId | **string** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -ID of the folder that the PostgreSQL cluster belongs to. || -|| createdAt | **string** (date-time) +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. +in bytes || +|| backendFlushAfter | **string** (int64) -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| name | **string** +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Name of the PostgreSQL cluster. -The name is unique within the folder. 1-63 characters long. || -|| description | **string** +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) + +Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Description of the PostgreSQL cluster. 0-256 characters long. || -|| labels | **string** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Custom labels for the PostgreSQL cluster as `` key:value `` pairs. -Maximum 64 per resource. || -|| environment | **enum** (Environment) +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Deployment environment of the PostgreSQL cluster. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -- `ENVIRONMENT_UNSPECIFIED` -- `PRODUCTION`: Stable environment with a conservative update policy: -only hotfixes are applied during regular maintenance. -- `PRESTABLE`: Environment with more aggressive update policy: new versions -are rolled out irrespective of backward compatibility. || -|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Description of monitoring systems relevant to the PostgreSQL cluster. || -|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Configuration of the PostgreSQL cluster. || -|| networkId | **string** +in milliseconds. || +|| lockTimeout | **string** (int64) -ID of the network that the cluster belongs to. || -|| health | **enum** (Health) +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Aggregated cluster health. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). -- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). -- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). -- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || -|| status | **enum** (Status) +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Current state of the cluster. +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -- `STATUS_UNKNOWN`: Cluster state is unknown. -- `CREATING`: Cluster is being created. -- `RUNNING`: Cluster is running normally. -- `ERROR`: Cluster encountered a problem and cannot operate. -- `UPDATING`: Cluster is being updated. -- `STOPPING`: Cluster is stopping. -- `STOPPED`: Cluster stopped. -- `STARTING`: Cluster is starting. || -|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Maintenance window for the cluster. || -|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** +in bytes. || +|| deadlockTimeout | **string** (int64) -Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || -|| securityGroupIds[] | **string** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -User security groups || -|| deletionProtection | **boolean** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| sqlInheritance | **boolean** -Deletion Protection inhibits deletion of the cluster || -|| hostGroupIds[] | **string** +This option has been removed in PostgreSQL 10. || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Host groups hosting VMs of the cluster. || -|# +in milliseconds. || +|| archiveTimeout | **string** (int64) -## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# -Monitoring system. +## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} #| ||Field | Description || -|| name | **string** +|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** -Name of the monitoring system. || -|| description | **string** +Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** -Description of the monitoring system. || -|| link | **string** +User-defined settings for a PostgreSQL 10 1C cluster. || +|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** -Link to the monitoring system charts for the PostgreSQL cluster. || +Default configuration for a PostgreSQL 10 1C cluster. || |# -## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} +## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || -|| version | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Version of PostgreSQL server software. || -|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** +in bytes. || +|| tempBuffers | **string** (int64) -Configuration of a PostgreSQL 9.6 server. +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -Configuration of a PostgreSQL 10 1C server. +in bytes. || +|| tempFileLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| vacuumCostDelay | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Configuration of a PostgreSQL 10 server. +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes || +|| backendFlushAfter | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -Configuration of a PostgreSQL 11 server. +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -Configuration of a PostgreSQL 11 1C server. +in bytes || +|| maxWalSize | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| minWalSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) -Configuration of a PostgreSQL 12 server. +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Configuration of a PostgreSQL 12 1C server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Configuration of a PostgreSQL 13 server. +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Configuration of a PostgreSQL 13 1C server. +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| lockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Configuration of a PostgreSQL 14 server. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -Configuration of a PostgreSQL 14 1C server. +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| deadlockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -Configuration of a PostgreSQL 15 server. +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| archiveTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -Configuration of a PostgreSQL 15 1C server. +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) -Configuration of a PostgreSQL 16 server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| onlineAnalyzeEnable | **boolean** || +|| plantunerFixEmptyTable | **boolean** || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| geqo | **boolean** -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -Configuration of a PostgreSQL 16 1C server. +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig2)** +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) -Configuration of the connection pooler. || -|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources2)** +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) -Resources allocated to PostgreSQL hosts. || -|| autofailover | **boolean** +selective pressure within the population || +|| geqoSeed | **number** (double) -Configuration setting which enables/disables autofailover in cluster. || -|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay2)** +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) -Time to start the daily backup, in the UTC timezone. || -|| backupRetainPeriodDays | **string** (int64) +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) -Retention policy of automated backups. || -|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access2)** +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -Access policy to DB || -|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics2)** +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -Configuration of the performance diagnostics service. || -|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling2)** +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. -Disk size autoscaling || +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} +## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** +|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** -Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** - -User-defined settings for a PostgreSQL 9.6 cluster. || -|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** +|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** -Default configuration for a PostgreSQL 9.6 cluster. || +User-defined settings for a PostgreSQL 10 cluster. || +|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** + +Default configuration for a PostgreSQL 10 cluster. || |# -## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62} +## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -19608,9 +22943,7 @@ in bytes || || checkpointTimeout | **string** (int64) in milliseconds. || -|| checkpointCompletionTarget | **number** (double) - -Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointCompletionTarget | **number** (double) || || checkpointFlushAfter | **string** (int64) in bytes || @@ -19763,9 +23096,6 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** - -This option has been removed in PostgreSQL 10. || || autovacuumMaxWorkers | **string** (int64) || || autovacuumVacuumCostDelay | **string** (int64) || || autovacuumVacuumCostLimit | **string** (int64) || @@ -19776,31 +23106,139 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) + +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} +## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** +|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** -Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** +|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** -User-defined settings for a PostgreSQL 10 1C cluster. || -|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** +User-defined settings for a PostgreSQL 11 cluster. || +|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** -Default configuration for a PostgreSQL 10 1C cluster. || +Default configuration for a PostgreSQL 11 cluster. || |# -## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2} +## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -19818,7 +23256,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -20041,6 +23478,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -20087,8 +23533,6 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || -|| onlineAnalyzeEnable | **boolean** || -|| plantunerFixEmptyTable | **boolean** || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -20118,6 +23562,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -20137,27 +23584,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} +## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** +|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** -Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** +|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** -User-defined settings for a PostgreSQL 10 cluster. || -|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** +User-defined settings for a PostgreSQL 11 1C cluster. || +|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** -Default configuration for a PostgreSQL 10 cluster. || +Default configuration for a PostgreSQL 11 1C cluster. || |# -## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102} +## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -20175,7 +23622,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -20380,6 +23826,7 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || || enableBitmapscan | **boolean** || || enableHashagg | **boolean** || || enableHashjoin | **boolean** || @@ -20398,6 +23845,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -20449,6 +23905,7 @@ in milliseconds. || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || || maxStackDepth | **string** (int64) in bytes. || @@ -20473,6 +23930,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -20492,23 +23952,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} +## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** +|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** -Effective settings for a PostgreSQL 11 cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** +|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** -User-defined settings for a PostgreSQL 11 cluster. || -|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** +User-defined settings for a PostgreSQL 12 cluster. || +|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** -Default configuration for a PostgreSQL 11 cluster. || +Default configuration for a PostgreSQL 12 cluster. || |# -## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112} +## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -20761,6 +24221,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -20858,23 +24325,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} +## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** +|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** -Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** +|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** -User-defined settings for a PostgreSQL 11 1C cluster. || -|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** +User-defined settings for a PostgreSQL 12 1C cluster. || +|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** -Default configuration for a PostgreSQL 11 1C cluster. || +Default configuration for a PostgreSQL 12 1C cluster. || |# -## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2} +## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -21128,6 +24595,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -21226,23 +24700,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} +## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** +|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** -Effective settings for a PostgreSQL 12 cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** +|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** -User-defined settings for a PostgreSQL 12 cluster. || -|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** +User-defined settings for a PostgreSQL 13 cluster. || +|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** -Default configuration for a PostgreSQL 12 cluster. || +Default configuration for a PostgreSQL 13 cluster. || |# -## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122} +## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -21548,6 +25022,30 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -21599,23 +25097,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} +## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** +|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** -Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** +|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** -User-defined settings for a PostgreSQL 12 1C cluster. || -|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** +User-defined settings for a PostgreSQL 13 1C cluster. || +|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** -Default configuration for a PostgreSQL 12 1C cluster. || +Default configuration for a PostgreSQL 13 1C cluster. || |# -## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2} +## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -21922,15 +25420,36 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || -|| maxStackDepth | **string** (int64) - -in bytes. || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -21974,23 +25493,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} +## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** +|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** -Effective settings for a PostgreSQL 13 cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** +|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** -User-defined settings for a PostgreSQL 13 cluster. || -|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** +User-defined settings for a PostgreSQL 14 cluster. || +|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** -Default configuration for a PostgreSQL 13 cluster. || +Default configuration for a PostgreSQL 14 cluster. || |# -## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132} +## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -22198,7 +25717,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -22242,7 +25760,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -22320,6 +25837,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -22371,23 +25903,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} +## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** +|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** -Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** +|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** -User-defined settings for a PostgreSQL 13 1C cluster. || -|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** +User-defined settings for a PostgreSQL 14 1C cluster. || +|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** -Default configuration for a PostgreSQL 13 1C cluster. || +Default configuration for a PostgreSQL 14 1C cluster. || |# -## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2} +## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -22595,7 +26127,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -22640,7 +26171,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -22718,6 +26248,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -22767,23 +26312,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} +## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** +|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** -Effective settings for a PostgreSQL 14 cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** +|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** -User-defined settings for a PostgreSQL 14 cluster. || -|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** +User-defined settings for a PostgreSQL 15 cluster. || +|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** -Default configuration for a PostgreSQL 14 cluster. || +Default configuration for a PostgreSQL 15 cluster. || |# -## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142} +## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -23053,7 +26598,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -23134,6 +26680,7 @@ in milliseconds. || || maxStackDepth | **string** (int64) in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -23177,23 +26724,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} +## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** +|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** -Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** +|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** -User-defined settings for a PostgreSQL 14 1C cluster. || -|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** +User-defined settings for a PostgreSQL 15 1C cluster. || +|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** -Default configuration for a PostgreSQL 14 1C cluster. || +Default configuration for a PostgreSQL 15 1C cluster. || |# -## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2} +## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -23464,7 +27011,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -23543,6 +27091,10 @@ in milliseconds. || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -23586,23 +27138,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} +## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** +|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** -Effective settings for a PostgreSQL 15 cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** +|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** -User-defined settings for a PostgreSQL 15 cluster. || -|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** +User-defined settings for a PostgreSQL 16 cluster. || +|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** -Default configuration for a PostgreSQL 15 cluster. || +Default configuration for a PostgreSQL 16 cluster. || |# -## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152} +## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -23688,12 +27240,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -23702,6 +27254,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -23716,6 +27269,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -23730,6 +27284,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -23901,6 +27456,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -23998,23 +27554,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} +## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** +|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** -Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** +|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** -User-defined settings for a PostgreSQL 15 1C cluster. || -|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** +User-defined settings for a PostgreSQL 16 1C cluster. || +|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** -Default configuration for a PostgreSQL 15 1C cluster. || +Default configuration for a PostgreSQL 16 1C cluster. || |# -## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2} +## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -24100,12 +27656,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -24114,6 +27670,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -24128,6 +27685,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -24142,6 +27700,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -24314,6 +27873,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -24412,27 +27972,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} +## PostgresqlConfigSet17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** +|| effectiveConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig172)** -Effective settings for a PostgreSQL 16 cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** +|| userConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig172)** -User-defined settings for a PostgreSQL 16 cluster. || -|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig172)** -Default configuration for a PostgreSQL 16 cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig172} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -24474,7 +28034,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -24826,29 +28385,42 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# -## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} +## PostgresqlConfigSet17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** +|| effectiveConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C2)** -Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** +|| userConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C2)** -User-defined settings for a PostgreSQL 16 1C cluster. || -|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C2)** -Default configuration for a PostgreSQL 16 1C cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2} +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -24890,7 +28462,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -25244,6 +28815,19 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# ## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig2} diff --git a/ru/managed-postgresql/api-ref/Cluster/get.md b/ru/managed-postgresql/api-ref/Cluster/get.md index 02743d241f8..957cbff30b9 100644 --- a/ru/managed-postgresql/api-ref/Cluster/get.md +++ b/ru/managed-postgresql/api-ref/Cluster/get.md @@ -47,7 +47,7 @@ To get the cluster ID use a [ClusterService.List](/docs/managed-postgresql/api-r ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "effectiveConfig": { "maxConnections": "string", @@ -6795,6 +6795,1024 @@ To get the cluster ID use a [ClusterService.List](/docs/managed-postgresql/api-r "passwordEncryption": "string" } }, + "postgresqlConfig_17": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, + "postgresqlConfig_17_1c": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, // end of the list of possible fields "poolerConfig": { "poolingMode": "string", @@ -6857,270 +7875,893 @@ To get the cluster ID use a [ClusterService.List](/docs/managed-postgresql/api-r } ``` -A PostgreSQL Cluster resource. For more information, see -the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. +A PostgreSQL Cluster resource. For more information, see +the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. + +#| +||Field | Description || +|| id | **string** + +ID of the PostgreSQL cluster. +This ID is assigned by MDB at creation time. || +|| folderId | **string** + +ID of the folder that the PostgreSQL cluster belongs to. || +|| createdAt | **string** (date-time) + +Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| name | **string** + +Name of the PostgreSQL cluster. +The name is unique within the folder. 1-63 characters long. || +|| description | **string** + +Description of the PostgreSQL cluster. 0-256 characters long. || +|| labels | **string** + +Custom labels for the PostgreSQL cluster as `` key:value `` pairs. +Maximum 64 per resource. || +|| environment | **enum** (Environment) + +Deployment environment of the PostgreSQL cluster. + +- `ENVIRONMENT_UNSPECIFIED` +- `PRODUCTION`: Stable environment with a conservative update policy: +only hotfixes are applied during regular maintenance. +- `PRESTABLE`: Environment with more aggressive update policy: new versions +are rolled out irrespective of backward compatibility. || +|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** + +Description of monitoring systems relevant to the PostgreSQL cluster. || +|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** + +Configuration of the PostgreSQL cluster. || +|| networkId | **string** + +ID of the network that the cluster belongs to. || +|| health | **enum** (Health) + +Aggregated cluster health. + +- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). +- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). +- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). +- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || +|| status | **enum** (Status) + +Current state of the cluster. + +- `STATUS_UNKNOWN`: Cluster state is unknown. +- `CREATING`: Cluster is being created. +- `RUNNING`: Cluster is running normally. +- `ERROR`: Cluster encountered a problem and cannot operate. +- `UPDATING`: Cluster is being updated. +- `STOPPING`: Cluster is stopping. +- `STOPPED`: Cluster stopped. +- `STARTING`: Cluster is starting. || +|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** + +Maintenance window for the cluster. || +|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** + +Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || +|| securityGroupIds[] | **string** + +User security groups || +|| deletionProtection | **boolean** + +Deletion Protection inhibits deletion of the cluster || +|| hostGroupIds[] | **string** + +Host groups hosting VMs of the cluster. || +|# + +## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} + +Monitoring system. + +#| +||Field | Description || +|| name | **string** + +Name of the monitoring system. || +|| description | **string** + +Description of the monitoring system. || +|| link | **string** + +Link to the monitoring system charts for the PostgreSQL cluster. || +|# + +## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} + +#| +||Field | Description || +|| version | **string** + +Version of PostgreSQL server software. || +|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** + +Configuration of a PostgreSQL 9.6 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** + +Configuration of a PostgreSQL 10 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** + +Configuration of a PostgreSQL 10 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** + +Configuration of a PostgreSQL 11 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** + +Configuration of a PostgreSQL 11 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** + +Configuration of a PostgreSQL 12 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** + +Configuration of a PostgreSQL 12 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** + +Configuration of a PostgreSQL 13 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** + +Configuration of a PostgreSQL 13 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** + +Configuration of a PostgreSQL 14 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** + +Configuration of a PostgreSQL 14 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** + +Configuration of a PostgreSQL 15 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** + +Configuration of a PostgreSQL 15 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** + +Configuration of a PostgreSQL 16 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** + +Configuration of a PostgreSQL 16 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfigSet17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfigSet17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** + +Configuration of the connection pooler. || +|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** + +Resources allocated to PostgreSQL hosts. || +|| autofailover | **boolean** + +Configuration setting which enables/disables autofailover in cluster. || +|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** + +Time to start the daily backup, in the UTC timezone. || +|| backupRetainPeriodDays | **string** (int64) + +Retention policy of automated backups. || +|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** + +Access policy to DB || +|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** + +Configuration of the performance diagnostics service. || +|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** + +Disk size autoscaling || +|# + +## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} #| ||Field | Description || -|| id | **string** +|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -ID of the PostgreSQL cluster. -This ID is assigned by MDB at creation time. || -|| folderId | **string** +Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -ID of the folder that the PostgreSQL cluster belongs to. || -|| createdAt | **string** (date-time) +User-defined settings for a PostgreSQL 9.6 cluster. || +|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. +Default configuration for a PostgreSQL 9.6 cluster. || +|# -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| name | **string** +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). -Name of the PostgreSQL cluster. -The name is unique within the folder. 1-63 characters long. || -|| description | **string** +#| +||Field | Description || +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) + +in bytes. || +|| maintenanceWorkMem | **string** (int64) + +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| vacuumCostDelay | **string** (int64) + +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) + +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) + +in bytes || +|| backendFlushAfter | **string** (int64) + +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) + +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) + +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) + +Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Description of the PostgreSQL cluster. 0-256 characters long. || -|| labels | **string** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Custom labels for the PostgreSQL cluster as `` key:value `` pairs. -Maximum 64 per resource. || -|| environment | **enum** (Environment) +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Deployment environment of the PostgreSQL cluster. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -- `ENVIRONMENT_UNSPECIFIED` -- `PRODUCTION`: Stable environment with a conservative update policy: -only hotfixes are applied during regular maintenance. -- `PRESTABLE`: Environment with more aggressive update policy: new versions -are rolled out irrespective of backward compatibility. || -|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Description of monitoring systems relevant to the PostgreSQL cluster. || -|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Configuration of the PostgreSQL cluster. || -|| networkId | **string** +in milliseconds. || +|| lockTimeout | **string** (int64) -ID of the network that the cluster belongs to. || -|| health | **enum** (Health) +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Aggregated cluster health. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). -- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). -- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). -- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || -|| status | **enum** (Status) +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Current state of the cluster. +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -- `STATUS_UNKNOWN`: Cluster state is unknown. -- `CREATING`: Cluster is being created. -- `RUNNING`: Cluster is running normally. -- `ERROR`: Cluster encountered a problem and cannot operate. -- `UPDATING`: Cluster is being updated. -- `STOPPING`: Cluster is stopping. -- `STOPPED`: Cluster stopped. -- `STARTING`: Cluster is starting. || -|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Maintenance window for the cluster. || -|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** +in bytes. || +|| deadlockTimeout | **string** (int64) -Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || -|| securityGroupIds[] | **string** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -User security groups || -|| deletionProtection | **boolean** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| sqlInheritance | **boolean** -Deletion Protection inhibits deletion of the cluster || -|| hostGroupIds[] | **string** +This option has been removed in PostgreSQL 10. || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Host groups hosting VMs of the cluster. || -|# +in milliseconds. || +|| archiveTimeout | **string** (int64) -## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# -Monitoring system. +## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} #| ||Field | Description || -|| name | **string** +|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Name of the monitoring system. || -|| description | **string** +Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Description of the monitoring system. || -|| link | **string** +User-defined settings for a PostgreSQL 10 1C cluster. || +|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Link to the monitoring system charts for the PostgreSQL cluster. || +Default configuration for a PostgreSQL 10 1C cluster. || |# -## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} +## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || -|| version | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Version of PostgreSQL server software. || -|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** +in bytes. || +|| tempBuffers | **string** (int64) -Configuration of a PostgreSQL 9.6 server. +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -Configuration of a PostgreSQL 10 1C server. +in bytes. || +|| tempFileLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| vacuumCostDelay | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Configuration of a PostgreSQL 10 server. +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes || +|| backendFlushAfter | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -Configuration of a PostgreSQL 11 server. +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -Configuration of a PostgreSQL 11 1C server. +in bytes || +|| maxWalSize | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| minWalSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) -Configuration of a PostgreSQL 12 server. +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Configuration of a PostgreSQL 12 1C server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Configuration of a PostgreSQL 13 server. +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Configuration of a PostgreSQL 13 1C server. +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| lockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Configuration of a PostgreSQL 14 server. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -Configuration of a PostgreSQL 14 1C server. +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| deadlockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -Configuration of a PostgreSQL 15 server. +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| archiveTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -Configuration of a PostgreSQL 15 1C server. +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) -Configuration of a PostgreSQL 16 server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| onlineAnalyzeEnable | **boolean** || +|| plantunerFixEmptyTable | **boolean** || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| geqo | **boolean** -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -Configuration of a PostgreSQL 16 1C server. +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) -Configuration of the connection pooler. || -|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) -Resources allocated to PostgreSQL hosts. || -|| autofailover | **boolean** +selective pressure within the population || +|| geqoSeed | **number** (double) -Configuration setting which enables/disables autofailover in cluster. || -|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) -Time to start the daily backup, in the UTC timezone. || -|| backupRetainPeriodDays | **string** (int64) +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) -Retention policy of automated backups. || -|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -Access policy to DB || -|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -Configuration of the performance diagnostics service. || -|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. -Disk size autoscaling || +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} +## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** - -User-defined settings for a PostgreSQL 9.6 cluster. || -|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Default configuration for a PostgreSQL 9.6 cluster. || +User-defined settings for a PostgreSQL 10 cluster. || +|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** + +Default configuration for a PostgreSQL 10 cluster. || |# -## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} +## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -7180,9 +8821,7 @@ in bytes || || checkpointTimeout | **string** (int64) in milliseconds. || -|| checkpointCompletionTarget | **number** (double) - -Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointCompletionTarget | **number** (double) || || checkpointFlushAfter | **string** (int64) in bytes || @@ -7335,9 +8974,6 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** - -This option has been removed in PostgreSQL 10. || || autovacuumMaxWorkers | **string** (int64) || || autovacuumVacuumCostDelay | **string** (int64) || || autovacuumVacuumCostLimit | **string** (int64) || @@ -7348,31 +8984,139 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) + +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} +## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -User-defined settings for a PostgreSQL 10 1C cluster. || -|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +User-defined settings for a PostgreSQL 11 cluster. || +|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Default configuration for a PostgreSQL 10 1C cluster. || +Default configuration for a PostgreSQL 11 cluster. || |# -## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} +## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7390,7 +9134,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -7613,6 +9356,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -7659,8 +9411,6 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || -|| onlineAnalyzeEnable | **boolean** || -|| plantunerFixEmptyTable | **boolean** || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -7690,6 +9440,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -7709,27 +9462,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} +## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -User-defined settings for a PostgreSQL 10 cluster. || -|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +User-defined settings for a PostgreSQL 11 1C cluster. || +|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Default configuration for a PostgreSQL 10 cluster. || +Default configuration for a PostgreSQL 11 1C cluster. || |# -## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} +## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7747,7 +9500,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -7952,6 +9704,7 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || || enableBitmapscan | **boolean** || || enableHashagg | **boolean** || || enableHashjoin | **boolean** || @@ -7970,6 +9723,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8021,6 +9783,7 @@ in milliseconds. || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || || maxStackDepth | **string** (int64) in bytes. || @@ -8045,6 +9808,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -8064,23 +9830,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} +## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Effective settings for a PostgreSQL 11 cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -User-defined settings for a PostgreSQL 11 cluster. || -|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +User-defined settings for a PostgreSQL 12 cluster. || +|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Default configuration for a PostgreSQL 11 cluster. || +Default configuration for a PostgreSQL 12 cluster. || |# -## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} +## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8333,6 +10099,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8430,23 +10203,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} +## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -User-defined settings for a PostgreSQL 11 1C cluster. || -|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +User-defined settings for a PostgreSQL 12 1C cluster. || +|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Default configuration for a PostgreSQL 11 1C cluster. || +Default configuration for a PostgreSQL 12 1C cluster. || |# -## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} +## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8700,6 +10473,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8798,23 +10578,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} +## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Effective settings for a PostgreSQL 12 cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -User-defined settings for a PostgreSQL 12 cluster. || -|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +User-defined settings for a PostgreSQL 13 cluster. || +|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Default configuration for a PostgreSQL 12 cluster. || +Default configuration for a PostgreSQL 13 cluster. || |# -## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} +## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9120,6 +10900,30 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -9171,23 +10975,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} +## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -User-defined settings for a PostgreSQL 12 1C cluster. || -|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +User-defined settings for a PostgreSQL 13 1C cluster. || +|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Default configuration for a PostgreSQL 12 1C cluster. || +Default configuration for a PostgreSQL 13 1C cluster. || |# -## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} +## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9494,15 +11298,36 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || -|| maxStackDepth | **string** (int64) - -in bytes. || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -9546,23 +11371,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} +## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Effective settings for a PostgreSQL 13 cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -User-defined settings for a PostgreSQL 13 cluster. || -|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +User-defined settings for a PostgreSQL 14 cluster. || +|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Default configuration for a PostgreSQL 13 cluster. || +Default configuration for a PostgreSQL 14 cluster. || |# -## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} +## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9770,7 +11595,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -9814,7 +11638,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -9892,6 +11715,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -9943,23 +11781,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} +## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -User-defined settings for a PostgreSQL 13 1C cluster. || -|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +User-defined settings for a PostgreSQL 14 1C cluster. || +|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Default configuration for a PostgreSQL 13 1C cluster. || +Default configuration for a PostgreSQL 14 1C cluster. || |# -## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} +## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10167,7 +12005,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -10212,7 +12049,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10290,6 +12126,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10339,23 +12190,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} +## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Effective settings for a PostgreSQL 14 cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -User-defined settings for a PostgreSQL 14 cluster. || -|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +User-defined settings for a PostgreSQL 15 cluster. || +|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Default configuration for a PostgreSQL 14 cluster. || +Default configuration for a PostgreSQL 15 cluster. || |# -## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} +## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10625,7 +12476,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -10706,6 +12558,7 @@ in milliseconds. || || maxStackDepth | **string** (int64) in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -10749,23 +12602,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} +## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -User-defined settings for a PostgreSQL 14 1C cluster. || -|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +User-defined settings for a PostgreSQL 15 1C cluster. || +|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Default configuration for a PostgreSQL 14 1C cluster. || +Default configuration for a PostgreSQL 15 1C cluster. || |# -## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} +## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11036,7 +12889,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -11115,6 +12969,10 @@ in milliseconds. || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -11158,23 +13016,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} +## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Effective settings for a PostgreSQL 15 cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -User-defined settings for a PostgreSQL 15 cluster. || -|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +User-defined settings for a PostgreSQL 16 cluster. || +|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Default configuration for a PostgreSQL 15 cluster. || +Default configuration for a PostgreSQL 16 cluster. || |# -## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} +## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11260,12 +13118,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11274,6 +13132,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11288,6 +13147,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11302,6 +13162,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11473,6 +13334,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11570,23 +13432,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} +## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -User-defined settings for a PostgreSQL 15 1C cluster. || -|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +User-defined settings for a PostgreSQL 16 1C cluster. || +|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Default configuration for a PostgreSQL 15 1C cluster. || +Default configuration for a PostgreSQL 16 1C cluster. || |# -## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} +## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11672,12 +13534,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11686,6 +13548,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11700,6 +13563,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11714,6 +13578,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11886,6 +13751,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11984,27 +13850,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} +## PostgresqlConfigSet17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| effectiveConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Effective settings for a PostgreSQL 16 cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| userConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -User-defined settings for a PostgreSQL 16 cluster. || -|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Default configuration for a PostgreSQL 16 cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12046,7 +13912,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12398,29 +14263,42 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# -## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} +## PostgresqlConfigSet17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| effectiveConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| userConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -User-defined settings for a PostgreSQL 16 1C cluster. || -|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Default configuration for a PostgreSQL 16 1C cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12462,7 +14340,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12816,6 +14693,19 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# ## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig} diff --git a/ru/managed-postgresql/api-ref/Cluster/list.md b/ru/managed-postgresql/api-ref/Cluster/list.md index 1b5af2cc4a9..f156d5a9ab2 100644 --- a/ru/managed-postgresql/api-ref/Cluster/list.md +++ b/ru/managed-postgresql/api-ref/Cluster/list.md @@ -64,7 +64,7 @@ The expression must specify: ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "effectiveConfig": { "maxConnections": "string", @@ -6812,6 +6812,1024 @@ The expression must specify: "passwordEncryption": "string" } }, + "postgresqlConfig_17": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, + "postgresqlConfig_17_1c": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, // end of the list of possible fields "poolerConfig": { "poolingMode": "string", @@ -6879,283 +7897,906 @@ The expression must specify: #| ||Field | Description || -|| clusters[] | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** +|| clusters[] | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** + +List of PostgreSQL Cluster resources. || +|| nextPageToken | **string** + +This token allows you to get the next page of results for list requests. If the number of results +is larger than [ListClustersRequest.pageSize](#yandex.cloud.mdb.postgresql.v1.ListClustersRequest), use the `nextPageToken` as the value +for the [ListClustersRequest.pageToken](#yandex.cloud.mdb.postgresql.v1.ListClustersRequest) parameter in the next list request. Each subsequent +list request will have its own `nextPageToken` to continue paging through the results. || +|# + +## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} + +A PostgreSQL Cluster resource. For more information, see +the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. + +#| +||Field | Description || +|| id | **string** + +ID of the PostgreSQL cluster. +This ID is assigned by MDB at creation time. || +|| folderId | **string** + +ID of the folder that the PostgreSQL cluster belongs to. || +|| createdAt | **string** (date-time) + +Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| name | **string** + +Name of the PostgreSQL cluster. +The name is unique within the folder. 1-63 characters long. || +|| description | **string** + +Description of the PostgreSQL cluster. 0-256 characters long. || +|| labels | **string** + +Custom labels for the PostgreSQL cluster as `` key:value `` pairs. +Maximum 64 per resource. || +|| environment | **enum** (Environment) + +Deployment environment of the PostgreSQL cluster. + +- `ENVIRONMENT_UNSPECIFIED` +- `PRODUCTION`: Stable environment with a conservative update policy: +only hotfixes are applied during regular maintenance. +- `PRESTABLE`: Environment with more aggressive update policy: new versions +are rolled out irrespective of backward compatibility. || +|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** + +Description of monitoring systems relevant to the PostgreSQL cluster. || +|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** + +Configuration of the PostgreSQL cluster. || +|| networkId | **string** + +ID of the network that the cluster belongs to. || +|| health | **enum** (Health) + +Aggregated cluster health. + +- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). +- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). +- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). +- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || +|| status | **enum** (Status) + +Current state of the cluster. + +- `STATUS_UNKNOWN`: Cluster state is unknown. +- `CREATING`: Cluster is being created. +- `RUNNING`: Cluster is running normally. +- `ERROR`: Cluster encountered a problem and cannot operate. +- `UPDATING`: Cluster is being updated. +- `STOPPING`: Cluster is stopping. +- `STOPPED`: Cluster stopped. +- `STARTING`: Cluster is starting. || +|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** + +Maintenance window for the cluster. || +|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** + +Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || +|| securityGroupIds[] | **string** + +User security groups || +|| deletionProtection | **boolean** + +Deletion Protection inhibits deletion of the cluster || +|| hostGroupIds[] | **string** + +Host groups hosting VMs of the cluster. || +|# + +## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} + +Monitoring system. + +#| +||Field | Description || +|| name | **string** + +Name of the monitoring system. || +|| description | **string** + +Description of the monitoring system. || +|| link | **string** + +Link to the monitoring system charts for the PostgreSQL cluster. || +|# + +## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} + +#| +||Field | Description || +|| version | **string** + +Version of PostgreSQL server software. || +|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** + +Configuration of a PostgreSQL 9.6 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** + +Configuration of a PostgreSQL 10 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** + +Configuration of a PostgreSQL 10 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** + +Configuration of a PostgreSQL 11 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** + +Configuration of a PostgreSQL 11 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** + +Configuration of a PostgreSQL 12 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** + +Configuration of a PostgreSQL 12 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** + +Configuration of a PostgreSQL 13 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** + +Configuration of a PostgreSQL 13 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** + +Configuration of a PostgreSQL 14 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** + +Configuration of a PostgreSQL 14 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** + +Configuration of a PostgreSQL 15 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** + +Configuration of a PostgreSQL 15 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** + +Configuration of a PostgreSQL 16 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** + +Configuration of a PostgreSQL 16 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfigSet17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfigSet17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** + +Configuration of the connection pooler. || +|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** + +Resources allocated to PostgreSQL hosts. || +|| autofailover | **boolean** + +Configuration setting which enables/disables autofailover in cluster. || +|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** + +Time to start the daily backup, in the UTC timezone. || +|| backupRetainPeriodDays | **string** (int64) + +Retention policy of automated backups. || +|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** + +Access policy to DB || +|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** + +Configuration of the performance diagnostics service. || +|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** + +Disk size autoscaling || +|# + +## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} + +#| +||Field | Description || +|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -List of PostgreSQL Cluster resources. || -|| nextPageToken | **string** +Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -This token allows you to get the next page of results for list requests. If the number of results -is larger than [ListClustersRequest.pageSize](#yandex.cloud.mdb.postgresql.v1.ListClustersRequest), use the `nextPageToken` as the value -for the [ListClustersRequest.pageToken](#yandex.cloud.mdb.postgresql.v1.ListClustersRequest) parameter in the next list request. Each subsequent -list request will have its own `nextPageToken` to continue paging through the results. || +User-defined settings for a PostgreSQL 9.6 cluster. || +|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** + +Default configuration for a PostgreSQL 9.6 cluster. || |# -## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} +## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} -A PostgreSQL Cluster resource. For more information, see -the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). #| ||Field | Description || -|| id | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -ID of the PostgreSQL cluster. -This ID is assigned by MDB at creation time. || -|| folderId | **string** +in bytes. || +|| tempBuffers | **string** (int64) -ID of the folder that the PostgreSQL cluster belongs to. || -|| createdAt | **string** (date-time) +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| name | **string** +in bytes. || +|| tempFileLimit | **string** (int64) -Name of the PostgreSQL cluster. -The name is unique within the folder. 1-63 characters long. || -|| description | **string** +in bytes. || +|| vacuumCostDelay | **string** (int64) + +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) + +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) + +in bytes || +|| backendFlushAfter | **string** (int64) + +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) + +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) + +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) + +Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Description of the PostgreSQL cluster. 0-256 characters long. || -|| labels | **string** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Custom labels for the PostgreSQL cluster as `` key:value `` pairs. -Maximum 64 per resource. || -|| environment | **enum** (Environment) +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Deployment environment of the PostgreSQL cluster. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -- `ENVIRONMENT_UNSPECIFIED` -- `PRODUCTION`: Stable environment with a conservative update policy: -only hotfixes are applied during regular maintenance. -- `PRESTABLE`: Environment with more aggressive update policy: new versions -are rolled out irrespective of backward compatibility. || -|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Description of monitoring systems relevant to the PostgreSQL cluster. || -|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Configuration of the PostgreSQL cluster. || -|| networkId | **string** +in milliseconds. || +|| lockTimeout | **string** (int64) -ID of the network that the cluster belongs to. || -|| health | **enum** (Health) +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Aggregated cluster health. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). -- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). -- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). -- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || -|| status | **enum** (Status) +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Current state of the cluster. +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -- `STATUS_UNKNOWN`: Cluster state is unknown. -- `CREATING`: Cluster is being created. -- `RUNNING`: Cluster is running normally. -- `ERROR`: Cluster encountered a problem and cannot operate. -- `UPDATING`: Cluster is being updated. -- `STOPPING`: Cluster is stopping. -- `STOPPED`: Cluster stopped. -- `STARTING`: Cluster is starting. || -|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Maintenance window for the cluster. || -|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** +in bytes. || +|| deadlockTimeout | **string** (int64) -Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || -|| securityGroupIds[] | **string** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -User security groups || -|| deletionProtection | **boolean** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| sqlInheritance | **boolean** -Deletion Protection inhibits deletion of the cluster || -|| hostGroupIds[] | **string** +This option has been removed in PostgreSQL 10. || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Host groups hosting VMs of the cluster. || -|# +in milliseconds. || +|| archiveTimeout | **string** (int64) -## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# -Monitoring system. +## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} #| ||Field | Description || -|| name | **string** +|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Name of the monitoring system. || -|| description | **string** +Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Description of the monitoring system. || -|| link | **string** +User-defined settings for a PostgreSQL 10 1C cluster. || +|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Link to the monitoring system charts for the PostgreSQL cluster. || +Default configuration for a PostgreSQL 10 1C cluster. || |# -## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} +## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || -|| version | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Version of PostgreSQL server software. || -|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** +in bytes. || +|| tempBuffers | **string** (int64) -Configuration of a PostgreSQL 9.6 server. +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -Configuration of a PostgreSQL 10 1C server. +in bytes. || +|| tempFileLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| vacuumCostDelay | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Configuration of a PostgreSQL 10 server. +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes || +|| backendFlushAfter | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -Configuration of a PostgreSQL 11 server. +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -Configuration of a PostgreSQL 11 1C server. +in bytes || +|| maxWalSize | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| minWalSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) -Configuration of a PostgreSQL 12 server. +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Configuration of a PostgreSQL 12 1C server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Configuration of a PostgreSQL 13 server. +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Configuration of a PostgreSQL 13 1C server. +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| lockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Configuration of a PostgreSQL 14 server. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -Configuration of a PostgreSQL 14 1C server. +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| deadlockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -Configuration of a PostgreSQL 15 server. +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| archiveTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -Configuration of a PostgreSQL 15 1C server. +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) -Configuration of a PostgreSQL 16 server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| onlineAnalyzeEnable | **boolean** || +|| plantunerFixEmptyTable | **boolean** || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| geqo | **boolean** -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -Configuration of a PostgreSQL 16 1C server. +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) -Configuration of the connection pooler. || -|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) -Resources allocated to PostgreSQL hosts. || -|| autofailover | **boolean** +selective pressure within the population || +|| geqoSeed | **number** (double) -Configuration setting which enables/disables autofailover in cluster. || -|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) -Time to start the daily backup, in the UTC timezone. || -|| backupRetainPeriodDays | **string** (int64) +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) -Retention policy of automated backups. || -|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -Access policy to DB || -|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -Configuration of the performance diagnostics service. || -|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. -Disk size autoscaling || +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} +## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** - -User-defined settings for a PostgreSQL 9.6 cluster. || -|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Default configuration for a PostgreSQL 9.6 cluster. || +User-defined settings for a PostgreSQL 10 cluster. || +|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** + +Default configuration for a PostgreSQL 10 cluster. || |# -## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} +## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -7215,9 +8856,7 @@ in bytes || || checkpointTimeout | **string** (int64) in milliseconds. || -|| checkpointCompletionTarget | **number** (double) - -Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointCompletionTarget | **number** (double) || || checkpointFlushAfter | **string** (int64) in bytes || @@ -7370,9 +9009,6 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** - -This option has been removed in PostgreSQL 10. || || autovacuumMaxWorkers | **string** (int64) || || autovacuumVacuumCostDelay | **string** (int64) || || autovacuumVacuumCostLimit | **string** (int64) || @@ -7383,31 +9019,139 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) + +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} +## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -User-defined settings for a PostgreSQL 10 1C cluster. || -|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +User-defined settings for a PostgreSQL 11 cluster. || +|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Default configuration for a PostgreSQL 10 1C cluster. || +Default configuration for a PostgreSQL 11 cluster. || |# -## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} +## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7425,7 +9169,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -7648,6 +9391,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -7694,8 +9446,6 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || -|| onlineAnalyzeEnable | **boolean** || -|| plantunerFixEmptyTable | **boolean** || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -7725,6 +9475,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -7744,27 +9497,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} +## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -User-defined settings for a PostgreSQL 10 cluster. || -|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +User-defined settings for a PostgreSQL 11 1C cluster. || +|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Default configuration for a PostgreSQL 10 cluster. || +Default configuration for a PostgreSQL 11 1C cluster. || |# -## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} +## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7782,7 +9535,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -7987,6 +9739,7 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || || enableBitmapscan | **boolean** || || enableHashagg | **boolean** || || enableHashjoin | **boolean** || @@ -8005,6 +9758,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8056,6 +9818,7 @@ in milliseconds. || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || || maxStackDepth | **string** (int64) in bytes. || @@ -8080,6 +9843,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -8099,23 +9865,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} +## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Effective settings for a PostgreSQL 11 cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -User-defined settings for a PostgreSQL 11 cluster. || -|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +User-defined settings for a PostgreSQL 12 cluster. || +|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Default configuration for a PostgreSQL 11 cluster. || +Default configuration for a PostgreSQL 12 cluster. || |# -## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} +## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8368,6 +10134,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8465,23 +10238,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} +## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -User-defined settings for a PostgreSQL 11 1C cluster. || -|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +User-defined settings for a PostgreSQL 12 1C cluster. || +|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Default configuration for a PostgreSQL 11 1C cluster. || +Default configuration for a PostgreSQL 12 1C cluster. || |# -## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} +## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8735,6 +10508,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8833,23 +10613,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} +## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Effective settings for a PostgreSQL 12 cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -User-defined settings for a PostgreSQL 12 cluster. || -|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +User-defined settings for a PostgreSQL 13 cluster. || +|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Default configuration for a PostgreSQL 12 cluster. || +Default configuration for a PostgreSQL 13 cluster. || |# -## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} +## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9155,6 +10935,30 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -9206,23 +11010,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} +## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -User-defined settings for a PostgreSQL 12 1C cluster. || -|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +User-defined settings for a PostgreSQL 13 1C cluster. || +|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Default configuration for a PostgreSQL 12 1C cluster. || +Default configuration for a PostgreSQL 13 1C cluster. || |# -## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} +## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9529,15 +11333,36 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || -|| maxStackDepth | **string** (int64) - -in bytes. || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -9581,23 +11406,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} +## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Effective settings for a PostgreSQL 13 cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -User-defined settings for a PostgreSQL 13 cluster. || -|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +User-defined settings for a PostgreSQL 14 cluster. || +|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Default configuration for a PostgreSQL 13 cluster. || +Default configuration for a PostgreSQL 14 cluster. || |# -## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} +## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9805,7 +11630,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -9849,7 +11673,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -9927,6 +11750,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -9978,23 +11816,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} +## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -User-defined settings for a PostgreSQL 13 1C cluster. || -|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +User-defined settings for a PostgreSQL 14 1C cluster. || +|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Default configuration for a PostgreSQL 13 1C cluster. || +Default configuration for a PostgreSQL 14 1C cluster. || |# -## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} +## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10202,7 +12040,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -10247,7 +12084,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10325,6 +12161,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10374,23 +12225,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} +## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Effective settings for a PostgreSQL 14 cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -User-defined settings for a PostgreSQL 14 cluster. || -|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +User-defined settings for a PostgreSQL 15 cluster. || +|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Default configuration for a PostgreSQL 14 cluster. || +Default configuration for a PostgreSQL 15 cluster. || |# -## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} +## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10660,7 +12511,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -10741,6 +12593,7 @@ in milliseconds. || || maxStackDepth | **string** (int64) in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -10784,23 +12637,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} +## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -User-defined settings for a PostgreSQL 14 1C cluster. || -|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +User-defined settings for a PostgreSQL 15 1C cluster. || +|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Default configuration for a PostgreSQL 14 1C cluster. || +Default configuration for a PostgreSQL 15 1C cluster. || |# -## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} +## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11071,7 +12924,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -11150,6 +13004,10 @@ in milliseconds. || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -11193,23 +13051,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} +## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Effective settings for a PostgreSQL 15 cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -User-defined settings for a PostgreSQL 15 cluster. || -|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +User-defined settings for a PostgreSQL 16 cluster. || +|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Default configuration for a PostgreSQL 15 cluster. || +Default configuration for a PostgreSQL 16 cluster. || |# -## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} +## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11295,12 +13153,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11309,6 +13167,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11323,6 +13182,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11337,6 +13197,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11508,6 +13369,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11605,23 +13467,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} +## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -User-defined settings for a PostgreSQL 15 1C cluster. || -|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +User-defined settings for a PostgreSQL 16 1C cluster. || +|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Default configuration for a PostgreSQL 15 1C cluster. || +Default configuration for a PostgreSQL 16 1C cluster. || |# -## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} +## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11707,12 +13569,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11721,6 +13583,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11735,6 +13598,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11749,6 +13613,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11921,6 +13786,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12019,27 +13885,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} +## PostgresqlConfigSet17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| effectiveConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Effective settings for a PostgreSQL 16 cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| userConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -User-defined settings for a PostgreSQL 16 cluster. || -|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Default configuration for a PostgreSQL 16 cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12081,7 +13947,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12433,29 +14298,42 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# -## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} +## PostgresqlConfigSet17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| effectiveConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| userConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -User-defined settings for a PostgreSQL 16 1C cluster. || -|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Default configuration for a PostgreSQL 16 1C cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12497,7 +14375,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12851,6 +14728,19 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# ## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig} diff --git a/ru/managed-postgresql/api-ref/Cluster/listHosts.md b/ru/managed-postgresql/api-ref/Cluster/listHosts.md index 651a0f906cf..7fca65f5ea6 100644 --- a/ru/managed-postgresql/api-ref/Cluster/listHosts.md +++ b/ru/managed-postgresql/api-ref/Cluster/listHosts.md @@ -66,7 +66,7 @@ returned by the previous list request. || "replicationSource": "string", "priority": "string", "config": { - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", @@ -1085,6 +1085,140 @@ returned by the previous list request. || "timezone": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" + }, + "postgresqlConfig_17": { + "recoveryMinApplyDelay": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "workMem": "string", + "tempFileLimit": "string", + "backendFlushAfter": "string", + "maxStandbyStreamingDelay": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + }, + "postgresqlConfig_17_1c": { + "recoveryMinApplyDelay": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "workMem": "string", + "tempFileLimit": "string", + "backendFlushAfter": "string", + "maxStandbyStreamingDelay": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" } // end of the list of possible fields }, @@ -1224,105 +1358,119 @@ Aggregated health of the service. If the field has default value, it is not retu Configuration for a host with PostgreSQL 9.6 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_10_1c | **[PostgresqlHostConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C)** Configuration for a host with PostgreSQL 10 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_10 | **[PostgresqlHostConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10)** Configuration for a host with PostgreSQL 10 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_11 | **[PostgresqlHostConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11)** Configuration for a host with PostgreSQL 11 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_11_1c | **[PostgresqlHostConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C)** Configuration for a host with PostgreSQL 11 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_12 | **[PostgresqlHostConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12)** Configuration for a host with PostgreSQL 12 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_12_1c | **[PostgresqlHostConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C)** Configuration for a host with PostgreSQL 12 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_13 | **[PostgresqlHostConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13)** Configuration for a host with PostgreSQL 13 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_13_1c | **[PostgresqlHostConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C)** Configuration for a host with PostgreSQL 13 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_14 | **[PostgresqlHostConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14)** Configuration for a host with PostgreSQL 14 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_14_1c | **[PostgresqlHostConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C)** Configuration for a host with PostgreSQL 14 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_15 | **[PostgresqlHostConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15)** Configuration for a host with PostgreSQL 15 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_15_1c | **[PostgresqlHostConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C)** Configuration for a host with PostgreSQL 15 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_16 | **[PostgresqlHostConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16)** Configuration for a host with PostgreSQL 16 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_16_1c | **[PostgresqlHostConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C)** Configuration for a host with PostgreSQL 16 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL server for the host. || +|| postgresqlConfig_17 | **[PostgresqlHostConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17)** + +Configuration for a host with PostgreSQL 17 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL server for the host. || +|| postgresqlConfig_17_1c | **[PostgresqlHostConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || |# @@ -4067,6 +4215,378 @@ in milliseconds. || || arrayNulls | **boolean** || || backslashQuote | **enum** (BackslashQuote) +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# + +## PostgresqlHostConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). + +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| workMem | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| debugParallelQuery | **enum** (DebugParallelQuery) + +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# + +## PostgresqlHostConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). + +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| workMem | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| debugParallelQuery | **enum** (DebugParallelQuery) + +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + - `BACKSLASH_QUOTE_UNSPECIFIED` - `BACKSLASH_QUOTE` - `BACKSLASH_QUOTE_ON` diff --git a/ru/managed-postgresql/api-ref/Cluster/move.md b/ru/managed-postgresql/api-ref/Cluster/move.md index e546afcc2f3..197c68ff3af 100644 --- a/ru/managed-postgresql/api-ref/Cluster/move.md +++ b/ru/managed-postgresql/api-ref/Cluster/move.md @@ -79,7 +79,7 @@ Required field. ID of the destination folder. || ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "effectiveConfig": { "maxConnections": "string", @@ -6827,6 +6827,1024 @@ Required field. ID of the destination folder. || "passwordEncryption": "string" } }, + "postgresqlConfig_17": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, + "postgresqlConfig_17_1c": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, // end of the list of possible fields "poolerConfig": { "poolingMode": "string", @@ -6891,373 +7909,996 @@ Required field. ID of the destination folder. || } ``` -An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). +An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). + +#| +||Field | Description || +|| id | **string** + +ID of the operation. || +|| description | **string** + +Description of the operation. 0-256 characters long. || +|| createdAt | **string** (date-time) + +Creation timestamp. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| createdBy | **string** + +ID of the user or service account who initiated the operation. || +|| modifiedAt | **string** (date-time) + +The time when the Operation resource was last modified. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| done | **boolean** + +If the value is `false`, it means the operation is still in progress. +If `true`, the operation is completed, and either `error` or `response` is available. || +|| metadata | **[MoveClusterMetadata](#yandex.cloud.mdb.postgresql.v1.MoveClusterMetadata)** + +Service-specific metadata associated with the operation. +It typically contains the ID of the target resource that the operation is performed on. +Any method that returns a long-running operation should document the metadata type, if any. || +|| error | **[Status](#google.rpc.Status)** + +The error result of the operation in case of failure or cancellation. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** + +The normal response of the operation in case of success. +If the original method returns no data on success, such as Delete, +the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). +If the original method is the standard Create/Update, +the response should be the target resource of the operation. +Any method that returns a long-running operation should document the response type, if any. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|# + +## MoveClusterMetadata {#yandex.cloud.mdb.postgresql.v1.MoveClusterMetadata} + +#| +||Field | Description || +|| clusterId | **string** + +ID of the PostgreSQL cluster being moved. || +|| sourceFolderId | **string** + +ID of the source folder. || +|| destinationFolderId | **string** + +ID of the destnation folder. || +|# + +## Status {#google.rpc.Status} + +The error result of the operation in case of failure or cancellation. + +#| +||Field | Description || +|| code | **integer** (int32) + +Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || +|| message | **string** + +An error message. || +|| details[] | **object** + +A list of messages that carry the error details. || +|# + +## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} + +A PostgreSQL Cluster resource. For more information, see +the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. + +#| +||Field | Description || +|| id | **string** + +ID of the PostgreSQL cluster. +This ID is assigned by MDB at creation time. || +|| folderId | **string** + +ID of the folder that the PostgreSQL cluster belongs to. || +|| createdAt | **string** (date-time) + +Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| name | **string** + +Name of the PostgreSQL cluster. +The name is unique within the folder. 1-63 characters long. || +|| description | **string** + +Description of the PostgreSQL cluster. 0-256 characters long. || +|| labels | **string** + +Custom labels for the PostgreSQL cluster as `` key:value `` pairs. +Maximum 64 per resource. || +|| environment | **enum** (Environment) + +Deployment environment of the PostgreSQL cluster. + +- `ENVIRONMENT_UNSPECIFIED` +- `PRODUCTION`: Stable environment with a conservative update policy: +only hotfixes are applied during regular maintenance. +- `PRESTABLE`: Environment with more aggressive update policy: new versions +are rolled out irrespective of backward compatibility. || +|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** + +Description of monitoring systems relevant to the PostgreSQL cluster. || +|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** + +Configuration of the PostgreSQL cluster. || +|| networkId | **string** + +ID of the network that the cluster belongs to. || +|| health | **enum** (Health) + +Aggregated cluster health. + +- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). +- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). +- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). +- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || +|| status | **enum** (Status) + +Current state of the cluster. + +- `STATUS_UNKNOWN`: Cluster state is unknown. +- `CREATING`: Cluster is being created. +- `RUNNING`: Cluster is running normally. +- `ERROR`: Cluster encountered a problem and cannot operate. +- `UPDATING`: Cluster is being updated. +- `STOPPING`: Cluster is stopping. +- `STOPPED`: Cluster stopped. +- `STARTING`: Cluster is starting. || +|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** + +Maintenance window for the cluster. || +|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** + +Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || +|| securityGroupIds[] | **string** + +User security groups || +|| deletionProtection | **boolean** + +Deletion Protection inhibits deletion of the cluster || +|| hostGroupIds[] | **string** + +Host groups hosting VMs of the cluster. || +|# + +## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} + +Monitoring system. + +#| +||Field | Description || +|| name | **string** + +Name of the monitoring system. || +|| description | **string** + +Description of the monitoring system. || +|| link | **string** + +Link to the monitoring system charts for the PostgreSQL cluster. || +|# + +## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} + +#| +||Field | Description || +|| version | **string** + +Version of PostgreSQL server software. || +|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** + +Configuration of a PostgreSQL 9.6 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** + +Configuration of a PostgreSQL 10 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** + +Configuration of a PostgreSQL 10 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** + +Configuration of a PostgreSQL 11 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** + +Configuration of a PostgreSQL 11 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** + +Configuration of a PostgreSQL 12 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** + +Configuration of a PostgreSQL 12 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** + +Configuration of a PostgreSQL 13 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** + +Configuration of a PostgreSQL 13 1C server. -#| -||Field | Description || -|| id | **string** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -ID of the operation. || -|| description | **string** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** -Description of the operation. 0-256 characters long. || -|| createdAt | **string** (date-time) +Configuration of a PostgreSQL 14 server. -Creation timestamp. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| createdBy | **string** +Configuration of a PostgreSQL 14 1C server. -ID of the user or service account who initiated the operation. || -|| modifiedAt | **string** (date-time) +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The time when the Operation resource was last modified. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Configuration of a PostgreSQL 15 server. -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| done | **boolean** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -If the value is `false`, it means the operation is still in progress. -If `true`, the operation is completed, and either `error` or `response` is available. || -|| metadata | **[MoveClusterMetadata](#yandex.cloud.mdb.postgresql.v1.MoveClusterMetadata)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** -Service-specific metadata associated with the operation. -It typically contains the ID of the target resource that the operation is performed on. -Any method that returns a long-running operation should document the metadata type, if any. || -|| error | **[Status](#google.rpc.Status)** +Configuration of a PostgreSQL 15 1C server. -The error result of the operation in case of failure or cancellation. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Includes only one of the fields `error`, `response`. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || -|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** +Configuration of a PostgreSQL 16 server. -The normal response of the operation in case of success. -If the original method returns no data on success, such as Delete, -the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). -If the original method is the standard Create/Update, -the response should be the target resource of the operation. -Any method that returns a long-running operation should document the response type, if any. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Includes only one of the fields `error`, `response`. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || +Configuration of a PostgreSQL 16 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfigSet17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfigSet17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** + +Configuration of the connection pooler. || +|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** + +Resources allocated to PostgreSQL hosts. || +|| autofailover | **boolean** + +Configuration setting which enables/disables autofailover in cluster. || +|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** + +Time to start the daily backup, in the UTC timezone. || +|| backupRetainPeriodDays | **string** (int64) + +Retention policy of automated backups. || +|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** + +Access policy to DB || +|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** + +Configuration of the performance diagnostics service. || +|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** + +Disk size autoscaling || |# -## MoveClusterMetadata {#yandex.cloud.mdb.postgresql.v1.MoveClusterMetadata} +## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} #| ||Field | Description || -|| clusterId | **string** +|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -ID of the PostgreSQL cluster being moved. || -|| sourceFolderId | **string** +Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -ID of the source folder. || -|| destinationFolderId | **string** +User-defined settings for a PostgreSQL 9.6 cluster. || +|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -ID of the destnation folder. || +Default configuration for a PostgreSQL 9.6 cluster. || |# -## Status {#google.rpc.Status} +## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} -The error result of the operation in case of failure or cancellation. +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). #| ||Field | Description || -|| code | **integer** (int32) +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || -|| message | **string** +in bytes. || +|| tempBuffers | **string** (int64) -An error message. || -|| details[] | **object** +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -A list of messages that carry the error details. || -|# +in bytes. || +|| maintenanceWorkMem | **string** (int64) -## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -A PostgreSQL Cluster resource. For more information, see -the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. +in bytes. || +|| tempFileLimit | **string** (int64) -#| -||Field | Description || -|| id | **string** +in bytes. || +|| vacuumCostDelay | **string** (int64) -ID of the PostgreSQL cluster. -This ID is assigned by MDB at creation time. || -|| folderId | **string** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -ID of the folder that the PostgreSQL cluster belongs to. || -|| createdAt | **string** (date-time) +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. +in bytes || +|| backendFlushAfter | **string** (int64) -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| name | **string** +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Name of the PostgreSQL cluster. -The name is unique within the folder. 1-63 characters long. || -|| description | **string** +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) + +Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Description of the PostgreSQL cluster. 0-256 characters long. || -|| labels | **string** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Custom labels for the PostgreSQL cluster as `` key:value `` pairs. -Maximum 64 per resource. || -|| environment | **enum** (Environment) +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Deployment environment of the PostgreSQL cluster. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -- `ENVIRONMENT_UNSPECIFIED` -- `PRODUCTION`: Stable environment with a conservative update policy: -only hotfixes are applied during regular maintenance. -- `PRESTABLE`: Environment with more aggressive update policy: new versions -are rolled out irrespective of backward compatibility. || -|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Description of monitoring systems relevant to the PostgreSQL cluster. || -|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Configuration of the PostgreSQL cluster. || -|| networkId | **string** +in milliseconds. || +|| lockTimeout | **string** (int64) -ID of the network that the cluster belongs to. || -|| health | **enum** (Health) +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Aggregated cluster health. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). -- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). -- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). -- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || -|| status | **enum** (Status) +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Current state of the cluster. +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -- `STATUS_UNKNOWN`: Cluster state is unknown. -- `CREATING`: Cluster is being created. -- `RUNNING`: Cluster is running normally. -- `ERROR`: Cluster encountered a problem and cannot operate. -- `UPDATING`: Cluster is being updated. -- `STOPPING`: Cluster is stopping. -- `STOPPED`: Cluster stopped. -- `STARTING`: Cluster is starting. || -|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Maintenance window for the cluster. || -|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** +in bytes. || +|| deadlockTimeout | **string** (int64) -Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || -|| securityGroupIds[] | **string** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -User security groups || -|| deletionProtection | **boolean** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| sqlInheritance | **boolean** -Deletion Protection inhibits deletion of the cluster || -|| hostGroupIds[] | **string** +This option has been removed in PostgreSQL 10. || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Host groups hosting VMs of the cluster. || -|# +in milliseconds. || +|| archiveTimeout | **string** (int64) -## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# -Monitoring system. +## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} #| ||Field | Description || -|| name | **string** +|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Name of the monitoring system. || -|| description | **string** +Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Description of the monitoring system. || -|| link | **string** +User-defined settings for a PostgreSQL 10 1C cluster. || +|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Link to the monitoring system charts for the PostgreSQL cluster. || +Default configuration for a PostgreSQL 10 1C cluster. || |# -## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} +## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || -|| version | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Version of PostgreSQL server software. || -|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** +in bytes. || +|| tempBuffers | **string** (int64) -Configuration of a PostgreSQL 9.6 server. +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -Configuration of a PostgreSQL 10 1C server. +in bytes. || +|| tempFileLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| vacuumCostDelay | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Configuration of a PostgreSQL 10 server. +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes || +|| backendFlushAfter | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -Configuration of a PostgreSQL 11 server. +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -Configuration of a PostgreSQL 11 1C server. +in bytes || +|| maxWalSize | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| minWalSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) -Configuration of a PostgreSQL 12 server. +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Configuration of a PostgreSQL 12 1C server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Configuration of a PostgreSQL 13 server. +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Configuration of a PostgreSQL 13 1C server. +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| lockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Configuration of a PostgreSQL 14 server. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -Configuration of a PostgreSQL 14 1C server. +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| deadlockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -Configuration of a PostgreSQL 15 server. +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| archiveTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -Configuration of a PostgreSQL 15 1C server. +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) -Configuration of a PostgreSQL 16 server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| onlineAnalyzeEnable | **boolean** || +|| plantunerFixEmptyTable | **boolean** || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| geqo | **boolean** -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -Configuration of a PostgreSQL 16 1C server. +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) -Configuration of the connection pooler. || -|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) -Resources allocated to PostgreSQL hosts. || -|| autofailover | **boolean** +selective pressure within the population || +|| geqoSeed | **number** (double) -Configuration setting which enables/disables autofailover in cluster. || -|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) -Time to start the daily backup, in the UTC timezone. || -|| backupRetainPeriodDays | **string** (int64) +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) -Retention policy of automated backups. || -|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -Access policy to DB || -|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -Configuration of the performance diagnostics service. || -|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. -Disk size autoscaling || +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} +## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** - -User-defined settings for a PostgreSQL 9.6 cluster. || -|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Default configuration for a PostgreSQL 9.6 cluster. || +User-defined settings for a PostgreSQL 10 cluster. || +|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** + +Default configuration for a PostgreSQL 10 cluster. || |# -## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} +## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -7317,9 +8958,7 @@ in bytes || || checkpointTimeout | **string** (int64) in milliseconds. || -|| checkpointCompletionTarget | **number** (double) - -Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointCompletionTarget | **number** (double) || || checkpointFlushAfter | **string** (int64) in bytes || @@ -7472,9 +9111,6 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** - -This option has been removed in PostgreSQL 10. || || autovacuumMaxWorkers | **string** (int64) || || autovacuumVacuumCostDelay | **string** (int64) || || autovacuumVacuumCostLimit | **string** (int64) || @@ -7485,31 +9121,139 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) + +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} +## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -User-defined settings for a PostgreSQL 10 1C cluster. || -|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +User-defined settings for a PostgreSQL 11 cluster. || +|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Default configuration for a PostgreSQL 10 1C cluster. || +Default configuration for a PostgreSQL 11 cluster. || |# -## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} +## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7527,7 +9271,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -7750,6 +9493,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -7796,8 +9548,6 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || -|| onlineAnalyzeEnable | **boolean** || -|| plantunerFixEmptyTable | **boolean** || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -7827,6 +9577,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -7846,27 +9599,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} +## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -User-defined settings for a PostgreSQL 10 cluster. || -|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +User-defined settings for a PostgreSQL 11 1C cluster. || +|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Default configuration for a PostgreSQL 10 cluster. || +Default configuration for a PostgreSQL 11 1C cluster. || |# -## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} +## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7884,7 +9637,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -8089,6 +9841,7 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || || enableBitmapscan | **boolean** || || enableHashagg | **boolean** || || enableHashjoin | **boolean** || @@ -8107,6 +9860,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8158,6 +9920,7 @@ in milliseconds. || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || || maxStackDepth | **string** (int64) in bytes. || @@ -8182,6 +9945,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -8201,23 +9967,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} +## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Effective settings for a PostgreSQL 11 cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -User-defined settings for a PostgreSQL 11 cluster. || -|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +User-defined settings for a PostgreSQL 12 cluster. || +|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Default configuration for a PostgreSQL 11 cluster. || +Default configuration for a PostgreSQL 12 cluster. || |# -## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} +## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8470,6 +10236,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8567,23 +10340,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} +## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -User-defined settings for a PostgreSQL 11 1C cluster. || -|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +User-defined settings for a PostgreSQL 12 1C cluster. || +|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Default configuration for a PostgreSQL 11 1C cluster. || +Default configuration for a PostgreSQL 12 1C cluster. || |# -## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} +## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8837,6 +10610,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8935,23 +10715,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} +## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Effective settings for a PostgreSQL 12 cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -User-defined settings for a PostgreSQL 12 cluster. || -|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +User-defined settings for a PostgreSQL 13 cluster. || +|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Default configuration for a PostgreSQL 12 cluster. || +Default configuration for a PostgreSQL 13 cluster. || |# -## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} +## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9257,6 +11037,30 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -9308,23 +11112,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} +## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -User-defined settings for a PostgreSQL 12 1C cluster. || -|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +User-defined settings for a PostgreSQL 13 1C cluster. || +|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Default configuration for a PostgreSQL 12 1C cluster. || +Default configuration for a PostgreSQL 13 1C cluster. || |# -## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} +## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9631,15 +11435,36 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || -|| maxStackDepth | **string** (int64) - -in bytes. || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -9683,23 +11508,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} +## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Effective settings for a PostgreSQL 13 cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -User-defined settings for a PostgreSQL 13 cluster. || -|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +User-defined settings for a PostgreSQL 14 cluster. || +|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Default configuration for a PostgreSQL 13 cluster. || +Default configuration for a PostgreSQL 14 cluster. || |# -## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} +## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9907,7 +11732,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -9951,7 +11775,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10029,6 +11852,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10080,23 +11918,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} +## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -User-defined settings for a PostgreSQL 13 1C cluster. || -|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +User-defined settings for a PostgreSQL 14 1C cluster. || +|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Default configuration for a PostgreSQL 13 1C cluster. || +Default configuration for a PostgreSQL 14 1C cluster. || |# -## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} +## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10304,7 +12142,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -10349,7 +12186,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10427,6 +12263,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10476,23 +12327,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} +## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Effective settings for a PostgreSQL 14 cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -User-defined settings for a PostgreSQL 14 cluster. || -|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +User-defined settings for a PostgreSQL 15 cluster. || +|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Default configuration for a PostgreSQL 14 cluster. || +Default configuration for a PostgreSQL 15 cluster. || |# -## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} +## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10762,7 +12613,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -10843,6 +12695,7 @@ in milliseconds. || || maxStackDepth | **string** (int64) in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -10886,23 +12739,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} +## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -User-defined settings for a PostgreSQL 14 1C cluster. || -|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +User-defined settings for a PostgreSQL 15 1C cluster. || +|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Default configuration for a PostgreSQL 14 1C cluster. || +Default configuration for a PostgreSQL 15 1C cluster. || |# -## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} +## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11173,7 +13026,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -11252,6 +13106,10 @@ in milliseconds. || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -11295,23 +13153,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} +## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Effective settings for a PostgreSQL 15 cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -User-defined settings for a PostgreSQL 15 cluster. || -|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +User-defined settings for a PostgreSQL 16 cluster. || +|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Default configuration for a PostgreSQL 15 cluster. || +Default configuration for a PostgreSQL 16 cluster. || |# -## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} +## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11397,12 +13255,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11411,6 +13269,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11425,6 +13284,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11439,6 +13299,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11610,6 +13471,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11707,23 +13569,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} +## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -User-defined settings for a PostgreSQL 15 1C cluster. || -|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +User-defined settings for a PostgreSQL 16 1C cluster. || +|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Default configuration for a PostgreSQL 15 1C cluster. || +Default configuration for a PostgreSQL 16 1C cluster. || |# -## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} +## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11809,12 +13671,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11823,6 +13685,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11837,6 +13700,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11851,6 +13715,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12023,6 +13888,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12121,27 +13987,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} +## PostgresqlConfigSet17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| effectiveConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Effective settings for a PostgreSQL 16 cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| userConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -User-defined settings for a PostgreSQL 16 cluster. || -|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Default configuration for a PostgreSQL 16 cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12183,7 +14049,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12535,29 +14400,42 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# -## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} +## PostgresqlConfigSet17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| effectiveConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| userConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -User-defined settings for a PostgreSQL 16 1C cluster. || -|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Default configuration for a PostgreSQL 16 1C cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12599,7 +14477,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12953,6 +14830,19 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# ## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig} diff --git a/ru/managed-postgresql/api-ref/Cluster/rescheduleMaintenance.md b/ru/managed-postgresql/api-ref/Cluster/rescheduleMaintenance.md index 5ad54f040a4..ec356370321 100644 --- a/ru/managed-postgresql/api-ref/Cluster/rescheduleMaintenance.md +++ b/ru/managed-postgresql/api-ref/Cluster/rescheduleMaintenance.md @@ -94,7 +94,7 @@ In some languages, built-in datetime utilities do not support nanosecond precisi ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "effectiveConfig": { "maxConnections": "string", @@ -6842,6 +6842,1024 @@ In some languages, built-in datetime utilities do not support nanosecond precisi "passwordEncryption": "string" } }, + "postgresqlConfig_17": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, + "postgresqlConfig_17_1c": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, // end of the list of possible fields "poolerConfig": { "poolingMode": "string", @@ -6906,379 +7924,1002 @@ In some languages, built-in datetime utilities do not support nanosecond precisi } ``` -An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). +An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). + +#| +||Field | Description || +|| id | **string** + +ID of the operation. || +|| description | **string** + +Description of the operation. 0-256 characters long. || +|| createdAt | **string** (date-time) + +Creation timestamp. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| createdBy | **string** + +ID of the user or service account who initiated the operation. || +|| modifiedAt | **string** (date-time) + +The time when the Operation resource was last modified. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| done | **boolean** + +If the value is `false`, it means the operation is still in progress. +If `true`, the operation is completed, and either `error` or `response` is available. || +|| metadata | **[RescheduleMaintenanceMetadata](#yandex.cloud.mdb.postgresql.v1.RescheduleMaintenanceMetadata)** + +Service-specific metadata associated with the operation. +It typically contains the ID of the target resource that the operation is performed on. +Any method that returns a long-running operation should document the metadata type, if any. || +|| error | **[Status](#google.rpc.Status)** + +The error result of the operation in case of failure or cancellation. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** + +The normal response of the operation in case of success. +If the original method returns no data on success, such as Delete, +the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). +If the original method is the standard Create/Update, +the response should be the target resource of the operation. +Any method that returns a long-running operation should document the response type, if any. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|# + +## RescheduleMaintenanceMetadata {#yandex.cloud.mdb.postgresql.v1.RescheduleMaintenanceMetadata} + +Rescheduled maintenance operation metadata. + +#| +||Field | Description || +|| clusterId | **string** + +Required. ID of the PostgreSQL cluster. || +|| delayedUntil | **string** (date-time) + +Required. The time until which this maintenance operation is to be delayed. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|# + +## Status {#google.rpc.Status} + +The error result of the operation in case of failure or cancellation. + +#| +||Field | Description || +|| code | **integer** (int32) + +Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || +|| message | **string** + +An error message. || +|| details[] | **object** + +A list of messages that carry the error details. || +|# + +## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} + +A PostgreSQL Cluster resource. For more information, see +the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. + +#| +||Field | Description || +|| id | **string** + +ID of the PostgreSQL cluster. +This ID is assigned by MDB at creation time. || +|| folderId | **string** + +ID of the folder that the PostgreSQL cluster belongs to. || +|| createdAt | **string** (date-time) + +Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| name | **string** + +Name of the PostgreSQL cluster. +The name is unique within the folder. 1-63 characters long. || +|| description | **string** + +Description of the PostgreSQL cluster. 0-256 characters long. || +|| labels | **string** + +Custom labels for the PostgreSQL cluster as `` key:value `` pairs. +Maximum 64 per resource. || +|| environment | **enum** (Environment) + +Deployment environment of the PostgreSQL cluster. + +- `ENVIRONMENT_UNSPECIFIED` +- `PRODUCTION`: Stable environment with a conservative update policy: +only hotfixes are applied during regular maintenance. +- `PRESTABLE`: Environment with more aggressive update policy: new versions +are rolled out irrespective of backward compatibility. || +|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** + +Description of monitoring systems relevant to the PostgreSQL cluster. || +|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** + +Configuration of the PostgreSQL cluster. || +|| networkId | **string** + +ID of the network that the cluster belongs to. || +|| health | **enum** (Health) + +Aggregated cluster health. + +- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). +- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). +- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). +- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || +|| status | **enum** (Status) + +Current state of the cluster. + +- `STATUS_UNKNOWN`: Cluster state is unknown. +- `CREATING`: Cluster is being created. +- `RUNNING`: Cluster is running normally. +- `ERROR`: Cluster encountered a problem and cannot operate. +- `UPDATING`: Cluster is being updated. +- `STOPPING`: Cluster is stopping. +- `STOPPED`: Cluster stopped. +- `STARTING`: Cluster is starting. || +|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** + +Maintenance window for the cluster. || +|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** + +Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || +|| securityGroupIds[] | **string** + +User security groups || +|| deletionProtection | **boolean** + +Deletion Protection inhibits deletion of the cluster || +|| hostGroupIds[] | **string** + +Host groups hosting VMs of the cluster. || +|# + +## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} + +Monitoring system. + +#| +||Field | Description || +|| name | **string** + +Name of the monitoring system. || +|| description | **string** + +Description of the monitoring system. || +|| link | **string** + +Link to the monitoring system charts for the PostgreSQL cluster. || +|# + +## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} + +#| +||Field | Description || +|| version | **string** + +Version of PostgreSQL server software. || +|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** + +Configuration of a PostgreSQL 9.6 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** + +Configuration of a PostgreSQL 10 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** + +Configuration of a PostgreSQL 10 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** + +Configuration of a PostgreSQL 11 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** + +Configuration of a PostgreSQL 11 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** + +Configuration of a PostgreSQL 12 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** + +Configuration of a PostgreSQL 12 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** + +Configuration of a PostgreSQL 13 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** + +Configuration of a PostgreSQL 13 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** -#| -||Field | Description || -|| id | **string** +Configuration of a PostgreSQL 14 server. -ID of the operation. || -|| description | **string** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Description of the operation. 0-256 characters long. || -|| createdAt | **string** (date-time) +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** -Creation timestamp. +Configuration of a PostgreSQL 14 1C server. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| createdBy | **string** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** -ID of the user or service account who initiated the operation. || -|| modifiedAt | **string** (date-time) +Configuration of a PostgreSQL 15 server. -The time when the Operation resource was last modified. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| done | **boolean** +Configuration of a PostgreSQL 15 1C server. -If the value is `false`, it means the operation is still in progress. -If `true`, the operation is completed, and either `error` or `response` is available. || -|| metadata | **[RescheduleMaintenanceMetadata](#yandex.cloud.mdb.postgresql.v1.RescheduleMaintenanceMetadata)** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Service-specific metadata associated with the operation. -It typically contains the ID of the target resource that the operation is performed on. -Any method that returns a long-running operation should document the metadata type, if any. || -|| error | **[Status](#google.rpc.Status)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** -The error result of the operation in case of failure or cancellation. +Configuration of a PostgreSQL 16 server. -Includes only one of the fields `error`, `response`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || -|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** -The normal response of the operation in case of success. -If the original method returns no data on success, such as Delete, -the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). -If the original method is the standard Create/Update, -the response should be the target resource of the operation. -Any method that returns a long-running operation should document the response type, if any. +Configuration of a PostgreSQL 16 1C server. -Includes only one of the fields `error`, `response`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || -|# +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfigSet17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17)** -## RescheduleMaintenanceMetadata {#yandex.cloud.mdb.postgresql.v1.RescheduleMaintenanceMetadata} +Configuration of a PostgreSQL 17 server. -Rescheduled maintenance operation metadata. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -#| -||Field | Description || -|| clusterId | **string** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfigSet17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C)** -Required. ID of the PostgreSQL cluster. || -|| delayedUntil | **string** (date-time) +Configuration of a PostgreSQL 17 1C server. -Required. The time until which this maintenance operation is to be delayed. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Configuration for PostgreSQL servers in the cluster. || +|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|# +Configuration of the connection pooler. || +|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** -## Status {#google.rpc.Status} +Resources allocated to PostgreSQL hosts. || +|| autofailover | **boolean** -The error result of the operation in case of failure or cancellation. +Configuration setting which enables/disables autofailover in cluster. || +|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** + +Time to start the daily backup, in the UTC timezone. || +|| backupRetainPeriodDays | **string** (int64) + +Retention policy of automated backups. || +|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** + +Access policy to DB || +|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** + +Configuration of the performance diagnostics service. || +|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** + +Disk size autoscaling || +|# + +## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} #| ||Field | Description || -|| code | **integer** (int32) +|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || -|| message | **string** +Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -An error message. || -|| details[] | **object** +User-defined settings for a PostgreSQL 9.6 cluster. || +|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -A list of messages that carry the error details. || +Default configuration for a PostgreSQL 9.6 cluster. || |# -## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} +## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} -A PostgreSQL Cluster resource. For more information, see -the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). #| ||Field | Description || -|| id | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -ID of the PostgreSQL cluster. -This ID is assigned by MDB at creation time. || -|| folderId | **string** +in bytes. || +|| tempBuffers | **string** (int64) -ID of the folder that the PostgreSQL cluster belongs to. || -|| createdAt | **string** (date-time) +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| name | **string** +in bytes. || +|| tempFileLimit | **string** (int64) -Name of the PostgreSQL cluster. -The name is unique within the folder. 1-63 characters long. || -|| description | **string** +in bytes. || +|| vacuumCostDelay | **string** (int64) + +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) + +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) + +in bytes || +|| backendFlushAfter | **string** (int64) + +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) + +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) + +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) + +Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Description of the PostgreSQL cluster. 0-256 characters long. || -|| labels | **string** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Custom labels for the PostgreSQL cluster as `` key:value `` pairs. -Maximum 64 per resource. || -|| environment | **enum** (Environment) +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Deployment environment of the PostgreSQL cluster. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -- `ENVIRONMENT_UNSPECIFIED` -- `PRODUCTION`: Stable environment with a conservative update policy: -only hotfixes are applied during regular maintenance. -- `PRESTABLE`: Environment with more aggressive update policy: new versions -are rolled out irrespective of backward compatibility. || -|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Description of monitoring systems relevant to the PostgreSQL cluster. || -|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Configuration of the PostgreSQL cluster. || -|| networkId | **string** +in milliseconds. || +|| lockTimeout | **string** (int64) -ID of the network that the cluster belongs to. || -|| health | **enum** (Health) +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Aggregated cluster health. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). -- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). -- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). -- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || -|| status | **enum** (Status) +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Current state of the cluster. +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -- `STATUS_UNKNOWN`: Cluster state is unknown. -- `CREATING`: Cluster is being created. -- `RUNNING`: Cluster is running normally. -- `ERROR`: Cluster encountered a problem and cannot operate. -- `UPDATING`: Cluster is being updated. -- `STOPPING`: Cluster is stopping. -- `STOPPED`: Cluster stopped. -- `STARTING`: Cluster is starting. || -|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Maintenance window for the cluster. || -|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** +in bytes. || +|| deadlockTimeout | **string** (int64) -Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || -|| securityGroupIds[] | **string** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -User security groups || -|| deletionProtection | **boolean** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| sqlInheritance | **boolean** -Deletion Protection inhibits deletion of the cluster || -|| hostGroupIds[] | **string** +This option has been removed in PostgreSQL 10. || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Host groups hosting VMs of the cluster. || -|# +in milliseconds. || +|| archiveTimeout | **string** (int64) -## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# -Monitoring system. +## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} #| ||Field | Description || -|| name | **string** +|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Name of the monitoring system. || -|| description | **string** +Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Description of the monitoring system. || -|| link | **string** +User-defined settings for a PostgreSQL 10 1C cluster. || +|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Link to the monitoring system charts for the PostgreSQL cluster. || +Default configuration for a PostgreSQL 10 1C cluster. || |# -## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} +## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || -|| version | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Version of PostgreSQL server software. || -|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** +in bytes. || +|| tempBuffers | **string** (int64) -Configuration of a PostgreSQL 9.6 server. +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -Configuration of a PostgreSQL 10 1C server. +in bytes. || +|| tempFileLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| vacuumCostDelay | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Configuration of a PostgreSQL 10 server. +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes || +|| backendFlushAfter | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -Configuration of a PostgreSQL 11 server. +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -Configuration of a PostgreSQL 11 1C server. +in bytes || +|| maxWalSize | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| minWalSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) -Configuration of a PostgreSQL 12 server. +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Configuration of a PostgreSQL 12 1C server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Configuration of a PostgreSQL 13 server. +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Configuration of a PostgreSQL 13 1C server. +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| lockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Configuration of a PostgreSQL 14 server. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -Configuration of a PostgreSQL 14 1C server. +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| deadlockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -Configuration of a PostgreSQL 15 server. +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| archiveTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -Configuration of a PostgreSQL 15 1C server. +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) -Configuration of a PostgreSQL 16 server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| onlineAnalyzeEnable | **boolean** || +|| plantunerFixEmptyTable | **boolean** || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| geqo | **boolean** -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -Configuration of a PostgreSQL 16 1C server. +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) -Configuration of the connection pooler. || -|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) -Resources allocated to PostgreSQL hosts. || -|| autofailover | **boolean** +selective pressure within the population || +|| geqoSeed | **number** (double) -Configuration setting which enables/disables autofailover in cluster. || -|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) -Time to start the daily backup, in the UTC timezone. || -|| backupRetainPeriodDays | **string** (int64) +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) -Retention policy of automated backups. || -|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -Access policy to DB || -|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -Configuration of the performance diagnostics service. || -|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. -Disk size autoscaling || +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} +## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** - -User-defined settings for a PostgreSQL 9.6 cluster. || -|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Default configuration for a PostgreSQL 9.6 cluster. || +User-defined settings for a PostgreSQL 10 cluster. || +|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** + +Default configuration for a PostgreSQL 10 cluster. || |# -## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} +## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -7338,9 +8979,7 @@ in bytes || || checkpointTimeout | **string** (int64) in milliseconds. || -|| checkpointCompletionTarget | **number** (double) - -Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointCompletionTarget | **number** (double) || || checkpointFlushAfter | **string** (int64) in bytes || @@ -7493,9 +9132,6 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** - -This option has been removed in PostgreSQL 10. || || autovacuumMaxWorkers | **string** (int64) || || autovacuumVacuumCostDelay | **string** (int64) || || autovacuumVacuumCostLimit | **string** (int64) || @@ -7506,31 +9142,139 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) + +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} +## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -User-defined settings for a PostgreSQL 10 1C cluster. || -|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +User-defined settings for a PostgreSQL 11 cluster. || +|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Default configuration for a PostgreSQL 10 1C cluster. || +Default configuration for a PostgreSQL 11 cluster. || |# -## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} +## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7548,7 +9292,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -7771,6 +9514,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -7817,8 +9569,6 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || -|| onlineAnalyzeEnable | **boolean** || -|| plantunerFixEmptyTable | **boolean** || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -7848,6 +9598,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -7867,27 +9620,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} +## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -User-defined settings for a PostgreSQL 10 cluster. || -|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +User-defined settings for a PostgreSQL 11 1C cluster. || +|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Default configuration for a PostgreSQL 10 cluster. || +Default configuration for a PostgreSQL 11 1C cluster. || |# -## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} +## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7905,7 +9658,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -8110,6 +9862,7 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || || enableBitmapscan | **boolean** || || enableHashagg | **boolean** || || enableHashjoin | **boolean** || @@ -8128,6 +9881,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8179,6 +9941,7 @@ in milliseconds. || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || || maxStackDepth | **string** (int64) in bytes. || @@ -8203,6 +9966,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -8222,23 +9988,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} +## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Effective settings for a PostgreSQL 11 cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -User-defined settings for a PostgreSQL 11 cluster. || -|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +User-defined settings for a PostgreSQL 12 cluster. || +|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Default configuration for a PostgreSQL 11 cluster. || +Default configuration for a PostgreSQL 12 cluster. || |# -## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} +## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8491,6 +10257,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8588,23 +10361,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} +## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -User-defined settings for a PostgreSQL 11 1C cluster. || -|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +User-defined settings for a PostgreSQL 12 1C cluster. || +|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Default configuration for a PostgreSQL 11 1C cluster. || +Default configuration for a PostgreSQL 12 1C cluster. || |# -## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} +## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8858,6 +10631,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8956,23 +10736,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} +## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Effective settings for a PostgreSQL 12 cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -User-defined settings for a PostgreSQL 12 cluster. || -|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +User-defined settings for a PostgreSQL 13 cluster. || +|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Default configuration for a PostgreSQL 12 cluster. || +Default configuration for a PostgreSQL 13 cluster. || |# -## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} +## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9278,6 +11058,30 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -9329,23 +11133,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} +## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -User-defined settings for a PostgreSQL 12 1C cluster. || -|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +User-defined settings for a PostgreSQL 13 1C cluster. || +|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Default configuration for a PostgreSQL 12 1C cluster. || +Default configuration for a PostgreSQL 13 1C cluster. || |# -## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} +## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9652,15 +11456,36 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || -|| maxStackDepth | **string** (int64) - -in bytes. || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -9704,23 +11529,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} +## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Effective settings for a PostgreSQL 13 cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -User-defined settings for a PostgreSQL 13 cluster. || -|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +User-defined settings for a PostgreSQL 14 cluster. || +|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Default configuration for a PostgreSQL 13 cluster. || +Default configuration for a PostgreSQL 14 cluster. || |# -## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} +## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9928,7 +11753,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -9972,7 +11796,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10050,6 +11873,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10101,23 +11939,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} +## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -User-defined settings for a PostgreSQL 13 1C cluster. || -|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +User-defined settings for a PostgreSQL 14 1C cluster. || +|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Default configuration for a PostgreSQL 13 1C cluster. || +Default configuration for a PostgreSQL 14 1C cluster. || |# -## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} +## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10325,7 +12163,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -10370,7 +12207,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10448,6 +12284,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10497,23 +12348,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} +## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Effective settings for a PostgreSQL 14 cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -User-defined settings for a PostgreSQL 14 cluster. || -|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +User-defined settings for a PostgreSQL 15 cluster. || +|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Default configuration for a PostgreSQL 14 cluster. || +Default configuration for a PostgreSQL 15 cluster. || |# -## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} +## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10783,7 +12634,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -10864,6 +12716,7 @@ in milliseconds. || || maxStackDepth | **string** (int64) in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -10907,23 +12760,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} +## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -User-defined settings for a PostgreSQL 14 1C cluster. || -|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +User-defined settings for a PostgreSQL 15 1C cluster. || +|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Default configuration for a PostgreSQL 14 1C cluster. || +Default configuration for a PostgreSQL 15 1C cluster. || |# -## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} +## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11194,7 +13047,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -11273,6 +13127,10 @@ in milliseconds. || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -11316,23 +13174,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} +## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Effective settings for a PostgreSQL 15 cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -User-defined settings for a PostgreSQL 15 cluster. || -|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +User-defined settings for a PostgreSQL 16 cluster. || +|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Default configuration for a PostgreSQL 15 cluster. || +Default configuration for a PostgreSQL 16 cluster. || |# -## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} +## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11418,12 +13276,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11432,6 +13290,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11446,6 +13305,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11460,6 +13320,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11631,6 +13492,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11728,23 +13590,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} +## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -User-defined settings for a PostgreSQL 15 1C cluster. || -|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +User-defined settings for a PostgreSQL 16 1C cluster. || +|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Default configuration for a PostgreSQL 15 1C cluster. || +Default configuration for a PostgreSQL 16 1C cluster. || |# -## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} +## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11830,12 +13692,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11844,6 +13706,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11858,6 +13721,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11872,6 +13736,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12044,6 +13909,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12142,27 +14008,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} +## PostgresqlConfigSet17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| effectiveConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Effective settings for a PostgreSQL 16 cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| userConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -User-defined settings for a PostgreSQL 16 cluster. || -|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Default configuration for a PostgreSQL 16 cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12204,7 +14070,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12556,29 +14421,42 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# -## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} +## PostgresqlConfigSet17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| effectiveConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| userConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -User-defined settings for a PostgreSQL 16 1C cluster. || -|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Default configuration for a PostgreSQL 16 1C cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12620,7 +14498,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12974,6 +14851,19 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# ## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig} diff --git a/ru/managed-postgresql/api-ref/Cluster/restore.md b/ru/managed-postgresql/api-ref/Cluster/restore.md index 664fdfc5cfe..bd219c381e6 100644 --- a/ru/managed-postgresql/api-ref/Cluster/restore.md +++ b/ru/managed-postgresql/api-ref/Cluster/restore.md @@ -26,7 +26,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "environment": "string", "configSpec": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "maxConnections": "string", "sharedBuffers": "string", @@ -2266,109 +2266,390 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "logAutovacuumMinDuration": "string", "passwordEncryption": "string" }, - // end of the list of possible fields - "poolerConfig": { - "poolingMode": "string", - "poolDiscard": "boolean" - }, - "resources": { - "resourcePresetId": "string", - "diskSize": "string", - "diskTypeId": "string" - }, - "autofailover": "boolean", - "backupWindowStart": { - "hours": "integer", - "minutes": "integer", - "seconds": "integer", - "nanos": "integer" - }, - "backupRetainPeriodDays": "string", - "access": { - "dataLens": "boolean", - "webSql": "boolean", - "serverless": "boolean", - "dataTransfer": "boolean", - "yandexQuery": "boolean" - }, - "performanceDiagnostics": { - "enabled": "boolean", - "sessionsSamplingInterval": "string", - "statementsSamplingInterval": "string" + "postgresqlConfig_17": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, - "diskSizeAutoscaling": { - "plannedUsageThreshold": "string", - "emergencyUsageThreshold": "string", - "diskSizeLimit": "string" - } - }, - "hostSpecs": [ - { - "zoneId": "string", - "subnetId": "string", - "assignPublicIp": "boolean", - "replicationSource": "string", - "priority": "string", - "configSpec": { - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` - "postgresqlConfig_9_6": { - "recoveryMinApplyDelay": "string", - "sharedBuffers": "string", - "tempBuffers": "string", - "workMem": "string", - "replacementSortTuples": "string", - "tempFileLimit": "string", - "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", - "maxStandbyStreamingDelay": "string", - "constraintExclusion": "string", - "cursorTupleFraction": "number", - "fromCollapseLimit": "string", - "joinCollapseLimit": "string", - "forceParallelMode": "string", - "clientMinMessages": "string", - "logMinMessages": "string", - "logMinErrorStatement": "string", - "logMinDurationStatement": "string", - "logCheckpoints": "boolean", - "logConnections": "boolean", - "logDisconnections": "boolean", - "logDuration": "boolean", - "logErrorVerbosity": "string", - "logLockWaits": "boolean", - "logStatement": "string", - "logTempFiles": "string", - "searchPath": "string", - "rowSecurity": "boolean", - "defaultTransactionIsolation": "string", - "statementTimeout": "string", - "lockTimeout": "string", - "idleInTransactionSessionTimeout": "string", - "byteaOutput": "string", - "xmlbinary": "string", - "xmloption": "string", - "ginPendingListLimit": "string", - "deadlockTimeout": "string", - "maxLocksPerTransaction": "string", - "maxPredLocksPerTransaction": "string", - "arrayNulls": "boolean", - "backslashQuote": "string", - "defaultWithOids": "boolean", - "escapeStringWarning": "boolean", - "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", - "quoteAllIdentifiers": "boolean", - "standardConformingStrings": "boolean", - "synchronizeSeqscans": "boolean", - "transformNullEquals": "boolean", - "exitOnError": "boolean", - "seqPageCost": "number", - "randomPageCost": "number", - "sqlInheritance": "boolean", - "effectiveIoConcurrency": "string", - "effectiveCacheSize": "string" - }, - "postgresqlConfig_10_1c": { + "postgresqlConfig_17_1c": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + // end of the list of possible fields + "poolerConfig": { + "poolingMode": "string", + "poolDiscard": "boolean" + }, + "resources": { + "resourcePresetId": "string", + "diskSize": "string", + "diskTypeId": "string" + }, + "autofailover": "boolean", + "backupWindowStart": { + "hours": "integer", + "minutes": "integer", + "seconds": "integer", + "nanos": "integer" + }, + "backupRetainPeriodDays": "string", + "access": { + "dataLens": "boolean", + "webSql": "boolean", + "serverless": "boolean", + "dataTransfer": "boolean", + "yandexQuery": "boolean" + }, + "performanceDiagnostics": { + "enabled": "boolean", + "sessionsSamplingInterval": "string", + "statementsSamplingInterval": "string" + }, + "diskSizeAutoscaling": { + "plannedUsageThreshold": "string", + "emergencyUsageThreshold": "string", + "diskSizeLimit": "string" + } + }, + "hostSpecs": [ + { + "zoneId": "string", + "subnetId": "string", + "assignPublicIp": "boolean", + "replicationSource": "string", + "priority": "string", + "configSpec": { + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` + "postgresqlConfig_9_6": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2421,24 +2702,11 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "exitOnError": "boolean", "seqPageCost": "number", "randomPageCost": "number", - "enableBitmapscan": "boolean", - "enableHashagg": "boolean", - "enableHashjoin": "boolean", - "enableIndexscan": "boolean", - "enableIndexonlyscan": "boolean", - "enableMaterial": "boolean", - "enableMergejoin": "boolean", - "enableNestloop": "boolean", - "enableSeqscan": "boolean", - "enableSort": "boolean", - "enableTidscan": "boolean", - "maxParallelWorkers": "string", - "maxParallelWorkersPerGather": "string", - "timezone": "string", + "sqlInheritance": "boolean", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_10": { + "postgresqlConfig_10_1c": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2508,11 +2776,12 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_11": { + "postgresqlConfig_10": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", "workMem": "string", + "replacementSortTuples": "string", "tempFileLimit": "string", "backendFlushAfter": "string", "oldSnapshotThreshold": "string", @@ -2577,7 +2846,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_11_1c": { + "postgresqlConfig_11": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2646,7 +2915,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_12": { + "postgresqlConfig_11_1c": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2715,7 +2984,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_12_1c": { + "postgresqlConfig_12": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2784,7 +3053,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_13": { + "postgresqlConfig_12_1c": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2853,7 +3122,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_13_1c": { + "postgresqlConfig_13": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2922,7 +3191,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_14": { + "postgresqlConfig_13_1c": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -2966,6 +3235,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -2990,7 +3260,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_14_1c": { + "postgresqlConfig_14": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -3058,7 +3328,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_15": { + "postgresqlConfig_14_1c": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -3126,7 +3396,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_15_1c": { + "postgresqlConfig_15": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -3194,7 +3464,7 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" }, - "postgresqlConfig_16": { + "postgresqlConfig_15_1c": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", "tempBuffers": "string", @@ -3207,7 +3477,75 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "debugParallelQuery": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + }, + "postgresqlConfig_16": { + "recoveryMinApplyDelay": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "workMem": "string", + "tempFileLimit": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "maxStandbyStreamingDelay": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -3329,6 +3667,140 @@ POST https://{{ api-host-mdb }}/managed-postgresql/v1/clusters:restore "timezone": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" + }, + "postgresqlConfig_17": { + "recoveryMinApplyDelay": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "workMem": "string", + "tempFileLimit": "string", + "backendFlushAfter": "string", + "maxStandbyStreamingDelay": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + }, + "postgresqlConfig_17_1c": { + "recoveryMinApplyDelay": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "workMem": "string", + "tempFileLimit": "string", + "backendFlushAfter": "string", + "maxStandbyStreamingDelay": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" } // end of the list of possible fields } @@ -3420,110 +3892,124 @@ Host groups hosting VMs of the cluster. || || version | **string** Version of PostgreSQL used in the cluster. -Possible values: `9.6`, `10`, `10_1c`, `11`, `12`, `13`, `14`, `15` || +Possible values: `9.6`, `10`, `10_1c`, `11`, `12`, `13`, `14`, `15`, `16`, `17` || || postgresqlConfig_9_6 | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** Configuration for a PostgreSQL 9.6 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_10_1c | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** Configuration for a PostgreSQL 10 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_10 | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** Configuration for a PostgreSQL 10 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_11 | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** Configuration for a PostgreSQL 11 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_11_1c | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** Configuration for a PostgreSQL 11 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_12 | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** Configuration for a PostgreSQL 12 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_12_1c | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** Configuration for a PostgreSQL 12 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_13 | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** Configuration for a PostgreSQL 13 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_13_1c | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** Configuration for a PostgreSQL 13 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_14 | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** Configuration for a PostgreSQL 14 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_14_1c | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** Configuration for a PostgreSQL 14 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_15 | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** Configuration for a PostgreSQL 15 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_15_1c | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** Configuration for a PostgreSQL 15 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_16 | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** Configuration for a PostgreSQL 16 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_16_1c | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** Configuration for a PostgreSQL 16 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** + +Configuration for a PostgreSQL 17 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** + +Configuration for a PostgreSQL 17 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** @@ -9030,272 +9516,82 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || -|| poolingMode | **enum** (PoolingMode) +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Mode that the connection pooler is working in. -See descriptions of all modes in the [documentation for PgBouncer](https://pgbouncer.github.io/usage). +in bytes. || +|| tempBuffers | **string** (int64) -- `POOLING_MODE_UNSPECIFIED` -- `SESSION`: Session pooling mode. -- `TRANSACTION`: Transaction pooling mode. -- `STATEMENT`: Statement pooling mode. || -|| poolDiscard | **boolean** +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Setting `server_reset_query_always` parameter in PgBouncer. || -|# +in bytes. || +|| maintenanceWorkMem | **string** (int64) -## Resources {#yandex.cloud.mdb.postgresql.v1.Resources} +in bytes. || +|| autovacuumWorkMem | **string** (int64) -#| -||Field | Description || -|| resourcePresetId | **string** +in bytes. || +|| tempFileLimit | **string** (int64) -ID of the preset for computational resources available to a host (CPU, memory etc.). -All available presets are listed in the [documentation](/docs/managed-postgresql/concepts/instance-types). || -|| diskSize | **string** (int64) +in bytes. || +|| vacuumCostDelay | **string** (int64) -Volume of the storage available to a host, in bytes. || -|| diskTypeId | **string** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Type of the storage environment for the host. -Possible values: -* network-hdd - network HDD drive, -* network-ssd - network SSD drive, -* local-ssd - local SSD storage. || -|# - -## TimeOfDay {#google.type.TimeOfDay} - -Represents a time of day. The date and time zone are either not significant -or are specified elsewhere. An API may choose to allow leap seconds. Related -types are [google.type.Date](https://github.com/googleapis/googleapis/blob/master/google/type/date.proto) and [google.protobuf.Timestamp](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/timestamp.proto). - -#| -||Field | Description || -|| hours | **integer** (int32) - -Hours of day in 24 hour format. Should be from 0 to 23. An API may choose -to allow the value "24:00:00" for scenarios like business closing time. || -|| minutes | **integer** (int32) - -Minutes of hour of day. Must be from 0 to 59. || -|| seconds | **integer** (int32) - -Seconds of minutes of the time. Must normally be from 0 to 59. An API may -allow the value 60 if it allows leap-seconds. || -|| nanos | **integer** (int32) - -Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. || -|# - -## Access {#yandex.cloud.mdb.postgresql.v1.Access} - -#| -||Field | Description || -|| dataLens | **boolean** - -Allow access for DataLens || -|| webSql | **boolean** - -Allow SQL queries to the cluster databases from the management console. - -See [SQL queries in the management console](/docs/managed-postgresql/operations/web-sql-query) for more details. || -|| serverless | **boolean** - -Allow access for Serverless || -|| dataTransfer | **boolean** - -Allow access for DataTransfer. || -|| yandexQuery | **boolean** - -Allow access for YandexQuery. || -|# - -## PerformanceDiagnostics {#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics} - -#| -||Field | Description || -|| enabled | **boolean** - -Configuration setting which enables/disables performance diagnostics service in cluster. || -|| sessionsSamplingInterval | **string** (int64) - -Interval (in seconds) for pg_stat_activity sampling || -|| statementsSamplingInterval | **string** (int64) - -Interval (in seconds) for pg_stat_statements sampling || -|# - -## DiskSizeAutoscaling {#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling} - -#| -||Field | Description || -|| plannedUsageThreshold | **string** (int64) - -Threshold of storage usage (in percent) that triggers automatic scaling of the storage during the maintenance window. Zero value means disabled threshold. || -|| emergencyUsageThreshold | **string** (int64) - -Threshold of storage usage (in percent) that triggers immediate automatic scaling of the storage. Zero value means disabled threshold. || -|| diskSizeLimit | **string** (int64) - -New storage size (in bytes) that is set when one of the thresholds is achieved. || -|# - -## HostSpec {#yandex.cloud.mdb.postgresql.v1.HostSpec} - -#| -||Field | Description || -|| zoneId | **string** - -ID of the availability zone where the host resides. -To get a list of available zones, use the [yandex.cloud.compute.v1.ZoneService.List](/docs/compute/api-ref/Zone/list#List) request. || -|| subnetId | **string** - -ID of the subnet that the host should belong to. This subnet should be a part -of the network that the cluster belongs to. -The ID of the network is set in the field [Cluster.networkId](#yandex.cloud.mdb.postgresql.v1.Cluster). || -|| assignPublicIp | **boolean** - -Whether the host should get a public IP address on creation. - -After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign -a public IP to a host without one, recreate the host with `assignPublicIp` set as needed. - -Possible values: -* false - don't assign a public IP to the host. -* true - the host should have a public IP address. || -|| replicationSource | **string** - -[Host.name](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) of the host to be used as the replication source (for cascading replication). || -|| priority | **string** (int64) - -Priority of the host as a replica. A higher value corresponds to higher priority. - -The host with the highest priority is the synchronous replica. All others are asynchronous. -The synchronous replica replaces the master when needed. - -When a replica becomes the master, its priority is ignored. || -|| configSpec | **[ConfigHostSpec](#yandex.cloud.mdb.postgresql.v1.ConfigHostSpec)** - -Configuration of a PostgreSQL server for the host. || -|# - -## ConfigHostSpec {#yandex.cloud.mdb.postgresql.v1.ConfigHostSpec} - -#| -||Field | Description || -|| postgresqlConfig_9_6 | **[PostgresqlHostConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6)** - -Configuration for a host with PostgreSQL 9.6 server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_10_1c | **[PostgresqlHostConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C)** - -Configuration for a host with PostgreSQL 10 1C server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_10 | **[PostgresqlHostConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10)** - -Configuration for a host with PostgreSQL 10 server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_11 | **[PostgresqlHostConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11)** - -Configuration for a host with PostgreSQL 11 server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_11_1c | **[PostgresqlHostConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C)** - -Configuration for a host with PostgreSQL 11 1C server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_12 | **[PostgresqlHostConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12)** - -Configuration for a host with PostgreSQL 12 server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_12_1c | **[PostgresqlHostConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C)** - -Configuration for a host with PostgreSQL 12 1C server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_13 | **[PostgresqlHostConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13)** - -Configuration for a host with PostgreSQL 13 server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_13_1c | **[PostgresqlHostConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C)** - -Configuration for a host with PostgreSQL 13 1C server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_14 | **[PostgresqlHostConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14)** - -Configuration for a host with PostgreSQL 14 server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_14_1c | **[PostgresqlHostConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C)** - -Configuration for a host with PostgreSQL 14 1C server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_15 | **[PostgresqlHostConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15)** - -Configuration for a host with PostgreSQL 15 server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_15_1c | **[PostgresqlHostConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C)** - -Configuration for a host with PostgreSQL 15 1C server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_16 | **[PostgresqlHostConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16)** - -Configuration for a host with PostgreSQL 16 server deployed. - -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|| postgresqlConfig_16_1c | **[PostgresqlHostConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C)** - -Configuration for a host with PostgreSQL 16 1C server deployed. +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || -|# +in bytes || +|| backendFlushAfter | **string** (int64) -## PostgresqlHostConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6} +in bytes || +|| walLevel | **enum** (WalLevel) -Options and structure of `PostgresqlHostConfig` reflects parameters of a PostgreSQL -configuration file. Detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/runtime-config.html). +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -#| -||Field | Description || -|| recoveryMinApplyDelay | **string** (int64) +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) in milliseconds. || -|| sharedBuffers | **string** (int64) - -in bytes. || -|| tempBuffers | **string** (int64) - -in bytes. || -|| workMem | **string** (int64) +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -in bytes. || -|| replacementSortTuples | **string** (int64) +in bytes || +|| maxWalSize | **string** (int64) in bytes. || -|| tempFileLimit | **string** (int64) +|| minWalSize | **string** (int64) in bytes. || -|| backendFlushAfter | **string** (int64) || -|| oldSnapshotThreshold | **string** (int64) || || maxStandbyStreamingDelay | **string** (int64) in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || || constraintExclusion | **enum** (ConstraintExclusion) - `CONSTRAINT_EXCLUSION_UNSPECIFIED` @@ -9305,12 +9601,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -9319,6 +9615,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -9333,6 +9630,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -9347,6 +9645,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -9427,7 +9726,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -9435,44 +9733,277 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** - -This option has been removed in PostgreSQL 10. || -|| effectiveIoConcurrency | **string** (int64) || -|| effectiveCacheSize | **string** (int64) || -|# +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -## PostgresqlHostConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C} +in milliseconds. || +|| archiveTimeout | **string** (int64) -Options and structure of `PostgresqlHostConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) -#| -||Field | Description || -|| recoveryMinApplyDelay | **string** (int64) +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || +|| maxStandbyArchiveDelay | **string** (int64) in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || +|# + +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). + +#| +||Field | Description || +|| maxConnections | **string** (int64) || || sharedBuffers | **string** (int64) in bytes. || || tempBuffers | **string** (int64) in bytes. || +|| maxPreparedTransactions | **string** (int64) || || workMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) +|| maintenanceWorkMem | **string** (int64) + +in bytes. || +|| autovacuumWorkMem | **string** (int64) in bytes. || || tempFileLimit | **string** (int64) in bytes. || -|| backendFlushAfter | **string** (int64) || -|| oldSnapshotThreshold | **string** (int64) || +|| vacuumCostDelay | **string** (int64) + +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) + +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) + +in bytes || +|| backendFlushAfter | **string** (int64) + +in bytes || +|| walLevel | **enum** (WalLevel) + +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) + +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || || maxStandbyStreamingDelay | **string** (int64) in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || || constraintExclusion | **enum** (ConstraintExclusion) - `CONSTRAINT_EXCLUSION_UNSPECIFIED` @@ -9482,12 +10013,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -9496,6 +10027,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -9510,6 +10042,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -9524,6 +10057,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -9604,7 +10138,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -9612,71 +10145,84 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| enableBitmapscan | **boolean** || -|| enableHashagg | **boolean** || -|| enableHashjoin | **boolean** || -|| enableIndexscan | **boolean** || -|| enableIndexonlyscan | **boolean** || -|| enableMaterial | **boolean** || -|| enableMergejoin | **boolean** || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) + +in milliseconds. || +|| archiveTimeout | **string** (int64) + +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || || enableNestloop | **boolean** || || enableSeqscan | **boolean** || || enableSort | **boolean** || || enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || || maxParallelWorkers | **string** (int64) || || maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || -|# - -## PostgresqlHostConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10} - -Options and structure of `PostgresqlHostConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). - -#| -||Field | Description || -|| recoveryMinApplyDelay | **string** (int64) - -in milliseconds. || -|| sharedBuffers | **string** (int64) - -in bytes. || -|| tempBuffers | **string** (int64) - -in bytes. || -|| workMem | **string** (int64) - -in bytes. || -|| replacementSortTuples | **string** (int64) - -in bytes. || -|| tempFileLimit | **string** (int64) +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -in bytes. || -|| backendFlushAfter | **string** (int64) || -|| oldSnapshotThreshold | **string** (int64) || -|| maxStandbyStreamingDelay | **string** (int64) +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || +|| autoExplainLogMinDuration | **string** (int64) in milliseconds. || -|| constraintExclusion | **enum** (ConstraintExclusion) - -- `CONSTRAINT_EXCLUSION_UNSPECIFIED` -- `CONSTRAINT_EXCLUSION_ON` -- `CONSTRAINT_EXCLUSION_OFF` -- `CONSTRAINT_EXCLUSION_PARTITION` || -|| cursorTupleFraction | **number** (double) || -|| fromCollapseLimit | **string** (int64) || -|| joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || -|| clientMinMessages | **enum** (LogLevel) +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` - `LOG_LEVEL_DEBUG5` @@ -9684,337 +10230,375 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || -|| logMinMessages | **enum** (LogLevel) +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) -- `LOG_LEVEL_UNSPECIFIED` -- `LOG_LEVEL_DEBUG5` -- `LOG_LEVEL_DEBUG4` -- `LOG_LEVEL_DEBUG3` -- `LOG_LEVEL_DEBUG2` -- `LOG_LEVEL_DEBUG1` -- `LOG_LEVEL_LOG` -- `LOG_LEVEL_NOTICE` -- `LOG_LEVEL_WARNING` -- `LOG_LEVEL_ERROR` -- `LOG_LEVEL_FATAL` -- `LOG_LEVEL_PANIC` || -|| logMinErrorStatement | **enum** (LogLevel) +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) -- `LOG_LEVEL_UNSPECIFIED` -- `LOG_LEVEL_DEBUG5` -- `LOG_LEVEL_DEBUG4` -- `LOG_LEVEL_DEBUG3` -- `LOG_LEVEL_DEBUG2` -- `LOG_LEVEL_DEBUG1` -- `LOG_LEVEL_LOG` -- `LOG_LEVEL_NOTICE` -- `LOG_LEVEL_WARNING` -- `LOG_LEVEL_ERROR` -- `LOG_LEVEL_FATAL` -- `LOG_LEVEL_PANIC` || -|| logMinDurationStatement | **string** (int64) +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) in milliseconds. || -|| logCheckpoints | **boolean** || -|| logConnections | **boolean** || -|| logDisconnections | **boolean** || -|| logDuration | **boolean** || -|| logErrorVerbosity | **enum** (LogErrorVerbosity) +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) -- `LOG_ERROR_VERBOSITY_UNSPECIFIED` -- `LOG_ERROR_VERBOSITY_TERSE` -- `LOG_ERROR_VERBOSITY_DEFAULT` -- `LOG_ERROR_VERBOSITY_VERBOSE` || -|| logLockWaits | **boolean** || -|| logStatement | **enum** (LogStatement) +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) -- `LOG_STATEMENT_UNSPECIFIED` -- `LOG_STATEMENT_NONE` -- `LOG_STATEMENT_DDL` -- `LOG_STATEMENT_MOD` -- `LOG_STATEMENT_ALL` || -|| logTempFiles | **string** (int64) || -|| searchPath | **string** || -|| rowSecurity | **boolean** || -|| defaultTransactionIsolation | **enum** (TransactionIsolation) +in bytes. || +|| clientConnectionCheckInterval | **string** (int64) -- `TRANSACTION_ISOLATION_UNSPECIFIED` -- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` -- `TRANSACTION_ISOLATION_READ_COMMITTED` -- `TRANSACTION_ISOLATION_REPEATABLE_READ` -- `TRANSACTION_ISOLATION_SERIALIZABLE` || -|| statementTimeout | **string** (int64) +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** in milliseconds. || -|| lockTimeout | **string** (int64) +|| vacuumFailsafeAge | **string** (int64) in milliseconds. || -|| idleInTransactionSessionTimeout | **string** (int64) +|| vacuumMultixactFailsafeAge | **string** (int64) in milliseconds. || -|| byteaOutput | **enum** (ByteaOutput) +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) -- `BYTEA_OUTPUT_UNSPECIFIED` -- `BYTEA_OUTPUT_HEX` -- `BYTEA_OUTPUT_ESCAPED` || -|| xmlbinary | **enum** (XmlBinary) +in bytes. || +|| enableGroupByReordering | **boolean** || +|| geqo | **boolean** -- `XML_BINARY_UNSPECIFIED` -- `XML_BINARY_BASE64` -- `XML_BINARY_HEX` || -|| xmloption | **enum** (XmlOption) +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -- `XML_OPTION_UNSPECIFIED` -- `XML_OPTION_DOCUMENT` -- `XML_OPTION_CONTENT` || -|| ginPendingListLimit | **string** (int64) +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -in bytes. || -|| deadlockTimeout | **string** (int64) +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || +|| maxStandbyArchiveDelay | **string** (int64) in milliseconds. || -|| maxLocksPerTransaction | **string** (int64) || -|| maxPredLocksPerTransaction | **string** (int64) || -|| arrayNulls | **boolean** || -|| backslashQuote | **enum** (BackslashQuote) +|| sessionDurationTimeout | **string** (int64) -- `BACKSLASH_QUOTE_UNSPECIFIED` -- `BACKSLASH_QUOTE` -- `BACKSLASH_QUOTE_ON` -- `BACKSLASH_QUOTE_OFF` -- `BACKSLASH_QUOTE_SAFE_ENCODING` || -|| defaultWithOids | **boolean** || -|| escapeStringWarning | **boolean** || -|| loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || -|| quoteAllIdentifiers | **boolean** || -|| standardConformingStrings | **boolean** || -|| synchronizeSeqscans | **boolean** || -|| transformNullEquals | **boolean** || -|| exitOnError | **boolean** || -|| seqPageCost | **number** (double) || -|| randomPageCost | **number** (double) || -|| enableBitmapscan | **boolean** || -|| enableHashagg | **boolean** || -|| enableHashjoin | **boolean** || -|| enableIndexscan | **boolean** || -|| enableIndexonlyscan | **boolean** || -|| enableMaterial | **boolean** || -|| enableMergejoin | **boolean** || -|| enableNestloop | **boolean** || -|| enableSeqscan | **boolean** || -|| enableSort | **boolean** || -|| enableTidscan | **boolean** || -|| maxParallelWorkers | **string** (int64) || -|| maxParallelWorkersPerGather | **string** (int64) || -|| timezone | **string** || -|| effectiveIoConcurrency | **string** (int64) || -|| effectiveCacheSize | **string** (int64) || -|# +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -## PostgresqlHostConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11} +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || +|# + +## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig} #| ||Field | Description || -|| recoveryMinApplyDelay | **string** (int64) - -in milliseconds. || -|| sharedBuffers | **string** (int64) +|| poolingMode | **enum** (PoolingMode) -in bytes. || -|| tempBuffers | **string** (int64) +Mode that the connection pooler is working in. +See descriptions of all modes in the [documentation for PgBouncer](https://pgbouncer.github.io/usage). -in bytes. || -|| workMem | **string** (int64) +- `POOLING_MODE_UNSPECIFIED` +- `SESSION`: Session pooling mode. +- `TRANSACTION`: Transaction pooling mode. +- `STATEMENT`: Statement pooling mode. || +|| poolDiscard | **boolean** -in bytes. || -|| tempFileLimit | **string** (int64) +Setting `server_reset_query_always` parameter in PgBouncer. || +|# -in bytes. || -|| backendFlushAfter | **string** (int64) || -|| oldSnapshotThreshold | **string** (int64) || -|| maxStandbyStreamingDelay | **string** (int64) +## Resources {#yandex.cloud.mdb.postgresql.v1.Resources} -in milliseconds. || -|| constraintExclusion | **enum** (ConstraintExclusion) +#| +||Field | Description || +|| resourcePresetId | **string** -- `CONSTRAINT_EXCLUSION_UNSPECIFIED` -- `CONSTRAINT_EXCLUSION_ON` -- `CONSTRAINT_EXCLUSION_OFF` -- `CONSTRAINT_EXCLUSION_PARTITION` || -|| cursorTupleFraction | **number** (double) || -|| fromCollapseLimit | **string** (int64) || -|| joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +ID of the preset for computational resources available to a host (CPU, memory etc.). +All available presets are listed in the [documentation](/docs/managed-postgresql/concepts/instance-types). || +|| diskSize | **string** (int64) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || -|| clientMinMessages | **enum** (LogLevel) +Volume of the storage available to a host, in bytes. || +|| diskTypeId | **string** -- `LOG_LEVEL_UNSPECIFIED` -- `LOG_LEVEL_DEBUG5` -- `LOG_LEVEL_DEBUG4` -- `LOG_LEVEL_DEBUG3` -- `LOG_LEVEL_DEBUG2` -- `LOG_LEVEL_DEBUG1` -- `LOG_LEVEL_LOG` -- `LOG_LEVEL_NOTICE` -- `LOG_LEVEL_WARNING` -- `LOG_LEVEL_ERROR` -- `LOG_LEVEL_FATAL` -- `LOG_LEVEL_PANIC` || -|| logMinMessages | **enum** (LogLevel) +Type of the storage environment for the host. +Possible values: +* network-hdd - network HDD drive, +* network-ssd - network SSD drive, +* local-ssd - local SSD storage. || +|# -- `LOG_LEVEL_UNSPECIFIED` -- `LOG_LEVEL_DEBUG5` -- `LOG_LEVEL_DEBUG4` -- `LOG_LEVEL_DEBUG3` -- `LOG_LEVEL_DEBUG2` -- `LOG_LEVEL_DEBUG1` -- `LOG_LEVEL_LOG` -- `LOG_LEVEL_NOTICE` -- `LOG_LEVEL_WARNING` -- `LOG_LEVEL_ERROR` -- `LOG_LEVEL_FATAL` -- `LOG_LEVEL_PANIC` || -|| logMinErrorStatement | **enum** (LogLevel) +## TimeOfDay {#google.type.TimeOfDay} -- `LOG_LEVEL_UNSPECIFIED` -- `LOG_LEVEL_DEBUG5` -- `LOG_LEVEL_DEBUG4` -- `LOG_LEVEL_DEBUG3` -- `LOG_LEVEL_DEBUG2` -- `LOG_LEVEL_DEBUG1` -- `LOG_LEVEL_LOG` -- `LOG_LEVEL_NOTICE` -- `LOG_LEVEL_WARNING` -- `LOG_LEVEL_ERROR` -- `LOG_LEVEL_FATAL` -- `LOG_LEVEL_PANIC` || -|| logMinDurationStatement | **string** (int64) +Represents a time of day. The date and time zone are either not significant +or are specified elsewhere. An API may choose to allow leap seconds. Related +types are [google.type.Date](https://github.com/googleapis/googleapis/blob/master/google/type/date.proto) and [google.protobuf.Timestamp](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/timestamp.proto). -in milliseconds. || -|| logCheckpoints | **boolean** || -|| logConnections | **boolean** || -|| logDisconnections | **boolean** || -|| logDuration | **boolean** || -|| logErrorVerbosity | **enum** (LogErrorVerbosity) +#| +||Field | Description || +|| hours | **integer** (int32) -- `LOG_ERROR_VERBOSITY_UNSPECIFIED` -- `LOG_ERROR_VERBOSITY_TERSE` -- `LOG_ERROR_VERBOSITY_DEFAULT` -- `LOG_ERROR_VERBOSITY_VERBOSE` || -|| logLockWaits | **boolean** || -|| logStatement | **enum** (LogStatement) +Hours of day in 24 hour format. Should be from 0 to 23. An API may choose +to allow the value "24:00:00" for scenarios like business closing time. || +|| minutes | **integer** (int32) -- `LOG_STATEMENT_UNSPECIFIED` -- `LOG_STATEMENT_NONE` -- `LOG_STATEMENT_DDL` -- `LOG_STATEMENT_MOD` -- `LOG_STATEMENT_ALL` || -|| logTempFiles | **string** (int64) || -|| searchPath | **string** || -|| rowSecurity | **boolean** || -|| defaultTransactionIsolation | **enum** (TransactionIsolation) +Minutes of hour of day. Must be from 0 to 59. || +|| seconds | **integer** (int32) -- `TRANSACTION_ISOLATION_UNSPECIFIED` -- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` -- `TRANSACTION_ISOLATION_READ_COMMITTED` -- `TRANSACTION_ISOLATION_REPEATABLE_READ` -- `TRANSACTION_ISOLATION_SERIALIZABLE` || -|| statementTimeout | **string** (int64) +Seconds of minutes of the time. Must normally be from 0 to 59. An API may +allow the value 60 if it allows leap-seconds. || +|| nanos | **integer** (int32) -in milliseconds. || -|| lockTimeout | **string** (int64) +Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. || +|# -in milliseconds. || -|| idleInTransactionSessionTimeout | **string** (int64) +## Access {#yandex.cloud.mdb.postgresql.v1.Access} -in milliseconds. || -|| byteaOutput | **enum** (ByteaOutput) +#| +||Field | Description || +|| dataLens | **boolean** -- `BYTEA_OUTPUT_UNSPECIFIED` -- `BYTEA_OUTPUT_HEX` -- `BYTEA_OUTPUT_ESCAPED` || -|| xmlbinary | **enum** (XmlBinary) +Allow access for DataLens || +|| webSql | **boolean** -- `XML_BINARY_UNSPECIFIED` -- `XML_BINARY_BASE64` -- `XML_BINARY_HEX` || -|| xmloption | **enum** (XmlOption) +Allow SQL queries to the cluster databases from the management console. -- `XML_OPTION_UNSPECIFIED` -- `XML_OPTION_DOCUMENT` -- `XML_OPTION_CONTENT` || -|| ginPendingListLimit | **string** (int64) +See [SQL queries in the management console](/docs/managed-postgresql/operations/web-sql-query) for more details. || +|| serverless | **boolean** -in bytes. || -|| deadlockTimeout | **string** (int64) +Allow access for Serverless || +|| dataTransfer | **boolean** -in milliseconds. || -|| maxLocksPerTransaction | **string** (int64) || -|| maxPredLocksPerTransaction | **string** (int64) || -|| arrayNulls | **boolean** || -|| backslashQuote | **enum** (BackslashQuote) +Allow access for DataTransfer. || +|| yandexQuery | **boolean** -- `BACKSLASH_QUOTE_UNSPECIFIED` -- `BACKSLASH_QUOTE` -- `BACKSLASH_QUOTE_ON` -- `BACKSLASH_QUOTE_OFF` -- `BACKSLASH_QUOTE_SAFE_ENCODING` || -|| defaultWithOids | **boolean** || -|| escapeStringWarning | **boolean** || -|| loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || -|| quoteAllIdentifiers | **boolean** || -|| standardConformingStrings | **boolean** || -|| synchronizeSeqscans | **boolean** || -|| transformNullEquals | **boolean** || -|| exitOnError | **boolean** || -|| seqPageCost | **number** (double) || -|| randomPageCost | **number** (double) || -|| enableBitmapscan | **boolean** || -|| enableHashagg | **boolean** || -|| enableHashjoin | **boolean** || -|| enableIndexscan | **boolean** || -|| enableIndexonlyscan | **boolean** || -|| enableMaterial | **boolean** || -|| enableMergejoin | **boolean** || -|| enableNestloop | **boolean** || -|| enableSeqscan | **boolean** || -|| enableSort | **boolean** || -|| enableTidscan | **boolean** || -|| maxParallelWorkers | **string** (int64) || -|| maxParallelWorkersPerGather | **string** (int64) || -|| timezone | **string** || -|| effectiveIoConcurrency | **string** (int64) || -|| effectiveCacheSize | **string** (int64) || +Allow access for YandexQuery. || |# -## PostgresqlHostConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C} - -Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +## PerformanceDiagnostics {#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics} #| ||Field | Description || -|| recoveryMinApplyDelay | **string** (int64) - -in milliseconds. || -|| sharedBuffers | **string** (int64) +|| enabled | **boolean** + +Configuration setting which enables/disables performance diagnostics service in cluster. || +|| sessionsSamplingInterval | **string** (int64) + +Interval (in seconds) for pg_stat_activity sampling || +|| statementsSamplingInterval | **string** (int64) + +Interval (in seconds) for pg_stat_statements sampling || +|# + +## DiskSizeAutoscaling {#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling} + +#| +||Field | Description || +|| plannedUsageThreshold | **string** (int64) + +Threshold of storage usage (in percent) that triggers automatic scaling of the storage during the maintenance window. Zero value means disabled threshold. || +|| emergencyUsageThreshold | **string** (int64) + +Threshold of storage usage (in percent) that triggers immediate automatic scaling of the storage. Zero value means disabled threshold. || +|| diskSizeLimit | **string** (int64) + +New storage size (in bytes) that is set when one of the thresholds is achieved. || +|# + +## HostSpec {#yandex.cloud.mdb.postgresql.v1.HostSpec} + +#| +||Field | Description || +|| zoneId | **string** + +ID of the availability zone where the host resides. +To get a list of available zones, use the [yandex.cloud.compute.v1.ZoneService.List](/docs/compute/api-ref/Zone/list#List) request. || +|| subnetId | **string** + +ID of the subnet that the host should belong to. This subnet should be a part +of the network that the cluster belongs to. +The ID of the network is set in the field [Cluster.networkId](#yandex.cloud.mdb.postgresql.v1.Cluster). || +|| assignPublicIp | **boolean** + +Whether the host should get a public IP address on creation. + +After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign +a public IP to a host without one, recreate the host with `assignPublicIp` set as needed. + +Possible values: +* false - don't assign a public IP to the host. +* true - the host should have a public IP address. || +|| replicationSource | **string** + +[Host.name](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) of the host to be used as the replication source (for cascading replication). || +|| priority | **string** (int64) + +Priority of the host as a replica. A higher value corresponds to higher priority. + +The host with the highest priority is the synchronous replica. All others are asynchronous. +The synchronous replica replaces the master when needed. + +When a replica becomes the master, its priority is ignored. || +|| configSpec | **[ConfigHostSpec](#yandex.cloud.mdb.postgresql.v1.ConfigHostSpec)** + +Configuration of a PostgreSQL server for the host. || +|# + +## ConfigHostSpec {#yandex.cloud.mdb.postgresql.v1.ConfigHostSpec} + +#| +||Field | Description || +|| postgresqlConfig_9_6 | **[PostgresqlHostConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6)** + +Configuration for a host with PostgreSQL 9.6 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_10_1c | **[PostgresqlHostConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C)** + +Configuration for a host with PostgreSQL 10 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_10 | **[PostgresqlHostConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10)** + +Configuration for a host with PostgreSQL 10 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_11 | **[PostgresqlHostConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11)** + +Configuration for a host with PostgreSQL 11 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_11_1c | **[PostgresqlHostConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C)** + +Configuration for a host with PostgreSQL 11 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_12 | **[PostgresqlHostConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12)** + +Configuration for a host with PostgreSQL 12 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_12_1c | **[PostgresqlHostConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C)** + +Configuration for a host with PostgreSQL 12 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_13 | **[PostgresqlHostConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13)** + +Configuration for a host with PostgreSQL 13 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_13_1c | **[PostgresqlHostConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C)** + +Configuration for a host with PostgreSQL 13 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_14 | **[PostgresqlHostConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14)** + +Configuration for a host with PostgreSQL 14 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_14_1c | **[PostgresqlHostConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C)** + +Configuration for a host with PostgreSQL 14 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_15 | **[PostgresqlHostConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15)** + +Configuration for a host with PostgreSQL 15 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_15_1c | **[PostgresqlHostConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C)** + +Configuration for a host with PostgreSQL 15 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_16 | **[PostgresqlHostConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16)** + +Configuration for a host with PostgreSQL 16 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_16_1c | **[PostgresqlHostConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C)** + +Configuration for a host with PostgreSQL 16 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17 | **[PostgresqlHostConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17_1c | **[PostgresqlHostConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|# + +## PostgresqlHostConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6} + +Options and structure of `PostgresqlHostConfig` reflects parameters of a PostgreSQL +configuration file. Detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/runtime-config.html). + +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) in bytes. || || tempBuffers | **string** (int64) @@ -10022,6 +10606,9 @@ in bytes. || in bytes. || || workMem | **string** (int64) +in bytes. || +|| replacementSortTuples | **string** (int64) + in bytes. || || tempFileLimit | **string** (int64) @@ -10170,29 +10757,18 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| enableBitmapscan | **boolean** || -|| enableHashagg | **boolean** || -|| enableHashjoin | **boolean** || -|| enableIndexscan | **boolean** || -|| enableIndexonlyscan | **boolean** || -|| enableMaterial | **boolean** || -|| enableMergejoin | **boolean** || -|| enableNestloop | **boolean** || -|| enableSeqscan | **boolean** || -|| enableSort | **boolean** || -|| enableTidscan | **boolean** || -|| maxParallelWorkers | **string** (int64) || -|| maxParallelWorkersPerGather | **string** (int64) || -|| timezone | **string** || +|| sqlInheritance | **boolean** + +This option has been removed in PostgreSQL 10. || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12} +## PostgresqlHostConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C} -Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +Options and structure of `PostgresqlHostConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -10207,6 +10783,9 @@ in bytes. || in bytes. || || workMem | **string** (int64) +in bytes. || +|| replacementSortTuples | **string** (int64) + in bytes. || || tempFileLimit | **string** (int64) @@ -10373,11 +10952,11 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C} +## PostgresqlHostConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10} -Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +Options and structure of `PostgresqlHostConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -10392,6 +10971,9 @@ in bytes. || in bytes. || || workMem | **string** (int64) +in bytes. || +|| replacementSortTuples | **string** (int64) + in bytes. || || tempFileLimit | **string** (int64) @@ -10558,7 +11140,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13} +## PostgresqlHostConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10743,7 +11325,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C} +## PostgresqlHostConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10928,7 +11510,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14} +## PostgresqlHostConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11087,6 +11669,7 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -11112,7 +11695,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C} +## PostgresqlHostConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11271,6 +11854,7 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -11296,7 +11880,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15} +## PostgresqlHostConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11455,6 +12039,7 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -11480,7 +12065,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C} +## PostgresqlHostConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11639,6 +12224,7 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -11664,7 +12250,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16} +## PostgresqlHostConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11701,12 +12287,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| debugParallelQuery | **enum** (DebugParallelQuery) +|| forceParallelMode | **enum** (ForceParallelMode) -- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` -- `DEBUG_PARALLEL_QUERY_ON` -- `DEBUG_PARALLEL_QUERY_OFF` -- `DEBUG_PARALLEL_QUERY_REGRESS` || +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11715,7 +12301,6 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` -- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11730,7 +12315,6 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` -- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11745,7 +12329,6 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` -- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11851,7 +12434,7 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## PostgresqlHostConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C} +## PostgresqlHostConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11888,12 +12471,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| debugParallelQuery | **enum** (DebugParallelQuery) +|| forceParallelMode | **enum** (ForceParallelMode) -- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` -- `DEBUG_PARALLEL_QUERY_ON` -- `DEBUG_PARALLEL_QUERY_OFF` -- `DEBUG_PARALLEL_QUERY_REGRESS` || +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11902,7 +12485,6 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` -- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11917,7 +12499,6 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` -- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11932,7 +12513,6 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` -- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12038,26 +12618,1140 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# -## Response {#yandex.cloud.operation.Operation} +## PostgresqlHostConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15} -**HTTP Code: 200 - OK** +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). -```json -{ - "id": "string", - "description": "string", - "createdAt": "string", - "createdBy": "string", - "modifiedAt": "string", - "done": "boolean", - "metadata": { - "clusterId": "string", - "backupId": "string" - }, - // Includes only one of the fields `error`, `response` - "error": { - "code": "integer", - "message": "string", +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| workMem | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| oldSnapshotThreshold | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# + +## PostgresqlHostConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). + +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| workMem | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| oldSnapshotThreshold | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# + +## PostgresqlHostConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). + +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| workMem | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| oldSnapshotThreshold | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| debugParallelQuery | **enum** (DebugParallelQuery) + +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# + +## PostgresqlHostConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). + +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| workMem | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| oldSnapshotThreshold | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| debugParallelQuery | **enum** (DebugParallelQuery) + +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# + +## PostgresqlHostConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). + +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| workMem | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| debugParallelQuery | **enum** (DebugParallelQuery) + +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# + +## PostgresqlHostConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). + +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| workMem | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| debugParallelQuery | **enum** (DebugParallelQuery) + +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# + +## Response {#yandex.cloud.operation.Operation} + +**HTTP Code: 200 - OK** + +```json +{ + "id": "string", + "description": "string", + "createdAt": "string", + "createdBy": "string", + "modifiedAt": "string", + "done": "boolean", + "metadata": { + "clusterId": "string", + "backupId": "string" + }, + // Includes only one of the fields `error`, `response` + "error": { + "code": "integer", + "message": "string", "details": [ "object" ] @@ -12079,7 +13773,7 @@ in milliseconds. || ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "effectiveConfig": { "maxConnections": "string", @@ -12154,15 +13848,723 @@ in milliseconds. || "exitOnError": "boolean", "seqPageCost": "number", "randomPageCost": "number", - "sqlInheritance": "boolean", + "sqlInheritance": "boolean", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "sqlInheritance": "boolean", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "sqlInheritance": "boolean", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + } + }, + "postgresqlConfig_10_1c": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "onlineAnalyzeEnable": "boolean", + "plantunerFixEmptyTable": "boolean", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "onlineAnalyzeEnable": "boolean", + "plantunerFixEmptyTable": "boolean", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "onlineAnalyzeEnable": "boolean", + "plantunerFixEmptyTable": "boolean", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" + } + }, + "postgresqlConfig_10": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", "autovacuumMaxWorkers": "string", "autovacuumVacuumCostDelay": "string", "autovacuumVacuumCostLimit": "string", "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", "effectiveIoConcurrency": "string", - "effectiveCacheSize": "string" + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" }, "userConfig": { "maxConnections": "string", @@ -12237,15 +14639,65 @@ in milliseconds. || "exitOnError": "boolean", "seqPageCost": "number", "randomPageCost": "number", - "sqlInheritance": "boolean", "autovacuumMaxWorkers": "string", "autovacuumVacuumCostDelay": "string", "autovacuumVacuumCostLimit": "string", "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", "effectiveIoConcurrency": "string", - "effectiveCacheSize": "string" + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" }, "defaultConfig": { "maxConnections": "string", @@ -12320,18 +14772,68 @@ in milliseconds. || "exitOnError": "boolean", "seqPageCost": "number", "randomPageCost": "number", - "sqlInheritance": "boolean", "autovacuumMaxWorkers": "string", "autovacuumVacuumCostDelay": "string", "autovacuumVacuumCostLimit": "string", "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", "effectiveIoConcurrency": "string", - "effectiveCacheSize": "string" + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" } }, - "postgresqlConfig_10_1c": { + "postgresqlConfig_11": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -12339,7 +14841,6 @@ in milliseconds. || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -12429,6 +14930,15 @@ in milliseconds. || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -12446,8 +14956,6 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", - "onlineAnalyzeEnable": "boolean", - "plantunerFixEmptyTable": "boolean", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -12461,6 +14969,9 @@ in milliseconds. || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -12474,7 +14985,6 @@ in milliseconds. || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -12564,6 +15074,15 @@ in milliseconds. || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -12581,8 +15100,6 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", - "onlineAnalyzeEnable": "boolean", - "plantunerFixEmptyTable": "boolean", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -12596,6 +15113,9 @@ in milliseconds. || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -12609,7 +15129,6 @@ in milliseconds. || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -12699,6 +15218,15 @@ in milliseconds. || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -12716,8 +15244,6 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", - "onlineAnalyzeEnable": "boolean", - "plantunerFixEmptyTable": "boolean", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -12731,6 +15257,9 @@ in milliseconds. || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -12738,7 +15267,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_10": { + "postgresqlConfig_11_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -12746,7 +15275,6 @@ in milliseconds. || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -12818,6 +15346,7 @@ in milliseconds. || "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", "enableBitmapscan": "boolean", "enableHashagg": "boolean", "enableHashjoin": "boolean", @@ -12836,6 +15365,15 @@ in milliseconds. || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -12858,6 +15396,7 @@ in milliseconds. || "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", @@ -12866,6 +15405,9 @@ in milliseconds. || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -12879,7 +15421,6 @@ in milliseconds. || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -12951,6 +15492,7 @@ in milliseconds. || "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", "enableBitmapscan": "boolean", "enableHashagg": "boolean", "enableHashjoin": "boolean", @@ -12969,6 +15511,15 @@ in milliseconds. || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -12991,6 +15542,7 @@ in milliseconds. || "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", @@ -12999,6 +15551,9 @@ in milliseconds. || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -13012,7 +15567,6 @@ in milliseconds. || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -13084,6 +15638,7 @@ in milliseconds. || "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", "enableBitmapscan": "boolean", "enableHashagg": "boolean", "enableHashjoin": "boolean", @@ -13102,6 +15657,15 @@ in milliseconds. || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -13124,6 +15688,7 @@ in milliseconds. || "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", @@ -13132,6 +15697,9 @@ in milliseconds. || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -13139,7 +15707,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_11": { + "postgresqlConfig_12": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -13245,6 +15813,8 @@ in milliseconds. || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -13389,6 +15959,8 @@ in milliseconds. || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -13533,6 +16105,8 @@ in milliseconds. || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -13573,7 +16147,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_11_1c": { + "postgresqlConfig_12_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -13680,6 +16254,8 @@ in milliseconds. || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -13826,6 +16402,8 @@ in milliseconds. || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -13972,6 +16550,8 @@ in milliseconds. || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -14013,7 +16593,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_12": { + "postgresqlConfig_13": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -14138,6 +16718,18 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -14284,6 +16876,18 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -14430,6 +17034,18 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -14453,7 +17069,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_12_1c": { + "postgresqlConfig_13_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -14579,13 +17195,24 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", - "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -14727,13 +17354,24 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", - "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -14875,13 +17513,24 @@ in milliseconds. || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", - "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -14899,7 +17548,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_13": { + "postgresqlConfig_14": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -14964,7 +17613,6 @@ in milliseconds. || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -15004,7 +17652,6 @@ in milliseconds. || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -15036,6 +17683,13 @@ in milliseconds. || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -15122,7 +17776,6 @@ in milliseconds. || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -15162,7 +17815,6 @@ in milliseconds. || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -15194,6 +17846,13 @@ in milliseconds. || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -15280,7 +17939,6 @@ in milliseconds. || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -15320,7 +17978,6 @@ in milliseconds. || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -15352,6 +18009,13 @@ in milliseconds. || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -15375,7 +18039,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_13_1c": { + "postgresqlConfig_14_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -15440,7 +18104,6 @@ in milliseconds. || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -15481,7 +18144,6 @@ in milliseconds. || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -15513,6 +18175,13 @@ in milliseconds. || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -15599,7 +18268,6 @@ in milliseconds. || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -15640,7 +18308,6 @@ in milliseconds. || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -15672,6 +18339,13 @@ in milliseconds. || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -15758,7 +18432,6 @@ in milliseconds. || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -15799,7 +18472,6 @@ in milliseconds. || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -15831,6 +18503,13 @@ in milliseconds. || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -15854,7 +18533,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_14": { + "postgresqlConfig_15": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -16002,6 +18681,7 @@ in milliseconds. || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -16165,6 +18845,7 @@ in milliseconds. || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -16328,6 +19009,7 @@ in milliseconds. || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -16345,7 +19027,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_14_1c": { + "postgresqlConfig_15_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -16494,6 +19176,8 @@ in milliseconds. || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -16658,6 +19342,8 @@ in milliseconds. || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -16822,6 +19508,8 @@ in milliseconds. || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -16839,7 +19527,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_15": { + "postgresqlConfig_16": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -16873,7 +19561,7 @@ in milliseconds. || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -17037,7 +19725,7 @@ in milliseconds. || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -17201,7 +19889,7 @@ in milliseconds. || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -17333,7 +20021,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_15_1c": { + "postgresqlConfig_16_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -17367,7 +20055,7 @@ in milliseconds. || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -17533,7 +20221,7 @@ in milliseconds. || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -17699,7 +20387,7 @@ in milliseconds. || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -17833,7 +20521,7 @@ in milliseconds. || "passwordEncryption": "string" } }, - "postgresqlConfig_16": { + "postgresqlConfig_17": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -17853,7 +20541,6 @@ in milliseconds. || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -17996,7 +20683,12 @@ in milliseconds. || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, "userConfig": { "maxConnections": "string", @@ -18017,7 +20709,6 @@ in milliseconds. || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -18160,7 +20851,12 @@ in milliseconds. || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, "defaultConfig": { "maxConnections": "string", @@ -18181,7 +20877,6 @@ in milliseconds. || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -18324,10 +21019,15 @@ in milliseconds. || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" } }, - "postgresqlConfig_16_1c": { + "postgresqlConfig_17_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -18347,7 +21047,6 @@ in milliseconds. || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -18492,7 +21191,12 @@ in milliseconds. || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, "userConfig": { "maxConnections": "string", @@ -18513,7 +21217,6 @@ in milliseconds. || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -18658,7 +21361,12 @@ in milliseconds. || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, "defaultConfig": { "maxConnections": "string", @@ -18679,7 +21387,6 @@ in milliseconds. || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -18824,7 +21531,12 @@ in milliseconds. || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" } }, // end of the list of possible fields @@ -18891,370 +21603,993 @@ in milliseconds. || } ``` -An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). +An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). + +#| +||Field | Description || +|| id | **string** + +ID of the operation. || +|| description | **string** + +Description of the operation. 0-256 characters long. || +|| createdAt | **string** (date-time) + +Creation timestamp. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| createdBy | **string** + +ID of the user or service account who initiated the operation. || +|| modifiedAt | **string** (date-time) + +The time when the Operation resource was last modified. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| done | **boolean** + +If the value is `false`, it means the operation is still in progress. +If `true`, the operation is completed, and either `error` or `response` is available. || +|| metadata | **[RestoreClusterMetadata](#yandex.cloud.mdb.postgresql.v1.RestoreClusterMetadata)** + +Service-specific metadata associated with the operation. +It typically contains the ID of the target resource that the operation is performed on. +Any method that returns a long-running operation should document the metadata type, if any. || +|| error | **[Status](#google.rpc.Status)** + +The error result of the operation in case of failure or cancellation. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** + +The normal response of the operation in case of success. +If the original method returns no data on success, such as Delete, +the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). +If the original method is the standard Create/Update, +the response should be the target resource of the operation. +Any method that returns a long-running operation should document the response type, if any. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|# + +## RestoreClusterMetadata {#yandex.cloud.mdb.postgresql.v1.RestoreClusterMetadata} + +#| +||Field | Description || +|| clusterId | **string** + +ID of the new PostgreSQL cluster that is being created from a backup. || +|| backupId | **string** + +ID of the backup that is being used for creating a cluster. || +|# + +## Status {#google.rpc.Status} + +The error result of the operation in case of failure or cancellation. + +#| +||Field | Description || +|| code | **integer** (int32) + +Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || +|| message | **string** + +An error message. || +|| details[] | **object** + +A list of messages that carry the error details. || +|# + +## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} + +A PostgreSQL Cluster resource. For more information, see +the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. + +#| +||Field | Description || +|| id | **string** + +ID of the PostgreSQL cluster. +This ID is assigned by MDB at creation time. || +|| folderId | **string** + +ID of the folder that the PostgreSQL cluster belongs to. || +|| createdAt | **string** (date-time) + +Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| name | **string** + +Name of the PostgreSQL cluster. +The name is unique within the folder. 1-63 characters long. || +|| description | **string** + +Description of the PostgreSQL cluster. 0-256 characters long. || +|| labels | **string** + +Custom labels for the PostgreSQL cluster as `` key:value `` pairs. +Maximum 64 per resource. || +|| environment | **enum** (Environment) + +Deployment environment of the PostgreSQL cluster. + +- `ENVIRONMENT_UNSPECIFIED` +- `PRODUCTION`: Stable environment with a conservative update policy: +only hotfixes are applied during regular maintenance. +- `PRESTABLE`: Environment with more aggressive update policy: new versions +are rolled out irrespective of backward compatibility. || +|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** + +Description of monitoring systems relevant to the PostgreSQL cluster. || +|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** + +Configuration of the PostgreSQL cluster. || +|| networkId | **string** + +ID of the network that the cluster belongs to. || +|| health | **enum** (Health) + +Aggregated cluster health. + +- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). +- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). +- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). +- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || +|| status | **enum** (Status) + +Current state of the cluster. + +- `STATUS_UNKNOWN`: Cluster state is unknown. +- `CREATING`: Cluster is being created. +- `RUNNING`: Cluster is running normally. +- `ERROR`: Cluster encountered a problem and cannot operate. +- `UPDATING`: Cluster is being updated. +- `STOPPING`: Cluster is stopping. +- `STOPPED`: Cluster stopped. +- `STARTING`: Cluster is starting. || +|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** + +Maintenance window for the cluster. || +|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** + +Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || +|| securityGroupIds[] | **string** + +User security groups || +|| deletionProtection | **boolean** + +Deletion Protection inhibits deletion of the cluster || +|| hostGroupIds[] | **string** + +Host groups hosting VMs of the cluster. || +|# + +## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} + +Monitoring system. + +#| +||Field | Description || +|| name | **string** + +Name of the monitoring system. || +|| description | **string** + +Description of the monitoring system. || +|| link | **string** + +Link to the monitoring system charts for the PostgreSQL cluster. || +|# + +## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} + +#| +||Field | Description || +|| version | **string** + +Version of PostgreSQL server software. || +|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** + +Configuration of a PostgreSQL 9.6 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** + +Configuration of a PostgreSQL 10 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** + +Configuration of a PostgreSQL 10 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** + +Configuration of a PostgreSQL 11 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** + +Configuration of a PostgreSQL 11 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** + +Configuration of a PostgreSQL 12 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** + +Configuration of a PostgreSQL 12 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** + +Configuration of a PostgreSQL 13 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** + +Configuration of a PostgreSQL 13 1C server. -#| -||Field | Description || -|| id | **string** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -ID of the operation. || -|| description | **string** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** -Description of the operation. 0-256 characters long. || -|| createdAt | **string** (date-time) +Configuration of a PostgreSQL 14 server. -Creation timestamp. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| createdBy | **string** +Configuration of a PostgreSQL 14 1C server. -ID of the user or service account who initiated the operation. || -|| modifiedAt | **string** (date-time) +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The time when the Operation resource was last modified. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Configuration of a PostgreSQL 15 server. -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| done | **boolean** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -If the value is `false`, it means the operation is still in progress. -If `true`, the operation is completed, and either `error` or `response` is available. || -|| metadata | **[RestoreClusterMetadata](#yandex.cloud.mdb.postgresql.v1.RestoreClusterMetadata)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** -Service-specific metadata associated with the operation. -It typically contains the ID of the target resource that the operation is performed on. -Any method that returns a long-running operation should document the metadata type, if any. || -|| error | **[Status](#google.rpc.Status)** +Configuration of a PostgreSQL 15 1C server. -The error result of the operation in case of failure or cancellation. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Includes only one of the fields `error`, `response`. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || -|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** +Configuration of a PostgreSQL 16 server. -The normal response of the operation in case of success. -If the original method returns no data on success, such as Delete, -the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). -If the original method is the standard Create/Update, -the response should be the target resource of the operation. -Any method that returns a long-running operation should document the response type, if any. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Includes only one of the fields `error`, `response`. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || +Configuration of a PostgreSQL 16 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfigSet17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfigSet17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig2)** + +Configuration of the connection pooler. || +|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources2)** + +Resources allocated to PostgreSQL hosts. || +|| autofailover | **boolean** + +Configuration setting which enables/disables autofailover in cluster. || +|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay2)** + +Time to start the daily backup, in the UTC timezone. || +|| backupRetainPeriodDays | **string** (int64) + +Retention policy of automated backups. || +|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access2)** + +Access policy to DB || +|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics2)** + +Configuration of the performance diagnostics service. || +|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling2)** + +Disk size autoscaling || |# -## RestoreClusterMetadata {#yandex.cloud.mdb.postgresql.v1.RestoreClusterMetadata} +## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} #| ||Field | Description || -|| clusterId | **string** +|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** -ID of the new PostgreSQL cluster that is being created from a backup. || -|| backupId | **string** +Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** -ID of the backup that is being used for creating a cluster. || +User-defined settings for a PostgreSQL 9.6 cluster. || +|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** + +Default configuration for a PostgreSQL 9.6 cluster. || |# -## Status {#google.rpc.Status} +## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62} -The error result of the operation in case of failure or cancellation. +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). #| ||Field | Description || -|| code | **integer** (int32) +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || -|| message | **string** +in bytes. || +|| tempBuffers | **string** (int64) -An error message. || -|| details[] | **object** +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -A list of messages that carry the error details. || -|# +in bytes. || +|| maintenanceWorkMem | **string** (int64) -## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -A PostgreSQL Cluster resource. For more information, see -the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. +in bytes. || +|| tempFileLimit | **string** (int64) -#| -||Field | Description || -|| id | **string** +in bytes. || +|| vacuumCostDelay | **string** (int64) -ID of the PostgreSQL cluster. -This ID is assigned by MDB at creation time. || -|| folderId | **string** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -ID of the folder that the PostgreSQL cluster belongs to. || -|| createdAt | **string** (date-time) +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. +in bytes || +|| backendFlushAfter | **string** (int64) -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| name | **string** +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Name of the PostgreSQL cluster. -The name is unique within the folder. 1-63 characters long. || -|| description | **string** +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) + +Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Description of the PostgreSQL cluster. 0-256 characters long. || -|| labels | **string** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Custom labels for the PostgreSQL cluster as `` key:value `` pairs. -Maximum 64 per resource. || -|| environment | **enum** (Environment) +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Deployment environment of the PostgreSQL cluster. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -- `ENVIRONMENT_UNSPECIFIED` -- `PRODUCTION`: Stable environment with a conservative update policy: -only hotfixes are applied during regular maintenance. -- `PRESTABLE`: Environment with more aggressive update policy: new versions -are rolled out irrespective of backward compatibility. || -|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Description of monitoring systems relevant to the PostgreSQL cluster. || -|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Configuration of the PostgreSQL cluster. || -|| networkId | **string** +in milliseconds. || +|| lockTimeout | **string** (int64) -ID of the network that the cluster belongs to. || -|| health | **enum** (Health) +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Aggregated cluster health. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). -- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). -- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). -- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || -|| status | **enum** (Status) +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Current state of the cluster. +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -- `STATUS_UNKNOWN`: Cluster state is unknown. -- `CREATING`: Cluster is being created. -- `RUNNING`: Cluster is running normally. -- `ERROR`: Cluster encountered a problem and cannot operate. -- `UPDATING`: Cluster is being updated. -- `STOPPING`: Cluster is stopping. -- `STOPPED`: Cluster stopped. -- `STARTING`: Cluster is starting. || -|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Maintenance window for the cluster. || -|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** +in bytes. || +|| deadlockTimeout | **string** (int64) -Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || -|| securityGroupIds[] | **string** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -User security groups || -|| deletionProtection | **boolean** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| sqlInheritance | **boolean** -Deletion Protection inhibits deletion of the cluster || -|| hostGroupIds[] | **string** +This option has been removed in PostgreSQL 10. || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Host groups hosting VMs of the cluster. || -|# +in milliseconds. || +|| archiveTimeout | **string** (int64) -## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# -Monitoring system. +## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} #| ||Field | Description || -|| name | **string** +|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** -Name of the monitoring system. || -|| description | **string** +Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** -Description of the monitoring system. || -|| link | **string** +User-defined settings for a PostgreSQL 10 1C cluster. || +|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** -Link to the monitoring system charts for the PostgreSQL cluster. || +Default configuration for a PostgreSQL 10 1C cluster. || |# -## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} +## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || -|| version | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Version of PostgreSQL server software. || -|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** +in bytes. || +|| tempBuffers | **string** (int64) -Configuration of a PostgreSQL 9.6 server. +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -Configuration of a PostgreSQL 10 1C server. +in bytes. || +|| tempFileLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| vacuumCostDelay | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Configuration of a PostgreSQL 10 server. +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes || +|| backendFlushAfter | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -Configuration of a PostgreSQL 11 server. +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -Configuration of a PostgreSQL 11 1C server. +in bytes || +|| maxWalSize | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| minWalSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) -Configuration of a PostgreSQL 12 server. +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Configuration of a PostgreSQL 12 1C server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Configuration of a PostgreSQL 13 server. +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Configuration of a PostgreSQL 13 1C server. +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| lockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Configuration of a PostgreSQL 14 server. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -Configuration of a PostgreSQL 14 1C server. +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| deadlockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -Configuration of a PostgreSQL 15 server. +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| archiveTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -Configuration of a PostgreSQL 15 1C server. +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) -Configuration of a PostgreSQL 16 server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| onlineAnalyzeEnable | **boolean** || +|| plantunerFixEmptyTable | **boolean** || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| geqo | **boolean** -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -Configuration of a PostgreSQL 16 1C server. +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig2)** +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) -Configuration of the connection pooler. || -|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources2)** +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) -Resources allocated to PostgreSQL hosts. || -|| autofailover | **boolean** +selective pressure within the population || +|| geqoSeed | **number** (double) -Configuration setting which enables/disables autofailover in cluster. || -|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay2)** +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) -Time to start the daily backup, in the UTC timezone. || -|| backupRetainPeriodDays | **string** (int64) +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) -Retention policy of automated backups. || -|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access2)** +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -Access policy to DB || -|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics2)** +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -Configuration of the performance diagnostics service. || -|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling2)** +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. -Disk size autoscaling || +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} +## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** +|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** -Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** - -User-defined settings for a PostgreSQL 9.6 cluster. || -|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** +|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** -Default configuration for a PostgreSQL 9.6 cluster. || +User-defined settings for a PostgreSQL 10 cluster. || +|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** + +Default configuration for a PostgreSQL 10 cluster. || |# -## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62} +## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -19314,9 +22649,7 @@ in bytes || || checkpointTimeout | **string** (int64) in milliseconds. || -|| checkpointCompletionTarget | **number** (double) - -Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointCompletionTarget | **number** (double) || || checkpointFlushAfter | **string** (int64) in bytes || @@ -19469,9 +22802,6 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** - -This option has been removed in PostgreSQL 10. || || autovacuumMaxWorkers | **string** (int64) || || autovacuumVacuumCostDelay | **string** (int64) || || autovacuumVacuumCostLimit | **string** (int64) || @@ -19482,31 +22812,139 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) + +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} +## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** +|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** -Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** +|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** -User-defined settings for a PostgreSQL 10 1C cluster. || -|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** +User-defined settings for a PostgreSQL 11 cluster. || +|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** -Default configuration for a PostgreSQL 10 1C cluster. || +Default configuration for a PostgreSQL 11 cluster. || |# -## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2} +## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -19524,7 +22962,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -19747,6 +23184,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -19793,8 +23239,6 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || -|| onlineAnalyzeEnable | **boolean** || -|| plantunerFixEmptyTable | **boolean** || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -19824,6 +23268,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -19843,27 +23290,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} +## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** +|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** -Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** +|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** -User-defined settings for a PostgreSQL 10 cluster. || -|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** +User-defined settings for a PostgreSQL 11 1C cluster. || +|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** -Default configuration for a PostgreSQL 10 cluster. || +Default configuration for a PostgreSQL 11 1C cluster. || |# -## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102} +## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -19881,7 +23328,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -20086,6 +23532,7 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || || enableBitmapscan | **boolean** || || enableHashagg | **boolean** || || enableHashjoin | **boolean** || @@ -20104,6 +23551,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -20155,6 +23611,7 @@ in milliseconds. || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || || maxStackDepth | **string** (int64) in bytes. || @@ -20179,6 +23636,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -20198,23 +23658,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} +## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** +|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** -Effective settings for a PostgreSQL 11 cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** +|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** -User-defined settings for a PostgreSQL 11 cluster. || -|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** +User-defined settings for a PostgreSQL 12 cluster. || +|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** -Default configuration for a PostgreSQL 11 cluster. || +Default configuration for a PostgreSQL 12 cluster. || |# -## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112} +## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -20467,6 +23927,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -20564,23 +24031,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} +## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** +|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** -Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** +|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** -User-defined settings for a PostgreSQL 11 1C cluster. || -|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** +User-defined settings for a PostgreSQL 12 1C cluster. || +|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** -Default configuration for a PostgreSQL 11 1C cluster. || +Default configuration for a PostgreSQL 12 1C cluster. || |# -## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2} +## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -20834,6 +24301,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -20932,23 +24406,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} +## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** +|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** -Effective settings for a PostgreSQL 12 cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** +|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** -User-defined settings for a PostgreSQL 12 cluster. || -|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** +User-defined settings for a PostgreSQL 13 cluster. || +|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** -Default configuration for a PostgreSQL 12 cluster. || +Default configuration for a PostgreSQL 13 cluster. || |# -## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122} +## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -21254,6 +24728,30 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -21305,23 +24803,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} +## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** +|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** -Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** +|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** -User-defined settings for a PostgreSQL 12 1C cluster. || -|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** +User-defined settings for a PostgreSQL 13 1C cluster. || +|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** -Default configuration for a PostgreSQL 12 1C cluster. || +Default configuration for a PostgreSQL 13 1C cluster. || |# -## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2} +## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -21628,15 +25126,36 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || -|| maxStackDepth | **string** (int64) - -in bytes. || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -21680,23 +25199,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} +## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** +|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** -Effective settings for a PostgreSQL 13 cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** +|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** -User-defined settings for a PostgreSQL 13 cluster. || -|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** +User-defined settings for a PostgreSQL 14 cluster. || +|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** -Default configuration for a PostgreSQL 13 cluster. || +Default configuration for a PostgreSQL 14 cluster. || |# -## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132} +## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -21904,7 +25423,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -21948,7 +25466,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -22026,6 +25543,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -22077,23 +25609,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} +## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** +|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** -Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** +|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** -User-defined settings for a PostgreSQL 13 1C cluster. || -|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** +User-defined settings for a PostgreSQL 14 1C cluster. || +|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** -Default configuration for a PostgreSQL 13 1C cluster. || +Default configuration for a PostgreSQL 14 1C cluster. || |# -## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2} +## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -22301,7 +25833,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -22346,7 +25877,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -22424,6 +25954,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -22473,23 +26018,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} +## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** +|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** -Effective settings for a PostgreSQL 14 cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** +|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** -User-defined settings for a PostgreSQL 14 cluster. || -|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** +User-defined settings for a PostgreSQL 15 cluster. || +|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** -Default configuration for a PostgreSQL 14 cluster. || +Default configuration for a PostgreSQL 15 cluster. || |# -## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142} +## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -22759,7 +26304,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -22840,6 +26386,7 @@ in milliseconds. || || maxStackDepth | **string** (int64) in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -22883,23 +26430,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} +## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** +|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** -Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** +|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** -User-defined settings for a PostgreSQL 14 1C cluster. || -|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** +User-defined settings for a PostgreSQL 15 1C cluster. || +|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** -Default configuration for a PostgreSQL 14 1C cluster. || +Default configuration for a PostgreSQL 15 1C cluster. || |# -## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2} +## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -23170,7 +26717,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -23249,6 +26797,10 @@ in milliseconds. || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -23292,23 +26844,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} +## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** +|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** -Effective settings for a PostgreSQL 15 cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** +|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** -User-defined settings for a PostgreSQL 15 cluster. || -|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** +User-defined settings for a PostgreSQL 16 cluster. || +|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** -Default configuration for a PostgreSQL 15 cluster. || +Default configuration for a PostgreSQL 16 cluster. || |# -## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152} +## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -23394,12 +26946,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -23408,6 +26960,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -23422,6 +26975,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -23436,6 +26990,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -23607,6 +27162,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -23704,23 +27260,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} +## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** +|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** -Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** +|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** -User-defined settings for a PostgreSQL 15 1C cluster. || -|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** +User-defined settings for a PostgreSQL 16 1C cluster. || +|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** -Default configuration for a PostgreSQL 15 1C cluster. || +Default configuration for a PostgreSQL 16 1C cluster. || |# -## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2} +## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -23806,12 +27362,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -23820,6 +27376,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -23834,6 +27391,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -23848,6 +27406,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -24020,6 +27579,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -24118,27 +27678,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} +## PostgresqlConfigSet17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** +|| effectiveConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig172)** -Effective settings for a PostgreSQL 16 cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** +|| userConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig172)** -User-defined settings for a PostgreSQL 16 cluster. || -|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig172)** -Default configuration for a PostgreSQL 16 cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig172} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -24180,7 +27740,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -24532,29 +28091,42 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# -## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} +## PostgresqlConfigSet17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** +|| effectiveConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C2)** -Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** +|| userConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C2)** -User-defined settings for a PostgreSQL 16 1C cluster. || -|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C2)** -Default configuration for a PostgreSQL 16 1C cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2} +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -24596,7 +28168,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -24950,6 +28521,19 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# ## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig2} diff --git a/ru/managed-postgresql/api-ref/Cluster/start.md b/ru/managed-postgresql/api-ref/Cluster/start.md index 549474ba612..98587e71aa3 100644 --- a/ru/managed-postgresql/api-ref/Cluster/start.md +++ b/ru/managed-postgresql/api-ref/Cluster/start.md @@ -62,7 +62,7 @@ Required field. ID of the PostgreSQL cluster to start. || ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "effectiveConfig": { "maxConnections": "string", @@ -6810,6 +6810,1024 @@ Required field. ID of the PostgreSQL cluster to start. || "passwordEncryption": "string" } }, + "postgresqlConfig_17": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, + "postgresqlConfig_17_1c": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, // end of the list of possible fields "poolerConfig": { "poolingMode": "string", @@ -6874,367 +7892,990 @@ Required field. ID of the PostgreSQL cluster to start. || } ``` -An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). +An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). + +#| +||Field | Description || +|| id | **string** + +ID of the operation. || +|| description | **string** + +Description of the operation. 0-256 characters long. || +|| createdAt | **string** (date-time) + +Creation timestamp. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| createdBy | **string** + +ID of the user or service account who initiated the operation. || +|| modifiedAt | **string** (date-time) + +The time when the Operation resource was last modified. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| done | **boolean** + +If the value is `false`, it means the operation is still in progress. +If `true`, the operation is completed, and either `error` or `response` is available. || +|| metadata | **[StartClusterMetadata](#yandex.cloud.mdb.postgresql.v1.StartClusterMetadata)** + +Service-specific metadata associated with the operation. +It typically contains the ID of the target resource that the operation is performed on. +Any method that returns a long-running operation should document the metadata type, if any. || +|| error | **[Status](#google.rpc.Status)** + +The error result of the operation in case of failure or cancellation. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** + +The normal response of the operation in case of success. +If the original method returns no data on success, such as Delete, +the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). +If the original method is the standard Create/Update, +the response should be the target resource of the operation. +Any method that returns a long-running operation should document the response type, if any. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|# + +## StartClusterMetadata {#yandex.cloud.mdb.postgresql.v1.StartClusterMetadata} + +#| +||Field | Description || +|| clusterId | **string** + +ID of the PostgreSQL cluster. || +|# + +## Status {#google.rpc.Status} + +The error result of the operation in case of failure or cancellation. + +#| +||Field | Description || +|| code | **integer** (int32) + +Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || +|| message | **string** + +An error message. || +|| details[] | **object** + +A list of messages that carry the error details. || +|# + +## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} + +A PostgreSQL Cluster resource. For more information, see +the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. + +#| +||Field | Description || +|| id | **string** + +ID of the PostgreSQL cluster. +This ID is assigned by MDB at creation time. || +|| folderId | **string** + +ID of the folder that the PostgreSQL cluster belongs to. || +|| createdAt | **string** (date-time) + +Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| name | **string** + +Name of the PostgreSQL cluster. +The name is unique within the folder. 1-63 characters long. || +|| description | **string** + +Description of the PostgreSQL cluster. 0-256 characters long. || +|| labels | **string** + +Custom labels for the PostgreSQL cluster as `` key:value `` pairs. +Maximum 64 per resource. || +|| environment | **enum** (Environment) + +Deployment environment of the PostgreSQL cluster. + +- `ENVIRONMENT_UNSPECIFIED` +- `PRODUCTION`: Stable environment with a conservative update policy: +only hotfixes are applied during regular maintenance. +- `PRESTABLE`: Environment with more aggressive update policy: new versions +are rolled out irrespective of backward compatibility. || +|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** + +Description of monitoring systems relevant to the PostgreSQL cluster. || +|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** + +Configuration of the PostgreSQL cluster. || +|| networkId | **string** + +ID of the network that the cluster belongs to. || +|| health | **enum** (Health) + +Aggregated cluster health. + +- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). +- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). +- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). +- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || +|| status | **enum** (Status) + +Current state of the cluster. + +- `STATUS_UNKNOWN`: Cluster state is unknown. +- `CREATING`: Cluster is being created. +- `RUNNING`: Cluster is running normally. +- `ERROR`: Cluster encountered a problem and cannot operate. +- `UPDATING`: Cluster is being updated. +- `STOPPING`: Cluster is stopping. +- `STOPPED`: Cluster stopped. +- `STARTING`: Cluster is starting. || +|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** + +Maintenance window for the cluster. || +|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** + +Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || +|| securityGroupIds[] | **string** + +User security groups || +|| deletionProtection | **boolean** + +Deletion Protection inhibits deletion of the cluster || +|| hostGroupIds[] | **string** + +Host groups hosting VMs of the cluster. || +|# + +## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} + +Monitoring system. + +#| +||Field | Description || +|| name | **string** + +Name of the monitoring system. || +|| description | **string** + +Description of the monitoring system. || +|| link | **string** + +Link to the monitoring system charts for the PostgreSQL cluster. || +|# + +## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} + +#| +||Field | Description || +|| version | **string** + +Version of PostgreSQL server software. || +|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** + +Configuration of a PostgreSQL 9.6 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** + +Configuration of a PostgreSQL 10 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** + +Configuration of a PostgreSQL 10 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** + +Configuration of a PostgreSQL 11 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** + +Configuration of a PostgreSQL 11 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** + +Configuration of a PostgreSQL 12 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** + +Configuration of a PostgreSQL 12 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** + +Configuration of a PostgreSQL 13 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** -#| -||Field | Description || -|| id | **string** +Configuration of a PostgreSQL 13 1C server. -ID of the operation. || -|| description | **string** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Description of the operation. 0-256 characters long. || -|| createdAt | **string** (date-time) +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** -Creation timestamp. +Configuration of a PostgreSQL 14 server. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| createdBy | **string** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** -ID of the user or service account who initiated the operation. || -|| modifiedAt | **string** (date-time) +Configuration of a PostgreSQL 14 1C server. -The time when the Operation resource was last modified. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| done | **boolean** +Configuration of a PostgreSQL 15 server. -If the value is `false`, it means the operation is still in progress. -If `true`, the operation is completed, and either `error` or `response` is available. || -|| metadata | **[StartClusterMetadata](#yandex.cloud.mdb.postgresql.v1.StartClusterMetadata)** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Service-specific metadata associated with the operation. -It typically contains the ID of the target resource that the operation is performed on. -Any method that returns a long-running operation should document the metadata type, if any. || -|| error | **[Status](#google.rpc.Status)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** -The error result of the operation in case of failure or cancellation. +Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `error`, `response`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || -|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** -The normal response of the operation in case of success. -If the original method returns no data on success, such as Delete, -the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). -If the original method is the standard Create/Update, -the response should be the target resource of the operation. -Any method that returns a long-running operation should document the response type, if any. +Configuration of a PostgreSQL 16 server. -Includes only one of the fields `error`, `response`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** + +Configuration of a PostgreSQL 16 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfigSet17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfigSet17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** + +Configuration of the connection pooler. || +|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** + +Resources allocated to PostgreSQL hosts. || +|| autofailover | **boolean** + +Configuration setting which enables/disables autofailover in cluster. || +|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** + +Time to start the daily backup, in the UTC timezone. || +|| backupRetainPeriodDays | **string** (int64) + +Retention policy of automated backups. || +|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** + +Access policy to DB || +|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** + +Configuration of the performance diagnostics service. || +|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** + +Disk size autoscaling || |# -## StartClusterMetadata {#yandex.cloud.mdb.postgresql.v1.StartClusterMetadata} +## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} #| ||Field | Description || -|| clusterId | **string** +|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -ID of the PostgreSQL cluster. || +Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** + +User-defined settings for a PostgreSQL 9.6 cluster. || +|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** + +Default configuration for a PostgreSQL 9.6 cluster. || |# -## Status {#google.rpc.Status} +## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} -The error result of the operation in case of failure or cancellation. +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). #| ||Field | Description || -|| code | **integer** (int32) +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || -|| message | **string** +in bytes. || +|| tempBuffers | **string** (int64) -An error message. || -|| details[] | **object** +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -A list of messages that carry the error details. || -|# +in bytes. || +|| maintenanceWorkMem | **string** (int64) -## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -A PostgreSQL Cluster resource. For more information, see -the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. +in bytes. || +|| tempFileLimit | **string** (int64) -#| -||Field | Description || -|| id | **string** +in bytes. || +|| vacuumCostDelay | **string** (int64) -ID of the PostgreSQL cluster. -This ID is assigned by MDB at creation time. || -|| folderId | **string** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -ID of the folder that the PostgreSQL cluster belongs to. || -|| createdAt | **string** (date-time) +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. +in bytes || +|| backendFlushAfter | **string** (int64) -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| name | **string** +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Name of the PostgreSQL cluster. -The name is unique within the folder. 1-63 characters long. || -|| description | **string** +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) + +Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Description of the PostgreSQL cluster. 0-256 characters long. || -|| labels | **string** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Custom labels for the PostgreSQL cluster as `` key:value `` pairs. -Maximum 64 per resource. || -|| environment | **enum** (Environment) +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Deployment environment of the PostgreSQL cluster. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -- `ENVIRONMENT_UNSPECIFIED` -- `PRODUCTION`: Stable environment with a conservative update policy: -only hotfixes are applied during regular maintenance. -- `PRESTABLE`: Environment with more aggressive update policy: new versions -are rolled out irrespective of backward compatibility. || -|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Description of monitoring systems relevant to the PostgreSQL cluster. || -|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Configuration of the PostgreSQL cluster. || -|| networkId | **string** +in milliseconds. || +|| lockTimeout | **string** (int64) -ID of the network that the cluster belongs to. || -|| health | **enum** (Health) +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Aggregated cluster health. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). -- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). -- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). -- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || -|| status | **enum** (Status) +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Current state of the cluster. +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -- `STATUS_UNKNOWN`: Cluster state is unknown. -- `CREATING`: Cluster is being created. -- `RUNNING`: Cluster is running normally. -- `ERROR`: Cluster encountered a problem and cannot operate. -- `UPDATING`: Cluster is being updated. -- `STOPPING`: Cluster is stopping. -- `STOPPED`: Cluster stopped. -- `STARTING`: Cluster is starting. || -|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Maintenance window for the cluster. || -|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** +in bytes. || +|| deadlockTimeout | **string** (int64) -Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || -|| securityGroupIds[] | **string** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -User security groups || -|| deletionProtection | **boolean** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| sqlInheritance | **boolean** -Deletion Protection inhibits deletion of the cluster || -|| hostGroupIds[] | **string** +This option has been removed in PostgreSQL 10. || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Host groups hosting VMs of the cluster. || -|# +in milliseconds. || +|| archiveTimeout | **string** (int64) -## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# -Monitoring system. +## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} #| ||Field | Description || -|| name | **string** +|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Name of the monitoring system. || -|| description | **string** +Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Description of the monitoring system. || -|| link | **string** +User-defined settings for a PostgreSQL 10 1C cluster. || +|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Link to the monitoring system charts for the PostgreSQL cluster. || +Default configuration for a PostgreSQL 10 1C cluster. || |# -## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} +## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || -|| version | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Version of PostgreSQL server software. || -|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** +in bytes. || +|| tempBuffers | **string** (int64) -Configuration of a PostgreSQL 9.6 server. +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -Configuration of a PostgreSQL 10 1C server. +in bytes. || +|| tempFileLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| vacuumCostDelay | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Configuration of a PostgreSQL 10 server. +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes || +|| backendFlushAfter | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -Configuration of a PostgreSQL 11 server. +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -Configuration of a PostgreSQL 11 1C server. +in bytes || +|| maxWalSize | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| minWalSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) -Configuration of a PostgreSQL 12 server. +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Configuration of a PostgreSQL 12 1C server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Configuration of a PostgreSQL 13 server. +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Configuration of a PostgreSQL 13 1C server. +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| lockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Configuration of a PostgreSQL 14 server. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -Configuration of a PostgreSQL 14 1C server. +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| deadlockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -Configuration of a PostgreSQL 15 server. +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| archiveTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -Configuration of a PostgreSQL 15 1C server. +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) -Configuration of a PostgreSQL 16 server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| onlineAnalyzeEnable | **boolean** || +|| plantunerFixEmptyTable | **boolean** || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| geqo | **boolean** -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -Configuration of a PostgreSQL 16 1C server. +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) -Configuration of the connection pooler. || -|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) -Resources allocated to PostgreSQL hosts. || -|| autofailover | **boolean** +selective pressure within the population || +|| geqoSeed | **number** (double) -Configuration setting which enables/disables autofailover in cluster. || -|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) -Time to start the daily backup, in the UTC timezone. || -|| backupRetainPeriodDays | **string** (int64) +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) -Retention policy of automated backups. || -|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -Access policy to DB || -|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -Configuration of the performance diagnostics service. || -|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. -Disk size autoscaling || +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} +## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** - -User-defined settings for a PostgreSQL 9.6 cluster. || -|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Default configuration for a PostgreSQL 9.6 cluster. || +User-defined settings for a PostgreSQL 10 cluster. || +|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** + +Default configuration for a PostgreSQL 10 cluster. || |# -## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} +## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -7294,9 +8935,7 @@ in bytes || || checkpointTimeout | **string** (int64) in milliseconds. || -|| checkpointCompletionTarget | **number** (double) - -Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointCompletionTarget | **number** (double) || || checkpointFlushAfter | **string** (int64) in bytes || @@ -7449,9 +9088,6 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** - -This option has been removed in PostgreSQL 10. || || autovacuumMaxWorkers | **string** (int64) || || autovacuumVacuumCostDelay | **string** (int64) || || autovacuumVacuumCostLimit | **string** (int64) || @@ -7462,31 +9098,139 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) + +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} +## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -User-defined settings for a PostgreSQL 10 1C cluster. || -|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +User-defined settings for a PostgreSQL 11 cluster. || +|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Default configuration for a PostgreSQL 10 1C cluster. || +Default configuration for a PostgreSQL 11 cluster. || |# -## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} +## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7504,7 +9248,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -7727,6 +9470,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -7773,8 +9525,6 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || -|| onlineAnalyzeEnable | **boolean** || -|| plantunerFixEmptyTable | **boolean** || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -7804,6 +9554,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -7823,27 +9576,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} +## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -User-defined settings for a PostgreSQL 10 cluster. || -|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +User-defined settings for a PostgreSQL 11 1C cluster. || +|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Default configuration for a PostgreSQL 10 cluster. || +Default configuration for a PostgreSQL 11 1C cluster. || |# -## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} +## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7861,7 +9614,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -8066,6 +9818,7 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || || enableBitmapscan | **boolean** || || enableHashagg | **boolean** || || enableHashjoin | **boolean** || @@ -8084,6 +9837,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8135,6 +9897,7 @@ in milliseconds. || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || || maxStackDepth | **string** (int64) in bytes. || @@ -8159,6 +9922,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -8178,23 +9944,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} +## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Effective settings for a PostgreSQL 11 cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -User-defined settings for a PostgreSQL 11 cluster. || -|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +User-defined settings for a PostgreSQL 12 cluster. || +|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Default configuration for a PostgreSQL 11 cluster. || +Default configuration for a PostgreSQL 12 cluster. || |# -## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} +## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8447,6 +10213,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8544,23 +10317,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} +## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -User-defined settings for a PostgreSQL 11 1C cluster. || -|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +User-defined settings for a PostgreSQL 12 1C cluster. || +|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Default configuration for a PostgreSQL 11 1C cluster. || +Default configuration for a PostgreSQL 12 1C cluster. || |# -## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} +## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8814,6 +10587,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8912,23 +10692,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} +## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Effective settings for a PostgreSQL 12 cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -User-defined settings for a PostgreSQL 12 cluster. || -|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +User-defined settings for a PostgreSQL 13 cluster. || +|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Default configuration for a PostgreSQL 12 cluster. || +Default configuration for a PostgreSQL 13 cluster. || |# -## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} +## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9234,6 +11014,30 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -9285,23 +11089,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} +## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -User-defined settings for a PostgreSQL 12 1C cluster. || -|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +User-defined settings for a PostgreSQL 13 1C cluster. || +|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Default configuration for a PostgreSQL 12 1C cluster. || +Default configuration for a PostgreSQL 13 1C cluster. || |# -## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} +## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9608,15 +11412,36 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || -|| maxStackDepth | **string** (int64) - -in bytes. || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -9660,23 +11485,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} +## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Effective settings for a PostgreSQL 13 cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -User-defined settings for a PostgreSQL 13 cluster. || -|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +User-defined settings for a PostgreSQL 14 cluster. || +|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Default configuration for a PostgreSQL 13 cluster. || +Default configuration for a PostgreSQL 14 cluster. || |# -## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} +## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9884,7 +11709,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -9928,7 +11752,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10006,6 +11829,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10057,23 +11895,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} +## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -User-defined settings for a PostgreSQL 13 1C cluster. || -|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +User-defined settings for a PostgreSQL 14 1C cluster. || +|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Default configuration for a PostgreSQL 13 1C cluster. || +Default configuration for a PostgreSQL 14 1C cluster. || |# -## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} +## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10281,7 +12119,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -10326,7 +12163,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10404,6 +12240,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10453,23 +12304,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} +## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Effective settings for a PostgreSQL 14 cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -User-defined settings for a PostgreSQL 14 cluster. || -|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +User-defined settings for a PostgreSQL 15 cluster. || +|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Default configuration for a PostgreSQL 14 cluster. || +Default configuration for a PostgreSQL 15 cluster. || |# -## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} +## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10739,7 +12590,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -10820,6 +12672,7 @@ in milliseconds. || || maxStackDepth | **string** (int64) in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -10863,23 +12716,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} +## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -User-defined settings for a PostgreSQL 14 1C cluster. || -|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +User-defined settings for a PostgreSQL 15 1C cluster. || +|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Default configuration for a PostgreSQL 14 1C cluster. || +Default configuration for a PostgreSQL 15 1C cluster. || |# -## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} +## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11150,7 +13003,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -11229,6 +13083,10 @@ in milliseconds. || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -11272,23 +13130,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} +## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Effective settings for a PostgreSQL 15 cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -User-defined settings for a PostgreSQL 15 cluster. || -|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +User-defined settings for a PostgreSQL 16 cluster. || +|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Default configuration for a PostgreSQL 15 cluster. || +Default configuration for a PostgreSQL 16 cluster. || |# -## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} +## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11374,12 +13232,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11388,6 +13246,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11402,6 +13261,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11416,6 +13276,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11587,6 +13448,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11684,23 +13546,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} +## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -User-defined settings for a PostgreSQL 15 1C cluster. || -|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +User-defined settings for a PostgreSQL 16 1C cluster. || +|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Default configuration for a PostgreSQL 15 1C cluster. || +Default configuration for a PostgreSQL 16 1C cluster. || |# -## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} +## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11786,12 +13648,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11800,6 +13662,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11814,6 +13677,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11828,6 +13692,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12000,6 +13865,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12098,27 +13964,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} +## PostgresqlConfigSet17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| effectiveConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Effective settings for a PostgreSQL 16 cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| userConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -User-defined settings for a PostgreSQL 16 cluster. || -|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Default configuration for a PostgreSQL 16 cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12160,7 +14026,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12512,29 +14377,42 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# -## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} +## PostgresqlConfigSet17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| effectiveConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| userConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -User-defined settings for a PostgreSQL 16 1C cluster. || -|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Default configuration for a PostgreSQL 16 1C cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12576,7 +14454,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12930,6 +14807,19 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# ## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig} diff --git a/ru/managed-postgresql/api-ref/Cluster/startFailover.md b/ru/managed-postgresql/api-ref/Cluster/startFailover.md index 097aae5f991..8a4adf90155 100644 --- a/ru/managed-postgresql/api-ref/Cluster/startFailover.md +++ b/ru/managed-postgresql/api-ref/Cluster/startFailover.md @@ -77,7 +77,7 @@ New master host. Switch to the most up-to-date replica if not provided. || ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "effectiveConfig": { "maxConnections": "string", @@ -6825,6 +6825,1024 @@ New master host. Switch to the most up-to-date replica if not provided. || "passwordEncryption": "string" } }, + "postgresqlConfig_17": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, + "postgresqlConfig_17_1c": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, // end of the list of possible fields "poolerConfig": { "poolingMode": "string", @@ -6889,367 +7907,990 @@ New master host. Switch to the most up-to-date replica if not provided. || } ``` -An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). +An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). + +#| +||Field | Description || +|| id | **string** + +ID of the operation. || +|| description | **string** + +Description of the operation. 0-256 characters long. || +|| createdAt | **string** (date-time) + +Creation timestamp. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| createdBy | **string** + +ID of the user or service account who initiated the operation. || +|| modifiedAt | **string** (date-time) + +The time when the Operation resource was last modified. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| done | **boolean** + +If the value is `false`, it means the operation is still in progress. +If `true`, the operation is completed, and either `error` or `response` is available. || +|| metadata | **[StartClusterFailoverMetadata](#yandex.cloud.mdb.postgresql.v1.StartClusterFailoverMetadata)** + +Service-specific metadata associated with the operation. +It typically contains the ID of the target resource that the operation is performed on. +Any method that returns a long-running operation should document the metadata type, if any. || +|| error | **[Status](#google.rpc.Status)** + +The error result of the operation in case of failure or cancellation. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** + +The normal response of the operation in case of success. +If the original method returns no data on success, such as Delete, +the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). +If the original method is the standard Create/Update, +the response should be the target resource of the operation. +Any method that returns a long-running operation should document the response type, if any. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|# + +## StartClusterFailoverMetadata {#yandex.cloud.mdb.postgresql.v1.StartClusterFailoverMetadata} + +#| +||Field | Description || +|| clusterId | **string** + +ID of the PostgreSQL cluster being failovered. || +|# + +## Status {#google.rpc.Status} + +The error result of the operation in case of failure or cancellation. + +#| +||Field | Description || +|| code | **integer** (int32) + +Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || +|| message | **string** + +An error message. || +|| details[] | **object** + +A list of messages that carry the error details. || +|# + +## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} + +A PostgreSQL Cluster resource. For more information, see +the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. + +#| +||Field | Description || +|| id | **string** + +ID of the PostgreSQL cluster. +This ID is assigned by MDB at creation time. || +|| folderId | **string** + +ID of the folder that the PostgreSQL cluster belongs to. || +|| createdAt | **string** (date-time) + +Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| name | **string** + +Name of the PostgreSQL cluster. +The name is unique within the folder. 1-63 characters long. || +|| description | **string** + +Description of the PostgreSQL cluster. 0-256 characters long. || +|| labels | **string** + +Custom labels for the PostgreSQL cluster as `` key:value `` pairs. +Maximum 64 per resource. || +|| environment | **enum** (Environment) + +Deployment environment of the PostgreSQL cluster. + +- `ENVIRONMENT_UNSPECIFIED` +- `PRODUCTION`: Stable environment with a conservative update policy: +only hotfixes are applied during regular maintenance. +- `PRESTABLE`: Environment with more aggressive update policy: new versions +are rolled out irrespective of backward compatibility. || +|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** + +Description of monitoring systems relevant to the PostgreSQL cluster. || +|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** + +Configuration of the PostgreSQL cluster. || +|| networkId | **string** + +ID of the network that the cluster belongs to. || +|| health | **enum** (Health) + +Aggregated cluster health. + +- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). +- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). +- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). +- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || +|| status | **enum** (Status) + +Current state of the cluster. + +- `STATUS_UNKNOWN`: Cluster state is unknown. +- `CREATING`: Cluster is being created. +- `RUNNING`: Cluster is running normally. +- `ERROR`: Cluster encountered a problem and cannot operate. +- `UPDATING`: Cluster is being updated. +- `STOPPING`: Cluster is stopping. +- `STOPPED`: Cluster stopped. +- `STARTING`: Cluster is starting. || +|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** + +Maintenance window for the cluster. || +|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** + +Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || +|| securityGroupIds[] | **string** + +User security groups || +|| deletionProtection | **boolean** + +Deletion Protection inhibits deletion of the cluster || +|| hostGroupIds[] | **string** + +Host groups hosting VMs of the cluster. || +|# + +## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} + +Monitoring system. + +#| +||Field | Description || +|| name | **string** + +Name of the monitoring system. || +|| description | **string** + +Description of the monitoring system. || +|| link | **string** + +Link to the monitoring system charts for the PostgreSQL cluster. || +|# + +## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} + +#| +||Field | Description || +|| version | **string** + +Version of PostgreSQL server software. || +|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** + +Configuration of a PostgreSQL 9.6 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** + +Configuration of a PostgreSQL 10 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** + +Configuration of a PostgreSQL 10 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** + +Configuration of a PostgreSQL 11 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** + +Configuration of a PostgreSQL 11 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** + +Configuration of a PostgreSQL 12 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** + +Configuration of a PostgreSQL 12 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** + +Configuration of a PostgreSQL 13 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** -#| -||Field | Description || -|| id | **string** +Configuration of a PostgreSQL 13 1C server. -ID of the operation. || -|| description | **string** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Description of the operation. 0-256 characters long. || -|| createdAt | **string** (date-time) +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** -Creation timestamp. +Configuration of a PostgreSQL 14 server. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| createdBy | **string** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** -ID of the user or service account who initiated the operation. || -|| modifiedAt | **string** (date-time) +Configuration of a PostgreSQL 14 1C server. -The time when the Operation resource was last modified. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| done | **boolean** +Configuration of a PostgreSQL 15 server. -If the value is `false`, it means the operation is still in progress. -If `true`, the operation is completed, and either `error` or `response` is available. || -|| metadata | **[StartClusterFailoverMetadata](#yandex.cloud.mdb.postgresql.v1.StartClusterFailoverMetadata)** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Service-specific metadata associated with the operation. -It typically contains the ID of the target resource that the operation is performed on. -Any method that returns a long-running operation should document the metadata type, if any. || -|| error | **[Status](#google.rpc.Status)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** -The error result of the operation in case of failure or cancellation. +Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `error`, `response`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || -|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** -The normal response of the operation in case of success. -If the original method returns no data on success, such as Delete, -the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). -If the original method is the standard Create/Update, -the response should be the target resource of the operation. -Any method that returns a long-running operation should document the response type, if any. +Configuration of a PostgreSQL 16 server. -Includes only one of the fields `error`, `response`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** + +Configuration of a PostgreSQL 16 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfigSet17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfigSet17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** + +Configuration of the connection pooler. || +|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** + +Resources allocated to PostgreSQL hosts. || +|| autofailover | **boolean** + +Configuration setting which enables/disables autofailover in cluster. || +|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** + +Time to start the daily backup, in the UTC timezone. || +|| backupRetainPeriodDays | **string** (int64) + +Retention policy of automated backups. || +|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** + +Access policy to DB || +|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** + +Configuration of the performance diagnostics service. || +|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** + +Disk size autoscaling || |# -## StartClusterFailoverMetadata {#yandex.cloud.mdb.postgresql.v1.StartClusterFailoverMetadata} +## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} #| ||Field | Description || -|| clusterId | **string** +|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -ID of the PostgreSQL cluster being failovered. || +Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** + +User-defined settings for a PostgreSQL 9.6 cluster. || +|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** + +Default configuration for a PostgreSQL 9.6 cluster. || |# -## Status {#google.rpc.Status} +## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} -The error result of the operation in case of failure or cancellation. +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). #| ||Field | Description || -|| code | **integer** (int32) +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || -|| message | **string** +in bytes. || +|| tempBuffers | **string** (int64) -An error message. || -|| details[] | **object** +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -A list of messages that carry the error details. || -|# +in bytes. || +|| maintenanceWorkMem | **string** (int64) -## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -A PostgreSQL Cluster resource. For more information, see -the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. +in bytes. || +|| tempFileLimit | **string** (int64) -#| -||Field | Description || -|| id | **string** +in bytes. || +|| vacuumCostDelay | **string** (int64) -ID of the PostgreSQL cluster. -This ID is assigned by MDB at creation time. || -|| folderId | **string** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -ID of the folder that the PostgreSQL cluster belongs to. || -|| createdAt | **string** (date-time) +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. +in bytes || +|| backendFlushAfter | **string** (int64) -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| name | **string** +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Name of the PostgreSQL cluster. -The name is unique within the folder. 1-63 characters long. || -|| description | **string** +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) + +Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Description of the PostgreSQL cluster. 0-256 characters long. || -|| labels | **string** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Custom labels for the PostgreSQL cluster as `` key:value `` pairs. -Maximum 64 per resource. || -|| environment | **enum** (Environment) +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Deployment environment of the PostgreSQL cluster. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -- `ENVIRONMENT_UNSPECIFIED` -- `PRODUCTION`: Stable environment with a conservative update policy: -only hotfixes are applied during regular maintenance. -- `PRESTABLE`: Environment with more aggressive update policy: new versions -are rolled out irrespective of backward compatibility. || -|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Description of monitoring systems relevant to the PostgreSQL cluster. || -|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Configuration of the PostgreSQL cluster. || -|| networkId | **string** +in milliseconds. || +|| lockTimeout | **string** (int64) -ID of the network that the cluster belongs to. || -|| health | **enum** (Health) +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Aggregated cluster health. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). -- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). -- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). -- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || -|| status | **enum** (Status) +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Current state of the cluster. +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -- `STATUS_UNKNOWN`: Cluster state is unknown. -- `CREATING`: Cluster is being created. -- `RUNNING`: Cluster is running normally. -- `ERROR`: Cluster encountered a problem and cannot operate. -- `UPDATING`: Cluster is being updated. -- `STOPPING`: Cluster is stopping. -- `STOPPED`: Cluster stopped. -- `STARTING`: Cluster is starting. || -|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Maintenance window for the cluster. || -|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** +in bytes. || +|| deadlockTimeout | **string** (int64) -Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || -|| securityGroupIds[] | **string** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -User security groups || -|| deletionProtection | **boolean** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| sqlInheritance | **boolean** -Deletion Protection inhibits deletion of the cluster || -|| hostGroupIds[] | **string** +This option has been removed in PostgreSQL 10. || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Host groups hosting VMs of the cluster. || -|# +in milliseconds. || +|| archiveTimeout | **string** (int64) -## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# -Monitoring system. +## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} #| ||Field | Description || -|| name | **string** +|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Name of the monitoring system. || -|| description | **string** +Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Description of the monitoring system. || -|| link | **string** +User-defined settings for a PostgreSQL 10 1C cluster. || +|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Link to the monitoring system charts for the PostgreSQL cluster. || +Default configuration for a PostgreSQL 10 1C cluster. || |# -## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} +## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || -|| version | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Version of PostgreSQL server software. || -|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** +in bytes. || +|| tempBuffers | **string** (int64) -Configuration of a PostgreSQL 9.6 server. +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -Configuration of a PostgreSQL 10 1C server. +in bytes. || +|| tempFileLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| vacuumCostDelay | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Configuration of a PostgreSQL 10 server. +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes || +|| backendFlushAfter | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -Configuration of a PostgreSQL 11 server. +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -Configuration of a PostgreSQL 11 1C server. +in bytes || +|| maxWalSize | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| minWalSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) -Configuration of a PostgreSQL 12 server. +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Configuration of a PostgreSQL 12 1C server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Configuration of a PostgreSQL 13 server. +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Configuration of a PostgreSQL 13 1C server. +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| lockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Configuration of a PostgreSQL 14 server. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -Configuration of a PostgreSQL 14 1C server. +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| deadlockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -Configuration of a PostgreSQL 15 server. +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| archiveTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -Configuration of a PostgreSQL 15 1C server. +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) -Configuration of a PostgreSQL 16 server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| onlineAnalyzeEnable | **boolean** || +|| plantunerFixEmptyTable | **boolean** || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| geqo | **boolean** -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -Configuration of a PostgreSQL 16 1C server. +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) -Configuration of the connection pooler. || -|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) -Resources allocated to PostgreSQL hosts. || -|| autofailover | **boolean** +selective pressure within the population || +|| geqoSeed | **number** (double) -Configuration setting which enables/disables autofailover in cluster. || -|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) -Time to start the daily backup, in the UTC timezone. || -|| backupRetainPeriodDays | **string** (int64) +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) -Retention policy of automated backups. || -|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -Access policy to DB || -|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -Configuration of the performance diagnostics service. || -|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. -Disk size autoscaling || +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} +## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** - -User-defined settings for a PostgreSQL 9.6 cluster. || -|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Default configuration for a PostgreSQL 9.6 cluster. || +User-defined settings for a PostgreSQL 10 cluster. || +|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** + +Default configuration for a PostgreSQL 10 cluster. || |# -## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} +## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -7309,9 +8950,7 @@ in bytes || || checkpointTimeout | **string** (int64) in milliseconds. || -|| checkpointCompletionTarget | **number** (double) - -Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointCompletionTarget | **number** (double) || || checkpointFlushAfter | **string** (int64) in bytes || @@ -7464,9 +9103,6 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** - -This option has been removed in PostgreSQL 10. || || autovacuumMaxWorkers | **string** (int64) || || autovacuumVacuumCostDelay | **string** (int64) || || autovacuumVacuumCostLimit | **string** (int64) || @@ -7477,31 +9113,139 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) + +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} +## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -User-defined settings for a PostgreSQL 10 1C cluster. || -|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +User-defined settings for a PostgreSQL 11 cluster. || +|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Default configuration for a PostgreSQL 10 1C cluster. || +Default configuration for a PostgreSQL 11 cluster. || |# -## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} +## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7519,7 +9263,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -7742,6 +9485,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -7788,8 +9540,6 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || -|| onlineAnalyzeEnable | **boolean** || -|| plantunerFixEmptyTable | **boolean** || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -7819,6 +9569,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -7838,27 +9591,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} +## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -User-defined settings for a PostgreSQL 10 cluster. || -|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +User-defined settings for a PostgreSQL 11 1C cluster. || +|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Default configuration for a PostgreSQL 10 cluster. || +Default configuration for a PostgreSQL 11 1C cluster. || |# -## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} +## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7876,7 +9629,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -8081,6 +9833,7 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || || enableBitmapscan | **boolean** || || enableHashagg | **boolean** || || enableHashjoin | **boolean** || @@ -8099,6 +9852,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8150,6 +9912,7 @@ in milliseconds. || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || || maxStackDepth | **string** (int64) in bytes. || @@ -8174,6 +9937,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -8193,23 +9959,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} +## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Effective settings for a PostgreSQL 11 cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -User-defined settings for a PostgreSQL 11 cluster. || -|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +User-defined settings for a PostgreSQL 12 cluster. || +|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Default configuration for a PostgreSQL 11 cluster. || +Default configuration for a PostgreSQL 12 cluster. || |# -## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} +## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8462,6 +10228,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8559,23 +10332,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} +## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -User-defined settings for a PostgreSQL 11 1C cluster. || -|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +User-defined settings for a PostgreSQL 12 1C cluster. || +|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Default configuration for a PostgreSQL 11 1C cluster. || +Default configuration for a PostgreSQL 12 1C cluster. || |# -## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} +## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8829,6 +10602,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8927,23 +10707,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} +## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Effective settings for a PostgreSQL 12 cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -User-defined settings for a PostgreSQL 12 cluster. || -|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +User-defined settings for a PostgreSQL 13 cluster. || +|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Default configuration for a PostgreSQL 12 cluster. || +Default configuration for a PostgreSQL 13 cluster. || |# -## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} +## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9249,6 +11029,30 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -9300,23 +11104,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} +## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -User-defined settings for a PostgreSQL 12 1C cluster. || -|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +User-defined settings for a PostgreSQL 13 1C cluster. || +|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Default configuration for a PostgreSQL 12 1C cluster. || +Default configuration for a PostgreSQL 13 1C cluster. || |# -## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} +## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9623,15 +11427,36 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || -|| maxStackDepth | **string** (int64) - -in bytes. || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -9675,23 +11500,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} +## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Effective settings for a PostgreSQL 13 cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -User-defined settings for a PostgreSQL 13 cluster. || -|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +User-defined settings for a PostgreSQL 14 cluster. || +|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Default configuration for a PostgreSQL 13 cluster. || +Default configuration for a PostgreSQL 14 cluster. || |# -## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} +## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9899,7 +11724,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -9943,7 +11767,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10021,6 +11844,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10072,23 +11910,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} +## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -User-defined settings for a PostgreSQL 13 1C cluster. || -|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +User-defined settings for a PostgreSQL 14 1C cluster. || +|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Default configuration for a PostgreSQL 13 1C cluster. || +Default configuration for a PostgreSQL 14 1C cluster. || |# -## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} +## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10296,7 +12134,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -10341,7 +12178,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10419,6 +12255,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10468,23 +12319,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} +## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Effective settings for a PostgreSQL 14 cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -User-defined settings for a PostgreSQL 14 cluster. || -|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +User-defined settings for a PostgreSQL 15 cluster. || +|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Default configuration for a PostgreSQL 14 cluster. || +Default configuration for a PostgreSQL 15 cluster. || |# -## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} +## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10754,7 +12605,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -10835,6 +12687,7 @@ in milliseconds. || || maxStackDepth | **string** (int64) in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -10878,23 +12731,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} +## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -User-defined settings for a PostgreSQL 14 1C cluster. || -|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +User-defined settings for a PostgreSQL 15 1C cluster. || +|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Default configuration for a PostgreSQL 14 1C cluster. || +Default configuration for a PostgreSQL 15 1C cluster. || |# -## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} +## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11165,7 +13018,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -11244,6 +13098,10 @@ in milliseconds. || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -11287,23 +13145,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} +## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Effective settings for a PostgreSQL 15 cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -User-defined settings for a PostgreSQL 15 cluster. || -|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +User-defined settings for a PostgreSQL 16 cluster. || +|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Default configuration for a PostgreSQL 15 cluster. || +Default configuration for a PostgreSQL 16 cluster. || |# -## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} +## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11389,12 +13247,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11403,6 +13261,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11417,6 +13276,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11431,6 +13291,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11602,6 +13463,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11699,23 +13561,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} +## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -User-defined settings for a PostgreSQL 15 1C cluster. || -|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +User-defined settings for a PostgreSQL 16 1C cluster. || +|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Default configuration for a PostgreSQL 15 1C cluster. || +Default configuration for a PostgreSQL 16 1C cluster. || |# -## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} +## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11801,12 +13663,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11815,6 +13677,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11829,6 +13692,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11843,6 +13707,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12015,6 +13880,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12113,27 +13979,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} +## PostgresqlConfigSet17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| effectiveConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Effective settings for a PostgreSQL 16 cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| userConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -User-defined settings for a PostgreSQL 16 cluster. || -|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Default configuration for a PostgreSQL 16 cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12175,7 +14041,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12527,29 +14392,42 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# -## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} +## PostgresqlConfigSet17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| effectiveConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| userConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -User-defined settings for a PostgreSQL 16 1C cluster. || -|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Default configuration for a PostgreSQL 16 1C cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12591,7 +14469,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12945,6 +14822,19 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# ## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig} diff --git a/ru/managed-postgresql/api-ref/Cluster/stop.md b/ru/managed-postgresql/api-ref/Cluster/stop.md index 6c1ca7243ef..025ae7e0174 100644 --- a/ru/managed-postgresql/api-ref/Cluster/stop.md +++ b/ru/managed-postgresql/api-ref/Cluster/stop.md @@ -62,7 +62,7 @@ Required field. ID of the PostgreSQL cluster to stop. || ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "effectiveConfig": { "maxConnections": "string", @@ -6810,6 +6810,1024 @@ Required field. ID of the PostgreSQL cluster to stop. || "passwordEncryption": "string" } }, + "postgresqlConfig_17": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, + "postgresqlConfig_17_1c": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + } + }, // end of the list of possible fields "poolerConfig": { "poolingMode": "string", @@ -6874,367 +7892,990 @@ Required field. ID of the PostgreSQL cluster to stop. || } ``` -An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). +An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). + +#| +||Field | Description || +|| id | **string** + +ID of the operation. || +|| description | **string** + +Description of the operation. 0-256 characters long. || +|| createdAt | **string** (date-time) + +Creation timestamp. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| createdBy | **string** + +ID of the user or service account who initiated the operation. || +|| modifiedAt | **string** (date-time) + +The time when the Operation resource was last modified. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| done | **boolean** + +If the value is `false`, it means the operation is still in progress. +If `true`, the operation is completed, and either `error` or `response` is available. || +|| metadata | **[StopClusterMetadata](#yandex.cloud.mdb.postgresql.v1.StopClusterMetadata)** + +Service-specific metadata associated with the operation. +It typically contains the ID of the target resource that the operation is performed on. +Any method that returns a long-running operation should document the metadata type, if any. || +|| error | **[Status](#google.rpc.Status)** + +The error result of the operation in case of failure or cancellation. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** + +The normal response of the operation in case of success. +If the original method returns no data on success, such as Delete, +the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). +If the original method is the standard Create/Update, +the response should be the target resource of the operation. +Any method that returns a long-running operation should document the response type, if any. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|# + +## StopClusterMetadata {#yandex.cloud.mdb.postgresql.v1.StopClusterMetadata} + +#| +||Field | Description || +|| clusterId | **string** + +ID of the PostgreSQL cluster. || +|# + +## Status {#google.rpc.Status} + +The error result of the operation in case of failure or cancellation. + +#| +||Field | Description || +|| code | **integer** (int32) + +Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || +|| message | **string** + +An error message. || +|| details[] | **object** + +A list of messages that carry the error details. || +|# + +## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} + +A PostgreSQL Cluster resource. For more information, see +the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. + +#| +||Field | Description || +|| id | **string** + +ID of the PostgreSQL cluster. +This ID is assigned by MDB at creation time. || +|| folderId | **string** + +ID of the folder that the PostgreSQL cluster belongs to. || +|| createdAt | **string** (date-time) + +Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| name | **string** + +Name of the PostgreSQL cluster. +The name is unique within the folder. 1-63 characters long. || +|| description | **string** + +Description of the PostgreSQL cluster. 0-256 characters long. || +|| labels | **string** + +Custom labels for the PostgreSQL cluster as `` key:value `` pairs. +Maximum 64 per resource. || +|| environment | **enum** (Environment) + +Deployment environment of the PostgreSQL cluster. + +- `ENVIRONMENT_UNSPECIFIED` +- `PRODUCTION`: Stable environment with a conservative update policy: +only hotfixes are applied during regular maintenance. +- `PRESTABLE`: Environment with more aggressive update policy: new versions +are rolled out irrespective of backward compatibility. || +|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** + +Description of monitoring systems relevant to the PostgreSQL cluster. || +|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** + +Configuration of the PostgreSQL cluster. || +|| networkId | **string** + +ID of the network that the cluster belongs to. || +|| health | **enum** (Health) + +Aggregated cluster health. + +- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). +- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). +- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). +- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || +|| status | **enum** (Status) + +Current state of the cluster. + +- `STATUS_UNKNOWN`: Cluster state is unknown. +- `CREATING`: Cluster is being created. +- `RUNNING`: Cluster is running normally. +- `ERROR`: Cluster encountered a problem and cannot operate. +- `UPDATING`: Cluster is being updated. +- `STOPPING`: Cluster is stopping. +- `STOPPED`: Cluster stopped. +- `STARTING`: Cluster is starting. || +|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** + +Maintenance window for the cluster. || +|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** + +Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || +|| securityGroupIds[] | **string** + +User security groups || +|| deletionProtection | **boolean** + +Deletion Protection inhibits deletion of the cluster || +|| hostGroupIds[] | **string** + +Host groups hosting VMs of the cluster. || +|# + +## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} + +Monitoring system. + +#| +||Field | Description || +|| name | **string** + +Name of the monitoring system. || +|| description | **string** + +Description of the monitoring system. || +|| link | **string** + +Link to the monitoring system charts for the PostgreSQL cluster. || +|# + +## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} + +#| +||Field | Description || +|| version | **string** + +Version of PostgreSQL server software. || +|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** + +Configuration of a PostgreSQL 9.6 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** + +Configuration of a PostgreSQL 10 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** + +Configuration of a PostgreSQL 10 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** + +Configuration of a PostgreSQL 11 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** + +Configuration of a PostgreSQL 11 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** + +Configuration of a PostgreSQL 12 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** + +Configuration of a PostgreSQL 12 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** + +Configuration of a PostgreSQL 13 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** -#| -||Field | Description || -|| id | **string** +Configuration of a PostgreSQL 13 1C server. -ID of the operation. || -|| description | **string** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Description of the operation. 0-256 characters long. || -|| createdAt | **string** (date-time) +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** -Creation timestamp. +Configuration of a PostgreSQL 14 server. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| createdBy | **string** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** -ID of the user or service account who initiated the operation. || -|| modifiedAt | **string** (date-time) +Configuration of a PostgreSQL 14 1C server. -The time when the Operation resource was last modified. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| done | **boolean** +Configuration of a PostgreSQL 15 server. -If the value is `false`, it means the operation is still in progress. -If `true`, the operation is completed, and either `error` or `response` is available. || -|| metadata | **[StopClusterMetadata](#yandex.cloud.mdb.postgresql.v1.StopClusterMetadata)** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Service-specific metadata associated with the operation. -It typically contains the ID of the target resource that the operation is performed on. -Any method that returns a long-running operation should document the metadata type, if any. || -|| error | **[Status](#google.rpc.Status)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** -The error result of the operation in case of failure or cancellation. +Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `error`, `response`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || -|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** -The normal response of the operation in case of success. -If the original method returns no data on success, such as Delete, -the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). -If the original method is the standard Create/Update, -the response should be the target resource of the operation. -Any method that returns a long-running operation should document the response type, if any. +Configuration of a PostgreSQL 16 server. -Includes only one of the fields `error`, `response`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** + +Configuration of a PostgreSQL 16 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfigSet17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfigSet17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** + +Configuration of the connection pooler. || +|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** + +Resources allocated to PostgreSQL hosts. || +|| autofailover | **boolean** + +Configuration setting which enables/disables autofailover in cluster. || +|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** + +Time to start the daily backup, in the UTC timezone. || +|| backupRetainPeriodDays | **string** (int64) + +Retention policy of automated backups. || +|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** + +Access policy to DB || +|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** + +Configuration of the performance diagnostics service. || +|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** + +Disk size autoscaling || |# -## StopClusterMetadata {#yandex.cloud.mdb.postgresql.v1.StopClusterMetadata} +## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} #| ||Field | Description || -|| clusterId | **string** +|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** -ID of the PostgreSQL cluster. || +Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** + +User-defined settings for a PostgreSQL 9.6 cluster. || +|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** + +Default configuration for a PostgreSQL 9.6 cluster. || |# -## Status {#google.rpc.Status} +## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} -The error result of the operation in case of failure or cancellation. +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). #| ||Field | Description || -|| code | **integer** (int32) +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || -|| message | **string** +in bytes. || +|| tempBuffers | **string** (int64) -An error message. || -|| details[] | **object** +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -A list of messages that carry the error details. || -|# +in bytes. || +|| maintenanceWorkMem | **string** (int64) -## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -A PostgreSQL Cluster resource. For more information, see -the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. +in bytes. || +|| tempFileLimit | **string** (int64) -#| -||Field | Description || -|| id | **string** +in bytes. || +|| vacuumCostDelay | **string** (int64) -ID of the PostgreSQL cluster. -This ID is assigned by MDB at creation time. || -|| folderId | **string** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -ID of the folder that the PostgreSQL cluster belongs to. || -|| createdAt | **string** (date-time) +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. +in bytes || +|| backendFlushAfter | **string** (int64) -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| name | **string** +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Name of the PostgreSQL cluster. -The name is unique within the folder. 1-63 characters long. || -|| description | **string** +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) + +Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Description of the PostgreSQL cluster. 0-256 characters long. || -|| labels | **string** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Custom labels for the PostgreSQL cluster as `` key:value `` pairs. -Maximum 64 per resource. || -|| environment | **enum** (Environment) +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Deployment environment of the PostgreSQL cluster. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -- `ENVIRONMENT_UNSPECIFIED` -- `PRODUCTION`: Stable environment with a conservative update policy: -only hotfixes are applied during regular maintenance. -- `PRESTABLE`: Environment with more aggressive update policy: new versions -are rolled out irrespective of backward compatibility. || -|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Description of monitoring systems relevant to the PostgreSQL cluster. || -|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Configuration of the PostgreSQL cluster. || -|| networkId | **string** +in milliseconds. || +|| lockTimeout | **string** (int64) -ID of the network that the cluster belongs to. || -|| health | **enum** (Health) +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Aggregated cluster health. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). -- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). -- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). -- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || -|| status | **enum** (Status) +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Current state of the cluster. +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -- `STATUS_UNKNOWN`: Cluster state is unknown. -- `CREATING`: Cluster is being created. -- `RUNNING`: Cluster is running normally. -- `ERROR`: Cluster encountered a problem and cannot operate. -- `UPDATING`: Cluster is being updated. -- `STOPPING`: Cluster is stopping. -- `STOPPED`: Cluster stopped. -- `STARTING`: Cluster is starting. || -|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Maintenance window for the cluster. || -|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** +in bytes. || +|| deadlockTimeout | **string** (int64) -Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || -|| securityGroupIds[] | **string** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -User security groups || -|| deletionProtection | **boolean** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| sqlInheritance | **boolean** -Deletion Protection inhibits deletion of the cluster || -|| hostGroupIds[] | **string** +This option has been removed in PostgreSQL 10. || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Host groups hosting VMs of the cluster. || -|# +in milliseconds. || +|| archiveTimeout | **string** (int64) -## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# -Monitoring system. +## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} #| ||Field | Description || -|| name | **string** +|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Name of the monitoring system. || -|| description | **string** +Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Description of the monitoring system. || -|| link | **string** +User-defined settings for a PostgreSQL 10 1C cluster. || +|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** -Link to the monitoring system charts for the PostgreSQL cluster. || +Default configuration for a PostgreSQL 10 1C cluster. || |# -## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} +## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || -|| version | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Version of PostgreSQL server software. || -|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** +in bytes. || +|| tempBuffers | **string** (int64) -Configuration of a PostgreSQL 9.6 server. +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -Configuration of a PostgreSQL 10 1C server. +in bytes. || +|| tempFileLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| vacuumCostDelay | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Configuration of a PostgreSQL 10 server. +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes || +|| backendFlushAfter | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -Configuration of a PostgreSQL 11 server. +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -Configuration of a PostgreSQL 11 1C server. +in bytes || +|| maxWalSize | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| minWalSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) -Configuration of a PostgreSQL 12 server. +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Configuration of a PostgreSQL 12 1C server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Configuration of a PostgreSQL 13 server. +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Configuration of a PostgreSQL 13 1C server. +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| lockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Configuration of a PostgreSQL 14 server. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -Configuration of a PostgreSQL 14 1C server. +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| deadlockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -Configuration of a PostgreSQL 15 server. +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| archiveTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -Configuration of a PostgreSQL 15 1C server. +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) -Configuration of a PostgreSQL 16 server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| onlineAnalyzeEnable | **boolean** || +|| plantunerFixEmptyTable | **boolean** || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| geqo | **boolean** -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -Configuration of a PostgreSQL 16 1C server. +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) -Configuration of the connection pooler. || -|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources)** +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) -Resources allocated to PostgreSQL hosts. || -|| autofailover | **boolean** +selective pressure within the population || +|| geqoSeed | **number** (double) -Configuration setting which enables/disables autofailover in cluster. || -|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) -Time to start the daily backup, in the UTC timezone. || -|| backupRetainPeriodDays | **string** (int64) +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) -Retention policy of automated backups. || -|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access)** +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -Access policy to DB || -|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics)** +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -Configuration of the performance diagnostics service. || -|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling)** +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. -Disk size autoscaling || +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} +## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** - -User-defined settings for a PostgreSQL 9.6 cluster. || -|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** -Default configuration for a PostgreSQL 9.6 cluster. || +User-defined settings for a PostgreSQL 10 cluster. || +|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** + +Default configuration for a PostgreSQL 10 cluster. || |# -## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6} +## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -7294,9 +8935,7 @@ in bytes || || checkpointTimeout | **string** (int64) in milliseconds. || -|| checkpointCompletionTarget | **number** (double) - -Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointCompletionTarget | **number** (double) || || checkpointFlushAfter | **string** (int64) in bytes || @@ -7449,9 +9088,6 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** - -This option has been removed in PostgreSQL 10. || || autovacuumMaxWorkers | **string** (int64) || || autovacuumVacuumCostDelay | **string** (int64) || || autovacuumVacuumCostLimit | **string** (int64) || @@ -7462,31 +9098,139 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) + +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} +## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -User-defined settings for a PostgreSQL 10 1C cluster. || -|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +User-defined settings for a PostgreSQL 11 cluster. || +|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** -Default configuration for a PostgreSQL 10 1C cluster. || +Default configuration for a PostgreSQL 11 cluster. || |# -## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C} +## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7504,7 +9248,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -7727,6 +9470,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -7773,8 +9525,6 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || -|| onlineAnalyzeEnable | **boolean** || -|| plantunerFixEmptyTable | **boolean** || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -7804,6 +9554,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -7823,27 +9576,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} +## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -User-defined settings for a PostgreSQL 10 cluster. || -|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +User-defined settings for a PostgreSQL 11 1C cluster. || +|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** -Default configuration for a PostgreSQL 10 cluster. || +Default configuration for a PostgreSQL 11 1C cluster. || |# -## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10} +## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -7861,7 +9614,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -8066,6 +9818,7 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || || enableBitmapscan | **boolean** || || enableHashagg | **boolean** || || enableHashjoin | **boolean** || @@ -8084,6 +9837,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8135,6 +9897,7 @@ in milliseconds. || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || || maxStackDepth | **string** (int64) in bytes. || @@ -8159,6 +9922,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -8178,23 +9944,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} +## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Effective settings for a PostgreSQL 11 cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -User-defined settings for a PostgreSQL 11 cluster. || -|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +User-defined settings for a PostgreSQL 12 cluster. || +|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** -Default configuration for a PostgreSQL 11 cluster. || +Default configuration for a PostgreSQL 12 cluster. || |# -## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11} +## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8447,6 +10213,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8544,23 +10317,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} +## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -User-defined settings for a PostgreSQL 11 1C cluster. || -|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** +User-defined settings for a PostgreSQL 12 1C cluster. || +|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** -Default configuration for a PostgreSQL 11 1C cluster. || +Default configuration for a PostgreSQL 12 1C cluster. || |# -## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C} +## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -8814,6 +10587,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -8912,23 +10692,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} +## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Effective settings for a PostgreSQL 12 cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -User-defined settings for a PostgreSQL 12 cluster. || -|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** +User-defined settings for a PostgreSQL 13 cluster. || +|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** -Default configuration for a PostgreSQL 12 cluster. || +Default configuration for a PostgreSQL 13 cluster. || |# -## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12} +## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9234,6 +11014,30 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -9285,23 +11089,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} +## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -User-defined settings for a PostgreSQL 12 1C cluster. || -|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** +User-defined settings for a PostgreSQL 13 1C cluster. || +|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** -Default configuration for a PostgreSQL 12 1C cluster. || +Default configuration for a PostgreSQL 13 1C cluster. || |# -## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C} +## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9608,15 +11412,36 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || -|| maxStackDepth | **string** (int64) - -in bytes. || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -9660,23 +11485,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} +## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Effective settings for a PostgreSQL 13 cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -User-defined settings for a PostgreSQL 13 cluster. || -|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** +User-defined settings for a PostgreSQL 14 cluster. || +|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** -Default configuration for a PostgreSQL 13 cluster. || +Default configuration for a PostgreSQL 14 cluster. || |# -## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13} +## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -9884,7 +11709,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -9928,7 +11752,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10006,6 +11829,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10057,23 +11895,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} +## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -User-defined settings for a PostgreSQL 13 1C cluster. || -|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** +User-defined settings for a PostgreSQL 14 1C cluster. || +|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** -Default configuration for a PostgreSQL 13 1C cluster. || +Default configuration for a PostgreSQL 14 1C cluster. || |# -## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C} +## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10281,7 +12119,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -10326,7 +12163,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -10404,6 +12240,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -10453,23 +12304,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} +## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Effective settings for a PostgreSQL 14 cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -User-defined settings for a PostgreSQL 14 cluster. || -|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** +User-defined settings for a PostgreSQL 15 cluster. || +|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** -Default configuration for a PostgreSQL 14 cluster. || +Default configuration for a PostgreSQL 15 cluster. || |# -## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14} +## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -10739,7 +12590,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -10820,6 +12672,7 @@ in milliseconds. || || maxStackDepth | **string** (int64) in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -10863,23 +12716,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} +## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -User-defined settings for a PostgreSQL 14 1C cluster. || -|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** +User-defined settings for a PostgreSQL 15 1C cluster. || +|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** -Default configuration for a PostgreSQL 14 1C cluster. || +Default configuration for a PostgreSQL 15 1C cluster. || |# -## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C} +## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11150,7 +13003,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -11229,6 +13083,10 @@ in milliseconds. || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -11272,23 +13130,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} +## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Effective settings for a PostgreSQL 15 cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -User-defined settings for a PostgreSQL 15 cluster. || -|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** +User-defined settings for a PostgreSQL 16 cluster. || +|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** -Default configuration for a PostgreSQL 15 cluster. || +Default configuration for a PostgreSQL 16 cluster. || |# -## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15} +## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11374,12 +13232,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11388,6 +13246,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11402,6 +13261,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11416,6 +13276,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11587,6 +13448,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11684,23 +13546,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} +## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -User-defined settings for a PostgreSQL 15 1C cluster. || -|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** +User-defined settings for a PostgreSQL 16 1C cluster. || +|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** -Default configuration for a PostgreSQL 15 1C cluster. || +Default configuration for a PostgreSQL 16 1C cluster. || |# -## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C} +## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -11786,12 +13648,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -11800,6 +13662,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11814,6 +13677,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -11828,6 +13692,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12000,6 +13865,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -12098,27 +13964,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} +## PostgresqlConfigSet17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| effectiveConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Effective settings for a PostgreSQL 16 cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +|| userConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -User-defined settings for a PostgreSQL 16 cluster. || -|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** -Default configuration for a PostgreSQL 16 cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12160,7 +14026,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12512,29 +14377,42 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# -## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} +## PostgresqlConfigSet17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| effectiveConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +|| userConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -User-defined settings for a PostgreSQL 16 1C cluster. || -|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** -Default configuration for a PostgreSQL 16 1C cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C} +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -12576,7 +14454,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -12930,6 +14807,19 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# ## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig} diff --git a/ru/managed-postgresql/api-ref/Cluster/update.md b/ru/managed-postgresql/api-ref/Cluster/update.md index 29b16227889..3e562334730 100644 --- a/ru/managed-postgresql/api-ref/Cluster/update.md +++ b/ru/managed-postgresql/api-ref/Cluster/update.md @@ -32,7 +32,7 @@ To get the PostgreSQL cluster ID, use a [ClusterService.List](/docs/managed-post "labels": "string", "configSpec": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "maxConnections": "string", "sharedBuffers": "string", @@ -2272,213 +2272,565 @@ To get the PostgreSQL cluster ID, use a [ClusterService.List](/docs/managed-post "logAutovacuumMinDuration": "string", "passwordEncryption": "string" }, - // end of the list of possible fields - "poolerConfig": { - "poolingMode": "string", - "poolDiscard": "boolean" - }, - "resources": { - "resourcePresetId": "string", - "diskSize": "string", - "diskTypeId": "string" - }, - "autofailover": "boolean", - "backupWindowStart": { - "hours": "integer", - "minutes": "integer", - "seconds": "integer", - "nanos": "integer" - }, - "backupRetainPeriodDays": "string", - "access": { - "dataLens": "boolean", - "webSql": "boolean", - "serverless": "boolean", - "dataTransfer": "boolean", - "yandexQuery": "boolean" - }, - "performanceDiagnostics": { - "enabled": "boolean", - "sessionsSamplingInterval": "string", - "statementsSamplingInterval": "string" + "postgresqlConfig_17": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, - "diskSizeAutoscaling": { - "plannedUsageThreshold": "string", - "emergencyUsageThreshold": "string", - "diskSizeLimit": "string" - } - }, - "name": "string", - "maintenanceWindow": { - // Includes only one of the fields `anytime`, `weeklyMaintenanceWindow` - "anytime": "object", - "weeklyMaintenanceWindow": { - "day": "string", - "hour": "string" - } - // end of the list of possible fields - }, - "securityGroupIds": [ - "string" - ], - "deletionProtection": "boolean", - "networkId": "string" -} -``` - -#| -||Field | Description || -|| updateMask | **string** (field-mask) - -A comma-separated names off ALL fields to be updated. -Only the specified fields will be changed. The others will be left untouched. -If the field is specified in `` updateMask `` and no value for that field was sent in the request, -the field's value will be reset to the default. The default value for most fields is null or 0. - -If `` updateMask `` is not sent in the request, all fields' values will be updated. -Fields specified in the request will be updated to provided values. -The rest of the fields will be reset to the default. || -|| description | **string** - -New description of the PostgreSQL cluster. || -|| labels | **string** - -Custom labels for the PostgreSQL cluster as `` key:value `` pairs. Maximum 64 per resource. -For example, "project": "mvp" or "source": "dictionary". - -The new set of labels will completely replace the old ones. To add a label, request the current -set with the [ClusterService.Get](/docs/managed-postgresql/api-ref/Cluster/get#Get) method, then send an [ClusterService.Update](#Update) request with the new label added to the set. || -|| configSpec | **[ConfigSpec](#yandex.cloud.mdb.postgresql.v1.ConfigSpec)** - -New configuration and resources for hosts in the cluster. || -|| name | **string** - -New name for the cluster. || -|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** - -New maintenance window settings for the cluster. || -|| securityGroupIds[] | **string** - -User security groups || -|| deletionProtection | **boolean** - -Deletion Protection inhibits deletion of the cluster || -|| networkId | **string** - -ID of the network to move the cluster to. || -|# - -## ConfigSpec {#yandex.cloud.mdb.postgresql.v1.ConfigSpec} + "postgresqlConfig_17_1c": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "logTransactionSampleRate": "number", + "planCacheMode": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" + }, + // end of the list of possible fields + "poolerConfig": { + "poolingMode": "string", + "poolDiscard": "boolean" + }, + "resources": { + "resourcePresetId": "string", + "diskSize": "string", + "diskTypeId": "string" + }, + "autofailover": "boolean", + "backupWindowStart": { + "hours": "integer", + "minutes": "integer", + "seconds": "integer", + "nanos": "integer" + }, + "backupRetainPeriodDays": "string", + "access": { + "dataLens": "boolean", + "webSql": "boolean", + "serverless": "boolean", + "dataTransfer": "boolean", + "yandexQuery": "boolean" + }, + "performanceDiagnostics": { + "enabled": "boolean", + "sessionsSamplingInterval": "string", + "statementsSamplingInterval": "string" + }, + "diskSizeAutoscaling": { + "plannedUsageThreshold": "string", + "emergencyUsageThreshold": "string", + "diskSizeLimit": "string" + } + }, + "name": "string", + "maintenanceWindow": { + // Includes only one of the fields `anytime`, `weeklyMaintenanceWindow` + "anytime": "object", + "weeklyMaintenanceWindow": { + "day": "string", + "hour": "string" + } + // end of the list of possible fields + }, + "securityGroupIds": [ + "string" + ], + "deletionProtection": "boolean", + "networkId": "string" +} +``` #| ||Field | Description || -|| version | **string** - -Version of PostgreSQL used in the cluster. -Possible values: `9.6`, `10`, `10_1c`, `11`, `12`, `13`, `14`, `15` || -|| postgresqlConfig_9_6 | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** +|| updateMask | **string** (field-mask) -Configuration for a PostgreSQL 9.6 cluster. +A comma-separated names off ALL fields to be updated. +Only the specified fields will be changed. The others will be left untouched. +If the field is specified in `` updateMask `` and no value for that field was sent in the request, +the field's value will be reset to the default. The default value for most fields is null or 0. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +If `` updateMask `` is not sent in the request, all fields' values will be updated. +Fields specified in the request will be updated to provided values. +The rest of the fields will be reset to the default. || +|| description | **string** -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_10_1c | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** +New description of the PostgreSQL cluster. || +|| labels | **string** -Configuration for a PostgreSQL 10 1C cluster. +Custom labels for the PostgreSQL cluster as `` key:value `` pairs. Maximum 64 per resource. +For example, "project": "mvp" or "source": "dictionary". -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +The new set of labels will completely replace the old ones. To add a label, request the current +set with the [ClusterService.Get](/docs/managed-postgresql/api-ref/Cluster/get#Get) method, then send an [ClusterService.Update](#Update) request with the new label added to the set. || +|| configSpec | **[ConfigSpec](#yandex.cloud.mdb.postgresql.v1.ConfigSpec)** -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_10 | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** +New configuration and resources for hosts in the cluster. || +|| name | **string** -Configuration for a PostgreSQL 10 cluster. +New name for the cluster. || +|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow)** -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +New maintenance window settings for the cluster. || +|| securityGroupIds[] | **string** -Configuration of a PostgreSQL cluster. || -|| postgresqlConfig_11 | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** +User security groups || +|| deletionProtection | **boolean** -Configuration for a PostgreSQL 11 cluster. +Deletion Protection inhibits deletion of the cluster || +|| networkId | **string** -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +ID of the network to move the cluster to. || +|# + +## ConfigSpec {#yandex.cloud.mdb.postgresql.v1.ConfigSpec} + +#| +||Field | Description || +|| version | **string** + +Version of PostgreSQL used in the cluster. +Possible values: `9.6`, `10`, `10_1c`, `11`, `12`, `13`, `14`, `15`, `16`, `17` || +|| postgresqlConfig_9_6 | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6)** + +Configuration for a PostgreSQL 9.6 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_10_1c | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C)** + +Configuration for a PostgreSQL 10 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_10 | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10)** + +Configuration for a PostgreSQL 10 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_11 | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11)** + +Configuration for a PostgreSQL 11 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_11_1c | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C)** Configuration for a PostgreSQL 11 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_12 | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12)** Configuration for a PostgreSQL 12 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_12_1c | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C)** Configuration for a PostgreSQL 12 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_13 | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13)** Configuration for a PostgreSQL 13 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_13_1c | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C)** Configuration for a PostgreSQL 13 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_14 | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14)** Configuration for a PostgreSQL 14 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_14_1c | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C)** Configuration for a PostgreSQL 14 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_15 | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15)** Configuration for a PostgreSQL 15 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_15_1c | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C)** Configuration for a PostgreSQL 15 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_16 | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16)** Configuration for a PostgreSQL 16 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_16_1c | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C)** Configuration for a PostgreSQL 16 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17)** + +Configuration for a PostgreSQL 17 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C)** + +Configuration for a PostgreSQL 17 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** @@ -7985,208 +8337,1692 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || -|| poolingMode | **enum** (PoolingMode) - -Mode that the connection pooler is working in. -See descriptions of all modes in the [documentation for PgBouncer](https://pgbouncer.github.io/usage). +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -- `POOLING_MODE_UNSPECIFIED` -- `SESSION`: Session pooling mode. -- `TRANSACTION`: Transaction pooling mode. -- `STATEMENT`: Statement pooling mode. || -|| poolDiscard | **boolean** +in bytes. || +|| tempBuffers | **string** (int64) -Setting `server_reset_query_always` parameter in PgBouncer. || -|# +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -## Resources {#yandex.cloud.mdb.postgresql.v1.Resources} +in bytes. || +|| maintenanceWorkMem | **string** (int64) -#| -||Field | Description || -|| resourcePresetId | **string** +in bytes. || +|| autovacuumWorkMem | **string** (int64) -ID of the preset for computational resources available to a host (CPU, memory etc.). -All available presets are listed in the [documentation](/docs/managed-postgresql/concepts/instance-types). || -|| diskSize | **string** (int64) +in bytes. || +|| tempFileLimit | **string** (int64) -Volume of the storage available to a host, in bytes. || -|| diskTypeId | **string** +in bytes. || +|| vacuumCostDelay | **string** (int64) -Type of the storage environment for the host. -Possible values: -* network-hdd - network HDD drive, -* network-ssd - network SSD drive, -* local-ssd - local SSD storage. || -|# +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -## TimeOfDay {#google.type.TimeOfDay} +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Represents a time of day. The date and time zone are either not significant -or are specified elsewhere. An API may choose to allow leap seconds. Related -types are [google.type.Date](https://github.com/googleapis/googleapis/blob/master/google/type/date.proto) and [google.protobuf.Timestamp](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/timestamp.proto). +in bytes || +|| backendFlushAfter | **string** (int64) -#| -||Field | Description || -|| hours | **integer** (int32) +in bytes || +|| walLevel | **enum** (WalLevel) -Hours of day in 24 hour format. Should be from 0 to 23. An API may choose -to allow the value "24:00:00" for scenarios like business closing time. || -|| minutes | **integer** (int32) +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Minutes of hour of day. Must be from 0 to 59. || -|| seconds | **integer** (int32) +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) -Seconds of minutes of the time. Must normally be from 0 to 59. An API may -allow the value 60 if it allows leap-seconds. || -|| nanos | **integer** (int32) +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. || -|# +in bytes || +|| maxWalSize | **string** (int64) -## Access {#yandex.cloud.mdb.postgresql.v1.Access} +in bytes. || +|| minWalSize | **string** (int64) -#| -||Field | Description || -|| dataLens | **boolean** +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) -Allow access for DataLens || -|| webSql | **boolean** +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) -Allow SQL queries to the cluster databases from the management console. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| debugParallelQuery | **enum** (DebugParallelQuery) -See [SQL queries in the management console](/docs/managed-postgresql/operations/web-sql-query) for more details. || -|| serverless | **boolean** +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Allow access for Serverless || -|| dataTransfer | **boolean** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Allow access for DataTransfer. || -|| yandexQuery | **boolean** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Allow access for YandexQuery. || -|# +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -## PerformanceDiagnostics {#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics} +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -#| -||Field | Description || -|| enabled | **boolean** +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Configuration setting which enables/disables performance diagnostics service in cluster. || -|| sessionsSamplingInterval | **string** (int64) +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Interval (in seconds) for pg_stat_activity sampling || -|| statementsSamplingInterval | **string** (int64) +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Interval (in seconds) for pg_stat_statements sampling || -|# +in milliseconds. || +|| lockTimeout | **string** (int64) -## DiskSizeAutoscaling {#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling} +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -#| -||Field | Description || -|| plannedUsageThreshold | **string** (int64) +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Threshold of storage usage (in percent) that triggers automatic scaling of the storage during the maintenance window. Zero value means disabled threshold. || -|| emergencyUsageThreshold | **string** (int64) +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Threshold of storage usage (in percent) that triggers immediate automatic scaling of the storage. Zero value means disabled threshold. || -|| diskSizeLimit | **string** (int64) +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -New storage size (in bytes) that is set when one of the thresholds is achieved. || -|# +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -## MaintenanceWindow {#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow} +in bytes. || +|| deadlockTimeout | **string** (int64) -A maintenance window settings. +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -#| -||Field | Description || -|| anytime | **object** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Maintenance operation can be scheduled anytime. +in milliseconds. || +|| archiveTimeout | **string** (int64) -Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`. +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) -The maintenance policy in effect. || -|| weeklyMaintenanceWindow | **[WeeklyMaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.WeeklyMaintenanceWindow)** +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -Maintenance operation can be scheduled on a weekly basis. +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || +|| autoExplainLogMinDuration | **string** (int64) -Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`. +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -The maintenance policy in effect. || +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || +|| maxStandbyArchiveDelay | **string** (int64) + +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# -## WeeklyMaintenanceWindow {#yandex.cloud.mdb.postgresql.v1.WeeklyMaintenanceWindow} +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C} -Weelky maintenance window settings. +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || -|| day | **enum** (WeekDay) +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Day of the week (in `DDD` format). +in bytes. || +|| tempBuffers | **string** (int64) -- `WEEK_DAY_UNSPECIFIED` -- `MON` -- `TUE` -- `WED` -- `THU` -- `FRI` -- `SAT` -- `SUN` || -|| hour | **string** (int64) +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Hour of the day in UTC (in `HH` format). || -|# +in bytes. || +|| maintenanceWorkMem | **string** (int64) -## Response {#yandex.cloud.operation.Operation} +in bytes. || +|| autovacuumWorkMem | **string** (int64) -**HTTP Code: 200 - OK** +in bytes. || +|| tempFileLimit | **string** (int64) -```json -{ - "id": "string", - "description": "string", - "createdAt": "string", - "createdBy": "string", - "modifiedAt": "string", - "done": "boolean", - "metadata": { - "clusterId": "string" - }, - // Includes only one of the fields `error`, `response` - "error": { - "code": "integer", - "message": "string", - "details": [ - "object" - ] - }, - "response": { - "id": "string", - "folderId": "string", - "createdAt": "string", - "name": "string", - "description": "string", - "labels": "string", - "environment": "string", - "monitoring": [ - { - "name": "string", - "description": "string", - "link": "string" - } - ], - "config": { - "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` - "postgresqlConfig_9_6": { +in bytes. || +|| vacuumCostDelay | **string** (int64) + +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) + +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) + +in bytes || +|| backendFlushAfter | **string** (int64) + +in bytes || +|| walLevel | **enum** (WalLevel) + +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) + +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| debugParallelQuery | **enum** (DebugParallelQuery) + +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) + +in milliseconds. || +|| archiveTimeout | **string** (int64) + +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || +|| maxStandbyArchiveDelay | **string** (int64) + +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || +|# + +## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig} + +#| +||Field | Description || +|| poolingMode | **enum** (PoolingMode) + +Mode that the connection pooler is working in. +See descriptions of all modes in the [documentation for PgBouncer](https://pgbouncer.github.io/usage). + +- `POOLING_MODE_UNSPECIFIED` +- `SESSION`: Session pooling mode. +- `TRANSACTION`: Transaction pooling mode. +- `STATEMENT`: Statement pooling mode. || +|| poolDiscard | **boolean** + +Setting `server_reset_query_always` parameter in PgBouncer. || +|# + +## Resources {#yandex.cloud.mdb.postgresql.v1.Resources} + +#| +||Field | Description || +|| resourcePresetId | **string** + +ID of the preset for computational resources available to a host (CPU, memory etc.). +All available presets are listed in the [documentation](/docs/managed-postgresql/concepts/instance-types). || +|| diskSize | **string** (int64) + +Volume of the storage available to a host, in bytes. || +|| diskTypeId | **string** + +Type of the storage environment for the host. +Possible values: +* network-hdd - network HDD drive, +* network-ssd - network SSD drive, +* local-ssd - local SSD storage. || +|# + +## TimeOfDay {#google.type.TimeOfDay} + +Represents a time of day. The date and time zone are either not significant +or are specified elsewhere. An API may choose to allow leap seconds. Related +types are [google.type.Date](https://github.com/googleapis/googleapis/blob/master/google/type/date.proto) and [google.protobuf.Timestamp](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/timestamp.proto). + +#| +||Field | Description || +|| hours | **integer** (int32) + +Hours of day in 24 hour format. Should be from 0 to 23. An API may choose +to allow the value "24:00:00" for scenarios like business closing time. || +|| minutes | **integer** (int32) + +Minutes of hour of day. Must be from 0 to 59. || +|| seconds | **integer** (int32) + +Seconds of minutes of the time. Must normally be from 0 to 59. An API may +allow the value 60 if it allows leap-seconds. || +|| nanos | **integer** (int32) + +Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. || +|# + +## Access {#yandex.cloud.mdb.postgresql.v1.Access} + +#| +||Field | Description || +|| dataLens | **boolean** + +Allow access for DataLens || +|| webSql | **boolean** + +Allow SQL queries to the cluster databases from the management console. + +See [SQL queries in the management console](/docs/managed-postgresql/operations/web-sql-query) for more details. || +|| serverless | **boolean** + +Allow access for Serverless || +|| dataTransfer | **boolean** + +Allow access for DataTransfer. || +|| yandexQuery | **boolean** + +Allow access for YandexQuery. || +|# + +## PerformanceDiagnostics {#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics} + +#| +||Field | Description || +|| enabled | **boolean** + +Configuration setting which enables/disables performance diagnostics service in cluster. || +|| sessionsSamplingInterval | **string** (int64) + +Interval (in seconds) for pg_stat_activity sampling || +|| statementsSamplingInterval | **string** (int64) + +Interval (in seconds) for pg_stat_statements sampling || +|# + +## DiskSizeAutoscaling {#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling} + +#| +||Field | Description || +|| plannedUsageThreshold | **string** (int64) + +Threshold of storage usage (in percent) that triggers automatic scaling of the storage during the maintenance window. Zero value means disabled threshold. || +|| emergencyUsageThreshold | **string** (int64) + +Threshold of storage usage (in percent) that triggers immediate automatic scaling of the storage. Zero value means disabled threshold. || +|| diskSizeLimit | **string** (int64) + +New storage size (in bytes) that is set when one of the thresholds is achieved. || +|# + +## MaintenanceWindow {#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow} + +A maintenance window settings. + +#| +||Field | Description || +|| anytime | **object** + +Maintenance operation can be scheduled anytime. + +Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`. + +The maintenance policy in effect. || +|| weeklyMaintenanceWindow | **[WeeklyMaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.WeeklyMaintenanceWindow)** + +Maintenance operation can be scheduled on a weekly basis. + +Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`. + +The maintenance policy in effect. || +|# + +## WeeklyMaintenanceWindow {#yandex.cloud.mdb.postgresql.v1.WeeklyMaintenanceWindow} + +Weelky maintenance window settings. + +#| +||Field | Description || +|| day | **enum** (WeekDay) + +Day of the week (in `DDD` format). + +- `WEEK_DAY_UNSPECIFIED` +- `MON` +- `TUE` +- `WED` +- `THU` +- `FRI` +- `SAT` +- `SUN` || +|| hour | **string** (int64) + +Hour of the day in UTC (in `HH` format). || +|# + +## Response {#yandex.cloud.operation.Operation} + +**HTTP Code: 200 - OK** + +```json +{ + "id": "string", + "description": "string", + "createdAt": "string", + "createdBy": "string", + "modifiedAt": "string", + "done": "boolean", + "metadata": { + "clusterId": "string" + }, + // Includes only one of the fields `error`, `response` + "error": { + "code": "integer", + "message": "string", + "details": [ + "object" + ] + }, + "response": { + "id": "string", + "folderId": "string", + "createdAt": "string", + "name": "string", + "description": "string", + "labels": "string", + "environment": "string", + "monitoring": [ + { + "name": "string", + "description": "string", + "link": "string" + } + ], + "config": { + "version": "string", + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` + "postgresqlConfig_9_6": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "sqlInheritance": "boolean", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "sqlInheritance": "boolean", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "sqlInheritance": "boolean", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + } + }, + "postgresqlConfig_10_1c": { + "effectiveConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "onlineAnalyzeEnable": "boolean", + "plantunerFixEmptyTable": "boolean", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" + }, + "userConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "onlineAnalyzeEnable": "boolean", + "plantunerFixEmptyTable": "boolean", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" + }, + "defaultConfig": { + "maxConnections": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "maxPreparedTransactions": "string", + "workMem": "string", + "maintenanceWorkMem": "string", + "replacementSortTuples": "string", + "autovacuumWorkMem": "string", + "tempFileLimit": "string", + "vacuumCostDelay": "string", + "vacuumCostPageHit": "string", + "vacuumCostPageMiss": "string", + "vacuumCostPageDirty": "string", + "vacuumCostLimit": "string", + "bgwriterDelay": "string", + "bgwriterLruMaxpages": "string", + "bgwriterLruMultiplier": "number", + "bgwriterFlushAfter": "string", + "backendFlushAfter": "string", + "oldSnapshotThreshold": "string", + "walLevel": "string", + "synchronousCommit": "string", + "checkpointTimeout": "string", + "checkpointCompletionTarget": "number", + "checkpointFlushAfter": "string", + "maxWalSize": "string", + "minWalSize": "string", + "maxStandbyStreamingDelay": "string", + "defaultStatisticsTarget": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "forceParallelMode": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "operatorPrecedenceWarning": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "autovacuumMaxWorkers": "string", + "autovacuumVacuumCostDelay": "string", + "autovacuumVacuumCostLimit": "string", + "autovacuumNaptime": "string", + "archiveTimeout": "string", + "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "onlineAnalyzeEnable": "boolean", + "plantunerFixEmptyTable": "boolean", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" + } + }, + "postgresqlConfig_10": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -8260,15 +10096,65 @@ Hour of the day in UTC (in `HH` format). || "exitOnError": "boolean", "seqPageCost": "number", "randomPageCost": "number", - "sqlInheritance": "boolean", "autovacuumMaxWorkers": "string", "autovacuumVacuumCostDelay": "string", "autovacuumVacuumCostLimit": "string", "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", "effectiveIoConcurrency": "string", - "effectiveCacheSize": "string" + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" }, "userConfig": { "maxConnections": "string", @@ -8343,15 +10229,65 @@ Hour of the day in UTC (in `HH` format). || "exitOnError": "boolean", "seqPageCost": "number", "randomPageCost": "number", - "sqlInheritance": "boolean", "autovacuumMaxWorkers": "string", "autovacuumVacuumCostDelay": "string", "autovacuumVacuumCostLimit": "string", "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", "effectiveIoConcurrency": "string", - "effectiveCacheSize": "string" + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" }, "defaultConfig": { "maxConnections": "string", @@ -8426,18 +10362,68 @@ Hour of the day in UTC (in `HH` format). || "exitOnError": "boolean", "seqPageCost": "number", "randomPageCost": "number", - "sqlInheritance": "boolean", "autovacuumMaxWorkers": "string", "autovacuumVacuumCostDelay": "string", "autovacuumVacuumCostLimit": "string", "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxWorkerProcesses": "string", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "autovacuumVacuumScaleFactor": "number", + "autovacuumAnalyzeScaleFactor": "number", + "defaultTransactionReadOnly": "boolean", + "timezone": "string", "effectiveIoConcurrency": "string", - "effectiveCacheSize": "string" + "effectiveCacheSize": "string", + "sharedPreloadLibraries": [ + "string" + ], + "autoExplainLogMinDuration": "string", + "autoExplainLogAnalyze": "boolean", + "autoExplainLogBuffers": "boolean", + "autoExplainLogTiming": "boolean", + "autoExplainLogTriggers": "boolean", + "autoExplainLogVerbose": "boolean", + "autoExplainLogNestedStatements": "boolean", + "autoExplainSampleRate": "number", + "pgHintPlanEnableHint": "boolean", + "pgHintPlanEnableHintTable": "boolean", + "pgHintPlanDebugPrint": "string", + "pgHintPlanMessageLevel": "string", + "pgQualstatsEnabled": "boolean", + "pgQualstatsTrackConstants": "boolean", + "pgQualstatsMax": "string", + "pgQualstatsResolveOids": "boolean", + "pgQualstatsSampleRate": "number", + "maxStackDepth": "string", + "geqo": "boolean", + "geqoThreshold": "string", + "geqoEffort": "string", + "geqoPoolSize": "string", + "geqoGenerations": "string", + "geqoSelectionBias": "number", + "geqoSeed": "number", + "maxStandbyArchiveDelay": "string", + "sessionDurationTimeout": "string", + "logReplicationCommands": "boolean", + "logAutovacuumMinDuration": "string", + "passwordEncryption": "string" } }, - "postgresqlConfig_10_1c": { + "postgresqlConfig_11": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -8445,7 +10431,6 @@ Hour of the day in UTC (in `HH` format). || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -8535,6 +10520,15 @@ Hour of the day in UTC (in `HH` format). || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -8552,8 +10546,6 @@ Hour of the day in UTC (in `HH` format). || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", - "onlineAnalyzeEnable": "boolean", - "plantunerFixEmptyTable": "boolean", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -8567,6 +10559,9 @@ Hour of the day in UTC (in `HH` format). || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -8580,7 +10575,6 @@ Hour of the day in UTC (in `HH` format). || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -8670,6 +10664,15 @@ Hour of the day in UTC (in `HH` format). || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -8687,8 +10690,6 @@ Hour of the day in UTC (in `HH` format). || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", - "onlineAnalyzeEnable": "boolean", - "plantunerFixEmptyTable": "boolean", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -8702,6 +10703,9 @@ Hour of the day in UTC (in `HH` format). || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -8715,7 +10719,6 @@ Hour of the day in UTC (in `HH` format). || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -8805,6 +10808,15 @@ Hour of the day in UTC (in `HH` format). || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -8822,8 +10834,6 @@ Hour of the day in UTC (in `HH` format). || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", - "onlineAnalyzeEnable": "boolean", - "plantunerFixEmptyTable": "boolean", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -8837,6 +10847,9 @@ Hour of the day in UTC (in `HH` format). || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -8844,7 +10857,7 @@ Hour of the day in UTC (in `HH` format). || "passwordEncryption": "string" } }, - "postgresqlConfig_10": { + "postgresqlConfig_11_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -8852,7 +10865,6 @@ Hour of the day in UTC (in `HH` format). || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -8924,6 +10936,7 @@ Hour of the day in UTC (in `HH` format). || "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", "enableBitmapscan": "boolean", "enableHashagg": "boolean", "enableHashjoin": "boolean", @@ -8942,6 +10955,15 @@ Hour of the day in UTC (in `HH` format). || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -8964,6 +10986,7 @@ Hour of the day in UTC (in `HH` format). || "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", @@ -8972,6 +10995,9 @@ Hour of the day in UTC (in `HH` format). || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -8985,7 +11011,6 @@ Hour of the day in UTC (in `HH` format). || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -9057,6 +11082,7 @@ Hour of the day in UTC (in `HH` format). || "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", "enableBitmapscan": "boolean", "enableHashagg": "boolean", "enableHashjoin": "boolean", @@ -9075,6 +11101,15 @@ Hour of the day in UTC (in `HH` format). || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -9097,6 +11132,7 @@ Hour of the day in UTC (in `HH` format). || "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", @@ -9105,6 +11141,9 @@ Hour of the day in UTC (in `HH` format). || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -9118,7 +11157,6 @@ Hour of the day in UTC (in `HH` format). || "maxPreparedTransactions": "string", "workMem": "string", "maintenanceWorkMem": "string", - "replacementSortTuples": "string", "autovacuumWorkMem": "string", "tempFileLimit": "string", "vacuumCostDelay": "string", @@ -9190,6 +11228,7 @@ Hour of the day in UTC (in `HH` format). || "autovacuumNaptime": "string", "archiveTimeout": "string", "trackActivityQuerySize": "string", + "onlineAnalyzeEnable": "boolean", "enableBitmapscan": "boolean", "enableHashagg": "boolean", "enableHashjoin": "boolean", @@ -9208,6 +11247,15 @@ Hour of the day in UTC (in `HH` format). || "autovacuumAnalyzeScaleFactor": "number", "defaultTransactionReadOnly": "boolean", "timezone": "string", + "enableParallelAppend": "boolean", + "enableParallelHash": "boolean", + "enablePartitionPruning": "boolean", + "enablePartitionwiseAggregate": "boolean", + "enablePartitionwiseJoin": "boolean", + "jit": "boolean", + "maxParallelMaintenanceWorkers": "string", + "parallelLeaderParticipation": "boolean", + "vacuumCleanupIndexScaleFactor": "number", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -9230,6 +11278,7 @@ Hour of the day in UTC (in `HH` format). || "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", + "plantunerFixEmptyTable": "boolean", "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", @@ -9238,6 +11287,9 @@ Hour of the day in UTC (in `HH` format). || "geqoGenerations": "string", "geqoSelectionBias": "number", "geqoSeed": "number", + "pgTrgmSimilarityThreshold": "number", + "pgTrgmWordSimilarityThreshold": "number", + "pgTrgmStrictWordSimilarityThreshold": "number", "maxStandbyArchiveDelay": "string", "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", @@ -9245,7 +11297,7 @@ Hour of the day in UTC (in `HH` format). || "passwordEncryption": "string" } }, - "postgresqlConfig_11": { + "postgresqlConfig_12": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -9351,6 +11403,8 @@ Hour of the day in UTC (in `HH` format). || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -9495,6 +11549,8 @@ Hour of the day in UTC (in `HH` format). || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -9639,6 +11695,8 @@ Hour of the day in UTC (in `HH` format). || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -9679,7 +11737,7 @@ Hour of the day in UTC (in `HH` format). || "passwordEncryption": "string" } }, - "postgresqlConfig_11_1c": { + "postgresqlConfig_12_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -9786,6 +11844,8 @@ Hour of the day in UTC (in `HH` format). || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -9932,6 +11992,8 @@ Hour of the day in UTC (in `HH` format). || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -10078,6 +12140,8 @@ Hour of the day in UTC (in `HH` format). || "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", "vacuumCleanupIndexScaleFactor": "number", + "logTransactionSampleRate": "number", + "planCacheMode": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string", "sharedPreloadLibraries": [ @@ -10119,7 +12183,7 @@ Hour of the day in UTC (in `HH` format). || "passwordEncryption": "string" } }, - "postgresqlConfig_12": { + "postgresqlConfig_13": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -10244,6 +12308,18 @@ Hour of the day in UTC (in `HH` format). || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -10390,6 +12466,18 @@ Hour of the day in UTC (in `HH` format). || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -10536,6 +12624,18 @@ Hour of the day in UTC (in `HH` format). || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -10559,7 +12659,7 @@ Hour of the day in UTC (in `HH` format). || "passwordEncryption": "string" } }, - "postgresqlConfig_12_1c": { + "postgresqlConfig_13_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -10685,13 +12785,24 @@ Hour of the day in UTC (in `HH` format). || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", - "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -10833,13 +12944,24 @@ Hour of the day in UTC (in `HH` format). || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", - "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -10981,13 +13103,24 @@ Hour of the day in UTC (in `HH` format). || "pgHintPlanEnableHintTable": "boolean", "pgHintPlanDebugPrint": "string", "pgHintPlanMessageLevel": "string", + "hashMemMultiplier": "number", + "logicalDecodingWorkMem": "string", + "maintenanceIoConcurrency": "string", + "maxSlotWalKeepSize": "string", + "walKeepSize": "string", + "enableIncrementalSort": "boolean", + "autovacuumVacuumInsertThreshold": "string", + "autovacuumVacuumInsertScaleFactor": "number", + "logMinDurationSample": "string", + "logStatementSampleRate": "number", + "logParameterMaxLength": "string", + "logParameterMaxLengthOnError": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", - "maxStackDepth": "string", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -11005,7 +13138,7 @@ Hour of the day in UTC (in `HH` format). || "passwordEncryption": "string" } }, - "postgresqlConfig_13": { + "postgresqlConfig_14": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -11070,7 +13203,6 @@ Hour of the day in UTC (in `HH` format). || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -11110,7 +13242,6 @@ Hour of the day in UTC (in `HH` format). || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -11142,6 +13273,13 @@ Hour of the day in UTC (in `HH` format). || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -11228,7 +13366,6 @@ Hour of the day in UTC (in `HH` format). || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -11268,7 +13405,6 @@ Hour of the day in UTC (in `HH` format). || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -11300,6 +13436,13 @@ Hour of the day in UTC (in `HH` format). || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -11386,7 +13529,6 @@ Hour of the day in UTC (in `HH` format). || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -11426,7 +13568,6 @@ Hour of the day in UTC (in `HH` format). || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -11458,6 +13599,13 @@ Hour of the day in UTC (in `HH` format). || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -11481,7 +13629,7 @@ Hour of the day in UTC (in `HH` format). || "passwordEncryption": "string" } }, - "postgresqlConfig_13_1c": { + "postgresqlConfig_14_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -11546,7 +13694,6 @@ Hour of the day in UTC (in `HH` format). || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -11587,7 +13734,6 @@ Hour of the day in UTC (in `HH` format). || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -11619,6 +13765,13 @@ Hour of the day in UTC (in `HH` format). || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -11705,7 +13858,6 @@ Hour of the day in UTC (in `HH` format). || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -11746,7 +13898,6 @@ Hour of the day in UTC (in `HH` format). || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -11778,6 +13929,13 @@ Hour of the day in UTC (in `HH` format). || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -11864,7 +14022,6 @@ Hour of the day in UTC (in `HH` format). || "defaultWithOids": "boolean", "escapeStringWarning": "boolean", "loCompatPrivileges": "boolean", - "operatorPrecedenceWarning": "boolean", "quoteAllIdentifiers": "boolean", "standardConformingStrings": "boolean", "synchronizeSeqscans": "boolean", @@ -11905,7 +14062,6 @@ Hour of the day in UTC (in `HH` format). || "jit": "boolean", "maxParallelMaintenanceWorkers": "string", "parallelLeaderParticipation": "boolean", - "vacuumCleanupIndexScaleFactor": "number", "logTransactionSampleRate": "number", "planCacheMode": "string", "effectiveIoConcurrency": "string", @@ -11937,6 +14093,13 @@ Hour of the day in UTC (in `HH` format). || "logStatementSampleRate": "number", "logParameterMaxLength": "string", "logParameterMaxLengthOnError": "string", + "clientConnectionCheckInterval": "string", + "enableAsyncAppend": "boolean", + "enableGathermerge": "boolean", + "enableMemoize": "boolean", + "logRecoveryConflictWaits": "boolean", + "vacuumFailsafeAge": "string", + "vacuumMultixactFailsafeAge": "string", "pgQualstatsEnabled": "boolean", "pgQualstatsTrackConstants": "boolean", "pgQualstatsMax": "string", @@ -11960,7 +14123,7 @@ Hour of the day in UTC (in `HH` format). || "passwordEncryption": "string" } }, - "postgresqlConfig_14": { + "postgresqlConfig_15": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -12108,6 +14271,7 @@ Hour of the day in UTC (in `HH` format). || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -12271,6 +14435,7 @@ Hour of the day in UTC (in `HH` format). || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -12434,6 +14599,7 @@ Hour of the day in UTC (in `HH` format). || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -12451,7 +14617,7 @@ Hour of the day in UTC (in `HH` format). || "passwordEncryption": "string" } }, - "postgresqlConfig_14_1c": { + "postgresqlConfig_15_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -12600,6 +14766,8 @@ Hour of the day in UTC (in `HH` format). || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -12764,6 +14932,8 @@ Hour of the day in UTC (in `HH` format). || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -12928,6 +15098,8 @@ Hour of the day in UTC (in `HH` format). || "pgQualstatsResolveOids": "boolean", "pgQualstatsSampleRate": "number", "plantunerFixEmptyTable": "boolean", + "maxStackDepth": "string", + "enableGroupByReordering": "boolean", "geqo": "boolean", "geqoThreshold": "string", "geqoEffort": "string", @@ -12945,7 +15117,7 @@ Hour of the day in UTC (in `HH` format). || "passwordEncryption": "string" } }, - "postgresqlConfig_15": { + "postgresqlConfig_16": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -12979,7 +15151,7 @@ Hour of the day in UTC (in `HH` format). || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -13143,7 +15315,7 @@ Hour of the day in UTC (in `HH` format). || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -13307,7 +15479,7 @@ Hour of the day in UTC (in `HH` format). || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -13439,7 +15611,7 @@ Hour of the day in UTC (in `HH` format). || "passwordEncryption": "string" } }, - "postgresqlConfig_15_1c": { + "postgresqlConfig_16_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -13473,7 +15645,7 @@ Hour of the day in UTC (in `HH` format). || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -13639,7 +15811,7 @@ Hour of the day in UTC (in `HH` format). || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -13805,7 +15977,7 @@ Hour of the day in UTC (in `HH` format). || "cursorTupleFraction": "number", "fromCollapseLimit": "string", "joinCollapseLimit": "string", - "forceParallelMode": "string", + "debugParallelQuery": "string", "clientMinMessages": "string", "logMinMessages": "string", "logMinErrorStatement": "string", @@ -13939,7 +16111,7 @@ Hour of the day in UTC (in `HH` format). || "passwordEncryption": "string" } }, - "postgresqlConfig_16": { + "postgresqlConfig_17": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -13959,7 +16131,6 @@ Hour of the day in UTC (in `HH` format). || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -14102,7 +16273,12 @@ Hour of the day in UTC (in `HH` format). || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, "userConfig": { "maxConnections": "string", @@ -14123,7 +16299,6 @@ Hour of the day in UTC (in `HH` format). || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -14266,7 +16441,12 @@ Hour of the day in UTC (in `HH` format). || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, "defaultConfig": { "maxConnections": "string", @@ -14287,7 +16467,6 @@ Hour of the day in UTC (in `HH` format). || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -14430,10 +16609,15 @@ Hour of the day in UTC (in `HH` format). || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" } }, - "postgresqlConfig_16_1c": { + "postgresqlConfig_17_1c": { "effectiveConfig": { "maxConnections": "string", "sharedBuffers": "string", @@ -14453,7 +16637,6 @@ Hour of the day in UTC (in `HH` format). || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -14598,7 +16781,12 @@ Hour of the day in UTC (in `HH` format). || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, "userConfig": { "maxConnections": "string", @@ -14619,7 +16807,6 @@ Hour of the day in UTC (in `HH` format). || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -14764,7 +16951,12 @@ Hour of the day in UTC (in `HH` format). || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" }, "defaultConfig": { "maxConnections": "string", @@ -14785,7 +16977,6 @@ Hour of the day in UTC (in `HH` format). || "bgwriterLruMultiplier": "number", "bgwriterFlushAfter": "string", "backendFlushAfter": "string", - "oldSnapshotThreshold": "string", "walLevel": "string", "synchronousCommit": "string", "checkpointTimeout": "string", @@ -14930,7 +17121,12 @@ Hour of the day in UTC (in `HH` format). || "sessionDurationTimeout": "string", "logReplicationCommands": "boolean", "logAutovacuumMinDuration": "string", - "passwordEncryption": "string" + "passwordEncryption": "string", + "autoExplainLogFormat": "string", + "trackCommitTimestamp": "boolean", + "maxLogicalReplicationWorkers": "string", + "maxWalSenders": "string", + "maxReplicationSlots": "string" } }, // end of the list of possible fields @@ -14997,367 +17193,990 @@ Hour of the day in UTC (in `HH` format). || } ``` -An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). +An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation). + +#| +||Field | Description || +|| id | **string** + +ID of the operation. || +|| description | **string** + +Description of the operation. 0-256 characters long. || +|| createdAt | **string** (date-time) + +Creation timestamp. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| createdBy | **string** + +ID of the user or service account who initiated the operation. || +|| modifiedAt | **string** (date-time) + +The time when the Operation resource was last modified. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| done | **boolean** + +If the value is `false`, it means the operation is still in progress. +If `true`, the operation is completed, and either `error` or `response` is available. || +|| metadata | **[UpdateClusterMetadata](#yandex.cloud.mdb.postgresql.v1.UpdateClusterMetadata)** + +Service-specific metadata associated with the operation. +It typically contains the ID of the target resource that the operation is performed on. +Any method that returns a long-running operation should document the metadata type, if any. || +|| error | **[Status](#google.rpc.Status)** + +The error result of the operation in case of failure or cancellation. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** + +The normal response of the operation in case of success. +If the original method returns no data on success, such as Delete, +the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). +If the original method is the standard Create/Update, +the response should be the target resource of the operation. +Any method that returns a long-running operation should document the response type, if any. + +Includes only one of the fields `error`, `response`. + +The operation result. +If `done == false` and there was no failure detected, neither `error` nor `response` is set. +If `done == false` and there was a failure detected, `error` is set. +If `done == true`, exactly one of `error` or `response` is set. || +|# + +## UpdateClusterMetadata {#yandex.cloud.mdb.postgresql.v1.UpdateClusterMetadata} + +#| +||Field | Description || +|| clusterId | **string** + +ID of the PostgreSQL Cluster resource that is being updated. || +|# + +## Status {#google.rpc.Status} + +The error result of the operation in case of failure or cancellation. + +#| +||Field | Description || +|| code | **integer** (int32) + +Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || +|| message | **string** + +An error message. || +|| details[] | **object** + +A list of messages that carry the error details. || +|# + +## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} + +A PostgreSQL Cluster resource. For more information, see +the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. + +#| +||Field | Description || +|| id | **string** + +ID of the PostgreSQL cluster. +This ID is assigned by MDB at creation time. || +|| folderId | **string** + +ID of the folder that the PostgreSQL cluster belongs to. || +|| createdAt | **string** (date-time) + +Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + +String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from +`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. + +To work with values in this field, use the APIs described in the +[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). +In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || +|| name | **string** + +Name of the PostgreSQL cluster. +The name is unique within the folder. 1-63 characters long. || +|| description | **string** + +Description of the PostgreSQL cluster. 0-256 characters long. || +|| labels | **string** + +Custom labels for the PostgreSQL cluster as `` key:value `` pairs. +Maximum 64 per resource. || +|| environment | **enum** (Environment) + +Deployment environment of the PostgreSQL cluster. + +- `ENVIRONMENT_UNSPECIFIED` +- `PRODUCTION`: Stable environment with a conservative update policy: +only hotfixes are applied during regular maintenance. +- `PRESTABLE`: Environment with more aggressive update policy: new versions +are rolled out irrespective of backward compatibility. || +|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** + +Description of monitoring systems relevant to the PostgreSQL cluster. || +|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** + +Configuration of the PostgreSQL cluster. || +|| networkId | **string** + +ID of the network that the cluster belongs to. || +|| health | **enum** (Health) + +Aggregated cluster health. + +- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). +- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). +- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). +- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || +|| status | **enum** (Status) + +Current state of the cluster. + +- `STATUS_UNKNOWN`: Cluster state is unknown. +- `CREATING`: Cluster is being created. +- `RUNNING`: Cluster is running normally. +- `ERROR`: Cluster encountered a problem and cannot operate. +- `UPDATING`: Cluster is being updated. +- `STOPPING`: Cluster is stopping. +- `STOPPED`: Cluster stopped. +- `STARTING`: Cluster is starting. || +|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow2)** + +Maintenance window for the cluster. || +|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** + +Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || +|| securityGroupIds[] | **string** + +User security groups || +|| deletionProtection | **boolean** + +Deletion Protection inhibits deletion of the cluster || +|| hostGroupIds[] | **string** + +Host groups hosting VMs of the cluster. || +|# + +## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} + +Monitoring system. + +#| +||Field | Description || +|| name | **string** + +Name of the monitoring system. || +|| description | **string** + +Description of the monitoring system. || +|| link | **string** + +Link to the monitoring system charts for the PostgreSQL cluster. || +|# + +## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} + +#| +||Field | Description || +|| version | **string** + +Version of PostgreSQL server software. || +|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** + +Configuration of a PostgreSQL 9.6 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** + +Configuration of a PostgreSQL 10 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** + +Configuration of a PostgreSQL 10 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** + +Configuration of a PostgreSQL 11 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** + +Configuration of a PostgreSQL 11 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** + +Configuration of a PostgreSQL 12 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** + +Configuration of a PostgreSQL 12 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** + +Configuration of a PostgreSQL 13 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** -#| -||Field | Description || -|| id | **string** +Configuration of a PostgreSQL 13 1C server. -ID of the operation. || -|| description | **string** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Description of the operation. 0-256 characters long. || -|| createdAt | **string** (date-time) +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** -Creation timestamp. +Configuration of a PostgreSQL 14 server. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| createdBy | **string** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** -ID of the user or service account who initiated the operation. || -|| modifiedAt | **string** (date-time) +Configuration of a PostgreSQL 14 1C server. -The time when the Operation resource was last modified. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| done | **boolean** +Configuration of a PostgreSQL 15 server. -If the value is `false`, it means the operation is still in progress. -If `true`, the operation is completed, and either `error` or `response` is available. || -|| metadata | **[UpdateClusterMetadata](#yandex.cloud.mdb.postgresql.v1.UpdateClusterMetadata)** +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -Service-specific metadata associated with the operation. -It typically contains the ID of the target resource that the operation is performed on. -Any method that returns a long-running operation should document the metadata type, if any. || -|| error | **[Status](#google.rpc.Status)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** -The error result of the operation in case of failure or cancellation. +Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `error`, `response`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || -|| response | **[Cluster](#yandex.cloud.mdb.postgresql.v1.Cluster)** +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** -The normal response of the operation in case of success. -If the original method returns no data on success, such as Delete, -the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). -If the original method is the standard Create/Update, -the response should be the target resource of the operation. -Any method that returns a long-running operation should document the response type, if any. +Configuration of a PostgreSQL 16 server. -Includes only one of the fields `error`, `response`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. -The operation result. -If `done == false` and there was no failure detected, neither `error` nor `response` is set. -If `done == false` and there was a failure detected, `error` is set. -If `done == true`, exactly one of `error` or `response` is set. || +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** + +Configuration of a PostgreSQL 16 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[PostgresqlConfigSet17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[PostgresqlConfigSet17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig2)** + +Configuration of the connection pooler. || +|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources2)** + +Resources allocated to PostgreSQL hosts. || +|| autofailover | **boolean** + +Configuration setting which enables/disables autofailover in cluster. || +|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay2)** + +Time to start the daily backup, in the UTC timezone. || +|| backupRetainPeriodDays | **string** (int64) + +Retention policy of automated backups. || +|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access2)** + +Access policy to DB || +|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics2)** + +Configuration of the performance diagnostics service. || +|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling2)** + +Disk size autoscaling || |# -## UpdateClusterMetadata {#yandex.cloud.mdb.postgresql.v1.UpdateClusterMetadata} +## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} #| ||Field | Description || -|| clusterId | **string** +|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** -ID of the PostgreSQL Cluster resource that is being updated. || +Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** + +User-defined settings for a PostgreSQL 9.6 cluster. || +|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** + +Default configuration for a PostgreSQL 9.6 cluster. || |# -## Status {#google.rpc.Status} +## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62} -The error result of the operation in case of failure or cancellation. +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). #| ||Field | Description || -|| code | **integer** (int32) +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || -|| message | **string** +in bytes. || +|| tempBuffers | **string** (int64) -An error message. || -|| details[] | **object** +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -A list of messages that carry the error details. || -|# +in bytes. || +|| maintenanceWorkMem | **string** (int64) -## Cluster {#yandex.cloud.mdb.postgresql.v1.Cluster} +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -A PostgreSQL Cluster resource. For more information, see -the [Concepts](/docs/managed-postgresql/concepts) section of the documentation. +in bytes. || +|| tempFileLimit | **string** (int64) -#| -||Field | Description || -|| id | **string** +in bytes. || +|| vacuumCostDelay | **string** (int64) -ID of the PostgreSQL cluster. -This ID is assigned by MDB at creation time. || -|| folderId | **string** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -ID of the folder that the PostgreSQL cluster belongs to. || -|| createdAt | **string** (date-time) +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. +in bytes || +|| backendFlushAfter | **string** (int64) -String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from -`0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -To work with values in this field, use the APIs described in the -[Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). -In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || -|| name | **string** +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Name of the PostgreSQL cluster. -The name is unique within the folder. 1-63 characters long. || -|| description | **string** +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) + +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) + +Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointFlushAfter | **string** (int64) + +in bytes || +|| maxWalSize | **string** (int64) + +in bytes. || +|| minWalSize | **string** (int64) + +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) + +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Description of the PostgreSQL cluster. 0-256 characters long. || -|| labels | **string** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Custom labels for the PostgreSQL cluster as `` key:value `` pairs. -Maximum 64 per resource. || -|| environment | **enum** (Environment) +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Deployment environment of the PostgreSQL cluster. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -- `ENVIRONMENT_UNSPECIFIED` -- `PRODUCTION`: Stable environment with a conservative update policy: -only hotfixes are applied during regular maintenance. -- `PRESTABLE`: Environment with more aggressive update policy: new versions -are rolled out irrespective of backward compatibility. || -|| monitoring[] | **[Monitoring](#yandex.cloud.mdb.postgresql.v1.Monitoring)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Description of monitoring systems relevant to the PostgreSQL cluster. || -|| config | **[ClusterConfig](#yandex.cloud.mdb.postgresql.v1.ClusterConfig)** +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Configuration of the PostgreSQL cluster. || -|| networkId | **string** +in milliseconds. || +|| lockTimeout | **string** (int64) -ID of the network that the cluster belongs to. || -|| health | **enum** (Health) +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Aggregated cluster health. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -- `HEALTH_UNKNOWN`: State of the cluster is unknown ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is UNKNOWN). -- `ALIVE`: Cluster is alive and well ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is ALIVE). -- `DEAD`: Cluster is inoperable ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for every host in the cluster is DEAD). -- `DEGRADED`: Cluster is working below capacity ([Host.health](/docs/managed-postgresql/api-ref/Cluster/listHosts#yandex.cloud.mdb.postgresql.v1.Host) for at least one host in the cluster is not ALIVE). || -|| status | **enum** (Status) +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Current state of the cluster. +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -- `STATUS_UNKNOWN`: Cluster state is unknown. -- `CREATING`: Cluster is being created. -- `RUNNING`: Cluster is running normally. -- `ERROR`: Cluster encountered a problem and cannot operate. -- `UPDATING`: Cluster is being updated. -- `STOPPING`: Cluster is stopping. -- `STOPPED`: Cluster stopped. -- `STARTING`: Cluster is starting. || -|| maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.postgresql.v1.MaintenanceWindow2)** +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Maintenance window for the cluster. || -|| plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.postgresql.v1.MaintenanceOperation)** +in bytes. || +|| deadlockTimeout | **string** (int64) -Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`. || -|| securityGroupIds[] | **string** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -User security groups || -|| deletionProtection | **boolean** +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| sqlInheritance | **boolean** -Deletion Protection inhibits deletion of the cluster || -|| hostGroupIds[] | **string** +This option has been removed in PostgreSQL 10. || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Host groups hosting VMs of the cluster. || -|# +in milliseconds. || +|| archiveTimeout | **string** (int64) -## Monitoring {#yandex.cloud.mdb.postgresql.v1.Monitoring} +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# -Monitoring system. +## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} #| ||Field | Description || -|| name | **string** +|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** -Name of the monitoring system. || -|| description | **string** +Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +in `userConfig` and `defaultConfig`). || +|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** -Description of the monitoring system. || -|| link | **string** +User-defined settings for a PostgreSQL 10 1C cluster. || +|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** -Link to the monitoring system charts for the PostgreSQL cluster. || +Default configuration for a PostgreSQL 10 1C cluster. || |# -## ClusterConfig {#yandex.cloud.mdb.postgresql.v1.ClusterConfig} +## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters whose detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || -|| version | **string** +|| maxConnections | **string** (int64) || +|| sharedBuffers | **string** (int64) -Version of PostgreSQL server software. || -|| postgresqlConfig_9_6 | **[PostgresqlConfigSet9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6)** +in bytes. || +|| tempBuffers | **string** (int64) -Configuration of a PostgreSQL 9.6 server. +in bytes. || +|| maxPreparedTransactions | **string** (int64) || +|| workMem | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| maintenanceWorkMem | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10_1c | **[PostgresqlConfigSet10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C)** +in bytes. || +|| replacementSortTuples | **string** (int64) || +|| autovacuumWorkMem | **string** (int64) -Configuration of a PostgreSQL 10 1C server. +in bytes. || +|| tempFileLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| vacuumCostDelay | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_10 | **[PostgresqlConfigSet10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10)** +in milliseconds. || +|| vacuumCostPageHit | **string** (int64) || +|| vacuumCostPageMiss | **string** (int64) || +|| vacuumCostPageDirty | **string** (int64) || +|| vacuumCostLimit | **string** (int64) || +|| bgwriterDelay | **string** (int64) -Configuration of a PostgreSQL 10 server. +in milliseconds. || +|| bgwriterLruMaxpages | **string** (int64) || +|| bgwriterLruMultiplier | **number** (double) || +|| bgwriterFlushAfter | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes || +|| backendFlushAfter | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11 | **[PostgresqlConfigSet11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11)** +in bytes || +|| oldSnapshotThreshold | **string** (int64) || +|| walLevel | **enum** (WalLevel) -Configuration of a PostgreSQL 11 server. +- `WAL_LEVEL_UNSPECIFIED` +- `WAL_LEVEL_REPLICA` +- `WAL_LEVEL_LOGICAL` || +|| synchronousCommit | **enum** (SynchronousCommit) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `SYNCHRONOUS_COMMIT_UNSPECIFIED` +- `SYNCHRONOUS_COMMIT_ON` +- `SYNCHRONOUS_COMMIT_OFF` +- `SYNCHRONOUS_COMMIT_LOCAL` +- `SYNCHRONOUS_COMMIT_REMOTE_WRITE` +- `SYNCHRONOUS_COMMIT_REMOTE_APPLY` || +|| checkpointTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_11_1c | **[PostgresqlConfigSet11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C)** +in milliseconds. || +|| checkpointCompletionTarget | **number** (double) || +|| checkpointFlushAfter | **string** (int64) -Configuration of a PostgreSQL 11 1C server. +in bytes || +|| maxWalSize | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| minWalSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12 | **[PostgresqlConfigSet12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12)** +in bytes. || +|| maxStandbyStreamingDelay | **string** (int64) -Configuration of a PostgreSQL 12 server. +in milliseconds. || +|| defaultStatisticsTarget | **string** (int64) || +|| constraintExclusion | **enum** (ConstraintExclusion) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| forceParallelMode | **enum** (ForceParallelMode) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_12_1c | **[PostgresqlConfigSet12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C)** +- `FORCE_PARALLEL_MODE_UNSPECIFIED` +- `FORCE_PARALLEL_MODE_ON` +- `FORCE_PARALLEL_MODE_OFF` +- `FORCE_PARALLEL_MODE_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) -Configuration of a PostgreSQL 12 1C server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13 | **[PostgresqlConfigSet13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13)** +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) -Configuration of a PostgreSQL 13 server. +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_13_1c | **[PostgresqlConfigSet13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C)** +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) -Configuration of a PostgreSQL 13 1C server. +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| lockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14 | **[PostgresqlConfigSet14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14)** +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) -Configuration of a PostgreSQL 14 server. +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_14_1c | **[PostgresqlConfigSet14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C)** +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) -Configuration of a PostgreSQL 14 1C server. +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| deadlockTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15 | **[PostgresqlConfigSet15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15)** +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) -Configuration of a PostgreSQL 15 server. +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| operatorPrecedenceWarning | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| autovacuumMaxWorkers | **string** (int64) || +|| autovacuumVacuumCostDelay | **string** (int64) || +|| autovacuumVacuumCostLimit | **string** (int64) || +|| autovacuumNaptime | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| archiveTimeout | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_15_1c | **[PostgresqlConfigSet15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C)** +in milliseconds. || +|| trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) -Configuration of a PostgreSQL 15 1C server. +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16 | **[PostgresqlConfigSet16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16)** +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) -Configuration of a PostgreSQL 16 server. +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| onlineAnalyzeEnable | **boolean** || +|| plantunerFixEmptyTable | **boolean** || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +in bytes. || +|| geqo | **boolean** -Configuration for PostgreSQL servers in the cluster. || -|| postgresqlConfig_16_1c | **[PostgresqlConfigSet16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C)** +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) -Configuration of a PostgreSQL 16 1C server. +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) -Configuration for PostgreSQL servers in the cluster. || -|| poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig2)** +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) -Configuration of the connection pooler. || -|| resources | **[Resources](#yandex.cloud.mdb.postgresql.v1.Resources2)** +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) -Resources allocated to PostgreSQL hosts. || -|| autofailover | **boolean** +selective pressure within the population || +|| geqoSeed | **number** (double) -Configuration setting which enables/disables autofailover in cluster. || -|| backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay2)** +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) -Time to start the daily backup, in the UTC timezone. || -|| backupRetainPeriodDays | **string** (int64) +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) -Retention policy of automated backups. || -|| access | **[Access](#yandex.cloud.mdb.postgresql.v1.Access2)** +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) -Access policy to DB || -|| performanceDiagnostics | **[PerformanceDiagnostics](#yandex.cloud.mdb.postgresql.v1.PerformanceDiagnostics2)** +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) -Configuration of the performance diagnostics service. || -|| diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.postgresql.v1.DiskSizeAutoscaling2)** +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. -Disk size autoscaling || +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6} +## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** +|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** -Required field. Effective settings for a PostgreSQL 9.6 cluster (a combination of settings defined +Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** - -User-defined settings for a PostgreSQL 9.6 cluster. || -|| defaultConfig | **[PostgresqlConfig9_6](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62)** +|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** -Default configuration for a PostgreSQL 9.6 cluster. || +User-defined settings for a PostgreSQL 10 cluster. || +|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** + +Default configuration for a PostgreSQL 10 cluster. || |# -## PostgresqlConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_62} +## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/9.6/static/runtime-config). +[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). #| ||Field | Description || @@ -15417,9 +18236,7 @@ in bytes || || checkpointTimeout | **string** (int64) in milliseconds. || -|| checkpointCompletionTarget | **number** (double) - -Acceptable values are 0.0 to 1.0, inclusive. || +|| checkpointCompletionTarget | **number** (double) || || checkpointFlushAfter | **string** (int64) in bytes || @@ -15572,9 +18389,6 @@ in milliseconds. || || exitOnError | **boolean** || || seqPageCost | **number** (double) || || randomPageCost | **number** (double) || -|| sqlInheritance | **boolean** - -This option has been removed in PostgreSQL 10. || || autovacuumMaxWorkers | **string** (int64) || || autovacuumVacuumCostDelay | **string** (int64) || || autovacuumVacuumCostLimit | **string** (int64) || @@ -15585,31 +18399,139 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxWorkerProcesses | **string** (int64) || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| autovacuumVacuumScaleFactor | **number** (double) || +|| autovacuumAnalyzeScaleFactor | **number** (double) || +|| defaultTransactionReadOnly | **boolean** || +|| timezone | **string** || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || +|| sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) + +- `SHARED_PRELOAD_LIBRARIES_UNSPECIFIED` +- `SHARED_PRELOAD_LIBRARIES_AUTO_EXPLAIN` +- `SHARED_PRELOAD_LIBRARIES_PG_HINT_PLAN` +- `SHARED_PRELOAD_LIBRARIES_TIMESCALEDB` +- `SHARED_PRELOAD_LIBRARIES_PG_QUALSTATS` +- `SHARED_PRELOAD_LIBRARIES_PG_CRON` +- `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` +- `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +|| autoExplainLogMinDuration | **string** (int64) + +in milliseconds. || +|| autoExplainLogAnalyze | **boolean** || +|| autoExplainLogBuffers | **boolean** || +|| autoExplainLogTiming | **boolean** || +|| autoExplainLogTriggers | **boolean** || +|| autoExplainLogVerbose | **boolean** || +|| autoExplainLogNestedStatements | **boolean** || +|| autoExplainSampleRate | **number** (double) || +|| pgHintPlanEnableHint | **boolean** || +|| pgHintPlanEnableHintTable | **boolean** || +|| pgHintPlanDebugPrint | **enum** (PgHintPlanDebugPrint) + +- `PG_HINT_PLAN_DEBUG_PRINT_UNSPECIFIED` +- `PG_HINT_PLAN_DEBUG_PRINT_OFF` +- `PG_HINT_PLAN_DEBUG_PRINT_ON` +- `PG_HINT_PLAN_DEBUG_PRINT_DETAILED` +- `PG_HINT_PLAN_DEBUG_PRINT_VERBOSE` || +|| pgHintPlanMessageLevel | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| pgQualstatsEnabled | **boolean** || +|| pgQualstatsTrackConstants | **boolean** || +|| pgQualstatsMax | **string** (int64) || +|| pgQualstatsResolveOids | **boolean** || +|| pgQualstatsSampleRate | **number** (double) || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| geqo | **boolean** + +enable Genetic Query Optimizer, by default is on || +|| geqoThreshold | **string** (int64) + +The number of tables to use geqo, default is 12 || +|| geqoEffort | **string** (int64) + +tradeoff between planning time and query plan quality, default is 5 || +|| geqoPoolSize | **string** (int64) + +number of individuals in the genetic population, useful values are typically 100 to 1000; default - 0 - choose based on based on geqo_effort || +|| geqoGenerations | **string** (int64) + +the number of generations used by GEQO, useful values are in the same range as the pool size || +|| geqoSelectionBias | **number** (double) + +selective pressure within the population || +|| geqoSeed | **number** (double) + +initial value of the random number generator used by GEQO || +|| maxStandbyArchiveDelay | **string** (int64) + +in milliseconds. || +|| sessionDurationTimeout | **string** (int64) + +Terminate any session that exceeds the designated timeout, specified in milliseconds. If a timeout is not specified, the default session timeout is set to 12 hours. To disable it, specify a value of 0. || +|| logReplicationCommands | **boolean** || +|| logAutovacuumMinDuration | **string** (int64) + +in milliseconds. The default is 1000 (1 sec). || +|| passwordEncryption | **enum** (PasswordEncryption) + +A default value for `` user_password_encryption `` user-level setting, if it not specified for new users. Possible values are `` PASSWORD_ENCRYPTION_MD5 `` or `` PASSWORD_ENCRYPTION_SCRAM_SHA_256 ``. The default is `` PASSWORD_ENCRYPTION_MD5 ``. + +- `PASSWORD_ENCRYPTION_UNSPECIFIED` +- `PASSWORD_ENCRYPTION_MD5` +- `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C} +## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** +|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** -Required field. Effective settings for a PostgreSQL 10 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** +|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** -User-defined settings for a PostgreSQL 10 1C cluster. || -|| defaultConfig | **[PostgresqlConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2)** +User-defined settings for a PostgreSQL 11 cluster. || +|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** -Default configuration for a PostgreSQL 10 1C cluster. || +Default configuration for a PostgreSQL 11 cluster. || |# -## PostgresqlConfig10_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C2} +## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -15627,7 +18549,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -15850,6 +18771,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -15896,8 +18826,6 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || -|| onlineAnalyzeEnable | **boolean** || -|| plantunerFixEmptyTable | **boolean** || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -15927,6 +18855,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -15946,27 +18877,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10} +## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** +|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** -Required field. Effective settings for a PostgreSQL 10 cluster (a combination of settings defined +Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** +|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** -User-defined settings for a PostgreSQL 10 cluster. || -|| defaultConfig | **[PostgresqlConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102)** +User-defined settings for a PostgreSQL 11 1C cluster. || +|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** -Default configuration for a PostgreSQL 10 cluster. || +Default configuration for a PostgreSQL 11 1C cluster. || |# -## PostgresqlConfig10 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig102} +## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file -parameters whose detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/10/runtime-config.html). +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). #| ||Field | Description || @@ -15984,7 +18915,6 @@ in bytes. || || maintenanceWorkMem | **string** (int64) in bytes. || -|| replacementSortTuples | **string** (int64) || || autovacuumWorkMem | **string** (int64) in bytes. || @@ -16189,6 +19119,7 @@ in milliseconds. || in milliseconds. || || trackActivityQuerySize | **string** (int64) || +|| onlineAnalyzeEnable | **boolean** || || enableBitmapscan | **boolean** || || enableHashagg | **boolean** || || enableHashjoin | **boolean** || @@ -16207,6 +19138,15 @@ in milliseconds. || || autovacuumAnalyzeScaleFactor | **number** (double) || || defaultTransactionReadOnly | **boolean** || || timezone | **string** || +|| enableParallelAppend | **boolean** || +|| enableParallelHash | **boolean** || +|| enablePartitionPruning | **boolean** || +|| enablePartitionwiseAggregate | **boolean** || +|| enablePartitionwiseJoin | **boolean** || +|| jit | **boolean** || +|| maxParallelMaintenanceWorkers | **string** (int64) || +|| parallelLeaderParticipation | **boolean** || +|| vacuumCleanupIndexScaleFactor | **number** (double) || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -16258,6 +19198,7 @@ in milliseconds. || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || +|| plantunerFixEmptyTable | **boolean** || || maxStackDepth | **string** (int64) in bytes. || @@ -16282,6 +19223,9 @@ selective pressure within the population || || geqoSeed | **number** (double) initial value of the random number generator used by GEQO || +|| pgTrgmSimilarityThreshold | **number** (double) || +|| pgTrgmWordSimilarityThreshold | **number** (double) || +|| pgTrgmStrictWordSimilarityThreshold | **number** (double) || || maxStandbyArchiveDelay | **string** (int64) in milliseconds. || @@ -16301,23 +19245,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11} +## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** +|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** -Effective settings for a PostgreSQL 11 cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** +|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** -User-defined settings for a PostgreSQL 11 cluster. || -|| defaultConfig | **[PostgresqlConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112)** +User-defined settings for a PostgreSQL 12 cluster. || +|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** -Default configuration for a PostgreSQL 11 cluster. || +Default configuration for a PostgreSQL 12 cluster. || |# -## PostgresqlConfig11 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig112} +## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -16570,6 +19514,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -16667,23 +19618,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C} +## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** +|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** -Effective settings for a PostgreSQL 11 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** +|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** -User-defined settings for a PostgreSQL 11 1C cluster. || -|| defaultConfig | **[PostgresqlConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2)** +User-defined settings for a PostgreSQL 12 1C cluster. || +|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** -Default configuration for a PostgreSQL 11 1C cluster. || +Default configuration for a PostgreSQL 12 1C cluster. || |# -## PostgresqlConfig11_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C2} +## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -16937,6 +19888,13 @@ in milliseconds. || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || || vacuumCleanupIndexScaleFactor | **number** (double) || +|| logTransactionSampleRate | **number** (double) || +|| planCacheMode | **enum** (PlanCacheMode) + +- `PLAN_CACHE_MODE_UNSPECIFIED` +- `PLAN_CACHE_MODE_AUTO` +- `PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN` +- `PLAN_CACHE_MODE_FORCE_GENERIC_PLAN` || || effectiveIoConcurrency | **string** (int64) || || effectiveCacheSize | **string** (int64) || || sharedPreloadLibraries[] | **enum** (SharedPreloadLibraries) @@ -17035,23 +19993,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12} +## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** +|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** -Effective settings for a PostgreSQL 12 cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** +|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** -User-defined settings for a PostgreSQL 12 cluster. || -|| defaultConfig | **[PostgresqlConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122)** +User-defined settings for a PostgreSQL 13 cluster. || +|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** -Default configuration for a PostgreSQL 12 cluster. || +Default configuration for a PostgreSQL 13 cluster. || |# -## PostgresqlConfig12 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig122} +## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -17357,6 +20315,30 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -17408,23 +20390,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C} +## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** +|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** -Effective settings for a PostgreSQL 12 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** +|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** -User-defined settings for a PostgreSQL 12 1C cluster. || -|| defaultConfig | **[PostgresqlConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2)** +User-defined settings for a PostgreSQL 13 1C cluster. || +|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** -Default configuration for a PostgreSQL 12 1C cluster. || +Default configuration for a PostgreSQL 13 1C cluster. || |# -## PostgresqlConfig12_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C2} +## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -17731,15 +20713,36 @@ in milliseconds. || - `LOG_LEVEL_ERROR` - `LOG_LEVEL_FATAL` - `LOG_LEVEL_PANIC` || +|| hashMemMultiplier | **number** (double) || +|| logicalDecodingWorkMem | **string** (int64) + +in bytes. || +|| maintenanceIoConcurrency | **string** (int64) || +|| maxSlotWalKeepSize | **string** (int64) + +in bytes. || +|| walKeepSize | **string** (int64) + +in bytes. || +|| enableIncrementalSort | **boolean** || +|| autovacuumVacuumInsertThreshold | **string** (int64) || +|| autovacuumVacuumInsertScaleFactor | **number** (double) || +|| logMinDurationSample | **string** (int64) + +in milliseconds. || +|| logStatementSampleRate | **number** (double) || +|| logParameterMaxLength | **string** (int64) + +in bytes. || +|| logParameterMaxLengthOnError | **string** (int64) + +in bytes. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || -|| maxStackDepth | **string** (int64) - -in bytes. || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -17783,23 +20786,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13} +## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** +|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** -Effective settings for a PostgreSQL 13 cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** +|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** -User-defined settings for a PostgreSQL 13 cluster. || -|| defaultConfig | **[PostgresqlConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132)** +User-defined settings for a PostgreSQL 14 cluster. || +|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** -Default configuration for a PostgreSQL 13 cluster. || +Default configuration for a PostgreSQL 14 cluster. || |# -## PostgresqlConfig13 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig132} +## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -18007,7 +21010,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -18051,7 +21053,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -18129,6 +21130,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -18180,23 +21196,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C} +## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** +|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** -Effective settings for a PostgreSQL 13 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** +|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** -User-defined settings for a PostgreSQL 13 1C cluster. || -|| defaultConfig | **[PostgresqlConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2)** +User-defined settings for a PostgreSQL 14 1C cluster. || +|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** -Default configuration for a PostgreSQL 13 1C cluster. || +Default configuration for a PostgreSQL 14 1C cluster. || |# -## PostgresqlConfig13_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C2} +## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -18404,7 +21420,6 @@ in milliseconds. || || defaultWithOids | **boolean** || || escapeStringWarning | **boolean** || || loCompatPrivileges | **boolean** || -|| operatorPrecedenceWarning | **boolean** || || quoteAllIdentifiers | **boolean** || || standardConformingStrings | **boolean** || || synchronizeSeqscans | **boolean** || @@ -18449,7 +21464,6 @@ in milliseconds. || || jit | **boolean** || || maxParallelMaintenanceWorkers | **string** (int64) || || parallelLeaderParticipation | **boolean** || -|| vacuumCleanupIndexScaleFactor | **number** (double) || || logTransactionSampleRate | **number** (double) || || planCacheMode | **enum** (PlanCacheMode) @@ -18527,6 +21541,21 @@ in bytes. || || logParameterMaxLengthOnError | **string** (int64) in bytes. || +|| clientConnectionCheckInterval | **string** (int64) + +in milliseconds. || +|| enableAsyncAppend | **boolean** || +|| enableGathermerge | **boolean** || +|| enableMemoize | **boolean** || +|| logRecoveryConflictWaits | **boolean** + +in milliseconds. || +|| vacuumFailsafeAge | **string** (int64) + +in milliseconds. || +|| vacuumMultixactFailsafeAge | **string** (int64) + +in milliseconds. || || pgQualstatsEnabled | **boolean** || || pgQualstatsTrackConstants | **boolean** || || pgQualstatsMax | **string** (int64) || @@ -18576,23 +21605,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14} +## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** +|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** -Effective settings for a PostgreSQL 14 cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** +|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** -User-defined settings for a PostgreSQL 14 cluster. || -|| defaultConfig | **[PostgresqlConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142)** +User-defined settings for a PostgreSQL 15 cluster. || +|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** -Default configuration for a PostgreSQL 14 cluster. || +Default configuration for a PostgreSQL 15 cluster. || |# -## PostgresqlConfig14 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig142} +## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -18862,7 +21891,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -18943,6 +21973,7 @@ in milliseconds. || || maxStackDepth | **string** (int64) in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -18986,23 +22017,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C} +## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** +|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** -Effective settings for a PostgreSQL 14 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** +|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** -User-defined settings for a PostgreSQL 14 1C cluster. || -|| defaultConfig | **[PostgresqlConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2)** +User-defined settings for a PostgreSQL 15 1C cluster. || +|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** -Default configuration for a PostgreSQL 14 1C cluster. || +Default configuration for a PostgreSQL 15 1C cluster. || |# -## PostgresqlConfig14_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C2} +## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -19273,7 +22304,8 @@ in milliseconds. || - `SHARED_PRELOAD_LIBRARIES_PG_CRON` - `SHARED_PRELOAD_LIBRARIES_PGLOGICAL` - `SHARED_PRELOAD_LIBRARIES_PG_PREWARM` -- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` || +- `SHARED_PRELOAD_LIBRARIES_PGAUDIT` +- `SHARED_PRELOAD_LIBRARIES_ANON` || || autoExplainLogMinDuration | **string** (int64) in milliseconds. || @@ -19352,6 +22384,10 @@ in milliseconds. || || pgQualstatsResolveOids | **boolean** || || pgQualstatsSampleRate | **number** (double) || || plantunerFixEmptyTable | **boolean** || +|| maxStackDepth | **string** (int64) + +in bytes. || +|| enableGroupByReordering | **boolean** || || geqo | **boolean** enable Genetic Query Optimizer, by default is on || @@ -19395,23 +22431,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15} +## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** +|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** -Effective settings for a PostgreSQL 15 cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** +|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** -User-defined settings for a PostgreSQL 15 cluster. || -|| defaultConfig | **[PostgresqlConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152)** +User-defined settings for a PostgreSQL 16 cluster. || +|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** -Default configuration for a PostgreSQL 15 cluster. || +Default configuration for a PostgreSQL 16 cluster. || |# -## PostgresqlConfig15 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig152} +## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -19497,12 +22533,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -19511,6 +22547,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -19525,6 +22562,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -19539,6 +22577,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -19710,6 +22749,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -19807,23 +22847,23 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C} +## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** +|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** -Effective settings for a PostgreSQL 15 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** +|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** -User-defined settings for a PostgreSQL 15 1C cluster. || -|| defaultConfig | **[PostgresqlConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2)** +User-defined settings for a PostgreSQL 16 1C cluster. || +|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** -Default configuration for a PostgreSQL 15 1C cluster. || +Default configuration for a PostgreSQL 16 1C cluster. || |# -## PostgresqlConfig15_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C2} +## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in @@ -19909,12 +22949,12 @@ in milliseconds. || || cursorTupleFraction | **number** (double) || || fromCollapseLimit | **string** (int64) || || joinCollapseLimit | **string** (int64) || -|| forceParallelMode | **enum** (ForceParallelMode) +|| debugParallelQuery | **enum** (DebugParallelQuery) -- `FORCE_PARALLEL_MODE_UNSPECIFIED` -- `FORCE_PARALLEL_MODE_ON` -- `FORCE_PARALLEL_MODE_OFF` -- `FORCE_PARALLEL_MODE_REGRESS` || +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || || clientMinMessages | **enum** (LogLevel) - `LOG_LEVEL_UNSPECIFIED` @@ -19923,6 +22963,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -19937,6 +22978,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -19951,6 +22993,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -20123,6 +23166,7 @@ in milliseconds. || - `LOG_LEVEL_DEBUG3` - `LOG_LEVEL_DEBUG2` - `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` - `LOG_LEVEL_LOG` - `LOG_LEVEL_NOTICE` - `LOG_LEVEL_WARNING` @@ -20221,27 +23265,27 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || |# -## PostgresqlConfigSet16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16} +## PostgresqlConfigSet17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** +|| effectiveConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig172)** -Effective settings for a PostgreSQL 16 cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** +|| userConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig172)** -User-defined settings for a PostgreSQL 16 cluster. || -|| defaultConfig | **[PostgresqlConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig172)** -Default configuration for a PostgreSQL 16 cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig162} +## PostgresqlConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig172} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -20283,7 +23327,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -20635,29 +23678,42 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# -## PostgresqlConfigSet16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C} +## PostgresqlConfigSet17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C} #| ||Field | Description || -|| effectiveConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** +|| effectiveConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C2)** -Effective settings for a PostgreSQL 16 1C cluster (a combination of settings defined +Effective settings for a PostgreSQL 17 1C cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || -|| userConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** +|| userConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C2)** -User-defined settings for a PostgreSQL 16 1C cluster. || -|| defaultConfig | **[PostgresqlConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2)** +User-defined settings for a PostgreSQL 17 cluster. || +|| defaultConfig | **[PostgresqlConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C2)** -Default configuration for a PostgreSQL 16 1C cluster. || +Default configuration for a PostgreSQL 17 cluster. || |# -## PostgresqlConfig16_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C2} +## PostgresqlConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C2} Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file parameters which detailed description is available in -[PostgreSQL documentation](https://www.postgresql.org/docs/11/runtime-config.html). +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). #| ||Field | Description || @@ -20699,7 +23755,6 @@ in bytes || || backendFlushAfter | **string** (int64) in bytes || -|| oldSnapshotThreshold | **string** (int64) || || walLevel | **enum** (WalLevel) - `WAL_LEVEL_UNSPECIFIED` @@ -21053,6 +24108,19 @@ A default value for `` user_password_encryption `` user-level setting, if it not - `PASSWORD_ENCRYPTION_UNSPECIFIED` - `PASSWORD_ENCRYPTION_MD5` - `PASSWORD_ENCRYPTION_SCRAM_SHA_256` || +|| autoExplainLogFormat | **enum** (AutoExplainLogFormat) + +Selects the `` EXPLAIN `` output format to be used. The allowed values are `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``, `` AUTO_EXPLAIN_LOG_FORMAT_XML ``, `` AUTO_EXPLAIN_LOG_FORMAT_JSON ``, and `` AUTO_EXPLAIN_LOG_FORMAT_YAML ``. The default is `` AUTO_EXPLAIN_LOG_FORMAT_TEXT ``. + +- `AUTO_EXPLAIN_LOG_FORMAT_UNSPECIFIED` +- `AUTO_EXPLAIN_LOG_FORMAT_TEXT` +- `AUTO_EXPLAIN_LOG_FORMAT_XML` +- `AUTO_EXPLAIN_LOG_FORMAT_JSON` +- `AUTO_EXPLAIN_LOG_FORMAT_YAML` || +|| trackCommitTimestamp | **boolean** || +|| maxLogicalReplicationWorkers | **string** (int64) || +|| maxWalSenders | **string** (int64) || +|| maxReplicationSlots | **string** (int64) || |# ## ConnectionPoolerConfig {#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig2} diff --git a/ru/managed-postgresql/api-ref/Cluster/updateHosts.md b/ru/managed-postgresql/api-ref/Cluster/updateHosts.md index b756930956e..b2fff548f23 100644 --- a/ru/managed-postgresql/api-ref/Cluster/updateHosts.md +++ b/ru/managed-postgresql/api-ref/Cluster/updateHosts.md @@ -33,7 +33,7 @@ To get the PostgreSQL cluster ID, use a [ClusterService.List](/docs/managed-post "replicationSource": "string", "priority": "string", "configSpec": { - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": { "recoveryMinApplyDelay": "string", "sharedBuffers": "string", @@ -1052,6 +1052,140 @@ To get the PostgreSQL cluster ID, use a [ClusterService.List](/docs/managed-post "timezone": "string", "effectiveIoConcurrency": "string", "effectiveCacheSize": "string" + }, + "postgresqlConfig_17": { + "recoveryMinApplyDelay": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "workMem": "string", + "tempFileLimit": "string", + "backendFlushAfter": "string", + "maxStandbyStreamingDelay": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" + }, + "postgresqlConfig_17_1c": { + "recoveryMinApplyDelay": "string", + "sharedBuffers": "string", + "tempBuffers": "string", + "workMem": "string", + "tempFileLimit": "string", + "backendFlushAfter": "string", + "maxStandbyStreamingDelay": "string", + "constraintExclusion": "string", + "cursorTupleFraction": "number", + "fromCollapseLimit": "string", + "joinCollapseLimit": "string", + "debugParallelQuery": "string", + "clientMinMessages": "string", + "logMinMessages": "string", + "logMinErrorStatement": "string", + "logMinDurationStatement": "string", + "logCheckpoints": "boolean", + "logConnections": "boolean", + "logDisconnections": "boolean", + "logDuration": "boolean", + "logErrorVerbosity": "string", + "logLockWaits": "boolean", + "logStatement": "string", + "logTempFiles": "string", + "searchPath": "string", + "rowSecurity": "boolean", + "defaultTransactionIsolation": "string", + "statementTimeout": "string", + "lockTimeout": "string", + "idleInTransactionSessionTimeout": "string", + "byteaOutput": "string", + "xmlbinary": "string", + "xmloption": "string", + "ginPendingListLimit": "string", + "deadlockTimeout": "string", + "maxLocksPerTransaction": "string", + "maxPredLocksPerTransaction": "string", + "arrayNulls": "boolean", + "backslashQuote": "string", + "defaultWithOids": "boolean", + "escapeStringWarning": "boolean", + "loCompatPrivileges": "boolean", + "quoteAllIdentifiers": "boolean", + "standardConformingStrings": "boolean", + "synchronizeSeqscans": "boolean", + "transformNullEquals": "boolean", + "exitOnError": "boolean", + "seqPageCost": "number", + "randomPageCost": "number", + "enableBitmapscan": "boolean", + "enableHashagg": "boolean", + "enableHashjoin": "boolean", + "enableIndexscan": "boolean", + "enableIndexonlyscan": "boolean", + "enableMaterial": "boolean", + "enableMergejoin": "boolean", + "enableNestloop": "boolean", + "enableSeqscan": "boolean", + "enableSort": "boolean", + "enableTidscan": "boolean", + "maxParallelWorkers": "string", + "maxParallelWorkersPerGather": "string", + "timezone": "string", + "effectiveIoConcurrency": "string", + "effectiveCacheSize": "string" } // end of the list of possible fields }, @@ -1113,77 +1247,87 @@ Whether the host should get a public IP address on creation. || Configuration for a host with PostgreSQL 9.6 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_10_1c | **[PostgresqlHostConfig10_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C)** Configuration for a host with PostgreSQL 10 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_10 | **[PostgresqlHostConfig10](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10)** Configuration for a host with PostgreSQL 10 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_11 | **[PostgresqlHostConfig11](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11)** Configuration for a host with PostgreSQL 11 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_11_1c | **[PostgresqlHostConfig11_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C)** Configuration for a host with PostgreSQL 11 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_12 | **[PostgresqlHostConfig12](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12)** Configuration for a host with PostgreSQL 12 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_12_1c | **[PostgresqlHostConfig12_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C)** Configuration for a host with PostgreSQL 12 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_13 | **[PostgresqlHostConfig13](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13)** Configuration for a host with PostgreSQL 13 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_13_1c | **[PostgresqlHostConfig13_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C)** Configuration for a host with PostgreSQL 13 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_14 | **[PostgresqlHostConfig14](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14)** Configuration for a host with PostgreSQL 14 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_14_1c | **[PostgresqlHostConfig14_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C)** Configuration for a host with PostgreSQL 14 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_15 | **[PostgresqlHostConfig15](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15)** Configuration for a host with PostgreSQL 15 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_15_1c | **[PostgresqlHostConfig15_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C)** Configuration for a host with PostgreSQL 15 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_16 | **[PostgresqlHostConfig16](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16)** Configuration for a host with PostgreSQL 16 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_16_1c | **[PostgresqlHostConfig16_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C)** Configuration for a host with PostgreSQL 16 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17 | **[PostgresqlHostConfig17](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17_1c | **[PostgresqlHostConfig17_1C](#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || |# ## PostgresqlHostConfig9_6 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6} @@ -3959,6 +4103,378 @@ in milliseconds. || || effectiveCacheSize | **string** (int64) || |# +## PostgresqlHostConfig17 {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). + +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| workMem | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| debugParallelQuery | **enum** (DebugParallelQuery) + +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# + +## PostgresqlHostConfig17_1C {#yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C} + +Options and structure of `PostgresqlConfig` reflects PostgreSQL configuration file +parameters which detailed description is available in +[PostgreSQL documentation](https://www.postgresql.org/docs/17/runtime-config.html). + +#| +||Field | Description || +|| recoveryMinApplyDelay | **string** (int64) + +in milliseconds. || +|| sharedBuffers | **string** (int64) + +in bytes. || +|| tempBuffers | **string** (int64) + +in bytes. || +|| workMem | **string** (int64) + +in bytes. || +|| tempFileLimit | **string** (int64) + +in bytes. || +|| backendFlushAfter | **string** (int64) || +|| maxStandbyStreamingDelay | **string** (int64) + +in milliseconds. || +|| constraintExclusion | **enum** (ConstraintExclusion) + +- `CONSTRAINT_EXCLUSION_UNSPECIFIED` +- `CONSTRAINT_EXCLUSION_ON` +- `CONSTRAINT_EXCLUSION_OFF` +- `CONSTRAINT_EXCLUSION_PARTITION` || +|| cursorTupleFraction | **number** (double) || +|| fromCollapseLimit | **string** (int64) || +|| joinCollapseLimit | **string** (int64) || +|| debugParallelQuery | **enum** (DebugParallelQuery) + +- `DEBUG_PARALLEL_QUERY_UNSPECIFIED` +- `DEBUG_PARALLEL_QUERY_ON` +- `DEBUG_PARALLEL_QUERY_OFF` +- `DEBUG_PARALLEL_QUERY_REGRESS` || +|| clientMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinMessages | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinErrorStatement | **enum** (LogLevel) + +- `LOG_LEVEL_UNSPECIFIED` +- `LOG_LEVEL_DEBUG5` +- `LOG_LEVEL_DEBUG4` +- `LOG_LEVEL_DEBUG3` +- `LOG_LEVEL_DEBUG2` +- `LOG_LEVEL_DEBUG1` +- `LOG_LEVEL_INFO` +- `LOG_LEVEL_LOG` +- `LOG_LEVEL_NOTICE` +- `LOG_LEVEL_WARNING` +- `LOG_LEVEL_ERROR` +- `LOG_LEVEL_FATAL` +- `LOG_LEVEL_PANIC` || +|| logMinDurationStatement | **string** (int64) + +in milliseconds. || +|| logCheckpoints | **boolean** || +|| logConnections | **boolean** || +|| logDisconnections | **boolean** || +|| logDuration | **boolean** || +|| logErrorVerbosity | **enum** (LogErrorVerbosity) + +- `LOG_ERROR_VERBOSITY_UNSPECIFIED` +- `LOG_ERROR_VERBOSITY_TERSE` +- `LOG_ERROR_VERBOSITY_DEFAULT` +- `LOG_ERROR_VERBOSITY_VERBOSE` || +|| logLockWaits | **boolean** || +|| logStatement | **enum** (LogStatement) + +- `LOG_STATEMENT_UNSPECIFIED` +- `LOG_STATEMENT_NONE` +- `LOG_STATEMENT_DDL` +- `LOG_STATEMENT_MOD` +- `LOG_STATEMENT_ALL` || +|| logTempFiles | **string** (int64) || +|| searchPath | **string** || +|| rowSecurity | **boolean** || +|| defaultTransactionIsolation | **enum** (TransactionIsolation) + +- `TRANSACTION_ISOLATION_UNSPECIFIED` +- `TRANSACTION_ISOLATION_READ_UNCOMMITTED` +- `TRANSACTION_ISOLATION_READ_COMMITTED` +- `TRANSACTION_ISOLATION_REPEATABLE_READ` +- `TRANSACTION_ISOLATION_SERIALIZABLE` || +|| statementTimeout | **string** (int64) + +in milliseconds. || +|| lockTimeout | **string** (int64) + +in milliseconds. || +|| idleInTransactionSessionTimeout | **string** (int64) + +in milliseconds. || +|| byteaOutput | **enum** (ByteaOutput) + +- `BYTEA_OUTPUT_UNSPECIFIED` +- `BYTEA_OUTPUT_HEX` +- `BYTEA_OUTPUT_ESCAPED` || +|| xmlbinary | **enum** (XmlBinary) + +- `XML_BINARY_UNSPECIFIED` +- `XML_BINARY_BASE64` +- `XML_BINARY_HEX` || +|| xmloption | **enum** (XmlOption) + +- `XML_OPTION_UNSPECIFIED` +- `XML_OPTION_DOCUMENT` +- `XML_OPTION_CONTENT` || +|| ginPendingListLimit | **string** (int64) + +in bytes. || +|| deadlockTimeout | **string** (int64) + +in milliseconds. || +|| maxLocksPerTransaction | **string** (int64) || +|| maxPredLocksPerTransaction | **string** (int64) || +|| arrayNulls | **boolean** || +|| backslashQuote | **enum** (BackslashQuote) + +- `BACKSLASH_QUOTE_UNSPECIFIED` +- `BACKSLASH_QUOTE` +- `BACKSLASH_QUOTE_ON` +- `BACKSLASH_QUOTE_OFF` +- `BACKSLASH_QUOTE_SAFE_ENCODING` || +|| defaultWithOids | **boolean** || +|| escapeStringWarning | **boolean** || +|| loCompatPrivileges | **boolean** || +|| quoteAllIdentifiers | **boolean** || +|| standardConformingStrings | **boolean** || +|| synchronizeSeqscans | **boolean** || +|| transformNullEquals | **boolean** || +|| exitOnError | **boolean** || +|| seqPageCost | **number** (double) || +|| randomPageCost | **number** (double) || +|| enableBitmapscan | **boolean** || +|| enableHashagg | **boolean** || +|| enableHashjoin | **boolean** || +|| enableIndexscan | **boolean** || +|| enableIndexonlyscan | **boolean** || +|| enableMaterial | **boolean** || +|| enableMergejoin | **boolean** || +|| enableNestloop | **boolean** || +|| enableSeqscan | **boolean** || +|| enableSort | **boolean** || +|| enableTidscan | **boolean** || +|| maxParallelWorkers | **string** (int64) || +|| maxParallelWorkersPerGather | **string** (int64) || +|| timezone | **string** || +|| effectiveIoConcurrency | **string** (int64) || +|| effectiveCacheSize | **string** (int64) || +|# + ## Response {#yandex.cloud.operation.Operation} **HTTP Code: 200 - OK** diff --git a/ru/managed-postgresql/api-ref/User/update.md b/ru/managed-postgresql/api-ref/User/update.md index 831f4405fb3..53d21f8ee3b 100644 --- a/ru/managed-postgresql/api-ref/User/update.md +++ b/ru/managed-postgresql/api-ref/User/update.md @@ -89,7 +89,7 @@ Set of permissions granted to the user to access specific databases. || Maximum number of database connections available to the user. -When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresqlConfig.maxConnections](/docs/managed-postgresql/api-ref/Cluster/get#yandex.cloud.mdb.postgresql.v1.ClusterConfig.postgresqlConfig) setting. +When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresql_config.max_connections] setting. When used in transaction pooling, this setting limits the number of user's active transactions; therefore, in this mode user can open thousands of connections, but only `N` concurrent connections will be opened, where `N` is the value of the setting. diff --git a/ru/managed-postgresql/api-ref/grpc/Cluster/addHosts.md b/ru/managed-postgresql/api-ref/grpc/Cluster/addHosts.md index ef97e10acb0..2b339bea82d 100644 --- a/ru/managed-postgresql/api-ref/grpc/Cluster/addHosts.md +++ b/ru/managed-postgresql/api-ref/grpc/Cluster/addHosts.md @@ -24,7 +24,7 @@ Creates new hosts for a cluster. "replicationSource": "string", "priority": "google.protobuf.Int64Value", "configSpec": { - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10", @@ -39,7 +39,9 @@ Creates new hosts for a cluster. "postgresqlConfig_15": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15", "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16", - "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C" + "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C" // end of the list of possible fields } } @@ -105,77 +107,87 @@ Configuration of a PostgreSQL server for the host. || Configuration for a host with PostgreSQL 9.6 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host10_1c.proto)** Configuration for a host with PostgreSQL 10 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host10.proto)** Configuration for a host with PostgreSQL 10 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host11.proto)** Configuration for a host with PostgreSQL 11 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host11_1c.proto)** Configuration for a host with PostgreSQL 11 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host12.proto)** Configuration for a host with PostgreSQL 12 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host12_1c.proto)** Configuration for a host with PostgreSQL 12 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host13.proto)** Configuration for a host with PostgreSQL 13 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host13_1c.proto)** Configuration for a host with PostgreSQL 13 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host14.proto)** Configuration for a host with PostgreSQL 14 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host14_1c.proto)** Configuration for a host with PostgreSQL 14 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host15.proto)** Configuration for a host with PostgreSQL 15 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host15_1c.proto)** Configuration for a host with PostgreSQL 15 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host16.proto)** Configuration for a host with PostgreSQL 16 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host16_1c.proto)** Configuration for a host with PostgreSQL 16 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host17.proto)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host17_1c.proto)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || |# ## operation.Operation {#yandex.cloud.operation.Operation} diff --git a/ru/managed-postgresql/api-ref/grpc/Cluster/backup.md b/ru/managed-postgresql/api-ref/grpc/Cluster/backup.md index 34a06762481..5bc8544fcd4 100644 --- a/ru/managed-postgresql/api-ref/grpc/Cluster/backup.md +++ b/ru/managed-postgresql/api-ref/grpc/Cluster/backup.md @@ -60,7 +60,7 @@ To get the PostgreSQL cluster ID, use a [ClusterService.List](/docs/managed-post ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10", @@ -76,6 +76,8 @@ To get the PostgreSQL cluster ID, use a [ClusterService.List](/docs/managed-post "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -313,105 +315,119 @@ Version of PostgreSQL server software. || Configuration of a PostgreSQL 9.6 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration of a PostgreSQL 10 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration of a PostgreSQL 10 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration of a PostgreSQL 11 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration of a PostgreSQL 11 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration of a PostgreSQL 12 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration of a PostgreSQL 12 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration of a PostgreSQL 13 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration of a PostgreSQL 13 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration of a PostgreSQL 14 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration of a PostgreSQL 14 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration of a PostgreSQL 15 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration of a PostgreSQL 16 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration of a PostgreSQL 16 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** diff --git a/ru/managed-postgresql/api-ref/grpc/Cluster/create.md b/ru/managed-postgresql/api-ref/grpc/Cluster/create.md index bfb21987540..5fa205fc30c 100644 --- a/ru/managed-postgresql/api-ref/grpc/Cluster/create.md +++ b/ru/managed-postgresql/api-ref/grpc/Cluster/create.md @@ -22,7 +22,7 @@ Creates a PostgreSQL cluster in the specified folder. "environment": "Environment", "configSpec": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10", @@ -38,6 +38,8 @@ Creates a PostgreSQL cluster in the specified folder. "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -130,7 +132,7 @@ Creates a PostgreSQL cluster in the specified folder. "replicationSource": "string", "priority": "google.protobuf.Int64Value", "configSpec": { - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10", @@ -145,7 +147,9 @@ Creates a PostgreSQL cluster in the specified folder. "postgresqlConfig_15": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15", "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16", - "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C" + "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C" // end of the list of possible fields } } @@ -218,110 +222,124 @@ Host groups hosting VMs of the cluster. || || version | **string** Version of PostgreSQL used in the cluster. -Possible values: `9.6`, `10`, `10_1c`, `11`, `12`, `13`, `14`, `15` || +Possible values: `9.6`, `10`, `10_1c`, `11`, `12`, `13`, `14`, `15`, `16`, `17` || || postgresqlConfig_9_6 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql9_6.proto)** Configuration for a PostgreSQL 9.6 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration for a PostgreSQL 10 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration for a PostgreSQL 10 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration for a PostgreSQL 11 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration for a PostgreSQL 11 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration for a PostgreSQL 12 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration for a PostgreSQL 12 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration for a PostgreSQL 13 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration for a PostgreSQL 13 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration for a PostgreSQL 14 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration for a PostgreSQL 14 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration for a PostgreSQL 15 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration for a PostgreSQL 15 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration for a PostgreSQL 16 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration for a PostgreSQL 16 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration for a PostgreSQL 17 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration for a PostgreSQL 17 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** @@ -503,7 +521,7 @@ Set of permissions to grant to the user to access specific databases. || Maximum number of database connections that should be available to the user. -When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresql_config_12.effective_config.max_connections] setting. +When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresqlConfig_12.effectiveConfig.maxConnections](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.maxconnections.proto) setting. When used in transaction pooling, this setting limits the number of user's active transactions; therefore, in this mode user can open thousands of connections, but only `N` concurrent connections will be opened, where `N` is the value of the setting. @@ -753,77 +771,87 @@ Configuration of a PostgreSQL server for the host. || Configuration for a host with PostgreSQL 9.6 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host10_1c.proto)** Configuration for a host with PostgreSQL 10 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host10.proto)** Configuration for a host with PostgreSQL 10 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host11.proto)** Configuration for a host with PostgreSQL 11 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host11_1c.proto)** Configuration for a host with PostgreSQL 11 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host12.proto)** Configuration for a host with PostgreSQL 12 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host12_1c.proto)** Configuration for a host with PostgreSQL 12 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host13.proto)** Configuration for a host with PostgreSQL 13 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host13_1c.proto)** Configuration for a host with PostgreSQL 13 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host14.proto)** Configuration for a host with PostgreSQL 14 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host14_1c.proto)** Configuration for a host with PostgreSQL 14 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host15.proto)** Configuration for a host with PostgreSQL 15 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host15_1c.proto)** Configuration for a host with PostgreSQL 15 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host16.proto)** Configuration for a host with PostgreSQL 16 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host16_1c.proto)** Configuration for a host with PostgreSQL 16 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host17.proto)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host17_1c.proto)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || |# ## operation.Operation {#yandex.cloud.operation.Operation} @@ -858,7 +886,7 @@ Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c` ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10", @@ -874,6 +902,8 @@ Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c` "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -1108,105 +1138,119 @@ Version of PostgreSQL server software. || Configuration of a PostgreSQL 9.6 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration of a PostgreSQL 10 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration of a PostgreSQL 10 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration of a PostgreSQL 11 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration of a PostgreSQL 11 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration of a PostgreSQL 12 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration of a PostgreSQL 12 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration of a PostgreSQL 13 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration of a PostgreSQL 13 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration of a PostgreSQL 14 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration of a PostgreSQL 14 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration of a PostgreSQL 15 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration of a PostgreSQL 16 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration of a PostgreSQL 16 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig2)** diff --git a/ru/managed-postgresql/api-ref/grpc/Cluster/get.md b/ru/managed-postgresql/api-ref/grpc/Cluster/get.md index ca5dd311b59..05f61417141 100644 --- a/ru/managed-postgresql/api-ref/grpc/Cluster/get.md +++ b/ru/managed-postgresql/api-ref/grpc/Cluster/get.md @@ -49,7 +49,7 @@ To get the cluster ID use a [ClusterService.List](/docs/managed-postgresql/api-r ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10", @@ -65,6 +65,8 @@ To get the cluster ID use a [ClusterService.List](/docs/managed-postgresql/api-r "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -231,105 +233,119 @@ Version of PostgreSQL server software. || Configuration of a PostgreSQL 9.6 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration of a PostgreSQL 10 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration of a PostgreSQL 10 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration of a PostgreSQL 11 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration of a PostgreSQL 11 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration of a PostgreSQL 12 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration of a PostgreSQL 12 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration of a PostgreSQL 13 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration of a PostgreSQL 13 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration of a PostgreSQL 14 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration of a PostgreSQL 14 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration of a PostgreSQL 15 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration of a PostgreSQL 16 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration of a PostgreSQL 16 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** diff --git a/ru/managed-postgresql/api-ref/grpc/Cluster/list.md b/ru/managed-postgresql/api-ref/grpc/Cluster/list.md index 8a0c746fdab..abb7a7fe1da 100644 --- a/ru/managed-postgresql/api-ref/grpc/Cluster/list.md +++ b/ru/managed-postgresql/api-ref/grpc/Cluster/list.md @@ -69,7 +69,7 @@ The expression must specify: ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10", @@ -85,6 +85,8 @@ The expression must specify: "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -269,105 +271,119 @@ Version of PostgreSQL server software. || Configuration of a PostgreSQL 9.6 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration of a PostgreSQL 10 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration of a PostgreSQL 10 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration of a PostgreSQL 11 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration of a PostgreSQL 11 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration of a PostgreSQL 12 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration of a PostgreSQL 12 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration of a PostgreSQL 13 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration of a PostgreSQL 13 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration of a PostgreSQL 14 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration of a PostgreSQL 14 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration of a PostgreSQL 15 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration of a PostgreSQL 16 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration of a PostgreSQL 16 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** diff --git a/ru/managed-postgresql/api-ref/grpc/Cluster/listHosts.md b/ru/managed-postgresql/api-ref/grpc/Cluster/listHosts.md index 7ab5ef2fdbe..98dc8020700 100644 --- a/ru/managed-postgresql/api-ref/grpc/Cluster/listHosts.md +++ b/ru/managed-postgresql/api-ref/grpc/Cluster/listHosts.md @@ -64,7 +64,7 @@ returned by the previous list request. || "replicationSource": "string", "priority": "google.protobuf.Int64Value", "config": { - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10", @@ -79,7 +79,9 @@ returned by the previous list request. || "postgresqlConfig_15": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15", "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16", - "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C" + "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C" // end of the list of possible fields }, "assignPublicIp": "bool", @@ -218,105 +220,119 @@ Aggregated health of the service. If the field has default value, it is not retu Configuration for a host with PostgreSQL 9.6 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host10_1c.proto)** Configuration for a host with PostgreSQL 10 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host10.proto)** Configuration for a host with PostgreSQL 10 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host11.proto)** Configuration for a host with PostgreSQL 11 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host11_1c.proto)** Configuration for a host with PostgreSQL 11 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host12.proto)** Configuration for a host with PostgreSQL 12 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host12_1c.proto)** Configuration for a host with PostgreSQL 12 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host13.proto)** Configuration for a host with PostgreSQL 13 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host13_1c.proto)** Configuration for a host with PostgreSQL 13 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host14.proto)** Configuration for a host with PostgreSQL 14 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host14_1c.proto)** Configuration for a host with PostgreSQL 14 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host15.proto)** Configuration for a host with PostgreSQL 15 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host15_1c.proto)** Configuration for a host with PostgreSQL 15 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host16.proto)** Configuration for a host with PostgreSQL 16 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host16_1c.proto)** Configuration for a host with PostgreSQL 16 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL server for the host. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host17.proto)** + +Configuration for a host with PostgreSQL 17 server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL server for the host. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host17_1c.proto)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL server for the host. || |# \ No newline at end of file diff --git a/ru/managed-postgresql/api-ref/grpc/Cluster/move.md b/ru/managed-postgresql/api-ref/grpc/Cluster/move.md index 51ab012ec25..bf79d1c269a 100644 --- a/ru/managed-postgresql/api-ref/grpc/Cluster/move.md +++ b/ru/managed-postgresql/api-ref/grpc/Cluster/move.md @@ -64,7 +64,7 @@ Required field. ID of the destination folder. || ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10", @@ -80,6 +80,8 @@ Required field. ID of the destination folder. || "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -320,105 +322,119 @@ Version of PostgreSQL server software. || Configuration of a PostgreSQL 9.6 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration of a PostgreSQL 10 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration of a PostgreSQL 10 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration of a PostgreSQL 11 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration of a PostgreSQL 11 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration of a PostgreSQL 12 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration of a PostgreSQL 12 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration of a PostgreSQL 13 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration of a PostgreSQL 13 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration of a PostgreSQL 14 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration of a PostgreSQL 14 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration of a PostgreSQL 15 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration of a PostgreSQL 16 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration of a PostgreSQL 16 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** diff --git a/ru/managed-postgresql/api-ref/grpc/Cluster/rescheduleMaintenance.md b/ru/managed-postgresql/api-ref/grpc/Cluster/rescheduleMaintenance.md index 5909dc205e6..9b9665b555a 100644 --- a/ru/managed-postgresql/api-ref/grpc/Cluster/rescheduleMaintenance.md +++ b/ru/managed-postgresql/api-ref/grpc/Cluster/rescheduleMaintenance.md @@ -72,7 +72,7 @@ The time until which this maintenance operation should be delayed. The value sho ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10", @@ -88,6 +88,8 @@ The time until which this maintenance operation should be delayed. The value sho "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -327,105 +329,119 @@ Version of PostgreSQL server software. || Configuration of a PostgreSQL 9.6 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration of a PostgreSQL 10 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration of a PostgreSQL 10 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration of a PostgreSQL 11 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration of a PostgreSQL 11 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration of a PostgreSQL 12 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration of a PostgreSQL 12 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration of a PostgreSQL 13 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration of a PostgreSQL 13 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration of a PostgreSQL 14 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration of a PostgreSQL 14 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration of a PostgreSQL 15 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration of a PostgreSQL 16 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration of a PostgreSQL 16 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** diff --git a/ru/managed-postgresql/api-ref/grpc/Cluster/restore.md b/ru/managed-postgresql/api-ref/grpc/Cluster/restore.md index e83434031e7..0c4883a5bbb 100644 --- a/ru/managed-postgresql/api-ref/grpc/Cluster/restore.md +++ b/ru/managed-postgresql/api-ref/grpc/Cluster/restore.md @@ -24,7 +24,7 @@ Creates a new PostgreSQL cluster using the specified backup. "environment": "Environment", "configSpec": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10", @@ -40,6 +40,8 @@ Creates a new PostgreSQL cluster using the specified backup. "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -79,7 +81,7 @@ Creates a new PostgreSQL cluster using the specified backup. "replicationSource": "string", "priority": "google.protobuf.Int64Value", "configSpec": { - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10", @@ -94,7 +96,9 @@ Creates a new PostgreSQL cluster using the specified backup. "postgresqlConfig_15": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15", "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16", - "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C" + "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C" // end of the list of possible fields } } @@ -178,110 +182,124 @@ Host groups hosting VMs of the cluster. || || version | **string** Version of PostgreSQL used in the cluster. -Possible values: `9.6`, `10`, `10_1c`, `11`, `12`, `13`, `14`, `15` || +Possible values: `9.6`, `10`, `10_1c`, `11`, `12`, `13`, `14`, `15`, `16`, `17` || || postgresqlConfig_9_6 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql9_6.proto)** Configuration for a PostgreSQL 9.6 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration for a PostgreSQL 10 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration for a PostgreSQL 10 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration for a PostgreSQL 11 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration for a PostgreSQL 11 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration for a PostgreSQL 12 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration for a PostgreSQL 12 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration for a PostgreSQL 13 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration for a PostgreSQL 13 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration for a PostgreSQL 14 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration for a PostgreSQL 14 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration for a PostgreSQL 15 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration for a PostgreSQL 15 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration for a PostgreSQL 16 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration for a PostgreSQL 16 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration for a PostgreSQL 17 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration for a PostgreSQL 17 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** @@ -448,77 +466,87 @@ Configuration of a PostgreSQL server for the host. || Configuration for a host with PostgreSQL 9.6 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host10_1c.proto)** Configuration for a host with PostgreSQL 10 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host10.proto)** Configuration for a host with PostgreSQL 10 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host11.proto)** Configuration for a host with PostgreSQL 11 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host11_1c.proto)** Configuration for a host with PostgreSQL 11 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host12.proto)** Configuration for a host with PostgreSQL 12 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host12_1c.proto)** Configuration for a host with PostgreSQL 12 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host13.proto)** Configuration for a host with PostgreSQL 13 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host13_1c.proto)** Configuration for a host with PostgreSQL 13 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host14.proto)** Configuration for a host with PostgreSQL 14 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host14_1c.proto)** Configuration for a host with PostgreSQL 14 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host15.proto)** Configuration for a host with PostgreSQL 15 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host15_1c.proto)** Configuration for a host with PostgreSQL 15 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host16.proto)** Configuration for a host with PostgreSQL 16 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host16_1c.proto)** Configuration for a host with PostgreSQL 16 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host17.proto)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host17_1c.proto)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || |# ## operation.Operation {#yandex.cloud.operation.Operation} @@ -554,7 +582,7 @@ Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c` ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10", @@ -570,6 +598,8 @@ Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c` "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -807,105 +837,119 @@ Version of PostgreSQL server software. || Configuration of a PostgreSQL 9.6 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration of a PostgreSQL 10 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration of a PostgreSQL 10 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration of a PostgreSQL 11 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration of a PostgreSQL 11 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration of a PostgreSQL 12 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration of a PostgreSQL 12 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration of a PostgreSQL 13 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration of a PostgreSQL 13 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration of a PostgreSQL 14 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration of a PostgreSQL 14 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration of a PostgreSQL 15 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration of a PostgreSQL 16 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration of a PostgreSQL 16 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig2)** diff --git a/ru/managed-postgresql/api-ref/grpc/Cluster/start.md b/ru/managed-postgresql/api-ref/grpc/Cluster/start.md index 0eb45bcfeb3..710eaf5bbe8 100644 --- a/ru/managed-postgresql/api-ref/grpc/Cluster/start.md +++ b/ru/managed-postgresql/api-ref/grpc/Cluster/start.md @@ -58,7 +58,7 @@ Required field. ID of the PostgreSQL cluster to start. || ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10", @@ -74,6 +74,8 @@ Required field. ID of the PostgreSQL cluster to start. || "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -308,105 +310,119 @@ Version of PostgreSQL server software. || Configuration of a PostgreSQL 9.6 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration of a PostgreSQL 10 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration of a PostgreSQL 10 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration of a PostgreSQL 11 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration of a PostgreSQL 11 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration of a PostgreSQL 12 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration of a PostgreSQL 12 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration of a PostgreSQL 13 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration of a PostgreSQL 13 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration of a PostgreSQL 14 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration of a PostgreSQL 14 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration of a PostgreSQL 15 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration of a PostgreSQL 16 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration of a PostgreSQL 16 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** diff --git a/ru/managed-postgresql/api-ref/grpc/Cluster/startFailover.md b/ru/managed-postgresql/api-ref/grpc/Cluster/startFailover.md index 2f47012aa52..9d572d4a036 100644 --- a/ru/managed-postgresql/api-ref/grpc/Cluster/startFailover.md +++ b/ru/managed-postgresql/api-ref/grpc/Cluster/startFailover.md @@ -62,7 +62,7 @@ New master host. Switch to the most up-to-date replica if not provided. || ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10", @@ -78,6 +78,8 @@ New master host. Switch to the most up-to-date replica if not provided. || "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -312,105 +314,119 @@ Version of PostgreSQL server software. || Configuration of a PostgreSQL 9.6 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration of a PostgreSQL 10 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration of a PostgreSQL 10 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration of a PostgreSQL 11 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration of a PostgreSQL 11 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration of a PostgreSQL 12 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration of a PostgreSQL 12 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration of a PostgreSQL 13 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration of a PostgreSQL 13 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration of a PostgreSQL 14 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration of a PostgreSQL 14 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration of a PostgreSQL 15 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration of a PostgreSQL 16 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration of a PostgreSQL 16 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** diff --git a/ru/managed-postgresql/api-ref/grpc/Cluster/stop.md b/ru/managed-postgresql/api-ref/grpc/Cluster/stop.md index 17c62608d80..1a78a191720 100644 --- a/ru/managed-postgresql/api-ref/grpc/Cluster/stop.md +++ b/ru/managed-postgresql/api-ref/grpc/Cluster/stop.md @@ -58,7 +58,7 @@ Required field. ID of the PostgreSQL cluster to stop. || ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10", @@ -74,6 +74,8 @@ Required field. ID of the PostgreSQL cluster to stop. || "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -308,105 +310,119 @@ Version of PostgreSQL server software. || Configuration of a PostgreSQL 9.6 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration of a PostgreSQL 10 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration of a PostgreSQL 10 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration of a PostgreSQL 11 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration of a PostgreSQL 11 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration of a PostgreSQL 12 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration of a PostgreSQL 12 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration of a PostgreSQL 13 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration of a PostgreSQL 13 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration of a PostgreSQL 14 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration of a PostgreSQL 14 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration of a PostgreSQL 15 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration of a PostgreSQL 16 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration of a PostgreSQL 16 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** diff --git a/ru/managed-postgresql/api-ref/grpc/Cluster/update.md b/ru/managed-postgresql/api-ref/grpc/Cluster/update.md index d091a02a39d..49e460decc7 100644 --- a/ru/managed-postgresql/api-ref/grpc/Cluster/update.md +++ b/ru/managed-postgresql/api-ref/grpc/Cluster/update.md @@ -21,7 +21,7 @@ Updates the specified PostgreSQL cluster. "labels": "string", "configSpec": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10", @@ -37,6 +37,8 @@ Updates the specified PostgreSQL cluster. "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -132,110 +134,124 @@ ID of the network to move the cluster to. || || version | **string** Version of PostgreSQL used in the cluster. -Possible values: `9.6`, `10`, `10_1c`, `11`, `12`, `13`, `14`, `15` || +Possible values: `9.6`, `10`, `10_1c`, `11`, `12`, `13`, `14`, `15`, `16`, `17` || || postgresqlConfig_9_6 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql9_6.proto)** Configuration for a PostgreSQL 9.6 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration for a PostgreSQL 10 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration for a PostgreSQL 10 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration for a PostgreSQL 11 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration for a PostgreSQL 11 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration for a PostgreSQL 12 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration for a PostgreSQL 12 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration for a PostgreSQL 13 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration for a PostgreSQL 13 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration for a PostgreSQL 14 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration for a PostgreSQL 14 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration for a PostgreSQL 15 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration for a PostgreSQL 15 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration for a PostgreSQL 16 cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration for a PostgreSQL 16 1C cluster. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration for a PostgreSQL 17 cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration of a PostgreSQL cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration for a PostgreSQL 17 1C cluster. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration of a PostgreSQL cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig)** @@ -439,7 +455,7 @@ Hour of the day in UTC (in `HH` format). || ], "config": { "version": "string", - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10", @@ -455,6 +471,8 @@ Hour of the day in UTC (in `HH` format). || "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16", "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C", // end of the list of possible fields "poolerConfig": { "poolingMode": "PoolingMode", @@ -689,105 +707,119 @@ Version of PostgreSQL server software. || Configuration of a PostgreSQL 9.6 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10_1c.proto)** Configuration of a PostgreSQL 10 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql10.proto)** Configuration of a PostgreSQL 10 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11.proto)** Configuration of a PostgreSQL 11 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql11_1c.proto)** Configuration of a PostgreSQL 11 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.proto)** Configuration of a PostgreSQL 12 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12_1c.proto)** Configuration of a PostgreSQL 12 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13.proto)** Configuration of a PostgreSQL 13 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql13_1c.proto)** Configuration of a PostgreSQL 13 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14.proto)** Configuration of a PostgreSQL 14 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql14_1c.proto)** Configuration of a PostgreSQL 14 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15.proto)** Configuration of a PostgreSQL 15 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql15_1c.proto)** Configuration of a PostgreSQL 15 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16.proto)** Configuration of a PostgreSQL 16 server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql16_1c.proto)** Configuration of a PostgreSQL 16 1C server. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17.proto)** + +Configuration of a PostgreSQL 17 server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. + +Configuration for PostgreSQL servers in the cluster. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql17_1c.proto)** + +Configuration of a PostgreSQL 17 1C server. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. Configuration for PostgreSQL servers in the cluster. || || poolerConfig | **[ConnectionPoolerConfig](#yandex.cloud.mdb.postgresql.v1.ConnectionPoolerConfig2)** diff --git a/ru/managed-postgresql/api-ref/grpc/Cluster/updateHosts.md b/ru/managed-postgresql/api-ref/grpc/Cluster/updateHosts.md index 3dd20e9ec32..2657a333112 100644 --- a/ru/managed-postgresql/api-ref/grpc/Cluster/updateHosts.md +++ b/ru/managed-postgresql/api-ref/grpc/Cluster/updateHosts.md @@ -22,7 +22,7 @@ Updates the specified hosts. "replicationSource": "string", "priority": "google.protobuf.Int64Value", "configSpec": { - // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c` + // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c` "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6", "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C", "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10", @@ -37,7 +37,9 @@ Updates the specified hosts. "postgresqlConfig_15": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15", "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C", "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16", - "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C" + "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C", + "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17", + "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C" // end of the list of possible fields }, "updateMask": "google.protobuf.FieldMask", @@ -95,77 +97,87 @@ Whether the host should get a public IP address on creation. || Configuration for a host with PostgreSQL 9.6 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_10_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host10_1c.proto)** Configuration for a host with PostgreSQL 10 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_10 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host10.proto)** Configuration for a host with PostgreSQL 10 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_11 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host11.proto)** Configuration for a host with PostgreSQL 11 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_11_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host11_1c.proto)** Configuration for a host with PostgreSQL 11 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_12 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host12.proto)** Configuration for a host with PostgreSQL 12 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_12_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host12_1c.proto)** Configuration for a host with PostgreSQL 12 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_13 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host13.proto)** Configuration for a host with PostgreSQL 13 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_13_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host13_1c.proto)** Configuration for a host with PostgreSQL 13 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_14 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host14.proto)** Configuration for a host with PostgreSQL 14 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_14_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host14_1c.proto)** Configuration for a host with PostgreSQL 14 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_15 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host15.proto)** Configuration for a host with PostgreSQL 15 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_15_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host15_1c.proto)** Configuration for a host with PostgreSQL 15 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_16 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host16.proto)** Configuration for a host with PostgreSQL 16 server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || || postgresqlConfig_16_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host16_1c.proto)** Configuration for a host with PostgreSQL 16 1C server deployed. -Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`. || +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17 | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host17.proto)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || +|| postgresqlConfig_17_1c | **[yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/host17_1c.proto)** + +Configuration for a host with PostgreSQL 17 1C server deployed. + +Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`. || |# ## operation.Operation {#yandex.cloud.operation.Operation} diff --git a/ru/managed-postgresql/api-ref/grpc/User/create.md b/ru/managed-postgresql/api-ref/grpc/User/create.md index aa6ca7aa288..6fe9295380b 100644 --- a/ru/managed-postgresql/api-ref/grpc/User/create.md +++ b/ru/managed-postgresql/api-ref/grpc/User/create.md @@ -82,7 +82,7 @@ Set of permissions to grant to the user to access specific databases. || Maximum number of database connections that should be available to the user. -When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresql_config_12.effective_config.max_connections] setting. +When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresqlConfig_12.effectiveConfig.maxConnections](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.maxconnections.proto) setting. When used in transaction pooling, this setting limits the number of user's active transactions; therefore, in this mode user can open thousands of connections, but only `N` concurrent connections will be opened, where `N` is the value of the setting. @@ -427,7 +427,7 @@ Set of permissions granted to the user to access specific databases. || Maximum number of database connections available to the user. -When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresql_config_12.effective_config.max_connections] setting. +When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresqlConfig_12.effectiveConfig.maxConnections](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.maxconnections.proto) setting. When used in transaction pooling, this setting limits the number of user's active transactions; therefore, in this mode user can open thousands of connections, but only `N` concurrent connections will be opened, where `N` is the value of the setting. diff --git a/ru/managed-postgresql/api-ref/grpc/User/get.md b/ru/managed-postgresql/api-ref/grpc/User/get.md index 220e5ae514d..dd4d74ef05b 100644 --- a/ru/managed-postgresql/api-ref/grpc/User/get.md +++ b/ru/managed-postgresql/api-ref/grpc/User/get.md @@ -92,7 +92,7 @@ Set of permissions granted to the user to access specific databases. || Maximum number of database connections available to the user. -When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresql_config_12.effective_config.max_connections] setting. +When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresqlConfig_12.effectiveConfig.maxConnections](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.maxconnections.proto) setting. When used in transaction pooling, this setting limits the number of user's active transactions; therefore, in this mode user can open thousands of connections, but only `N` concurrent connections will be opened, where `N` is the value of the setting. diff --git a/ru/managed-postgresql/api-ref/grpc/User/grantPermission.md b/ru/managed-postgresql/api-ref/grpc/User/grantPermission.md index c1d21a7dff5..6d57d370cbc 100644 --- a/ru/managed-postgresql/api-ref/grpc/User/grantPermission.md +++ b/ru/managed-postgresql/api-ref/grpc/User/grantPermission.md @@ -190,7 +190,7 @@ Set of permissions granted to the user to access specific databases. || Maximum number of database connections available to the user. -When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresql_config_12.effective_config.max_connections] setting. +When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresqlConfig_12.effectiveConfig.maxConnections](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.maxconnections.proto) setting. When used in transaction pooling, this setting limits the number of user's active transactions; therefore, in this mode user can open thousands of connections, but only `N` concurrent connections will be opened, where `N` is the value of the setting. diff --git a/ru/managed-postgresql/api-ref/grpc/User/list.md b/ru/managed-postgresql/api-ref/grpc/User/list.md index 39c6577314d..54670be8e8f 100644 --- a/ru/managed-postgresql/api-ref/grpc/User/list.md +++ b/ru/managed-postgresql/api-ref/grpc/User/list.md @@ -116,7 +116,7 @@ Set of permissions granted to the user to access specific databases. || Maximum number of database connections available to the user. -When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresql_config_12.effective_config.max_connections] setting. +When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresqlConfig_12.effectiveConfig.maxConnections](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.maxconnections.proto) setting. When used in transaction pooling, this setting limits the number of user's active transactions; therefore, in this mode user can open thousands of connections, but only `N` concurrent connections will be opened, where `N` is the value of the setting. diff --git a/ru/managed-postgresql/api-ref/grpc/User/revokePermission.md b/ru/managed-postgresql/api-ref/grpc/User/revokePermission.md index e22f309cfec..0fa1aa2d0da 100644 --- a/ru/managed-postgresql/api-ref/grpc/User/revokePermission.md +++ b/ru/managed-postgresql/api-ref/grpc/User/revokePermission.md @@ -178,7 +178,7 @@ Set of permissions granted to the user to access specific databases. || Maximum number of database connections available to the user. -When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresql_config_12.effective_config.max_connections] setting. +When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresqlConfig_12.effectiveConfig.maxConnections](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.maxconnections.proto) setting. When used in transaction pooling, this setting limits the number of user's active transactions; therefore, in this mode user can open thousands of connections, but only `N` concurrent connections will be opened, where `N` is the value of the setting. diff --git a/ru/managed-postgresql/api-ref/grpc/User/update.md b/ru/managed-postgresql/api-ref/grpc/User/update.md index 3af8b836098..6102125c235 100644 --- a/ru/managed-postgresql/api-ref/grpc/User/update.md +++ b/ru/managed-postgresql/api-ref/grpc/User/update.md @@ -76,7 +76,7 @@ Set of permissions granted to the user to access specific databases. || Maximum number of database connections available to the user. -When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresqlConfig.maxConnections](/docs/managed-postgresql/api-ref/grpc/Cluster/get#yandex.cloud.mdb.postgresql.v1.ClusterConfig.postgresqlConfig) setting. +When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresql_config.max_connections] setting. When used in transaction pooling, this setting limits the number of user's active transactions; therefore, in this mode user can open thousands of connections, but only `N` concurrent connections will be opened, where `N` is the value of the setting. @@ -418,7 +418,7 @@ Set of permissions granted to the user to access specific databases. || Maximum number of database connections available to the user. -When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresql_config_12.effective_config.max_connections] setting. +When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the [Cluster.config.postgresqlConfig_12.effectiveConfig.maxConnections](https://github.com/yandex-cloud/cloudapi/blob/master/yandex/cloud/mdb/postgresql/v1/config/postgresql12.maxconnections.proto) setting. When used in transaction pooling, this setting limits the number of user's active transactions; therefore, in this mode user can open thousands of connections, but only `N` concurrent connections will be opened, where `N` is the value of the setting. diff --git a/ru/managed-postgresql/operations/extensions/cluster-extensions.md b/ru/managed-postgresql/operations/extensions/cluster-extensions.md index 057a0842bad..0efa75718e4 100644 --- a/ru/managed-postgresql/operations/extensions/cluster-extensions.md +++ b/ru/managed-postgresql/operations/extensions/cluster-extensions.md @@ -19,7 +19,8 @@ * `pg_cron` — необходима для работы [расширения pg_cron](https://github.com/citusdata/pg_cron); * `pg_hint_plan` — необходима для работы [расширения pg_hint_plan](https://pghintplan.osdn.jp/pg_hint_plan.html); * `pg_qualstats` — необходима для работы [расширения pg_qualstats](https://github.com/powa-team/pg_qualstats); -* `timescaledb` — необходима для использования [расширения TimescaleDB](https://github.com/timescale/timescaledb). +* `timescaledb` — необходима для использования [расширения TimescaleDB](https://github.com/timescale/timescaledb); +* `anon` — необходима для использования [расширения postgresql_anonymizer](https://postgresql-anonymizer.readthedocs.io/en/stable/). {% note warning %} @@ -327,6 +328,7 @@ ||

    [postgis_tiger_geocoder](https://postgis.net/docs/postgis_installation.html#loading_extras_tiger_geocoder)

    Содержит функции для геокодирования на основе данных в формате [TIGER](https://wiki.openstreetmap.org/wiki/TIGER).

    | 2.5.2 | 3.0.0 | 3.1.4 | 3.1.4 | 3.3.2 | 3.4.0 || ||

    [postgis_topology](https://postgis.net/docs/Topology.html)

    Содержит типы данных и функции расширения `postgis` для управления топологическими объектами.

    | 2.5.2 | 3.0.0 | 3.1.4 | 3.1.4 | 3.3.2 | 3.4.0 || ||

    [postgres_fdw]({{ pg-docs }}/static/postgres-fdw.html)

    Добавляет поддержку [Foreign Data Wrapper](https://wiki.postgresql.org/wiki/Foreign_data_wrappers) для доступа к внешним серверам {{ PG }}.

    Для использования расширения необходима [роль `mdb_admin`](../../concepts/roles.md#mdb-admin).

    | 1.0 | 1.0 | 1.0 | 1.1 | 1.1 | 1.1 || +||

    [postgresql_anonymizer](https://postgresql-anonymizer.readthedocs.io/en/stable/)

    Позволяет замаскировать или заменить данные в базе данных {{ PG }}.

    Требует [подключения библиотеки общего пользования](#libraries-connection) `anon`.

    Для использования расширения необходима [роль `mdb_admin`](../../concepts/roles.md#mdb-admin).

    | - | - | - | - | 1.3.2 | 1.3.2 || ||

    [rum](https://github.com/postgrespro/rum)

    Добавляет метод доступа для работы с индексами `RUM`.

    | 1.3 | 1.3 | 1.3 | 1.3 | 1.3 | 1.3 || ||

    [seg]({{ pg-docs }}/static/seg.html)

    Содержит тип данных `seg` для представления отрезков линий или интервалов с плавающей запятой.

    | 1.3 | 1.3 | 1.3 | 1.4 | 1.4 | 1.4 || ||

    [smlar](http://sigaev.ru/git/gitweb.cgi?p=smlar.git;a=blob;hb=HEAD;f=README)

    Содержит набор функций для определения сходства массивов.

    | 1.0 | 1.0 | 1.0 | 1.0 | 1.0 | 1.0 || diff --git a/ru/managed-postgresql/operations/extensions/pg_anon.md b/ru/managed-postgresql/operations/extensions/pg_anon.md new file mode 100644 index 00000000000..21680f9bdda --- /dev/null +++ b/ru/managed-postgresql/operations/extensions/pg_anon.md @@ -0,0 +1,84 @@ +# Использование postgresql_anonymizer в {{ mpg-name }} + +Расширение `postgresql_anonymizer` позволяет замаскировать или заменить в базе данных {{ PG }} персональные данные или информацию, составляющую коммерческую тайну. + +Для анонимизации используется декларативный подход: можно объявить правила маскирования с помощью DDL и задать стратегию анонимизации в определении таблицы. + +Способы анонимизации данных: + + * [Статическое маскирование](https://postgresql-anonymizer.readthedocs.io/en/stable/static_masking/) — заменяет конфиденциальные данные другими в соответствии с правилами маскирования. Восстановить исходные данные невозможно. + * [Обобщение](https://postgresql-anonymizer.readthedocs.io/en/stable/generalization/) — заменяет значение (число или дату) диапазоном, который содержит это значение. + +## Установить расширение postgresql_anonymizer в кластер {{ PG }} {#anon-install} + +Чтобы установить расширение `postgresql_anonymizer` в кластер {{ PG }}: + +1. [Подключите к кластеру библиотеку общего пользования](./cluster-extensions.md#libraries-connection) с именем `anon`. +1. [Добавьте расширение](./cluster-extensions.md#update-extensions) `anon` к базе данных. + +1. [Назначьте владельцу этой базы данных](../grant.md#grant-role) роль `mdb_admin`, если это еще не сделано. + + Имя владельца можно запросить со [списком баз данных в кластере](../databases.md#list-db). + +Подробнее о расширении `postgresql_anonymizer` см. в [официальной документации](https://postgresql-anonymizer.readthedocs.io/en/stable/). + +## Пример использования {#usage-example} + +В примере используется статическое маскирование: данные заменяются другими по правилам маскирования. + +1. [Подключитесь к базе данных](../connect.md#bash) с помощью утилиты `psql`. + +1. Создайте таблицу `employees` и наполните ее данными: + + ```sql + CREATE TABLE employees ( + id SERIAL, + name TEXT, + company TEXT, + code TEXT + ); + + INSERT INTO employees + VALUES + (111,'Maria Belova','Bank of Saratov','405-657'), + (222,'Pavel Petrov','Head and Hands','601-245') + ; + ``` + +1. Проверьте результат: + + ```sql + SELECT * FROM employees; + ``` + + ```text + id | name | company | code + ----+------------------+-----------------+----------- + 111 | Maria Belova | Bank of Saratov | 405-657 + 222 | Pavel Petrov | Head and Hands | 601-245 + ``` + +1. Объявите правила маскирования: + + ```sql + SECURITY LABEL FOR anon ON COLUMN employees.company + IS 'MASKED WITH FUNCTION anon.fake_company()'; + + SECURITY LABEL FOR anon ON COLUMN employees.code + IS 'MASKED WITH FUNCTION anon.random_zip()'; + ``` + +1. Замените данные в замаскированных столбцах: + + ```sql + SELECT anon.anonymize_database(); + ``` + +1. Убедитесь, что данные в столбцах `company` и `code` изменились: + + ```text + id | name | company | code + ----+------------------+----------------------------------+--------- + 111 | Maria Belova | Schneider, Phillips and Martinez | 82175 + 222 | Pavel Petrov | White, Hines and Ramos | 49306 + ``` \ No newline at end of file diff --git a/ru/managed-postgresql/operations/index.md b/ru/managed-postgresql/operations/index.md index a394f42069b..ee5d112e7fe 100644 --- a/ru/managed-postgresql/operations/index.md +++ b/ru/managed-postgresql/operations/index.md @@ -38,6 +38,7 @@ description: На странице представлен список поша * [Использование pg_repack](./extensions/pg_repack.md) * [Использование pgaudit](./extensions/pgaudit.md) * [Использование pgcrypto](./extensions/pgcrypto.md) +* [Использование postgresql_anonymizer](./extensions/pg_anon.md) * [Использование словаря Hunspell для полнотекстового поиска](./extensions/hunspell.md) ## Логи и мониторинг {#logs-and-monitoring} diff --git a/ru/managed-postgresql/toc.yaml b/ru/managed-postgresql/toc.yaml index ddd9ef7d7e4..0147ca8ba41 100644 --- a/ru/managed-postgresql/toc.yaml +++ b/ru/managed-postgresql/toc.yaml @@ -59,6 +59,8 @@ items: href: operations/extensions/pgaudit.md - name: pgcrypto href: operations/extensions/pgcrypto.md + - name: postgresql_anonymizer + href: operations/extensions/pg_anon.md - name: Словари от Hunspell для полнотекстового поиска href: operations/extensions/hunspell.md - name: Логи и мониторинг diff --git a/ru/managed-redis/api-ref/Cluster/backup.md b/ru/managed-redis/api-ref/Cluster/backup.md index 60609e7559d..ec02a03f6bd 100644 --- a/ru/managed-redis/api-ref/Cluster/backup.md +++ b/ru/managed-redis/api-ref/Cluster/backup.md @@ -341,7 +341,16 @@ To get the Redis cluster ID, use a [ClusterService.List](/docs/managed-redis/api "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "userConfig": { "maxmemoryPolicy": "string", @@ -361,7 +370,16 @@ To get the Redis cluster ID, use a [ClusterService.List](/docs/managed-redis/api "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "defaultConfig": { "maxmemoryPolicy": "string", @@ -381,7 +399,16 @@ To get the Redis cluster ID, use a [ClusterService.List](/docs/managed-redis/api "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" } }, "diskSizeAutoscaling": { @@ -1148,6 +1175,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **string** (int64) Redis maxmemory percent || +|| luaTimeLimit | **string** (int64) + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **string** (int64) + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **boolean** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **boolean** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **boolean** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **string** (int64) + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **string** (int64) + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **boolean** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **boolean** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit} diff --git a/ru/managed-redis/api-ref/Cluster/create.md b/ru/managed-redis/api-ref/Cluster/create.md index 6761f86e892..65d13ad44ae 100644 --- a/ru/managed-redis/api-ref/Cluster/create.md +++ b/ru/managed-redis/api-ref/Cluster/create.md @@ -137,7 +137,16 @@ POST https://{{ api-host-mdb }}/managed-redis/v1/clusters "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "diskSizeAutoscaling": { "plannedUsageThreshold": "string", @@ -665,6 +674,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **string** (int64) Redis maxmemory percent || +|| luaTimeLimit | **string** (int64) + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **string** (int64) + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **boolean** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **boolean** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **boolean** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **string** (int64) + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **string** (int64) + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **boolean** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **boolean** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit} @@ -1091,7 +1127,16 @@ Hour of the day in UTC (in `HH` format). || "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "userConfig": { "maxmemoryPolicy": "string", @@ -1111,7 +1156,16 @@ Hour of the day in UTC (in `HH` format). || "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "defaultConfig": { "maxmemoryPolicy": "string", @@ -1131,7 +1185,16 @@ Hour of the day in UTC (in `HH` format). || "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" } }, "diskSizeAutoscaling": { @@ -1898,6 +1961,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **string** (int64) Redis maxmemory percent || +|| luaTimeLimit | **string** (int64) + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **string** (int64) + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **boolean** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **boolean** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **boolean** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **string** (int64) + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **string** (int64) + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **boolean** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **boolean** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit2} diff --git a/ru/managed-redis/api-ref/Cluster/enableSharding.md b/ru/managed-redis/api-ref/Cluster/enableSharding.md index 13a7f6d8387..d472eb0d2ed 100644 --- a/ru/managed-redis/api-ref/Cluster/enableSharding.md +++ b/ru/managed-redis/api-ref/Cluster/enableSharding.md @@ -340,7 +340,16 @@ Required field. Required. ID of the Redis cluster to return. || "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "userConfig": { "maxmemoryPolicy": "string", @@ -360,7 +369,16 @@ Required field. Required. ID of the Redis cluster to return. || "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "defaultConfig": { "maxmemoryPolicy": "string", @@ -380,7 +398,16 @@ Required field. Required. ID of the Redis cluster to return. || "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" } }, "diskSizeAutoscaling": { @@ -1145,6 +1172,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **string** (int64) Redis maxmemory percent || +|| luaTimeLimit | **string** (int64) + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **string** (int64) + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **boolean** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **boolean** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **boolean** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **string** (int64) + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **string** (int64) + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **boolean** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **boolean** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit} diff --git a/ru/managed-redis/api-ref/Cluster/get.md b/ru/managed-redis/api-ref/Cluster/get.md index 64a08889b5a..39ac4b69433 100644 --- a/ru/managed-redis/api-ref/Cluster/get.md +++ b/ru/managed-redis/api-ref/Cluster/get.md @@ -325,7 +325,16 @@ To get the cluster ID use a [ClusterService.List](/docs/managed-redis/api-ref/Cl "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "userConfig": { "maxmemoryPolicy": "string", @@ -345,7 +354,16 @@ To get the cluster ID use a [ClusterService.List](/docs/managed-redis/api-ref/Cl "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "defaultConfig": { "maxmemoryPolicy": "string", @@ -365,7 +383,16 @@ To get the cluster ID use a [ClusterService.List](/docs/managed-redis/api-ref/Cl "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" } }, "diskSizeAutoscaling": { @@ -1033,6 +1060,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **string** (int64) Redis maxmemory percent || +|| luaTimeLimit | **string** (int64) + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **string** (int64) + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **boolean** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **boolean** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **boolean** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **string** (int64) + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **string** (int64) + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **boolean** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **boolean** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit} diff --git a/ru/managed-redis/api-ref/Cluster/list.md b/ru/managed-redis/api-ref/Cluster/list.md index 5b883535957..89f1dfbc93d 100644 --- a/ru/managed-redis/api-ref/Cluster/list.md +++ b/ru/managed-redis/api-ref/Cluster/list.md @@ -342,7 +342,16 @@ The expression must specify: "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "userConfig": { "maxmemoryPolicy": "string", @@ -362,7 +371,16 @@ The expression must specify: "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "defaultConfig": { "maxmemoryPolicy": "string", @@ -382,7 +400,16 @@ The expression must specify: "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" } }, "diskSizeAutoscaling": { @@ -1068,6 +1095,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **string** (int64) Redis maxmemory percent || +|| luaTimeLimit | **string** (int64) + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **string** (int64) + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **boolean** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **boolean** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **boolean** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **string** (int64) + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **string** (int64) + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **boolean** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **boolean** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit} diff --git a/ru/managed-redis/api-ref/Cluster/move.md b/ru/managed-redis/api-ref/Cluster/move.md index 5c8bc4053f3..116ad14f207 100644 --- a/ru/managed-redis/api-ref/Cluster/move.md +++ b/ru/managed-redis/api-ref/Cluster/move.md @@ -357,7 +357,16 @@ Required field. ID of the destination folder. || "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "userConfig": { "maxmemoryPolicy": "string", @@ -377,7 +386,16 @@ Required field. ID of the destination folder. || "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "defaultConfig": { "maxmemoryPolicy": "string", @@ -397,7 +415,16 @@ Required field. ID of the destination folder. || "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" } }, "diskSizeAutoscaling": { @@ -1170,6 +1197,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **string** (int64) Redis maxmemory percent || +|| luaTimeLimit | **string** (int64) + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **string** (int64) + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **boolean** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **boolean** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **boolean** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **string** (int64) + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **string** (int64) + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **boolean** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **boolean** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit} diff --git a/ru/managed-redis/api-ref/Cluster/rebalance.md b/ru/managed-redis/api-ref/Cluster/rebalance.md index efbdf9a97a9..5c4f4023f64 100644 --- a/ru/managed-redis/api-ref/Cluster/rebalance.md +++ b/ru/managed-redis/api-ref/Cluster/rebalance.md @@ -341,7 +341,16 @@ To get the cluster ID use a [ClusterService.List](/docs/managed-redis/api-ref/Cl "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "userConfig": { "maxmemoryPolicy": "string", @@ -361,7 +370,16 @@ To get the cluster ID use a [ClusterService.List](/docs/managed-redis/api-ref/Cl "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "defaultConfig": { "maxmemoryPolicy": "string", @@ -381,7 +399,16 @@ To get the cluster ID use a [ClusterService.List](/docs/managed-redis/api-ref/Cl "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" } }, "diskSizeAutoscaling": { @@ -1148,6 +1175,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **string** (int64) Redis maxmemory percent || +|| luaTimeLimit | **string** (int64) + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **string** (int64) + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **boolean** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **boolean** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **boolean** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **string** (int64) + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **string** (int64) + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **boolean** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **boolean** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit} diff --git a/ru/managed-redis/api-ref/Cluster/rescheduleMaintenance.md b/ru/managed-redis/api-ref/Cluster/rescheduleMaintenance.md index d7114fd39d6..64adfdbd279 100644 --- a/ru/managed-redis/api-ref/Cluster/rescheduleMaintenance.md +++ b/ru/managed-redis/api-ref/Cluster/rescheduleMaintenance.md @@ -372,7 +372,16 @@ In some languages, built-in datetime utilities do not support nanosecond precisi "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "userConfig": { "maxmemoryPolicy": "string", @@ -392,7 +401,16 @@ In some languages, built-in datetime utilities do not support nanosecond precisi "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "defaultConfig": { "maxmemoryPolicy": "string", @@ -412,7 +430,16 @@ In some languages, built-in datetime utilities do not support nanosecond precisi "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" } }, "diskSizeAutoscaling": { @@ -1189,6 +1216,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **string** (int64) Redis maxmemory percent || +|| luaTimeLimit | **string** (int64) + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **string** (int64) + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **boolean** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **boolean** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **boolean** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **string** (int64) + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **string** (int64) + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **boolean** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **boolean** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit} diff --git a/ru/managed-redis/api-ref/Cluster/restore.md b/ru/managed-redis/api-ref/Cluster/restore.md index 3d8dc1c26c2..8f41490f0db 100644 --- a/ru/managed-redis/api-ref/Cluster/restore.md +++ b/ru/managed-redis/api-ref/Cluster/restore.md @@ -137,7 +137,16 @@ POST https://{{ api-host-mdb }}/managed-redis/v1/clusters:restore "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "diskSizeAutoscaling": { "plannedUsageThreshold": "string", @@ -667,6 +676,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **string** (int64) Redis maxmemory percent || +|| luaTimeLimit | **string** (int64) + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **string** (int64) + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **boolean** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **boolean** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **boolean** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **string** (int64) + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **string** (int64) + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **boolean** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **boolean** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit} @@ -1094,7 +1130,16 @@ Hour of the day in UTC (in `HH` format). || "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "userConfig": { "maxmemoryPolicy": "string", @@ -1114,7 +1159,16 @@ Hour of the day in UTC (in `HH` format). || "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "defaultConfig": { "maxmemoryPolicy": "string", @@ -1134,7 +1188,16 @@ Hour of the day in UTC (in `HH` format). || "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" } }, "diskSizeAutoscaling": { @@ -1904,6 +1967,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **string** (int64) Redis maxmemory percent || +|| luaTimeLimit | **string** (int64) + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **string** (int64) + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **boolean** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **boolean** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **boolean** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **string** (int64) + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **string** (int64) + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **boolean** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **boolean** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit2} diff --git a/ru/managed-redis/api-ref/Cluster/start.md b/ru/managed-redis/api-ref/Cluster/start.md index dcda7e61a2f..58975f9062a 100644 --- a/ru/managed-redis/api-ref/Cluster/start.md +++ b/ru/managed-redis/api-ref/Cluster/start.md @@ -340,7 +340,16 @@ Required field. ID of the Redis cluster to start. || "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "userConfig": { "maxmemoryPolicy": "string", @@ -360,7 +369,16 @@ Required field. ID of the Redis cluster to start. || "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "defaultConfig": { "maxmemoryPolicy": "string", @@ -380,7 +398,16 @@ Required field. ID of the Redis cluster to start. || "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" } }, "diskSizeAutoscaling": { @@ -1147,6 +1174,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **string** (int64) Redis maxmemory percent || +|| luaTimeLimit | **string** (int64) + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **string** (int64) + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **boolean** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **boolean** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **boolean** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **string** (int64) + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **string** (int64) + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **boolean** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **boolean** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit} diff --git a/ru/managed-redis/api-ref/Cluster/startFailover.md b/ru/managed-redis/api-ref/Cluster/startFailover.md index 7bf4ff3e15b..bbf8326c196 100644 --- a/ru/managed-redis/api-ref/Cluster/startFailover.md +++ b/ru/managed-redis/api-ref/Cluster/startFailover.md @@ -360,7 +360,16 @@ List of hostnames which should not be masters. Can be empty for sentinel cluster "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "userConfig": { "maxmemoryPolicy": "string", @@ -380,7 +389,16 @@ List of hostnames which should not be masters. Can be empty for sentinel cluster "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "defaultConfig": { "maxmemoryPolicy": "string", @@ -400,7 +418,16 @@ List of hostnames which should not be masters. Can be empty for sentinel cluster "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" } }, "diskSizeAutoscaling": { @@ -1170,6 +1197,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **string** (int64) Redis maxmemory percent || +|| luaTimeLimit | **string** (int64) + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **string** (int64) + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **boolean** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **boolean** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **boolean** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **string** (int64) + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **string** (int64) + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **boolean** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **boolean** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit} diff --git a/ru/managed-redis/api-ref/Cluster/stop.md b/ru/managed-redis/api-ref/Cluster/stop.md index 9e3de160756..e65c5e6eebb 100644 --- a/ru/managed-redis/api-ref/Cluster/stop.md +++ b/ru/managed-redis/api-ref/Cluster/stop.md @@ -340,7 +340,16 @@ Required field. ID of the Redis cluster to stop. || "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "userConfig": { "maxmemoryPolicy": "string", @@ -360,7 +369,16 @@ Required field. ID of the Redis cluster to stop. || "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "defaultConfig": { "maxmemoryPolicy": "string", @@ -380,7 +398,16 @@ Required field. ID of the Redis cluster to stop. || "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" } }, "diskSizeAutoscaling": { @@ -1147,6 +1174,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **string** (int64) Redis maxmemory percent || +|| luaTimeLimit | **string** (int64) + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **string** (int64) + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **boolean** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **boolean** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **boolean** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **string** (int64) + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **string** (int64) + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **boolean** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **boolean** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit} diff --git a/ru/managed-redis/api-ref/Cluster/streamLogs.md b/ru/managed-redis/api-ref/Cluster/streamLogs.md index 810e004b71a..fd4a63061a2 100644 --- a/ru/managed-redis/api-ref/Cluster/streamLogs.md +++ b/ru/managed-redis/api-ref/Cluster/streamLogs.md @@ -63,7 +63,7 @@ request to start streaming from next log record. || A filter expression that filters resources listed in the response. The expression must specify: -1. The field name. Currently filtering can be applied to the [LogRecord.logs.hostname](/docs/compute/api-ref/Instance/create#yandex.cloud.compute.v1.CreateInstanceRequest) field +1. The field name. Currently filtering can be applied to the [LogRecord.logs.hostname] field 2. An `=` operator. 3. The value in double quotes (`"`). Must be 3-63 characters long and match the regular expression `[a-z][-a-z0-9]{1,61}[a-z0-9]`. Examples of a filter `message.hostname='node1.db.cloud.yandex.net'`. || diff --git a/ru/managed-redis/api-ref/Cluster/update.md b/ru/managed-redis/api-ref/Cluster/update.md index 7baf07f4af8..efebd30f841 100644 --- a/ru/managed-redis/api-ref/Cluster/update.md +++ b/ru/managed-redis/api-ref/Cluster/update.md @@ -145,7 +145,16 @@ To get the Redis cluster ID, use a [ClusterService.List](/docs/managed-redis/api "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "diskSizeAutoscaling": { "plannedUsageThreshold": "string", @@ -655,6 +664,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **string** (int64) Redis maxmemory percent || +|| luaTimeLimit | **string** (int64) + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **string** (int64) + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **boolean** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **boolean** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **boolean** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **string** (int64) + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **string** (int64) + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **boolean** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **boolean** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit} @@ -1050,7 +1086,16 @@ Hour of the day in UTC (in `HH` format). || "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "userConfig": { "maxmemoryPolicy": "string", @@ -1070,7 +1115,16 @@ Hour of the day in UTC (in `HH` format). || "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" }, "defaultConfig": { "maxmemoryPolicy": "string", @@ -1090,7 +1144,16 @@ Hour of the day in UTC (in `HH` format). || "softLimit": "string", "softSeconds": "string" }, - "maxmemoryPercent": "string" + "maxmemoryPercent": "string", + "luaTimeLimit": "string", + "replBacklogSizePercent": "string", + "clusterRequireFullCoverage": "boolean", + "clusterAllowReadsWhenDown": "boolean", + "clusterAllowPubsubshardWhenDown": "boolean", + "lfuDecayTime": "string", + "lfuLogFactor": "string", + "turnBeforeSwitchover": "boolean", + "allowDataLoss": "boolean" } }, "diskSizeAutoscaling": { @@ -1857,6 +1920,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **string** (int64) Redis maxmemory percent || +|| luaTimeLimit | **string** (int64) + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **string** (int64) + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **boolean** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **boolean** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **boolean** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **string** (int64) + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **string** (int64) + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **boolean** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **boolean** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit2} diff --git a/ru/managed-redis/api-ref/grpc/Cluster/backup.md b/ru/managed-redis/api-ref/grpc/Cluster/backup.md index 0f358f4d497..d51bb6b192a 100644 --- a/ru/managed-redis/api-ref/grpc/Cluster/backup.md +++ b/ru/managed-redis/api-ref/grpc/Cluster/backup.md @@ -332,7 +332,16 @@ To get the Redis cluster ID, use a [ClusterService.List](/docs/managed-redis/api "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "userConfig": { "maxmemoryPolicy": "MaxmemoryPolicy", @@ -352,7 +361,16 @@ To get the Redis cluster ID, use a [ClusterService.List](/docs/managed-redis/api "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "defaultConfig": { "maxmemoryPolicy": "MaxmemoryPolicy", @@ -372,7 +390,16 @@ To get the Redis cluster ID, use a [ClusterService.List](/docs/managed-redis/api "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" } }, "diskSizeAutoscaling": { @@ -1077,6 +1104,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** Redis maxmemory percent || +|| luaTimeLimit | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit} diff --git a/ru/managed-redis/api-ref/grpc/Cluster/create.md b/ru/managed-redis/api-ref/grpc/Cluster/create.md index fe912d1e5ba..24ba456f14b 100644 --- a/ru/managed-redis/api-ref/grpc/Cluster/create.md +++ b/ru/managed-redis/api-ref/grpc/Cluster/create.md @@ -130,7 +130,16 @@ Creates a Redis cluster in the specified folder. "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "diskSizeAutoscaling": { "plannedUsageThreshold": "google.protobuf.Int64Value", @@ -634,6 +643,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** Redis maxmemory percent || +|| luaTimeLimit | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit} @@ -1054,7 +1090,16 @@ Hour of the day in UTC (in `HH` format). || "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "userConfig": { "maxmemoryPolicy": "MaxmemoryPolicy", @@ -1074,7 +1119,16 @@ Hour of the day in UTC (in `HH` format). || "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "defaultConfig": { "maxmemoryPolicy": "MaxmemoryPolicy", @@ -1094,7 +1148,16 @@ Hour of the day in UTC (in `HH` format). || "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" } }, "diskSizeAutoscaling": { @@ -1799,6 +1862,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** Redis maxmemory percent || +|| luaTimeLimit | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit2} diff --git a/ru/managed-redis/api-ref/grpc/Cluster/enableSharding.md b/ru/managed-redis/api-ref/grpc/Cluster/enableSharding.md index 86d5149e42d..b941dd7ea04 100644 --- a/ru/managed-redis/api-ref/grpc/Cluster/enableSharding.md +++ b/ru/managed-redis/api-ref/grpc/Cluster/enableSharding.md @@ -331,7 +331,16 @@ Required field. Required. ID of the Redis cluster to return. || "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "userConfig": { "maxmemoryPolicy": "MaxmemoryPolicy", @@ -351,7 +360,16 @@ Required field. Required. ID of the Redis cluster to return. || "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "defaultConfig": { "maxmemoryPolicy": "MaxmemoryPolicy", @@ -371,7 +389,16 @@ Required field. Required. ID of the Redis cluster to return. || "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" } }, "diskSizeAutoscaling": { @@ -1074,6 +1101,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** Redis maxmemory percent || +|| luaTimeLimit | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit} diff --git a/ru/managed-redis/api-ref/grpc/Cluster/get.md b/ru/managed-redis/api-ref/grpc/Cluster/get.md index 5644855cd70..2fa56415875 100644 --- a/ru/managed-redis/api-ref/grpc/Cluster/get.md +++ b/ru/managed-redis/api-ref/grpc/Cluster/get.md @@ -322,7 +322,16 @@ To get the cluster ID use a [ClusterService.List](/docs/managed-redis/api-ref/gr "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "userConfig": { "maxmemoryPolicy": "MaxmemoryPolicy", @@ -342,7 +351,16 @@ To get the cluster ID use a [ClusterService.List](/docs/managed-redis/api-ref/gr "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "defaultConfig": { "maxmemoryPolicy": "MaxmemoryPolicy", @@ -362,7 +380,16 @@ To get the cluster ID use a [ClusterService.List](/docs/managed-redis/api-ref/gr "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" } }, "diskSizeAutoscaling": { @@ -999,6 +1026,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** Redis maxmemory percent || +|| luaTimeLimit | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit} diff --git a/ru/managed-redis/api-ref/grpc/Cluster/list.md b/ru/managed-redis/api-ref/grpc/Cluster/list.md index 3b435d7875f..6d9cc17a5e1 100644 --- a/ru/managed-redis/api-ref/grpc/Cluster/list.md +++ b/ru/managed-redis/api-ref/grpc/Cluster/list.md @@ -342,7 +342,16 @@ The expression must specify: "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "userConfig": { "maxmemoryPolicy": "MaxmemoryPolicy", @@ -362,7 +371,16 @@ The expression must specify: "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "defaultConfig": { "maxmemoryPolicy": "MaxmemoryPolicy", @@ -382,7 +400,16 @@ The expression must specify: "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" } }, "diskSizeAutoscaling": { @@ -1037,6 +1064,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** Redis maxmemory percent || +|| luaTimeLimit | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit} diff --git a/ru/managed-redis/api-ref/grpc/Cluster/move.md b/ru/managed-redis/api-ref/grpc/Cluster/move.md index 7a241ac804f..773ae52fb3a 100644 --- a/ru/managed-redis/api-ref/grpc/Cluster/move.md +++ b/ru/managed-redis/api-ref/grpc/Cluster/move.md @@ -337,7 +337,16 @@ Required field. ID of the destination folder. || "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "userConfig": { "maxmemoryPolicy": "MaxmemoryPolicy", @@ -357,7 +366,16 @@ Required field. ID of the destination folder. || "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "defaultConfig": { "maxmemoryPolicy": "MaxmemoryPolicy", @@ -377,7 +395,16 @@ Required field. ID of the destination folder. || "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" } }, "diskSizeAutoscaling": { @@ -1088,6 +1115,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** Redis maxmemory percent || +|| luaTimeLimit | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit} diff --git a/ru/managed-redis/api-ref/grpc/Cluster/rebalance.md b/ru/managed-redis/api-ref/grpc/Cluster/rebalance.md index 9d8c144bb3c..bdca88808dd 100644 --- a/ru/managed-redis/api-ref/grpc/Cluster/rebalance.md +++ b/ru/managed-redis/api-ref/grpc/Cluster/rebalance.md @@ -332,7 +332,16 @@ To get the cluster ID use a [ClusterService.List](/docs/managed-redis/api-ref/gr "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "userConfig": { "maxmemoryPolicy": "MaxmemoryPolicy", @@ -352,7 +361,16 @@ To get the cluster ID use a [ClusterService.List](/docs/managed-redis/api-ref/gr "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "defaultConfig": { "maxmemoryPolicy": "MaxmemoryPolicy", @@ -372,7 +390,16 @@ To get the cluster ID use a [ClusterService.List](/docs/managed-redis/api-ref/gr "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" } }, "diskSizeAutoscaling": { @@ -1077,6 +1104,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** Redis maxmemory percent || +|| luaTimeLimit | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit} diff --git a/ru/managed-redis/api-ref/grpc/Cluster/rescheduleMaintenance.md b/ru/managed-redis/api-ref/grpc/Cluster/rescheduleMaintenance.md index da2512c25e6..261a6add9c7 100644 --- a/ru/managed-redis/api-ref/grpc/Cluster/rescheduleMaintenance.md +++ b/ru/managed-redis/api-ref/grpc/Cluster/rescheduleMaintenance.md @@ -345,7 +345,16 @@ The time until which this maintenance operation should be delayed. The value sho "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "userConfig": { "maxmemoryPolicy": "MaxmemoryPolicy", @@ -365,7 +374,16 @@ The time until which this maintenance operation should be delayed. The value sho "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "defaultConfig": { "maxmemoryPolicy": "MaxmemoryPolicy", @@ -385,7 +403,16 @@ The time until which this maintenance operation should be delayed. The value sho "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" } }, "diskSizeAutoscaling": { @@ -1093,6 +1120,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** Redis maxmemory percent || +|| luaTimeLimit | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit} diff --git a/ru/managed-redis/api-ref/grpc/Cluster/restore.md b/ru/managed-redis/api-ref/grpc/Cluster/restore.md index 77b894d551c..bc538fbd2db 100644 --- a/ru/managed-redis/api-ref/grpc/Cluster/restore.md +++ b/ru/managed-redis/api-ref/grpc/Cluster/restore.md @@ -130,7 +130,16 @@ Creates a new Redis cluster using the specified backup. "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "diskSizeAutoscaling": { "plannedUsageThreshold": "google.protobuf.Int64Value", @@ -636,6 +645,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** Redis maxmemory percent || +|| luaTimeLimit | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit} @@ -1057,7 +1093,16 @@ Hour of the day in UTC (in `HH` format). || "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "userConfig": { "maxmemoryPolicy": "MaxmemoryPolicy", @@ -1077,7 +1122,16 @@ Hour of the day in UTC (in `HH` format). || "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "defaultConfig": { "maxmemoryPolicy": "MaxmemoryPolicy", @@ -1097,7 +1151,16 @@ Hour of the day in UTC (in `HH` format). || "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" } }, "diskSizeAutoscaling": { @@ -1805,6 +1868,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** Redis maxmemory percent || +|| luaTimeLimit | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit2} diff --git a/ru/managed-redis/api-ref/grpc/Cluster/start.md b/ru/managed-redis/api-ref/grpc/Cluster/start.md index 5e010cf3915..9b7c99fee78 100644 --- a/ru/managed-redis/api-ref/grpc/Cluster/start.md +++ b/ru/managed-redis/api-ref/grpc/Cluster/start.md @@ -331,7 +331,16 @@ Required field. ID of the Redis cluster to start. || "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "userConfig": { "maxmemoryPolicy": "MaxmemoryPolicy", @@ -351,7 +360,16 @@ Required field. ID of the Redis cluster to start. || "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "defaultConfig": { "maxmemoryPolicy": "MaxmemoryPolicy", @@ -371,7 +389,16 @@ Required field. ID of the Redis cluster to start. || "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" } }, "diskSizeAutoscaling": { @@ -1076,6 +1103,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** Redis maxmemory percent || +|| luaTimeLimit | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit} diff --git a/ru/managed-redis/api-ref/grpc/Cluster/startFailover.md b/ru/managed-redis/api-ref/grpc/Cluster/startFailover.md index 00808c25b58..9597c0bbc12 100644 --- a/ru/managed-redis/api-ref/grpc/Cluster/startFailover.md +++ b/ru/managed-redis/api-ref/grpc/Cluster/startFailover.md @@ -340,7 +340,16 @@ List of hostnames which should not be masters. Can be empty for sentinel cluster "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "userConfig": { "maxmemoryPolicy": "MaxmemoryPolicy", @@ -360,7 +369,16 @@ List of hostnames which should not be masters. Can be empty for sentinel cluster "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "defaultConfig": { "maxmemoryPolicy": "MaxmemoryPolicy", @@ -380,7 +398,16 @@ List of hostnames which should not be masters. Can be empty for sentinel cluster "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" } }, "diskSizeAutoscaling": { @@ -1088,6 +1115,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** Redis maxmemory percent || +|| luaTimeLimit | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit} diff --git a/ru/managed-redis/api-ref/grpc/Cluster/stop.md b/ru/managed-redis/api-ref/grpc/Cluster/stop.md index 2d9b231249d..2738253f421 100644 --- a/ru/managed-redis/api-ref/grpc/Cluster/stop.md +++ b/ru/managed-redis/api-ref/grpc/Cluster/stop.md @@ -331,7 +331,16 @@ Required field. ID of the Redis cluster to stop. || "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "userConfig": { "maxmemoryPolicy": "MaxmemoryPolicy", @@ -351,7 +360,16 @@ Required field. ID of the Redis cluster to stop. || "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "defaultConfig": { "maxmemoryPolicy": "MaxmemoryPolicy", @@ -371,7 +389,16 @@ Required field. ID of the Redis cluster to stop. || "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" } }, "diskSizeAutoscaling": { @@ -1076,6 +1103,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** Redis maxmemory percent || +|| luaTimeLimit | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit} diff --git a/ru/managed-redis/api-ref/grpc/Cluster/streamLogs.md b/ru/managed-redis/api-ref/grpc/Cluster/streamLogs.md index 0034501592c..12404bce16a 100644 --- a/ru/managed-redis/api-ref/grpc/Cluster/streamLogs.md +++ b/ru/managed-redis/api-ref/grpc/Cluster/streamLogs.md @@ -55,7 +55,7 @@ request to start streaming from next log record. || A filter expression that filters resources listed in the response. The expression must specify: -1. The field name. Currently filtering can be applied to the [LogRecord.logs.hostname](/docs/compute/api-ref/grpc/Instance/create#yandex.cloud.compute.v1.CreateInstanceRequest) field +1. The field name. Currently filtering can be applied to the [LogRecord.logs.hostname] field 2. An `=` operator. 3. The value in double quotes (`"`). Must be 3-63 characters long and match the regular expression `[a-z][-a-z0-9]{1,61}[a-z0-9]`. Examples of a filter `message.hostname='node1.db.cloud.yandex.net'`. || diff --git a/ru/managed-redis/api-ref/grpc/Cluster/update.md b/ru/managed-redis/api-ref/grpc/Cluster/update.md index cbeb70163e9..bacec230140 100644 --- a/ru/managed-redis/api-ref/grpc/Cluster/update.md +++ b/ru/managed-redis/api-ref/grpc/Cluster/update.md @@ -129,7 +129,16 @@ Updates the specified Redis cluster. "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "diskSizeAutoscaling": { "plannedUsageThreshold": "google.protobuf.Int64Value", @@ -612,6 +621,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** Redis maxmemory percent || +|| luaTimeLimit | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit} @@ -1001,7 +1037,16 @@ Hour of the day in UTC (in `HH` format). || "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "userConfig": { "maxmemoryPolicy": "MaxmemoryPolicy", @@ -1021,7 +1066,16 @@ Hour of the day in UTC (in `HH` format). || "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" }, "defaultConfig": { "maxmemoryPolicy": "MaxmemoryPolicy", @@ -1041,7 +1095,16 @@ Hour of the day in UTC (in `HH` format). || "softLimit": "google.protobuf.Int64Value", "softSeconds": "google.protobuf.Int64Value" }, - "maxmemoryPercent": "google.protobuf.Int64Value" + "maxmemoryPercent": "google.protobuf.Int64Value", + "luaTimeLimit": "google.protobuf.Int64Value", + "replBacklogSizePercent": "google.protobuf.Int64Value", + "clusterRequireFullCoverage": "google.protobuf.BoolValue", + "clusterAllowReadsWhenDown": "google.protobuf.BoolValue", + "clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue", + "lfuDecayTime": "google.protobuf.Int64Value", + "lfuLogFactor": "google.protobuf.Int64Value", + "turnBeforeSwitchover": "google.protobuf.BoolValue", + "allowDataLoss": "google.protobuf.BoolValue" } }, "diskSizeAutoscaling": { @@ -1746,6 +1809,33 @@ Redis connection output buffers limits for clients. || || maxmemoryPercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** Redis maxmemory percent || +|| luaTimeLimit | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism || +|| replBacklogSizePercent | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Replication backlog size as a percentage of flavor maxmemory || +|| clusterRequireFullCoverage | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Controls whether all hash slots must be covered by nodes || +|| clusterAllowReadsWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows read operations when cluster is down || +|| clusterAllowPubsubshardWhenDown | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Permits Pub/Sub shard operations when cluster is down || +|| lfuDecayTime | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) || +|| lfuLogFactor | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** + +Determines how the frequency counter represents key hits. || +|| turnBeforeSwitchover | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows to turn before switchover in RDSync || +|| allowDataLoss | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** + +Allows some data to be lost in favor of faster switchover/restart || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit2} diff --git a/ru/marketplace/license-manager/api-ref/Instance/list.md b/ru/marketplace/license-manager/api-ref/Instance/list.md index 4b3a061e047..0ccc201a062 100644 --- a/ru/marketplace/license-manager/api-ref/Instance/list.md +++ b/ru/marketplace/license-manager/api-ref/Instance/list.md @@ -35,7 +35,7 @@ Page token. To get the next page of results, set `page_token` to the A filter expression that filters subscription instances listed in the response. The expression must specify: -1. The field name. Currently you can use filtering only on [Instance.name](#yandex.cloud.marketplace.licensemanager.v1.Template) field. +1. The field name. Currently you can use filtering only on [Instance.name] field. 2. An operator. Can be either `=` or `!=` for single values, `IN` or `NOT IN` for lists of values. 3. The value. Must be in double quotes `""`. Must be 3-63 characters long and match the regular expression `^[a-z][-a-z0-9]{1,61}[a-z0-9]`. Example of a filter: `name="my-subscription-instance"`. || diff --git a/ru/marketplace/license-manager/api-ref/Lock/list.md b/ru/marketplace/license-manager/api-ref/Lock/list.md index 83db017ec68..67598836d68 100644 --- a/ru/marketplace/license-manager/api-ref/Lock/list.md +++ b/ru/marketplace/license-manager/api-ref/Lock/list.md @@ -38,7 +38,7 @@ Page token. To get the next page of results, set `page_token` to the A filter expression that filters subscription locks listed in the response. The expression must specify: -1. The field name. Currently you can use filtering only on [Lock.productId](/docs/marketplace/license-manager/api-ref/Instance/get#yandex.cloud.marketplace.licensemanager.v1.Template) field. +1. The field name. Currently you can use filtering only on [Lock.product_id] field. 2. An operator. Can be either `=` or `!=` for single values, `IN` or `NOT IN` for lists of values. 3. The value. Must be in double quotes `""`. Must be 3-63 characters long and match the regular expression `^[a-z][-a-z0-9]{1,61}[a-z0-9]`. Example of a filter: `product_id="my-product-id"`. || diff --git a/ru/marketplace/license-manager/api-ref/grpc/Instance/list.md b/ru/marketplace/license-manager/api-ref/grpc/Instance/list.md index 0c20688d637..e721cd9f82a 100644 --- a/ru/marketplace/license-manager/api-ref/grpc/Instance/list.md +++ b/ru/marketplace/license-manager/api-ref/grpc/Instance/list.md @@ -43,7 +43,7 @@ Page token. To get the next page of results, set `page_token` to the A filter expression that filters subscription instances listed in the response. The expression must specify: -1. The field name. Currently you can use filtering only on [Instance.name](#yandex.cloud.marketplace.licensemanager.v1.Template) field. +1. The field name. Currently you can use filtering only on [Instance.name] field. 2. An operator. Can be either `=` or `!=` for single values, `IN` or `NOT IN` for lists of values. 3. The value. Must be in double quotes `""`. Must be 3-63 characters long and match the regular expression `^[a-z][-a-z0-9]{1,61}[a-z0-9]`. Example of a filter: `name="my-subscription-instance"`. || diff --git a/ru/marketplace/license-manager/api-ref/grpc/Lock/list.md b/ru/marketplace/license-manager/api-ref/grpc/Lock/list.md index 3b5712f292c..afd07bc3f17 100644 --- a/ru/marketplace/license-manager/api-ref/grpc/Lock/list.md +++ b/ru/marketplace/license-manager/api-ref/grpc/Lock/list.md @@ -47,7 +47,7 @@ Page token. To get the next page of results, set `page_token` to the A filter expression that filters subscription locks listed in the response. The expression must specify: -1. The field name. Currently you can use filtering only on [Lock.productId](/docs/marketplace/license-manager/api-ref/grpc/Instance/get#yandex.cloud.marketplace.licensemanager.v1.Template) field. +1. The field name. Currently you can use filtering only on [Lock.product_id] field. 2. An operator. Can be either `=` or `!=` for single values, `IN` or `NOT IN` for lists of values. 3. The value. Must be in double quotes `""`. Must be 3-63 characters long and match the regular expression `^[a-z][-a-z0-9]{1,61}[a-z0-9]`. Example of a filter: `product_id="my-product-id"`. || diff --git a/ru/marketplace/operations/registration.md b/ru/marketplace/operations/registration.md index 28527177536..5c46ab306eb 100644 --- a/ru/marketplace/operations/registration.md +++ b/ru/marketplace/operations/registration.md @@ -16,7 +16,7 @@ * Выберите страну плательщика. * Укажите имя платежного аккаунта, которое будет отображаться в списке платежных аккаунтов. 1. Если в блоке **{{ ui-key.yacloud_billing_account.cloud-billing-account.section_persons }}** показан список доступных плательщиков, вы можете выбрать одного из них или добавить нового. -1. Для добавления нового плательщика выберите **{{ ui-key.yacloud_billing_account.cloud-billing-account.section_person-type }}** — `{{ ui-key.startrek.ui_components_page-admin_BillingAccountInfo.person-type-company }}`. +1. Для добавления нового плательщика выберите **{{ ui-key.yacloud_billing_account.cloud-billing-account.section_person-type }}** — `Юридическое лицо или ИП`. * Выберите способ оплаты: `{{ ui-key.yacloud_billing.billing.account.overview.payment-type_label_card }}` или `{{ ui-key.yacloud_billing.billing.account.overview.payment-type_label_invoice }}`. В любой момент после создания платежного аккаунта вы можете [изменить способ оплаты](../../billing/operations/change-payment-method.md). * Укажите юридическую информацию о вашей организации. diff --git a/ru/metadata-hub/release-notes/index.md b/ru/metadata-hub/release-notes/index.md index 3b8957e8deb..04cf6d8a1d7 100644 --- a/ru/metadata-hub/release-notes/index.md +++ b/ru/metadata-hub/release-notes/index.md @@ -5,6 +5,17 @@ description: В разделе представлена история изме # История изменений {{ metadata-hub-full-name }} в 2024 году +## Октябрь {#october} + +### Новые возможности {#new-features-october} + +* Добавлены новые возможности для интеграции {{ connection-manager-name }} с [{{ data-transfer-full-name }}](../../data-transfer/quickstart.md): выпадающий список доступных подключений при создании трансфера. +* В {{ schema-registry-name }} поддержан механизм аутентификации с помощью [API-ключей](../../iam/concepts/authorization/api-key.md), который избавляет от необходимости регулярно обновлять значение секрета для аутентификации. + +### Решенные проблемы {#problems-solved-october} + +* Улучшена стабильность при массовом создании подключений в {{ connection-manager-name }}. + ## Сентябрь {#september} ### Новые возможности {#new-features-september} diff --git a/ru/microsoft/toc.yaml b/ru/microsoft/toc.yaml index e1f2bf0ba03..6d2f41658e5 100644 --- a/ru/microsoft/toc.yaml +++ b/ru/microsoft/toc.yaml @@ -9,6 +9,18 @@ items: href: byol.md - name: Безопасная передача пароля в скрипт инициализации href: tutorials/secure-password-script.md + - name: Развертывание Active Directory + href: tutorials/active-directory.md + - name: Развертывание Microsoft Exchange + href: tutorials/exchange.md + - name: Развертывание Remote Desktop Services + href: tutorials/rds.md + - name: Развертывание Remote Desktop Gateway + href: tutorials/rds-gw.md + - name: >- + Развертывание группы доступности Always On с внутренним сетевым + балансировщиком + href: tutorials/mssql-alwayson-lb.md - name: Лицензирование items: - name: Лицензии Microsoft в {{ yandex-cloud }} diff --git a/ru/microsoft/tutorials/active-directory.md b/ru/microsoft/tutorials/active-directory.md new file mode 100644 index 00000000000..9c8c15f84a6 --- /dev/null +++ b/ru/microsoft/tutorials/active-directory.md @@ -0,0 +1,16 @@ +--- +title: Установка и развертывание Active Directory (AD) в облаке +description: Пошаговая инструкция процесса установки и развертывания Active Directory (AD) в облаке {{ yandex-cloud }}. Чтобы развернуть инфраструктуру Active Directory (AD) необходимо подготовить облако, создать сеть и подсети, создать виртуальную машину для Active Directory. +canonical: '{{ link-docs }}/tutorials/windows/active-directory' +keywords: + - установка Active Directory + - развертывание Active Directory + - установка AD + - active directory + - active directory как запустить + - планирование active directory + - настройка ad + - настройка active directory +--- + +{% include [active-directory](../../_tutorials/windows/active-directory.md) %} \ No newline at end of file diff --git a/ru/microsoft/tutorials/exchange.md b/ru/microsoft/tutorials/exchange.md new file mode 100644 index 00000000000..5c598d6e063 --- /dev/null +++ b/ru/microsoft/tutorials/exchange.md @@ -0,0 +1,7 @@ +--- +title: Развертывание Microsoft Exchange +description: В этом сценарии вы создадите сервера Microsoft Exchange в {{ yandex-cloud }}. +canonical: '{{ link-docs }}/tutorials/windows/exchange' +--- + +{% include [exchange.md](../../_tutorials/windows/exchange.md) %} \ No newline at end of file diff --git a/ru/microsoft/tutorials/index.md b/ru/microsoft/tutorials/index.md index ff2943cf94e..2bdf2b48122 100644 --- a/ru/microsoft/tutorials/index.md +++ b/ru/microsoft/tutorials/index.md @@ -5,8 +5,10 @@ description: На странице представлен список прак # Практические руководства по использованию продуктов Microsoft в {{ yandex-cloud }} - - -* [Использование своей лицензии для продуктов Microsoft](../byol.md) -* [{#T}](./secure-password-script.md) - +* [{#T}](../byol.md) +* [{#T}](secure-password-script.md) +* [{#T}](active-directory.md) +* [{#T}](exchange.md) +* [{#T}](rds.md) +* [{#T}](rds-gw.md) +* [{#T}](mssql-alwayson-lb.md) diff --git a/ru/microsoft/tutorials/mssql-alwayson-lb.md b/ru/microsoft/tutorials/mssql-alwayson-lb.md new file mode 100644 index 00000000000..1f61e62b817 --- /dev/null +++ b/ru/microsoft/tutorials/mssql-alwayson-lb.md @@ -0,0 +1,7 @@ +--- +title: Развертывание группы доступности Always On с внутренним сетевым балансировщиком +description: В этом сценарии вы создадите в {{ yandex-cloud }} группы доступности Always On с балансировкой нагрузки между узлами с помощью внутреннего сетевого балансировщика. +canonical: '{{ link-docs }}/tutorials/windows/mssql-alwayson-lb' +--- + +{% include [mssql-alwayson-lb](../../_tutorials/windows/mssql-alwayson-lb.md) %} \ No newline at end of file diff --git a/ru/microsoft/tutorials/rds-gw.md b/ru/microsoft/tutorials/rds-gw.md new file mode 100644 index 00000000000..2e5f1968061 --- /dev/null +++ b/ru/microsoft/tutorials/rds-gw.md @@ -0,0 +1,7 @@ +--- +title: Развертывание Remote Desktop Gateway +description: В этом сценарии вы создадите и настроите инфраструктуру Remote Desktop Gateway. +canonical: '{{ link-docs }}/tutorials/windows/rds-gw' +--- + +{% include [rds-gw](../../_tutorials/windows/rds-gw.md) %} \ No newline at end of file diff --git a/ru/microsoft/tutorials/rds.md b/ru/microsoft/tutorials/rds.md new file mode 100644 index 00000000000..5b9edf73411 --- /dev/null +++ b/ru/microsoft/tutorials/rds.md @@ -0,0 +1,7 @@ +--- +title: Развертывание Microsoft Remote Desktop Services +description: В этом сценарии вы создадите и настроите инфраструктуру Microsoft Windows Server Datacenter с предустановленной службой Remote Desktop Services в {{ yandex-cloud }}. +canonical: '{{ link-docs }}/tutorials/windows/rds' +--- + +{% include [rds.md](../../_tutorials/windows/rds.md) %} \ No newline at end of file diff --git a/ru/microsoft/tutorials/secure-password-script.md b/ru/microsoft/tutorials/secure-password-script.md index 6d4d7b32e5b..60921ff2788 100644 --- a/ru/microsoft/tutorials/secure-password-script.md +++ b/ru/microsoft/tutorials/secure-password-script.md @@ -1,447 +1,7 @@ -# Безопасная передача пароля в скрипт инициализации +--- +title: Безопасная передача пароля в скрипт инициализации +description: В этом сценарии вы узнаете как безопасно передать пароль в скрипт инициализации. +canonical: '{{ link-docs }}/tutorials/windows/secure-password-script' +--- -При создании виртуальной машины из образа с операционной системой Windows вы можете использовать скрипт инициализации. Например, в скрипте можно задать логин и пароль администратора и других пользователей системы. Чтобы защитить чувствительные данные, вместо явного указания в скрипте используйте возможности сервиса {{ lockbox-name }}. - -В данном руководстве вы создадите ВМ с ОС Windows используя скрипт инициализации, в котором логины и пароли пользователей системы будут получены из сервиса {{ lockbox-name }}. - -Чтобы создать ВМ и защитить конфиденциальную информацию в скрипте инициализации: - -1. [Создайте сервисный аккаунт](#create-account) -1. [Создайте ключ {{ kms-short-name }}](#create-key) -1. [Создайте секрет](#create-secret) -1. [Создайте ВМ](#create-vm) -1. [Авторизуйтесь в ОС Windows](#login-windows) - -Если созданные ресурсы вам больше не нужны, [удалите их](#clear-out). - -## Перед началом работы {#before-you-begin} - -{% include [before-you-begin](../../_tutorials/_tutorials_includes/before-you-begin.md) %} - -### Необходимые платные ресурсы {#paid-resources} - -В стоимость поддержки инфраструктуры входит: - -* плата за ВМ (см. [тарифы {{ compute-full-name }}](../../compute/pricing.md)); -* плата за использование образа (зависит от образа); -* плата за использование ключа {{ kms-short-name }} (см. [тарифы {{ kms-short-name }}](../../kms/pricing.md)); -* плата за использование секрета (см. [тарифы {{ lockbox-name }}](../../lockbox/pricing.md)). - -## Создайте сервисный аккаунт {#create-account} - -{% list tabs group=instructions %} - -- Консоль управления {#console} - - 1. В [консоли управления]({{ link-console-main }}) выберите каталог, в котором хотите создать сервисный аккаунт. - 1. В списке сервисов выберите **{{ ui-key.yacloud.iam.folder.dashboard.label_iam }}**. - 1. Нажмите кнопку **{{ ui-key.yacloud.iam.folder.service-accounts.button_add }}**. - 1. Введите имя сервисного аккаунта, например, `win-secret-sa`. - 1. Нажмите кнопку **{{ ui-key.yacloud.iam.folder.service-account.popup-robot_button_add }}**. - -- CLI {#cli} - - {% include [default-catalogue](../../_includes/default-catalogue.md) %} - - Выполните команду для создания сервисного аккаунта, указав имя `win-secret-sa`: - - ```bash - yc iam service-account create --name win-secret-sa - ``` - - Где `name` — имя сервисного аккаунта. - - Результат: - - ```text - id: ajehr0to1g8b******** - folder_id: b1gv87ssvu49******** - created_at: "2024-03-15T09:03:11.665153755Z" - name: win-secret-sa - ``` - -- API {#api} - - Чтобы создать сервисный аккаунт, воспользуйтесь вызовом gRPC API [ServiceAccountService/Create](../../iam/api-ref/grpc/ServiceAccount/create.md) или методом [create](../../iam/api-ref/ServiceAccount/create.md) для ресурса `ServiceAccount` REST API. - -{% endlist %} - -## Создайте ключ {{ kms-short-name }} {#create-key} - -1. Создайте [ключ шифрования](../../kms/concepts/key.md): - - {% list tabs group=instructions %} - - - Консоль управления {#console} - - 1. В [консоли управления]({{ link-console-main }}) выберите [каталог](../../resource-manager/concepts/resources-hierarchy.md#folder), в котором будет создан ключ. - 1. Выберите сервис **{{ ui-key.yacloud.iam.folder.dashboard.label_kms }}**. - 1. На панели слева выберите ![image](../../_assets/console-icons/key.svg) **{{ ui-key.yacloud.kms.switch_symmetric-keys }}**. - 1. Нажмите **{{ ui-key.yacloud.kms.symmetric-keys.button_empty-create }}** и задайте атрибуты ключа: - * **{{ ui-key.yacloud.common.name }}** — `win-secret-key`. - * **{{ ui-key.yacloud.kms.symmetric-key.form.field_algorithm }}** — `AES-256`. - * Для остальных параметров оставьте значения по умолчанию. - 1. Нажмите **{{ ui-key.yacloud.common.create }}**. - - Вместе с ключом создается его первая версия: кликните ключ в списке, чтобы открыть страницу с его атрибутами. - - - CLI {#cli} - - Выполните команду: - - ```bash - yc kms symmetric-key create \ - --name win-secret-key \ - --default-algorithm aes-256 - ``` - - Где: - - * `--name` — имя ключа. - * `--default-algorithm` — алгоритм шифрования: `aes-128`, `aes-192` или `aes-256`. - - - {{ TF }} {#tf} - - {% include [terraform-definition](../../_tutorials/_tutorials_includes/terraform-definition.md) %} - - {% include [terraform-install](../../_includes/terraform-install.md) %} - - {% include [terraform-key-create](../../_includes/kms/terraform-key-create.md) %} - - - API {#api} - - Воспользуйтесь методом REST API [create](../../kms/api-ref/SymmetricKey/create.md) для ресурса [SymmetricKey](../../kms/api-ref/SymmetricKey/index.md) или вызовом gRPC API [SymmetricKeyService/Create](../../kms/api-ref/grpc/SymmetricKey/create.md). - - {% endlist %} - -1. Назначьте сервисному аккаунту `win-secret-sa` [роль](../../iam/concepts/access-control/roles.md) `kms.keys.encrypterDercrypter`: - - {% list tabs group=instructions %} - - - Консоль управления {#console} - - 1. На странице ключа перейдите на вкладку **Права доступа**. - 1. Перейдите на вкладку **{{ ui-key.yacloud.common.resource-acl.label_access-bindings }}**. - 1. Найдите аккаунт `win-secret-sa` в списке и нажмите значок ![image](../../_assets/options.svg). - 1. Нажмите кнопку **{{ ui-key.yacloud.common.resource-acl.button_assign-binding }}**. - 1. В открывшемся диалоге нажмите кнопку **Добавить роль** и выберите роль `kms.keys.encrypterDercrypter`. - - - CLI {#cli} - - Выполните команду: - - ```bash - yc resource-manager folder add-access-binding <идентификатор_каталога> \ - --role kms.keys.encrypterDercrypter \ - --subject serviceAccount:<идентификатор_сервисного_аккаунта> - ``` - - - API {#api} - - Чтобы назначить сервисному аккаунту роль на каталог, воспользуйтесь методом REST API [setAccessBindings](../../iam/api-ref/ServiceAccount/setAccessBindings.md) для ресурса [ServiceAccount](../../iam/api-ref/ServiceAccount/index.md) или вызовом gRPC API [ServiceAccountService/SetAccessBindings](../../iam/api-ref/grpc/ServiceAccount/setAccessBindings.md). - - {% endlist %} - -## Создайте секрет {#create-secret} - -Создайте секрет в сервисе {{ lockbox-name }} и сохраните в нем логины и пароли пользователей, для которых будут созданы учетные записи в ОС Windows. - -{% note warning %} - -При выборе пароля обязательно соблюдайте требования к безопасности пароля, иначе учетная запись для пользователя не будет создана. -Пароль должен: - -* быть не короче восьми символов; -* не содержать в себе имени учетной записи; -* содержать знаки минимум трех из четырех групп: - - латинские заглавные буквы (A-Z); - - латинские строчные буквы (a-z); - - цифры (0-9); - - неалфавитные символы (!, ?, %, $, # и т. д.). - -{% endnote %} - -{% list tabs group=instructions %} - -- Консоль управления {#console} - - 1. В [консоли управления]({{ link-console-main }}) выберите [каталог](../../resource-manager/concepts/resources-hierarchy.md#folder), в котором будет создан секрет. - 1. В списке сервисов выберите **{{ ui-key.yacloud.iam.folder.dashboard.label_lockbox }}**. - 1. Нажмите кнопку **{{ ui-key.yacloud.lockbox.button_create-secret }}**. - 1. В поле **{{ ui-key.yacloud.common.name }}** введите имя секрета: `win-secret`. - 1. В поле **{{ ui-key.yacloud.lockbox.forms.title_kms-key }}** укажите ключ `win-secret-key`. - 1. В блоке **{{ ui-key.yacloud.lockbox.label_version-dialog-title }}**: - * В поле **{{ ui-key.yacloud.lockbox.forms.label_key }}** введите логин для администратора `Administrator`. - * В поле **{{ ui-key.yacloud.lockbox.forms.label_value }}** введите пароль для администратора. - 1. При желании, добавьте еще пользователей. Для этого нажмите кнопку **{{ ui-key.yacloud.lockbox.forms.button_add-pair }}** и введите логин и пароль для следующего пользователя. - 1. Нажмите кнопку **{{ ui-key.yacloud.common.create }}**. - -- CLI {#cli} - - 1. Выполните команду: - - ```bash - yc lockbox secret create \ - --name win-secret \ - --kms-key-id <идентификатор_ключа> \ - --payload "[{'key': 'Administrator', 'text_value': '<пароль_администратора>'},{'key': 'user1', 'text_value': '<пароль_пользователя>'}]" \ - --cloud-id <идентификатор_облака> \ - --folder-id <идентификатор_каталога> - ``` - - Где: - * `--name` — имя секрета. Обязательный параметр. - * `--kms-key-id` — идентификатор ключа {{ kms-short-name }}. - * `--description` — описание секрета. Необязательный параметр. - * `--payload` — содержимое секрета в виде массива формата YAML или JSON. - * `--cloud-id` — [идентификатор облака](../../resource-manager/operations/cloud/get-id.md), в котором будет создан секрет. - * `--folder-id` — [идентификатор каталога](../../resource-manager/operations/folder/get-id.md), в котором будет создан секрет. - -- {{ TF }} {#tf} - - {% include [terraform-install](../../_includes/terraform-install.md) %} - - 1. Опишите в конфигурационном файле параметры ресурсов, которые необходимо создать: - - ```hcl - resource "yandex_lockbox_secret" "win_secret" { - name = "<имя_секрета>" - folder_id = "<идентификатор_каталога>" - kms_key_id = "<идентификатор_ключа_шифрования>" - } - resource "yandex_lockbox_secret_version" "win_secret_version" { - secret_id = yandex_lockbox_secret.win_secret.id - entries { - key = "Administrator" - text_value = "<пароль_администратора>" - } - entries { - key = "user1" - text_value = "<пароль_пользователя>" - } - } - ``` - - Где: - * `name` — имя секрета. Обязательный параметр. - * `folder_id` — [идентификатор](../../resource-manager/operations/folder/get-id.md) [каталога](../../resource-manager/concepts/resources-hierarchy.md#folder) в котором будет создан секрет. Необязательный параметр. - * `kms_key_id` — идентификатор [ключа шифрования {{ kms-name }}](../../kms/concepts/key.md). Указанный ключ {{ kms-name }} используется для шифрования секрета. - * `entries` — содержимое секрета. - - {% include [secret-version-tf-note](../../_includes/lockbox/secret-version-tf-note.md) %} - - {% note warning %} - - Для повышения безопасности пароль в конфигурационном файле лучше задавать через переменную окружения. - - {% endnote %} - - 1. Создайте ресурсы: - - {% include [terraform-validate-plan-apply](../../_tutorials/_tutorials_includes/terraform-validate-plan-apply.md) %} - -- API {#api} - - Чтобы создать секрет, воспользуйтесь методом REST API [create](../../lockbox/api-ref/Secret/create.md) для ресурса [Secret](../../lockbox/api-ref/Secret/index.md) или вызовом gRPC API [SecretService/Create](../../lockbox/api-ref/grpc/Secret/create.md). - -{% endlist %} - -1. Назначьте сервисному аккаунту `win-secret-sa` [роль](../../iam/concepts/access-control/roles.md) `lockbox.payloadViewer`: - - {% list tabs group=instructions %} - - - Консоль управления {#console} - - 1. На странице секрета перейдите на вкладку **Права доступа**. - 1. Перейдите на вкладку **{{ ui-key.yacloud.common.resource-acl.label_access-bindings }}**. - 1. Найдите аккаунт `win-secret-sa` в списке и нажмите значок ![image](../../_assets/options.svg). - 1. Нажмите кнопку **{{ ui-key.yacloud.common.resource-acl.button_assign-binding }}**. - 1. В открывшемся диалоге нажмите кнопку **Добавить роль** и выберите роль `lockbox.payloadViewer`. - - - CLI {#cli} - - Выполните команду: - - ```bash - yc resource-manager folder add-access-binding <идентификатор_каталога> \ - --role lockbox.payloadViewer \ - --subject serviceAccount:<идентификатор_сервисного_аккаунта> - ``` - - - API {#api} - - Чтобы назначить сервисному аккаунту роль на каталог, воспользуйтесь методом REST API [setAccessBindings](../../iam/api-ref/ServiceAccount/setAccessBindings.md) для ресурса [ServiceAccount](../../iam/api-ref/ServiceAccount/index.md) или вызовом gRPC API [ServiceAccountService/SetAccessBindings](../../iam/api-ref/grpc/ServiceAccount/setAccessBindings.md). - - {% endlist %} - -## Создайте ВМ {#create-vm} - -Создайте ВМ с ОС Windows и учетными записями администратора и пользователей. - -1. Создайте файл `init.ps1` и сохраните в него код: - - ```text - #ps1 - - # logging - Start-Transcript -Path "$ENV:SystemDrive\provision2.txt" -IncludeInvocationHeader -Force - "Bootstrap script started" | Write-Host - - # SECRET'S ID: - $SecretID = "" - - [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 - $SecretURL = "https://payload.lockbox.{{ api-host }}/lockbox/v1/secrets/$SecretID/payload" - - "Secret ID is $SecretID" - "Payload URL is $SecretURL" - - $YCToken = (Invoke-RestMethod -Headers @{'Metadata-Flavor'='Google'} -Uri "http://169.254.169.254/computeMetadata/v1/instance/service-accounts/default/token").access_token - if (!$YCToken) { - throw "Service Account doesn't connected to VM. Please, add Service account with roles lockbox.payloadViewer and kms.key.encryptorDecryptor to VM and try again." - } - - # Creating parameters for REST-invokations - $Headers = @{ - Authorization="Bearer $YCToken" - } - - $Params = @{ - Uri = $SecretURL - Method = "GET" - Headers = $Headers - } - - # Getting secret via REST invoke - $Secret = Invoke-RestMethod @Params - $SecretAdministratorPlainTextPassword = $Secret.entries[0].textValue - - # inserting value's from terraform - if (-not [string]::IsNullOrEmpty($SecretAdministratorPlainTextPassword)) { - "Set local administrator password" | Write-Host - $SecretAdministratorPassword = $SecretAdministratorPlainTextPassword | ConvertTo-SecureString -AsPlainText -Force - # S-1-5-21domain-500 is a well-known SID for Administrator - # https://docs.microsoft.com/en-us/troubleshoot/windows-server/identity/security-identifiers-in-windows - $Administrator = Get-LocalUser | Where-Object -Property "SID" -like "S-1-5-21-*-500" - $Administrator | Set-LocalUser -Password $SecretAdministratorPassword - } - - # Creating new users if any - if($Secret.entries.count -gt 1) { - foreach($User in $Secret.entries[1..($Secret.entries.count-1)]){ - $SecretUserPassword = $User.textValue | ConvertTo-SecureString -AsPlainText -Force - New-LocalUser -Name $User.key -Password $SecretUserPassword -FullName $User.key - Add-LocalGroupMember -Group Users -Member $User.key - Add-LocalGroupMember -Group "Remote Desktop Users" -Member $User.key - } - } - - "Bootstrap script ended" | Write-Host - ``` - -1. В файле `init.ps1` замените плейсхолдер `` на реальный идентификатор секрета, в котором вы сохранили учетки пользователей. - -1. Создайте ВМ: - - {% list tabs group=instructions %} - - - Консоль управления {#console} - - 1. В [консоли управления]({{ link-console-main }}) откройте [каталог](../../resource-manager/concepts/resources-hierarchy.md#folder), в котором будет создана ВМ. - 1. Справа сверху нажмите кнопку **{{ ui-key.yacloud.iam.folder.dashboard.button_add }}**. - 1. В открывшемся списке выберите **{{ ui-key.yacloud.iam.folder.dashboard.value_compute }}**. - 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_base }}**: - * Введите имя ВМ, например, `win-test`. - * Выберите [зону доступности](../../overview/concepts/geo-scope.md), в которой будет находиться ВМ. - 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_image }}** выберите [образ](../../compute/concepts/image.md) с ОС Windows. - 1. В блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** укажите данные для доступа на ВМ: - * Выберите [сервисный аккаунт](../../iam/concepts/index.md#sa) `win-secret-sa`. - * В поле **{{ ui-key.yacloud.compute.instances.create.field_access-advanced }}** разрешите доступ к [серийной консоли](../../compute/operations/serial-console/index.md). - 1. В блоке **{{ ui-key.yacloud.common.metadata }}**: - * в поле с плейсхолдером **Ключ** укажите `user-data`; - * в поле с плейсхолдером **Значение** скопируйте содержимое файла `init.ps1`. - 1. Нажмите кнопку **{{ ui-key.yacloud.compute.instances.create.button_create }}**. - - - CLI {#cli} - - Выполните команду: - - ```bash - yc compute instance create --name win-test --hostname windows10 --zone {{ region-id }}-a --create-boot-disk image-id= --cores 2 --core-fraction 100 --memory 4 --metadata-from-file user-data=init.ps1 --network-interface subnet-name=,nat-ip-version=ipv4 --service-account-name win-test-sa --platform standard-v3 - ``` - - Где: - * imade_id — идентификатор образа с ОС Windows. - * subnet_name — имя подсети в каталоге, в которой вы хотите разместить ВМ. - - {% endlist %} - - -## Авторизуйтесь в ОС Windows {#login-windows} - -Чтобы проверить, что данные из секрета были успешно использованы для создания пользователей, авторизуйтесь в ОС виртуальной машины: - -1. В [консоли управления]({{ link-console-main }}) выберите каталог, которому принадлежит виртуальная машина. -1. Выберите сервис **{{ ui-key.yacloud.iam.folder.dashboard.label_compute }}**. -1. Выберите виртуальную машину `win-test`. -1. Перейдите на вкладку **{{ ui-key.yacloud.compute.instance.switch_console }}**. -1. В блоке **{{ ui-key.yacloud.compute.instance.switch_console }}** выберите `COM2` и нажмите кнопку **{{ ui-key.yacloud.compute.instance.console.connect }}**. В командной строке отобразится приглашение ввода команд: - - ```bash - SAC> - ``` - -1. Просмотрите список открытых каналов: - - ```bash - SAC>ch - Channel List - - (Use "ch -?" for information on using channels) - - # Status Channel Name - 0 (AV) SAC - 1 (AV) Cmd0001 - ``` - -1. Чтобы перейти на канал нажмите сочетание клавиш **ESC** + **TAB** или выполните команду: - - ```bash - SAC>ch -sn Cmd0001 - Name: Cmd0001 - Description: Command - Type: VT-UTF8 - Channel GUID: e203fb79-d80d-11ea-87e3-c2679e14957d - Application Type GUID: 63d02271-8aa4-11d5-bccf-00b0d014a2d0 - - Press for next channel. - Press 0 to return to the SAC channel. - Use any other key to view this channel. - ``` - -1. Нажмите **Enter** и последовательно введите: - - Имя пользователя. - - Домен, если вход выполняется под доменной учетной записью. Иначе введите имя хоста либо оставьте пустым. - - Пароль. - - ```bash - Please enter login credentials. - Username: Administrator - Domain : - Password: *************** - ``` - -1. Если авторизация прошла успешно, запустится экземпляр интерпретатора командной строки: - - ```bash - C:\Windows\system32> - ``` - - Успешная авторизация означает, что данные из секрета были использованы при создании виртуальной машины. - -## Как удалить созданные ресурсы {#clear-out} - -Чтобы перестать платить за созданные ресурсы: -* [удалите](../../compute/operations/vm-control/vm-delete.md) ВМ; -* [удалите](../../lockbox/operations/secret-delete.md) секрет; -* [удалите](../../kms/operations/key.md#delete) ключ; +{% include [secure-password-script](../../_tutorials/windows/secure-password-script.md) %} \ No newline at end of file diff --git a/ru/monitoring/concepts/data-collection/unified-agent/index.md b/ru/monitoring/concepts/data-collection/unified-agent/index.md index 97bd2c34850..dc4c0b4ec7a 100644 --- a/ru/monitoring/concepts/data-collection/unified-agent/index.md +++ b/ru/monitoring/concepts/data-collection/unified-agent/index.md @@ -21,7 +21,7 @@ - [сбор системных метрик Linux](../../../operations/unified-agent/linux_metrics.md) (процессор, память, диск); - сбор метрик в формате [Prometheus](https://prometheus.io); -- поставку метрик в {{monitoring-full-name}}; +- поставку метрик в {{ monitoring-full-name }}; - файловое хранилище для надежной доставки данных. Примеры использования агента приведены в разделе [{#T}](../../../operations/index.md#working-with-metrics). Подробнее про способы установки {{ unified-agent-short-name }} читайте в разделе [{#T}](./installation.md). Синтаксис файла конфигурации агента описан в разделе [{#T}](./configuration.md). diff --git a/ru/monitoring/toc.yaml b/ru/monitoring/toc.yaml index 46c33453741..c140d6ba2cd 100644 --- a/ru/monitoring/toc.yaml +++ b/ru/monitoring/toc.yaml @@ -117,6 +117,8 @@ items: href: tutorials/autoscale-monitoring.md - name: Мониторинг показаний датчиков и уведомления о событиях href: tutorials/monitoring.md + - name: Визуализация данных {{ monitoring-full-name }} + href: tutorials/data-from-monitoring-visualization.md - name: '{{ managed-prometheus-name }}' items: - name: Обзор diff --git a/ru/monitoring/tutorials/data-from-monitoring-visualization.md b/ru/monitoring/tutorials/data-from-monitoring-visualization.md new file mode 100644 index 00000000000..3bf3a1c8027 --- /dev/null +++ b/ru/monitoring/tutorials/data-from-monitoring-visualization.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/datalens/data-from-monitoring-visualization' +--- + +{% include [data-from-monitoring-visualization](../../_tutorials/datalens/data-from-monitoring-visualization.md) %} diff --git a/ru/network-load-balancer/release-notes.md b/ru/network-load-balancer/release-notes.md new file mode 100644 index 00000000000..e570923d838 --- /dev/null +++ b/ru/network-load-balancer/release-notes.md @@ -0,0 +1,10 @@ +--- +title: История изменений в {{ network-load-balancer-full-name }} +description: В разделе представлена история изменений сервиса {{ network-load-balancer-name }}. +--- + +# История изменений в {{ network-load-balancer-full-name }} + +## III квартал 2024 {#q3-2024} + +Оптимизирована работа проверок состояния — устранен троттлинг. diff --git a/ru/network-load-balancer/toc.yaml b/ru/network-load-balancer/toc.yaml index f6bc7019892..df8cfafd19c 100644 --- a/ru/network-load-balancer/toc.yaml +++ b/ru/network-load-balancer/toc.yaml @@ -49,6 +49,8 @@ items: href: tutorials/index.md - name: Архитектура и защита базового интернет-сервиса href: tutorials/web-service.md + - name: Реализация отказоустойчивых сценариев для сетевых виртуальных машин + href: tutorials/route-switcher.md - name: Настройка отказоустойчивой архитектуры в {{ yandex-cloud }} href: tutorials/fault-tolerance.md - name: >- @@ -73,6 +75,20 @@ items: href: tutorials/updating-under-load.md - name: Интеграция {{ dns-name }} и корпоративного сервиса DNS href: tutorials/dns-integration.md + - name: Подключение к {{ objstorage-name }} из {{ vpc-name }} + href: tutorials/storage-vpc-access.md + - name: Подключение к {{ container-registry-name }} из {{ vpc-name }} + href: tutorials/vpc-cr-access.md + - name: >- + Реализация защищенной высокодоступной сетевой инфраструктуры с + выделением DMZ на основе Check Point NGFW + href: tutorials/high-accessible-dmz.md + - name: Развертывание Microsoft Exchange + href: tutorials/exchange.md + - name: >- + Развертывание группы доступности Always On с внутренним сетевым + балансировщиком + href: tutorials/mssql-alwayson-lb.md - name: Концепции items: - name: Обзор @@ -241,6 +257,8 @@ items: href: metrics.md - name: Аудитные логи {{ at-name }} href: at-ref.md + - name: История изменений + href: release-notes.md - name: Вопросы и ответы href: qa/index.md - name: Обучающие курсы diff --git a/ru/network-load-balancer/tutorials/exchange.md b/ru/network-load-balancer/tutorials/exchange.md new file mode 100644 index 00000000000..5c598d6e063 --- /dev/null +++ b/ru/network-load-balancer/tutorials/exchange.md @@ -0,0 +1,7 @@ +--- +title: Развертывание Microsoft Exchange +description: В этом сценарии вы создадите сервера Microsoft Exchange в {{ yandex-cloud }}. +canonical: '{{ link-docs }}/tutorials/windows/exchange' +--- + +{% include [exchange.md](../../_tutorials/windows/exchange.md) %} \ No newline at end of file diff --git a/ru/network-load-balancer/tutorials/high-accessible-dmz.md b/ru/network-load-balancer/tutorials/high-accessible-dmz.md new file mode 100644 index 00000000000..ecc8f6d1212 --- /dev/null +++ b/ru/network-load-balancer/tutorials/high-accessible-dmz.md @@ -0,0 +1,6 @@ +--- +canonical: '{{ link-docs }}/tutorials/routing/high-accessible-dmz' +--- + + +{% include [high-accessible-dmz](../../_tutorials/routing/high-accessible-dmz.md) %} \ No newline at end of file diff --git a/ru/network-load-balancer/tutorials/index.md b/ru/network-load-balancer/tutorials/index.md index 29e9468bb17..f2b8f25d61c 100644 --- a/ru/network-load-balancer/tutorials/index.md +++ b/ru/network-load-balancer/tutorials/index.md @@ -11,3 +11,5 @@ description: Различные сценарии использования {{ n * [{#T}](./vm-autoscale/index.md) * [{#T}](./updating-under-load.md) * [{#T}](./dns-integration.md) +* [{#T}](./exchange.md) +* [{#T}](./mssql-alwayson-lb.md) diff --git a/ru/network-load-balancer/tutorials/mssql-alwayson-lb.md b/ru/network-load-balancer/tutorials/mssql-alwayson-lb.md new file mode 100644 index 00000000000..1f61e62b817 --- /dev/null +++ b/ru/network-load-balancer/tutorials/mssql-alwayson-lb.md @@ -0,0 +1,7 @@ +--- +title: Развертывание группы доступности Always On с внутренним сетевым балансировщиком +description: В этом сценарии вы создадите в {{ yandex-cloud }} группы доступности Always On с балансировкой нагрузки между узлами с помощью внутреннего сетевого балансировщика. +canonical: '{{ link-docs }}/tutorials/windows/mssql-alwayson-lb' +--- + +{% include [mssql-alwayson-lb](../../_tutorials/windows/mssql-alwayson-lb.md) %} \ No newline at end of file diff --git a/ru/network-load-balancer/tutorials/route-switcher.md b/ru/network-load-balancer/tutorials/route-switcher.md new file mode 100644 index 00000000000..c99a393b9a3 --- /dev/null +++ b/ru/network-load-balancer/tutorials/route-switcher.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/routing/route-switcher' +--- + +{% include [route-switcher](../../_tutorials/routing/route-switcher.md) %} \ No newline at end of file diff --git a/ru/network-load-balancer/tutorials/storage-vpc-access.md b/ru/network-load-balancer/tutorials/storage-vpc-access.md new file mode 100644 index 00000000000..55d0ddd87ec --- /dev/null +++ b/ru/network-load-balancer/tutorials/storage-vpc-access.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/routing/storage-vpc-access' +--- + +{% include [storage-vpc-access](../../_tutorials/routing/storage-vpc-access.md) %} \ No newline at end of file diff --git a/ru/network-load-balancer/tutorials/vpc-cr-access.md b/ru/network-load-balancer/tutorials/vpc-cr-access.md new file mode 100644 index 00000000000..e684154f946 --- /dev/null +++ b/ru/network-load-balancer/tutorials/vpc-cr-access.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/routing/vpc-cr-access' +--- + +{% include [vpc-cr-access](../../_tutorials/routing/vpc-cr-access.md) %} \ No newline at end of file diff --git a/ru/organization/concepts/membership.md b/ru/organization/concepts/membership.md index 78e4986b817..506eae0844c 100644 --- a/ru/organization/concepts/membership.md +++ b/ru/organization/concepts/membership.md @@ -14,9 +14,8 @@ description: Членство в организации позволяет по Членами организации могут быть: -* Пользователи, которые были приглашены в организацию и приняли такое приглашение. +* Пользователи, которые были приглашены в организацию и приняли такое приглашение. Чтобы получить приглашение, попросите [владельца](../security/index.md#organization-manager-organizations-owner) или [администратора](../security/index.md#organization-manager-admin) этой организации [добавить](../operations/add-account.md) вас. * Пользователи [федерации удостоверений](./add-federation.md), которая создана внутри организации (автоматически являются членами организации). - -Чтобы вступить в организацию, попросите [владельца](../security/index.md#organization-manager-organizations-owner) или [администратора](../security/index.md#organization-manager-admin) этой организации [добавить](../operations/add-account.md) вас. Вы также можете [создать](../operations/manage-organizations.md#create-additional-org) собственную организацию и стать ее владельцем. +* Владельцы организации, которые [создали](../operations/manage-organizations.md#create-additional-org) организацию или получили соответствующую роль. Пользователь может быть владельцем или членом одновременно нескольких организаций. [Переключаться](../operations/manage-organizations.md#switch-to-another-org) между организациями можно в [консоли управления]({{ link-console-main }}) и в [интерфейсе {{ cloud-center }}]({{ cloud-center-link }}). \ No newline at end of file diff --git a/ru/organization/operations/os-login-access.md b/ru/organization/operations/os-login-access.md index 8fec62ae139..695f608948c 100644 --- a/ru/organization/operations/os-login-access.md +++ b/ru/organization/operations/os-login-access.md @@ -11,7 +11,7 @@ description: Следуя данной инструкции, вы сможете {% note info %} -Образы с поддержкой OS Login доступны в [{{ marketplace-full-name }}](/marketplace) и содержат `OS Login` в названии. +Образы с поддержкой OS Login доступны в [{{ marketplace-full-name }}](/marketplace). Для ВМ, созданных из таких образов, в [консоли управления]({{ link-console-main }}) в форме создания и редактирования ВМ в блоке **{{ ui-key.yacloud.compute.instances.create.section_access }}** активна опция **Доступ по OS Login**. Если эта опция неактивна, значит выбранный образ не поддерживает доступ по OS Login. {% endnote %} diff --git a/ru/overview/sla.md b/ru/overview/sla.md index 8c75ddfdaaf..082ccb0b5c2 100644 --- a/ru/overview/sla.md +++ b/ru/overview/sla.md @@ -9,5 +9,5 @@ description: Соглашение об уровне обслуживания SLA * уровни обслуживания сервисов {{ yandex-cloud }}. Вы можете ознакомиться с SLA по ссылкам: -* [Соглашение об уровне обслуживания {{ yandex-cloud }}](https://yandex.ru/legal/cloud_sla/?lang=ru) +* [Соглашение об уровне обслуживания {{ yandex-cloud }}]({{ link-sla }}) * [Уровни обслуживания для сервисов {{ yandex-cloud }}](https://yandex.ru/legal/cloud_sla_levels/?lang=ru) diff --git a/ru/presets.yaml b/ru/presets.yaml index 21a4e1a3ec0..4a7800066a8 100644 --- a/ru/presets.yaml +++ b/ru/presets.yaml @@ -60,7 +60,7 @@ default: billing-docs-email: cloud_docs@support.yandex.ru billing-interface: Интерфейс Yandex Cloud Billing billing-name: Yandex Cloud Billing - billing-oferta-url: https://yandex.ru/legal/cloud_oferta/ + billing-oferta-url: https://yandex.ru/legal/cloud_oferta/?lang=ru brand-voice-cc: Brand Voice Call Center brand-voice-cc-name: SpeechKit Brand Voice Call Center brand-voice-core: Brand Voice Self Service @@ -314,6 +314,7 @@ default: https://storage.yandexcloud.net/yc-compliance/certificates/YC_PCI_DSS_Guide.pdf link-saml: https://ru.wikipedia.org/wiki/SAML link-sd-main: https://center.yandex.cloud/security/ + link-sla: https://yandex.ru/legal/cloud_sla/ link-sla-greenplum: https://yandex.ru/legal/cloud_sla_greenplum/ link-sla-kafka: https://yandex.ru/legal/cloud_sla_kfk/ link-speechsense-main: https://speechsense.yandex.cloud/ @@ -663,6 +664,7 @@ default: s3-storage-host-doc-files: storage.yandexcloud.net/doc-files s3-storage-host-mch: storage.yandexcloud.net/managed-clickhouse s3-web-host: website.yandexcloud.net + sample-rfc3339-timestamp: '2006-01-02T15:04:05Z' schema-registry-name: Schema Registry sd-full-name: Yandex Security Deck sd-name: Security Deck @@ -689,7 +691,7 @@ default: speechkit-name: SpeechKit speechkit-short-name: SpeechKit speechkit-slug: speechkit - speechsense-endpoint: api.talk-analytics.yandexcloud.net:443 + speechsense-endpoint: api.speechsense.yandexcloud.net:443 speechsense-full-name: Yandex SpeechSense speechsense-name: SpeechSense SPRK: Apache Spark™ @@ -1241,10 +1243,12 @@ default: v3: cpu: c100|month|string: "5\_436,00\_₸" + c100|number: 7.55 c100|string: "7,55\_₸" c50|month|string: "2\_448,00\_₸" c50|string: "3,40\_₸" ram|month|string: "1\_440,00\_₸" + ram|number: 2 ram|string: "2,00\_₸" local-nvme: ch|month|string: "65,05\_₸" @@ -1288,10 +1292,12 @@ default: v3: cpu: c100|month|string: "5\_760,00\_₸" + c100|number: 8 c100|string: "8,00\_₸" c50|month|string: "2\_700,00\_₸" c50|string: "3,75\_₸" ram|month|string: "3\_240,00\_₸" + ram|number: 4.5 ram|string: "4,50\_₸" mysql: v1: @@ -1327,20 +1333,24 @@ default: c100: dedicated|string: "2,50\_₸" c100|month|string: "6\_048,00\_₸" + c100|number: 8.4 c100|string: "8,40\_₸" c50|month|string: "2\_340,00\_₸" c50|string: "3,25\_₸" ram: dedicated|string: "0,75\_₸" ram|month|string: "1\_656,00\_₸" + ram|number: 2.3 ram|string: "2,30\_₸" network-hdd: ch|month|number: 16 ch|month|string: "16,00\_₸" elasticsearch|month|string: "16,00\_₸" greenplum|month|string: "16,00\_₸" + kafka|month|number: 16 kafka|month|string: "16,00\_₸" mongodb|month|string: "16,00\_₸" + mysql|month|number: 16 mysql|month|string: "16,00\_₸" opensearch|month|string: "16,00\_₸" pg|month|string: "16,00\_₸" @@ -1348,6 +1358,7 @@ default: ch|month|string: "65,05\_₸" elasticsearch|month|string: "65,05\_₸" greenplum|month|string: "65,05\_₸" + kafka|month|number: 65.05 kafka|month|string: "65,05\_₸" mongodb|month|string: "65,05\_₸" mysql|month|string: "65,05\_₸" @@ -1507,8 +1518,10 @@ default: c100|month|string: "3\_924,00\_₸" c100|string: "5,45\_₸" c50|month|string: "2\_520,00\_₸" + c50|number: 3.5 c50|string: "3,50\_₸" ram|month|string: "1\_008,00\_₸" + ram|number: 1.4 ram|string: "1,40\_₸" sku|KZT|mk8s: master: @@ -1704,15 +1717,35 @@ default: v1|string: "15\_000,00\_₸" sku|KZT|sws: requests: + v1|number: 0 v1|pricingRate: '0': + 01|number: 125000 01|string: "125\_000,00\_₸" + 1|number: 17500 1|string: "17\_500,00\_₸" + 10|number: 1000 10|string: "1\_000,00\_₸" + 100|number: 700 100|string: "700,00\_₸" + 1000|number: 250 1000|string: "250,00\_₸" 10000|string: "125,00\_₸" v1|string: Не тарифицируется + waf: + requests: + v1|number: 0 + v1|pricingRate: + '0': + 01|number: 125000 + 01|string: "125\_000,00\_₸" + 1|number: 17500 + 1|string: "17\_500,00\_₸" + 10|number: 1000 + 10|string: "1\_000,00\_₸" + 100|number: 700 + 100|string: "700,00\_₸" + 1000|number: 250 sku|KZT|v1: commitment: selfcheckout: @@ -2117,6 +2150,7 @@ default: v1|string: Не тарифицируется sku|RUB|datalens: users: + v1|number: 990 v1|string: "990,00\_₽" sku|RUB|datatransfer: compute: @@ -2372,10 +2406,12 @@ default: v3: cpu: c100|month|string: "1\_087,20\_₽" + c100|number: 1.51 c100|string: "1,51\_₽" c50|month|string: "489,60\_₽" c50|string: "0,68\_₽" ram|month|string: "288,00\_₽" + ram|number: 0.4 ram|string: "0,40\_₽" local-nvme: ch|month|string: "13,01\_₽" @@ -2419,10 +2455,12 @@ default: v3: cpu: c100|month|string: "1\_152,00\_₽" + c100|number: 1.6 c100|string: "1,60\_₽" c50|month|string: "540,00\_₽" c50|string: "0,75\_₽" ram|month|string: "648,00\_₽" + ram|number: 0.9 ram|string: "0,90\_₽" mysql: v1: @@ -2458,20 +2496,24 @@ default: c100: dedicated|string: "0,50\_₽" c100|month|string: "1\_209,60\_₽" + c100|number: 1.68 c100|string: "1,68\_₽" c50|month|string: "468,00\_₽" c50|string: "0,65\_₽" ram: dedicated|string: "0,15\_₽" ram|month|string: "331,20\_₽" + ram|number: 0.46 ram|string: "0,46\_₽" network-hdd: ch|month|number: 3.2 ch|month|string: "3,20\_₽" elasticsearch|month|string: "3,20\_₽" greenplum|month|string: "3,20\_₽" + kafka|month|number: 3.2 kafka|month|string: "3,20\_₽" mongodb|month|string: "3,20\_₽" + mysql|month|number: 3.2 mysql|month|string: "3,20\_₽" opensearch|month|string: "3,20\_₽" pg|month|string: "3,20\_₽" @@ -2479,6 +2521,7 @@ default: ch|month|string: "13,01\_₽" elasticsearch|month|string: "13,01\_₽" greenplum|month|string: "13,01\_₽" + kafka|month|number: 13.01 kafka|month|string: "13,01\_₽" mongodb|month|string: "13,01\_₽" mysql|month|string: "13,01\_₽" @@ -2638,8 +2681,10 @@ default: c100|month|string: "784,80\_₽" c100|string: "1,09\_₽" c50|month|string: "504,00\_₽" + c50|number: 0.7 c50|string: "0,70\_₽" ram|month|string: "201,60\_₽" + ram|number: 0.28 ram|string: "0,28\_₽" sku|RUB|mk8s: master: @@ -2835,15 +2880,35 @@ default: v1|string: "3\_000,00\_₽" sku|RUB|sws: requests: + v1|number: 0 v1|pricingRate: '0': + 01|number: 25000 01|string: "25\_000,00\_₽" + 1|number: 3500 1|string: "3\_500,00\_₽" + 10|number: 200 10|string: "200,00\_₽" + 100|number: 140 100|string: "140,00\_₽" + 1000|number: 50 1000|string: "50,00\_₽" 10000|string: "25,00\_₽" v1|string: Не тарифицируется + waf: + requests: + v1|number: 0 + v1|pricingRate: + '0': + 01|number: 25000 + 01|string: "25\_000,00\_₽" + 1|number: 3500 + 1|string: "3\_500,00\_₽" + 10|number: 200 + 10|string: "200,00\_₽" + 100|number: 140 + 100|string: "140,00\_₽" + 1000|number: 50 sku|RUB|v1: commitment: selfcheckout: @@ -3494,10 +3559,12 @@ default: v3: cpu: c100|month|string: "8,697600\_$" + c100|number: 0.01208 c100|string: "0,012080\_$" c50|month|string: "3,916800\_$" c50|string: "0,005440\_$" ram|month|string: "2,304000\_$" + ram|number: 0.0032 ram|string: "0,003200\_$" local-nvme: ch|month|string: "0,104080\_$" @@ -3541,10 +3608,12 @@ default: v3: cpu: c100|month|string: "9,216000\_$" + c100|number: 0.0128 c100|string: "0,012800\_$" c50|month|string: "4,320000\_$" c50|string: "0,006000\_$" ram|month|string: "5,184000\_$" + ram|number: 0.0072 ram|string: "0,007200\_$" mysql: v1: @@ -3592,6 +3661,7 @@ default: ch|month|string: "0,025600\_$" elasticsearch|month|string: "0,025600\_$" greenplum|month|string: "0,025600\_$" + kafka|month|number: 0.0256 kafka|month|string: "0,025600\_$" mongodb|month|string: "0,025600\_$" mysql|month|string: "0,025600\_$" @@ -3601,6 +3671,7 @@ default: ch|month|string: "0,104080\_$" elasticsearch|month|string: "0,104080\_$" greenplum|month|string: "0,104080\_$" + kafka|month|number: 0.10408 kafka|month|string: "0,104080\_$" mongodb|month|string: "0,104080\_$" mysql|month|string: "0,104080\_$" @@ -3754,7 +3825,9 @@ default: v3: cpu: c100|string: "0,008720\_$" + c50|number: 0.0056 c50|string: "0,005600\_$" + ram|number: 0.00224 ram|string: "0,002240\_$" sku|USD|mk8s: master: @@ -3948,15 +4021,30 @@ default: v1|string: "24,000000\_$" sku|USD|sws: requests: + v1|number: 0 v1|pricingRate: '0': + 01|number: 200 01|string: "200,000000\_$" + 1|number: 28 1|string: "28,000000\_$" + 10|number: 1.6 10|string: "1,600000\_$" + 100|number: 1.12 100|string: "1,120000\_$" + 1000|number: 0.4 1000|string: "0,400000\_$" 10000|string: "0,200000\_$" v1|string: Не тарифицируется + waf: + requests: + v1|pricingRate: + '0': + 01|number: 200 + 1|number: 28 + 10|number: 1.6 + 100|number: 1.12 + 1000|number: 0.4 sku|USD|v1: commitment: selfcheckout: @@ -4687,162 +4775,39 @@ default: issue: Создать задачу transition: Изменить статус задачи startrek: - ui_components_actions-panel_ActionsPanel: + ui_Boards_pages_PageAgileBoard_PageAgileBoardHeader_EnableBacklogButton: + enable-backlog: Включить бэклог + ui_Boards_pages_PageAgileBoard_PageAgileBoardHeader: + settings: Настройки + ui_Common_pages_page-my_PageMy: + page-title: Моя страница + ui_Common_pages_promo_Page: + login-button-label: Войти в Tracker + ui_Common_smart-components_actions-panel_ActionsPanel: action-menu-title: Действия - ui_components_admin-repositories_ConnectRepositoryDialog_fields_UrlField: - server-url-label: Ссылка на репозиторий - ui_components_admin-repositories_ConnectRepositoryDialog: + ui_Common_smart-components_admin-repositories_ConnectRepositoryDialog: connect: Подключить token-label: Токен - ui_components_admin-tab-types_AdminTabTypes: - title: Типы задач - ui_components_agile_agile-board_AgileBoardActionsMenu: - delete-board-menu-item: Удалить доску - migration-rollback: Миграция в старую версию - ui_components_agile_agile-board_AgileBoardAddColumnButton: - new-column-button: Добавить колонку - ui_components_agile_agile-board_AgileBoardColumnHeader: - column-menu--add-note: Добавить заметку - column-menu--delete: Удалить - column-menu--edit: Редактировать - ui_components_agile_agile-board_AgileBoardCreateModal: - board-type--scrum: С бэклогом и спринтами - board-type--simple: Простая - submit-btn: Создать - ui_components_agile_agile-board_AgileBoardEmptyScreen: - empty-screen--new-issue: Новая задача - ui_components_agile_agile-board_AgileBoardIssue: - issue-actions--delete-from-board: Убрать с доски - issue-actions--move-down: Перенести вниз колонки - issue-actions--move-up: Перенести наверх колонки - ui_components_agile_agile-board_AgileBoardMigrationForm: - submit-btn: Начать миграцию - ui_components_agile_agile-board_AgileBoardUnusedStatuses: - unused-statuses-add-to-column: Добавить в колонку - unused-statuses-create-column: Создать колонку - ui_components_agile_backlog_BacklogAddColumnButton: - add-column: Добавить колонку - ui_components_agile_backlog_BacklogIssue: - backlog-default-column: Бэклог - ui_components_agile_common_AddIssueButton: - add-issue-button: Добавить задачу - ui_components_agile_common_AgileFilters: - action-title-save: Сохранить - all-issues-filter-title: Все задачи - reset-button: Сбросить - ui_components_agile_common_AgileTabs: - backlog: Бэклог - board: Доска - poker: Покер - ui_components_agile_common_BulkActionsPanel: - add-to-sprint: Добавить в спринт - ui_components_agile_common_ColumnForm: - create-column-label--statuses: Статусы в колонке - create-column-submit-button--create: Добавить - ui_components_agile_common_FieldsSelect: - fields-settings: Поля карточки - ui_components_agile_common_FinishedSprintsButton: - finished-sprints: Завершенные спринты - ui_components_agile_common_IssueActionsMenu: - select-issue: Выделить - ui_components_agile_common_QuickFilterPopup: - filters-manage: Управление фильтрами - ui_components_agile_common_QuickFiltersItem: - quick-filter--assignee-me: Я исполнитель - quick-filter--author-me: Я автор - ui_components_agile_common_SprintForm: - create-sprint: Создать спринт - edit-sprint: Редактировать спринт - ui_components_agile_common_SprintFormFields: - take-sprint-to-work: Взять в работу - ui_components_agile_common_StartSprintButton: - start: Запустить - ui_components_agile_common_UnusedStatusesButton: - unused-statuses-button: Неиспользуемые статусы - ui_components_agile_common_ViewModeControl: - columns: Колонки - columnsByStatus: Колонки по статусам - customColumns: Произвольные колонки - ui_components_agile_poker_hooks: - add-issue-to-poker: Добавить в покер - ui_components_agile_poker_PokerButton: - poker: Покер - ui_components_agile_poker_PokerIssueForm: - apply-estimate: Выставить итоговую - show-estimates: Показать оценки - ui_components_agile_settings_AgileSettingsLayout: - issue-updates: Автоматическое добавление
    и удаление задач - poker: Покер - ui_components_agile_settings_BoardIssueUpdatesSettings: - import-title: Добавление задач на доску - removal-title: Удаление задач с доски - ui_components_agile_settings_PokerSettings: - aggregation-function-field-label: Расчёт итоговой оценки - deck-field-label: Колода оценок - display-estimated-field-label: Отображать оценённые задачи - save: Сохранить - ui_components_App: - title-queues: Очереди - ui_components_attachments-manager: + ui_Common_smart-components_attachments-manager: attach: Прикрепить файлы attachments-section-title: Файлы - ui_components_bulk_BulkChangeParametersDialog: + ui_Common_smart-components_bulk_BulkChangeParametersDialog: button-submit-text: Применить - ui_components_BulkSuggestPopup: + ui_Common_smart-components_BulkSuggestPopup: apply: Применить - ui_components_CreateIssueForm: - create-issue: Создать задачу - ui_components_dashboard_CollapseHeader: - copy-menu-item: Копировать - ui_components_dashboard_DashboardActionsMenu: - set-start-page-action: Сделать стартовой - ui_components_dashboard_DashboardHeader: - dashboard-header-add-button: Добавить - dashboard-header-add-orgAdmin: Информация для сотрудников - dashboard-header-settings-button: Редактировать - ui_components_dashboard_FilterEditor: - editor-source-radio-query: Язык запросов - ui_components_dashboard_InfoPresetsWidget: - choose-template-button: Выбрать шаблон - widget-title: Шаблоны рабочих процессов - ui_components_dashboard_IssuesStatEditor: - editor-sort-by-field-label: Сортировка - editor-source-radio-parameters: Параметры - ui_components_dashboard_OrgAdminEditor: - editor-published-field-label: Виджет опубликован - editor-save-button: Сохранить - ui_components_dashboard_TableWidget: - show-all: Показать все - ui_components_entity-page_ActivitySection: - activity: Активность - new-activity-on-top: Сначала новые - ui_components_entity-page_checklist_ChecklistActionsMenu: + ui_Common_smart-components_entity-page_checklist_ChecklistActionsMenu: remove-title: Удалить чеклист - ui_components_entity-page_checklist_ChecklistItem: - button-cancel: Отменить - button-submit: Сохранить - remove-item-title: Удалить пункт - ui_components_entity-page_checklist_Footer: + ui_Common_smart-components_entity-page_checklist_Footer: new-item-button-caption: Добавить пункт - ui_components_entity-page_checklist_Header: + ui_Common_smart-components_entity-page_checklist_Header: header-title: Чеклист - ui_components_entity-page_comments_CommentEditor_mobile: - write-comment: Написать комментарий - ui_components_entity-page_macros_FavoriteButton: + ui_Common_smart-components_entity-page_macros_FavoriteButton: button-tooltip-add: Добавить в избранное - ui_components_entity-page_macros_MacrosExecutor: - apply-button-label: Выполнить - ui_components_entity-page_sidebar_SidebarFieldsSelect: + ui_Common_smart-components_entity-page_sidebar_SidebarFieldsSelect: add-sidebar-field: Изменить список параметров - ui_components_FieldEdit: - form-submit: Сохранить - ui_components_filter-field: - save-button: Сохранить - ui_components_filter-pane_FieldsSelectButton: + ui_Common_smart-components_filter-pane_FieldsSelectButton: add-filter-field-button-title: Добавить поле для фильтрации - ui_components_filter-pane_ViewModeSwitch: - mode-gantt: Диаграмма Ганта - ui_components_filter-pane: + ui_Common_smart-components_filter-pane: action-title-save: Сохранить action-title-save-as: Сохранить как новый all-issues-filter-title: Все задачи @@ -4850,35 +4815,68 @@ default: list-mode-tree: Древовидный список reset-button: Сбросить search-placeholder: Поиск по названию задачи - ui_components_FilterExportMenu: - menu-item-export: Выгрузить - title: Действия над фильтром - ui_components_FormField_TimeTrackingBlock: + ui_Common_smart-components_FormField_TimeTrackingBlock: field-comment-title: Комментарий field-datetime-title: Дата записи field-estimation-title: Общая оценка задачи field-remain-title: Осталось времени field-spent-title: Затрачено времени - ui_components_Gantt_IssueActionsCell: - issue-action-menu-title: Меню действий задачи - ui_components_Gantt: - color-type-by-manual: назначать вручную - color-type-by-parameter: по параметрам задачи - color-type-monochrome: однотонный - delete-link: Удалить связь - exit: Выйти - scale-days: Неделя - scale-month: Месяц - scale-quarters: Квартал - shift-blocked-with-blocker: >- - Автоматически сдвигать сроки зависимой задачи при переносе дедлайна - блокирующей задачи - show-external-blockers: Показывать внешние блокеры - show-issue-assignee: исполнителя - show-issue-title: название - show-links: Показывать блокирующие связи - timeline-config: Настройки диаграммы - ui_components_issue-actions_IssueMenu: + ui_Common_smart-components_page-admin_OrganizationSmallPane: + add-org-button: Добавить организацию + ui_Common_smart-components_page-admin_OrgGroupsPane: + access-level_full-access: Полный + access-level_read_only: Чтение + title_access: Доступ в Tracker + ui_Common_smart-components_page-admin_OrgPanes_CloudOrgPane: + federation-task-action: Подключить + source-title: Yandex Cloud Organization + ui_Common_smart-components_page-admin_OrgPanes_DirectoryOrgPane: + domain-task-action: Подключить + source-title: Яндекс 360 для бизнеса + ui_Common_smart-components_page-admin_PageAdmin: + access-and-payment: Доступы и оплата + menu-item-groups: Группы + menu-item-orgs: Организации + menu-item-repositories: Репозитории + menu-item-users: Пользователи + ui_Common_smart-components_SortButton: + default-title: Сортировка + ui_Common_smart-components_timetracking-history-dialog_TimeTrackingDialogBody: + column-comment: Комментарий + column-date: Дата записи + column-spent: Затрачено времени + ui_Common_smart-components_timetracking-history-dialog_TimeTrackingHistoryDialog: + title: История учёта времени + ui_Common_smart-components_TrackerSearch: + queues: Очереди + ui_Dashboards_smart-components_DashboardHeader: + dashboard-header-add-button: Добавить + dashboard-header-add-orgAdmin: Информация для сотрудников + dashboard-header-settings-button: Редактировать + ui_Dashboards_smart-components_InfoPresetsWidget: + choose-template-button: Выбрать шаблон + widget-title: Шаблоны рабочих процессов + ui_Dashboards_smart-components_OrgAdminEditor: + editor-published-field-label: Виджет опубликован + editor-save-button: Сохранить + ui_Issues_pages_page-issues_touch: + all-issues-filter-title: Все задачи + query-language: Язык запросов + ui_Issues_pages_PageCreateIssue: + change-template: Редактировать форму + change-title-and-description: Изменить название и описание + create-new: Создать форму + create-new-template: Создать новую форму + description-placeholder: >- + Добавьте описание, чтобы исполнителю было понятно, что нужно сделать в + этой задаче + switch-to-admin-panel: Перейти в админку + try-yandex-forms: Попробуйте Yandex Forms для создания задач + ui_Issues_pages_PageCreateIssueForm: + continue: Продолжить + ui_Issues_pure-components_issue-comments-templates: + create-template-item: Создать шаблон + ui_Issues_smart-components_issue-actions_IssueMenu: add-notification: Добавить напоминание add-worklog: Указать затраченное время calendar-event-me: Зарезервировать время для работы над задачей @@ -4889,22 +4887,16 @@ default: move-issue: Изменить очередь title: Действия to-subissue: Сделать подзадачей - ui_components_issue-actions_worklog_AddWorklogDialog: + ui_Issues_smart-components_issue-actions_worklog_AddWorklogDialog: apply-button: Сохранить date-label: Начало работы duration-label: Затрачено времени - ui_components_issue-comments-templates: - create-template-item: Создать шаблон - ui_components_issue-links_ExternalLinksCollapse: + ui_Issues_smart-components_issue-links_ExternalLinksCollapse: external-relations: Связи с внешними приложениями - ui_components_issue-links_InternalLinksCollapse: - relations: Связанные задачи - ui_components_issue-templates_Select: + ui_Issues_smart-components_issue-templates_Select: manage-templates: Управление шаблонами select-template: Применить шаблон - ui_components_IssueActionsButton: - menu-item-create-subticket: Создать подзадачу - ui_components_IssueBulkActionPanel: + ui_Issues_smart-components_IssueBulkActionPanel: add-link: Добавить связь add-me-to-followers: Добавить меня в наблюдатели add-to-board: Добавить на доску @@ -4917,77 +4909,15 @@ default: move: Переместить remove-from-both-fields: Из обоих полей remove-me-from: Удалить меня из поля... - ui_components_issues_create-issue-popup_NewIssueForm: - milestone-type: Веха - ui_components_issues-import_IssuesImportDialog: - import: Импортировать - ui_components_issues-import_IssuesImportFilters: - add-parameters: Добавить параметры - ui_components_IssuesGroupHeader: - no-epic: Без эпика - ui_components_IssuesPresetSelect: + ui_Issues_smart-components_IssuesPresetSelect: preset_assignee: Я исполнитель preset_author: Я автор preset_deadline: Скоро дедлайн preset-deadline: Скоро дедлайн - ui_components_IssueTabs: - description-tab: Описание - fields-tab: Параметры - links-tab: Связи - ui_components_ModalTextEditor: - save: Сохранить - ui_components_navigation: - invite-user: Добавить пользователя - ui_components_new-process_ProcessTypeStepRedesign: - information-time-tracking-title: Учёт времени - process-type-development: Разработка - process-type-project: Управление проектами - process-type-standard: Базовый - process-type-support: Поддержка - ui_components_new-process_QueueSetupForm: - next-button: Продолжить - ui_components_page-admin_BillingAccountInfo: - person-type-company: Юридическое лицо или ИП - person-type-invididual: Физическое лицо - rebind-account: Заменить платёжный аккаунт - refill-balance: Пополнить баланс - refill-dialog-ok-issue: Выписать счёт - ui_components_page-admin_BillingAccountList: - bind: Привязать - create-account: Создать новый аккаунт - ui_components_page-admin_BillingScreen: - create-account: Создать - ui_components_page-admin_ChangeOrganizationModal: - add-button: Сменить организацию - ui_components_page-admin_OrganizationSmallPane: - add-org-button: Добавить организацию - ui_components_page-admin_OrgMainInfoPane: - org-manage-button: Управление организацией - ui_components_page-admin_OrgPanes_CloudOrgPane: - federation-task-action: Подключить - source-title: Yandex Cloud Organization - ui_components_page-admin_OrgPanes_DirectoryOrgPane: - domain-task-action: Подключить - source-title: Яндекс 360 для бизнеса - ui_components_page-admin_OrgUsersPane: - access-level_full-access: Полный - access-level_read_only: Чтение - title_access: Доступ в Tracker - ui_components_page-admin_PageAdmin: - access-and-payment: Доступы и оплата - menu-item-groups: Группы - menu-item-orgs: Организации - menu-item-repositories: Репозитории - menu-item-users: Пользователи - ui_components_page-issues_touch_FilterSettingsMenu: - item-filters: Фильтры - item-group: Группировка - ui_components_page-issues_touch: - all-issues-filter-title: Все задачи - query-language: Язык запросов - ui_components_page-my_PageMy: - page-title: Моя страница - ui_components_page-queue-admin_AliasesCreateForm: + ui_Portfolios_smart-components_project-list_utils: + field-name-resolution: Резолюция + filter-macro-empty_: Без значения + ui_Queues_pages_page-queue-admin_AliasesCreateForm: mail-address: Почта mail-allow-external: Принимать письма не только от сотрудников организации mail-archive-folder: Папка для архива @@ -5000,7 +4930,7 @@ default: mail-settings-title: Почта для получения писем mail-ssl: Защищенное соединение (SSL) save-button: Сохранить - ui_components_page-queue-admin_AliasesFormSendPanel: + ui_Queues_pages_page-queue-admin_AliasesFormSendPanel: send-mail-login: Логин send-mail-password: Пароль send-mail-port: Порт @@ -5009,89 +4939,28 @@ default: send-settings-title: Почта для отправки ответов signature-settings-title: Подписи test-mail-button: Отправить тестовое письмо - ui_components_page-queue-admin_AliasesStateList: + ui_Queues_pages_page-queue-admin_AliasesStateList: action-add-mail: Добавить адрес action-domain: Подключить домен - ui_components_page-queue-admin_queue-admin-tab-integrations-forms_components_FormsMenu: - add-form: Добавить форму - create-new: Создать новую - ui_components_page-queue-admin_QueueActionsMenu: + ui_Queues_pages_page-queue-admin_QueueActionsMenu: remove-queue-action: Удалить очередь - ui_components_page-queue-admin_QueueAdminPageContent: + ui_Queues_pages_page-queue-admin_QueueAdminPageContent: menu-item-aliases: Почтовые ящики menu-item-autoactions: Автодействия menu-item-forms: Интеграция форм menu-item-permissions: Права доступа menu-item-timetracking: Учёт времени menu-item-workflows: Рабочие процессы - ui_components_page-queue-admin_QueueAdminTabPermissions_ChangeOwnerForm: + ui_Queues_pages_page-queue-admin_QueueAdminTabPermissions_ChangeOwnerForm: change-owner: Изменить владельца set-as-default: Назначать исполнителем по умолчанию - ui_components_page-queue-admin_Signature: - alias-title: Псевдоним - ui_components_PageAgileBoard_PageAgileBoardHeader_EnableBacklogButton: - enable-backlog: Включить бэклог - ui_components_PageAgileBoard_PageAgileBoardHeader: - settings: Настройки - ui_components_PageAgileBoardSettings_Header: - settings: Настройки - ui_components_PageCreateIssue: - change-template: Редактировать форму - change-title-and-description: Изменить название и описание - create-new: Создать форму - create-new-template: Создать новую форму - description-placeholder: >- - Добавьте описание, чтобы исполнителю было понятно, что нужно сделать в - этой задаче - switch-to-admin-panel: Перейти в админку - try-yandex-forms: Попробуйте Yandex Forms для создания задач - ui_components_PageCreateIssueForm: - continue: Продолжить - ui_components_PageHiThere: - wrong-user-btn: Войти - ui_components_PageIssues: - search-title: Поиск по всем задачам - ui_components_PageQueue_header: + ui_Queues_pages_PageQueue_header: export: Выгрузить settings: Настройки очереди subscribe: Подписаться subscribe-all: Подписаться на все уведомления subscribe-new-tickets: Подписаться на создание задач - ui_components_PageQueues: - new-queue: Создать очередь - ui_components_portfolios_Header: - description-tab: О портфеле - projects-tab: Проекты - ui_components_portfolios_portfolio-page_ListFilterPane: - filter-issues: По задачам - filter-projects: По проектам - search-placeholder: Поиск - ui_components_portfolios_PortfolioMenu: - remove-portfolio: Удалить портфель проектов - ui_components_projects_hooks: - copy-to-clipboard: Скопировать ссылку - delete-from-project: Удалить из проекта - issue-actions--move-down: Перенести вниз списка - issue-actions--move-up: Перенести наверх списка - ui_components_projects_Sidebar: - sidebar-param-title--endDate: Дедлайн - sidebar-param-title--lead: Ответственный - sidebar-param-title--startDate: Дата начала - sidebar-param-title--status: Статус - sidebar-param-title--teamUsers: Участники - ui_components_projects_Table: - add-issue: Добавить задачу - add-sub-issue: Добавить подзадачу - ui_components_projects_utils: - field-name-resolution: Резолюция - filter-macro-empty_: Без значения - ui_components_promo_Page: - login-button-label: Войти в Tracker - ui_components_queue-admin-tab-integrations_IntegrationForms: - title: Формы - ui_components_queue-admin-tab-main_QueueAdminTabMain: - save: Сохранить - ui_components_queue-admin-tab-timetracking_TimetackingForm: + ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm: field-can-assignee-update-time: Разрешить редактирование своих записей field-show-time-field-on-close: Рассчитывать затраченное время автоматически field-track-time-in-issues: Включить расширенный учёт времени @@ -5099,40 +4968,34 @@ default: field-use-summary-time: Отображать поле “Общая оценка задачи” field-working-calendar: График работы save: Сохранить - ui_components_queue-admin-tab-workflows_CopyWorkflowDialog: + ui_Queues_pages_queue-admin-tab-workflows_CopyWorkflowDialog: action-copy: Скопировать label-name: Название нового процесса label-queue: Копировать из очереди label-workflow: Копируемый процесс - ui_components_queue-admin-tab-workflows_WorkflowsStateList: + ui_Queues_pages_queue-admin-tab-workflows_WorkflowsStateList: action-new-process: Создать рабочий процесс default-type-title: Тип задачи по умолчанию - ui_components_QueueAdminTemplateOptions: + ui_Queues_smart-components_new-process_ProcessTypeStepRedesign: + information-time-tracking-title: Учёт времени + process-type-development: Разработка + process-type-project: Управление проектами + process-type-standard: Базовый + process-type-support: Поддержка + ui_Queues_smart-components_new-process_QueueSetupForm: + next-button: Продолжить + ui_Queues_smart-components_QueueAdminTemplateOptions: allow-empty-template: Разрешить создание задач без формы always: всегда never: никогда team: только команде очереди - ui_components_settings_IssueUpdatesSettings: - save: Сохранить - ui_components_SortButton: - default-title: Сортировка - ui_components_timetracking-history-dialog_TimeTrackingDialogBody: - column-comment: Комментарий - column-date: Дата записи - column-spent: Затрачено времени - ui_components_timetracking-history-dialog_TimeTrackingHistoryDialog: - title: История учёта времени - ui_components_TrackerSearch: - queues: Очереди - ui_components_TransitionScreen: - screen-next-button: Продолжить - ui_components_workflow-conditions_ConditionsMenu: + ui_Queues_smart-components_workflow-conditions_ConditionsMenu: add-condition: Добавить условие - ui_components_workflow-conditions_WorkflowGroupCondition: + ui_Queues_smart-components_workflow-conditions_WorkflowGroupCondition: add-conditions-group: Добавить группу условий - ui_components_workflow-functions_WorkflowFunctionMenu: + ui_Queues_smart-components_workflow-functions_WorkflowFunctionMenu: menu-title: Добавить автоматизацию - ui_components_workflow-functions: + ui_Queues_smart-components_workflow-functions: type-AddCommentFunction: Добавить комментарий type-AddTextToFieldFunction: Заполнить поле type-CalculateFieldFunction: Записать сумму чисел в поле @@ -5265,10 +5128,12 @@ default: label_from: От label_product: Продукты label_service: Сервисы + label_title: Детализация label_title-usage-short: Потребление за label_to: До label_top-cost: Стоимость потребления label_top-total: К оплате + popup-csv_button_download: Скачать tab_label: По меткам tab_product: По продуктам tab_service: По сервисам @@ -6092,19 +5957,6 @@ default: title_section-server-network-settings: Сетевые настройки title_section-server-product: Образ title_server-access: Доступ - billing: - account: - dashboard-overview: - button_refill: Пополнить баланс - popup-refill_button_company-action: Выписать счет - detail: - button_export: Экспорт детализации - label_title: Детализация - popup-csv_button_download: Скачать - tab_product: По продуктам - switch_detail: Детализация - label_accounts: Аккаунты - label_service: Биллинг cdn: button_activate-shielding: Включить button_add-domain: Добавить доменное имя @@ -6287,7 +6139,6 @@ default: switch_logs: Логи switch_ml-models: Машинное обучение switch_monitoring: Мониторинг - switch_operations: Операции switch_shard-groups: Группы шардов switch_shards: Шарды switch_users: Пользователи @@ -6396,7 +6247,6 @@ default: compute: network-select: field_address: IP-адрес - field_advanced: Дополнительно field_external: Публичный адрес field_internal-ipv4: Внутренний IPv4-адрес field_security-groups: Группы безопасности @@ -6422,7 +6272,6 @@ default: field_platform: Платформа field_preemptible: Прерываемая field_sw-accelerated-net: Программное ускорение сети - label_sw-accelerated-net: Программно-ускоренная сеть label_tab-custom: Своя конфигурация label_tab-gpu: GPU value_platform-tab-gpu: Есть GPU @@ -6632,7 +6481,8 @@ default: popup-upload_field_pooled: Оптимизировать для развертывания instance: access-method: - field_os-login-access-method: Доступ через OS Login + field_os-login-access-method: Доступ по OS Login + label_oslogin-control-ssh-option-title: SSH-ключ console: connect: Подключиться edit-network-interface: @@ -6671,7 +6521,6 @@ default: button_create: Добавить field_name: Имя field_source: Наполнение - label_title: Добавление дополнительного диска value_source-disk: Диск value_source-image: Образ value_source-none: Пустой @@ -6708,7 +6557,7 @@ default: image_value_marketplace: Marketplace label_add-network-interface: Добавить сетевой интерфейс section_access: Доступ - section_additional: Дополнительные настройки + section_additional: Дополнительно section_backup: Cloud Backup section_base: Общая информация section_coi: Настройка Docker-контейнера @@ -6737,12 +6586,10 @@ default: landing: action_create-resource: Создать ресурс nfs: - button_attach-filesystem-to-the-instance: Подключить файловое хранилище button_attach-instance-to-the-filesystem: Подключить к ВМ button_create-filesystem: Создать файловое хранилище button_detach-instance-from-the-filesystem: Отключить файловое хранилище label_attached-instances: Виртуальные машины - label_filesystems: Файловые хранилища placement-group: disks: button_add-disk: Добавить диск @@ -7052,7 +6899,7 @@ default: label_cloud-desktop: Cloud Desktop label_compute: Compute Cloud label_container-registry: Container Registry - label_data-proc: Yandex Data Proc + label_data-proc: Yandex Data Processing label_data-streams: Data Streams label_data-transfer: Data Transfer label_data-transfer_ru: Data Transfer @@ -7099,7 +6946,7 @@ default: label_yq_ru: Yandex Query value_audit-trails: Audit trail value_compute: Виртуальная машина - value_data-proc: Кластер Yandex Data Proc + value_data-proc: Кластер Yandex Data Processing value_data-streams: Data Streams value_data-transfer: Data Transfer value_managed-mysql: Кластер MySQL @@ -7228,7 +7075,7 @@ default: popup-add_field_name: Имя node-group: access-method: - field_os-login-access-method: Доступ через OS Login + field_os-login-access-method: Доступ по OS Login overview: label_network-hdd: HDD label_network-ssd: SSD @@ -7311,6 +7158,7 @@ default: field_connector-secret-access-key: Секретный ключ field_connector-security-protocol: Протокол безопасности field_connector-ssl-truststore-certificates: Сертификат в формате PEM + field_kraft-combined-mode: Комбинированный режим field_rest-api-config: Kafka Rest API field_schema-registry: Реестр схем данных label_brokers-per-az: Количество брокеров в зоне @@ -7485,6 +7333,7 @@ default: label_value: Значение title_auto-generation_params_section: Параметры автоматической генерации title_kms-key: Ключ KMS + title_secret-data-section: Данные секрета title_secret-type: Тип секрета title_secret-type-custom: Пользовательский title_secret-type-generated: Генерируемый @@ -7707,7 +7556,6 @@ default: button_add-host: Добавить хост button_add-initialization-action: Добавить button_add-subcluster: Добавить - button_configure: Добавить button_configure-settings: Настроить button_create: Создать кластер button_create-shard: Создать шард @@ -7741,7 +7589,6 @@ default: field_diagnostics-sessions-interval: Интервал сбора сессий field_diagnostics-statements-interval: Интервал сбора запросов field_initialization-action-args: Аргументы - field_initialization-action-timeout: Таймаут field_initialization-action-uri: URI field_security-group: Группы безопасности host_column_assign_public_ip: Публичный доступ @@ -7751,7 +7598,6 @@ default: host_column_zone: Зона доступности label_autoscaling-activated: Автоматическое масштабирование label_compute-subcluster: Compute - label_create-subcluster: Добавить подкластер label_data-subcluster: Data label_deletion-protection: Защита от удаления label_disk-size: Размер @@ -7823,7 +7669,6 @@ default: switch_hosts: Хосты switch_logs: Логи switch_monitoring: Мониторинг - switch_operations: Операции switch_shards: Шарды switch_users: Пользователи hosts: @@ -7841,7 +7686,6 @@ default: switch_hosts: Хосты switch_logs: Логи switch_monitoring: Мониторинг - switch_operations: Операции switch_users: Пользователи field_backup_priority: Приоритет cоздания бэкапа field_priority: Приоритет мастера @@ -7854,6 +7698,7 @@ default: field_dashboards-url: kibana_url field_enabled: Активировать field_idp-entity-id: idp_entity_id + field_jwt-default-expiration-timeout: Таймаут сессии field_roles-key: roles_key field_sp-entity-id: sp_entity_id field_subject-key: subject_key @@ -7893,7 +7738,6 @@ default: switch_hosts: Хосты switch_logs: Логи switch_monitoring: Мониторинг - switch_operations: Операции switch_users: Пользователи databases: dialog: @@ -8437,7 +8281,6 @@ default: overview: button_create_route-table: Создать таблицу маршрутизации button_create_subnetwork: Создать подсеть - column_subnetwork_id: Идентификатор section_subnetworks: Подсети security-groups: button_add-rule: Добавить правило @@ -8749,6 +8592,9 @@ default: title: Пароль user: title: Пользователь + ConnmanConnection: + connection_id: + title: Подключение ConvertRecordOptions: add_rest_column: title: Добавить неразмеченные столбцы @@ -9331,9 +9177,6 @@ default: console: form: postgres: - ConnmanConnection: - connection_id: - title: Идентификатор подключения OnPremisePostgres: ca_certificate: title: Сертификат CA @@ -10144,7 +9987,7 @@ default: yc_crossplane: helmChart: name: cr.yandex/yc-marketplace/yandex-cloud/crossplane/crossplane - tag: 1.14.7 + tag: 1.14.8 yc_csi-s3: helmChart: name: cr.yandex/yc-marketplace/yandex-cloud/csi-s3/csi-s3 diff --git a/ru/query/quickstart/batch-example.md b/ru/query/quickstart/batch-example.md index d74e4f1a86f..897e5a3020b 100644 --- a/ru/query/quickstart/batch-example.md +++ b/ru/query/quickstart/batch-example.md @@ -6,10 +6,10 @@ Для выполнения примера: -1. [{#T}](#before-you-begin). -1. [{#T}](#create-binding). -1. [{#T}](#run-query). -1. [{#T}](#check-result). +1. [Подготовьтесь к работе](#before-you-begin). +1. [Подключитесь к данным](#create-binding). +1. [Выполните запрос](#run-query). +1. [Исследуйте результат](#check-result). {% note info %} diff --git a/ru/query/quickstart/streaming-example.md b/ru/query/quickstart/streaming-example.md index 77589d69140..49df6c5772f 100644 --- a/ru/query/quickstart/streaming-example.md +++ b/ru/query/quickstart/streaming-example.md @@ -6,11 +6,11 @@ Для выполнения примера: -1. [{#T}](#before-you-begin). -1. [{#T}](#create-datastream). -1. [{#T}](#configure-generation). -1. [{#T}](#run-query). -1. [{#T}](#check-result). +1. [Подготовьтесь к работе](#before-you-begin). +1. [Создайте поток данных](#create-datastream). +1. [Настройте генерацию данных](#configure-generation). +1. [Выполните запрос](#run-query). +1. [Исследуйте результат](#check-result). {% note info %} diff --git a/ru/query/quickstart/unified-example.md b/ru/query/quickstart/unified-example.md index 3907ef5d481..624b8fa0ff7 100644 --- a/ru/query/quickstart/unified-example.md +++ b/ru/query/quickstart/unified-example.md @@ -10,9 +10,9 @@ Для выполнения примера: -1. [{#T}](#before-you-begin). -1. [{#T}](#batch). -1. [{#T}](#stream). +1. [Подготовьтесь к работе](#before-you-begin). +1. [Проанализируйте данные из {{ objstorage-name }}](#batch). +1. [Проанализируйте потоковые данные из {{ yds-name }}](#stream). {% note info %} diff --git a/ru/query/sources-and-sinks/object-storage-write.md b/ru/query/sources-and-sinks/object-storage-write.md index cbb1fb4bdc7..c74635b0f50 100644 --- a/ru/query/sources-and-sinks/object-storage-write.md +++ b/ru/query/sources-and-sinks/object-storage-write.md @@ -12,7 +12,7 @@ FROM $data; ``` -Список поддерживаемых форматов и алгоритмов сжатия данных приведен в разделе [{#T}](#write-formats). +Список поддерживаемых форматов и алгоритмов сжатия данных приведен в разделе [Поддерживаемые форматы записи](#write-formats). ## Запись данных через соединение {#connection-write} diff --git a/ru/query/tutorials/cloud-logging.md b/ru/query/tutorials/cloud-logging.md index 8579ddf6ea7..d5caeef32ed 100644 --- a/ru/query/tutorials/cloud-logging.md +++ b/ru/query/tutorials/cloud-logging.md @@ -14,11 +14,11 @@ Для выполнения сценария: -1. [{#T}](#create-yds-stream). -1. [{#T}](#create-log-group). -1. [{#T}](#send-to-loggroup). -1. [{#T}](#connect-query). -1. [{#T}](#query). +1. [Создайте поток данных {{ yds-name }}](#create-yds-stream). +1. [Создайте лог-группу {{ cloud-logging-name }}](#create-log-group). +1. [Запустите отправку данных в лог-группу](#send-to-loggroup). +1. [Подключите {{ yq-name }} к потоку данных](#connect-query). +1. [Выполните запрос к данным](#query). ## Перед началом работы {#before-you-begin} diff --git a/ru/query/tutorials/debezium.md b/ru/query/tutorials/debezium.md index ef0ff3e59db..ab88c7bc198 100644 --- a/ru/query/tutorials/debezium.md +++ b/ru/query/tutorials/debezium.md @@ -17,11 +17,11 @@ description: Следуя данному руководству, вы сможе Для выполнения сценария: -1. [{#T}](#create-yds-stream). -1. [{#T}](#credentials). -1. [{#T}](#debezium-server). -1. [{#T}](#connect-query). -1. [{#T}](#query). +1. [Создайте поток данных {{ yds-name }}](#create-yds-stream). +1. [Настройте реквизиты подключения к потоку](#credentials). +1. [Настройте Debezium Server](#debezium-server). +1. [Подключите {{ yq-name }} к потоку данных](#connect-query). +1. [Выполните запрос к данным](#query). ## Перед началом работы {#before-you-begin} diff --git a/ru/resource-manager/toc.yaml b/ru/resource-manager/toc.yaml index 7f6e2b1b931..6d863f0eb71 100644 --- a/ru/resource-manager/toc.yaml +++ b/ru/resource-manager/toc.yaml @@ -45,6 +45,12 @@ items: href: operations/folder/notify.md - name: Посмотреть операции с ресурсами сервиса href: operations/operation-logs.md + - name: Практические руководства + items: + - name: Все руководства + href: tutorials/index.md + - name: Настройка сетевого взаимодействия ресурсов из разных каталогов + href: tutorials/multi-folder-vpc.md - name: Концепции items: - name: Иерархия ресурсов Yandex Cloud diff --git a/ru/resource-manager/tutorials/index.md b/ru/resource-manager/tutorials/index.md new file mode 100644 index 00000000000..eba5bfd7394 --- /dev/null +++ b/ru/resource-manager/tutorials/index.md @@ -0,0 +1,8 @@ +--- +title: Сценарии использования {{ resmgr-full-name }} +description: Различные сценарии использования {{ resmgr-full-name }} в {{ yandex-cloud }}. +--- + +# Практические руководства {{ resmgr-name }} + +* [{#T}](multi-folder-vpc.md) diff --git a/ru/resource-manager/tutorials/multi-folder-vpc.md b/ru/resource-manager/tutorials/multi-folder-vpc.md new file mode 100644 index 00000000000..87fd22e412c --- /dev/null +++ b/ru/resource-manager/tutorials/multi-folder-vpc.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/routing/multi-folder-vpc' +--- + +{% include [multi-folder-vpc](../../_tutorials/routing/multi-folder-vpc.md) %} \ No newline at end of file diff --git a/ru/search-api/concepts/html-response.md b/ru/search-api/concepts/html-response.md index d26caecda23..45f6cd3a715 100644 --- a/ru/search-api/concepts/html-response.md +++ b/ru/search-api/concepts/html-response.md @@ -5,11 +5,15 @@ description: В данной статье описан HTML-формат отв # HTML-формат ответа при текстовом поиске -В ответ на текстовый поисковый запрос {{ search-api-name }} может возвращать HTML-файл с результатами поиска, идентичный HTML-странице соответствующей поисковой выдачи на главной странице [Яндекс Поиска]({{ link-yandex }}). +В ответ на текстовый поисковый запрос {{ search-api-name }} может возвращать HTML-файл с результатами поиска. Возвращаемый HTML-файл идентичен HTML-странице соответствующей поисковой выдачи на главной странице [Яндекс Поиска]({{ link-yandex }}) в [режиме инкогнито](https://ru.wikipedia.org/wiki/Режим_инкогнито). В настоящий момент ответ в HTML-формате доступен только для запросов, выполненных через интерфейс [API v1](./index.md#api-v1). -{% note alert %} +Результат запроса в HTML-формате содержит больше данных, чем результат аналогичного запроса в [XML-формате](./response.md): результат в HTML-формате включает в себя рекламу, быстрые ответы, а также другие элементы, которые могут появиться в поисковой выдаче. HTML-формат ответа регулярно обновляется вместе с форматом поисковой выдачи Яндекса. + +См. [пример](https://{{ s3-storage-host-doc-files }}/search-api-html-result-example.html) поисковой выдачи в HTML-формате. + +{% note info %} По каждому поисковому запросу возвращается не более 1000 результатов. В зависимости от значения атрибута [docs-in-group](post-request.md#post-docs-in-group), каждый результат может содержать от одного до трех документов. Максимальное количество страниц с результатами поиска определяется количеством групп документов, возвращаемых на каждой странице (значение атрибута [groups-on-page](post-request.md#post-groups-on-page)). Например, если атрибут `groups-on-page` передан со значением `10`, может быть сформировано не более 100 страниц, содержащих результаты поиска. diff --git a/ru/speechsense/api-ref/Talk/get.md b/ru/speechsense/api-ref/Talk/get.md index fc2fb9daa70..196f58ff35d 100644 --- a/ru/speechsense/api-ref/Talk/get.md +++ b/ru/speechsense/api-ref/Talk/get.md @@ -10,7 +10,7 @@ rpc for bulk get ## HTTP request ``` -POST https://speechsense.{{ api-host }}/speechsense/v1/talks/get +POST https://rest-api.speechsense.yandexcloud.net/speechsense/v1/talks/get ``` ## Body parameters {#yandex.cloud.speechsense.v1.GetTalkRequest} diff --git a/ru/speechsense/api-ref/Talk/search.md b/ru/speechsense/api-ref/Talk/search.md index 0bd3537333a..933ccd0ca1a 100644 --- a/ru/speechsense/api-ref/Talk/search.md +++ b/ru/speechsense/api-ref/Talk/search.md @@ -10,7 +10,7 @@ rpc for searching talks. will return ids only ## HTTP request ``` -POST https://speechsense.{{ api-host }}/speechsense/v1/talks/search +POST https://rest-api.speechsense.yandexcloud.net/speechsense/v1/talks/search ``` ## Body parameters {#yandex.cloud.speechsense.v1.SearchTalkRequest} diff --git a/ru/speechsense/api-ref/Talk/upload.md b/ru/speechsense/api-ref/Talk/upload.md index 5274ad7dda3..1538077f7b6 100644 --- a/ru/speechsense/api-ref/Talk/upload.md +++ b/ru/speechsense/api-ref/Talk/upload.md @@ -10,7 +10,7 @@ rpc for uploading talk document as single message ## HTTP request ``` -POST https://speechsense.{{ api-host }}/speechsense/v1/talks/upload +POST https://rest-api.speechsense.yandexcloud.net/speechsense/v1/talks/upload ``` ## Body parameters {#yandex.cloud.speechsense.v1.UploadTalkRequest} diff --git a/ru/speechsense/api-ref/Talk/uploadText.md b/ru/speechsense/api-ref/Talk/uploadText.md index c984eb86804..93847f040fb 100644 --- a/ru/speechsense/api-ref/Talk/uploadText.md +++ b/ru/speechsense/api-ref/Talk/uploadText.md @@ -10,7 +10,7 @@ rpc for uploading text talk document ## HTTP request ``` -POST https://speechsense.{{ api-host }}/speechsense/v1/talks/uploadText +POST https://rest-api.speechsense.yandexcloud.net/speechsense/v1/talks/uploadText ``` ## Body parameters {#yandex.cloud.speechsense.v1.UploadTextRequest} diff --git a/ru/speechsense/concepts/dictionaries.md b/ru/speechsense/concepts/dictionaries.md index c8fa2131cd1..ea089944cef 100644 --- a/ru/speechsense/concepts/dictionaries.md +++ b/ru/speechsense/concepts/dictionaries.md @@ -2,7 +2,7 @@ _Словарь_ — это набор ключевых фраз для [тегов](tags.md). Если диалог в {{ speechsense-name }} содержит фразу из словаря, на такой диалог назначается тег со соответствующим словарем. -Словари позволяют переиспользовать одинаковый набор ключевых слов для нескольких тегов. Так вы можете указать нужный набор слов один раз и поддерживать его в одном словаре. Если пользователь изменил набор слов в нем, изменения автоматически подтянутся во все теги, содержащие этот словарь. +Словари позволяют переиспользовать одинаковый набор ключевых слов для нескольких тегов. Так вы можете указать нужный набор слов один раз и поддерживать его в одном словаре. Если пользователь изменил набор слов в нем, изменения автоматически подтянутся во все теги, содержащие этот словарь. Если тег содержит несколько словарей, их содержимое суммируется, как если бы между ними стоял логический оператор ИЛИ. В {{ speechsense-name }} действуют три набора словарей: diff --git a/ru/speechsense/concepts/limits.md b/ru/speechsense/concepts/limits.md new file mode 100644 index 00000000000..b9f6f2f49f4 --- /dev/null +++ b/ru/speechsense/concepts/limits.md @@ -0,0 +1,12 @@ +--- +title: Квоты и лимиты в {{ speechsense-full-name }} +description: В {{ speechsense-full-name }} действуют лимиты и квоты на пересчет тегов, поисковую выдачу и срок хранения пользовательских данных. Более подробно об ограничениях в сервисе вы узнаете из данной статьи. +--- + +# Квоты и лимиты в {{ speechsense-name }} + +В сервисе {{ speechsense-name }} действуют следующие ограничения: + +{% include [quotes-limits-def.md](../../_includes/quotes-limits-def.md) %} + +{% include [speechsense-limits.md](../../_includes/speechsense-limits.md) %} diff --git a/ru/speechsense/operations/data/upload-chat-text.md b/ru/speechsense/operations/data/upload-chat-text.md index c650674a006..27bbc68cfb4 100644 --- a/ru/speechsense/operations/data/upload-chat-text.md +++ b/ru/speechsense/operations/data/upload-chat-text.md @@ -48,7 +48,7 @@ # Для аутентификации с IAM-токеном замените параметр api_key на iam_token def upload_talk(connection_id: str, metadata: Dict[str, str], api_key: str, text_data): credentials = grpc.ssl_channel_credentials() - channel = grpc.secure_channel('api.talk-analytics.yandexcloud.net:443', credentials) + channel = grpc.secure_channel('api.speechsense.yandexcloud.net:443', credentials) talk_service_stub = talk_service_pb2_grpc.TalkServiceStub(channel) diff --git a/ru/speechsense/operations/project/tag/create.md b/ru/speechsense/operations/project/tag/create.md index 1c6350209ee..a3bb16288b2 100644 --- a/ru/speechsense/operations/project/tag/create.md +++ b/ru/speechsense/operations/project/tag/create.md @@ -28,7 +28,7 @@ 1. В поле **{{ ui-key.yc-ui-talkanalytics.tags.key-phrases-key-value }}** перечислите фразы-триггеры. Каждую фразу укажите на отдельной строке. Если в диалоге присутствует фраза-триггер, этому диалогу присваивается тег. - Вместе с перечисленными ключевыми словами вы также можете указать [словари](../../../concepts/dictionaries.md). Они содержат заранее подготовленный набор фраз-триггеров. Теги будут назначаться на диалоги, которые содержат фразы из списка в поле **{{ ui-key.yc-ui-talkanalytics.tags.key-phrases-key-value }}** и из указанных словарей. Чтобы использовать словари, нажмите кнопку ![icon](../../../../_assets/console-icons/book-open.svg) **{{ ui-key.yc-ui-talkanalytics.dictionaries.add-dictionary }}** и в выпадающем списке выберите нужные словари. + Вместе с перечисленными ключевыми словами вы также можете указать [словари](../../../concepts/dictionaries.md), содержащие заранее подготовленный набор фраз-триггеров. Если указать несколько словарей, их содержимое будет суммироваться, как если бы между ними стоял логический оператор ИЛИ. Теги будут назначаться на диалоги, которые содержат фразы из списка в поле **{{ ui-key.yc-ui-talkanalytics.tags.key-phrases-key-value }}** и из указанных словарей. Чтобы использовать словари, нажмите кнопку ![icon](../../../../_assets/console-icons/book-open.svg) **{{ ui-key.yc-ui-talkanalytics.dictionaries.add-dictionary }}** и в выпадающем списке выберите нужные словари. 1. {% include [select-exact-match](../../../../_includes/speechsense/tag/select-exact-match.md) %} 1. {% include [specify-distance-between-words](../../../../_includes/speechsense/tag/specify-distance-between-words.md) %} diff --git a/ru/speechsense/toc.yaml b/ru/speechsense/toc.yaml index 3d2a197b01a..ba76334ab02 100644 --- a/ru/speechsense/toc.yaml +++ b/ru/speechsense/toc.yaml @@ -95,6 +95,8 @@ items: href: concepts/reports/neuro-parameters.md - name: Поддерживаемые форматы аудио href: concepts/formats.md + - name: Квоты и лимиты + href: concepts/limits.md - name: Справочник API items: - name: Аутентификация в API diff --git a/ru/storage/operations/objects/upload.md b/ru/storage/operations/objects/upload.md index 79e584f8adc..bd50265dde8 100644 --- a/ru/storage/operations/objects/upload.md +++ b/ru/storage/operations/objects/upload.md @@ -44,7 +44,7 @@ description: Следуя данной инструкции, вы сможете ```bash aws --endpoint-url=https://{{ s3-storage-host }}/ \ - s3 cp <путь_к_локальному_файлу>/ s3://<имя_бакета>/<ключ_объекта> + s3 cp <путь_к_локальному_файлу> s3://<имя_бакета>/<ключ_объекта> ``` Где: diff --git a/ru/storage/quickstart/quickstart-aws-cli.md b/ru/storage/quickstart/quickstart-aws-cli.md index ff321abeb67..5f0fa672ce7 100644 --- a/ru/storage/quickstart/quickstart-aws-cli.md +++ b/ru/storage/quickstart/quickstart-aws-cli.md @@ -23,7 +23,7 @@ description: Следуя данной инструкции, вы сможете - Консоль управления {#console} 1. Перейдите в [консоль управления]({{ link-console-main }}), затем войдите в {{ yandex-cloud }} или зарегистрируйтесь, если вы еще не зарегистрированы. - 1. На странице [**{{ ui-key.yacloud.billing.label_service }}**]({{ link-console-billing }}) убедитесь, что у вас подключен [платежный аккаунт](../../billing/concepts/billing-account.md) и он находится в статусе `ACTIVE` или `TRIAL_ACTIVE`. Если платежного аккаунта нет, [создайте его](../../billing/quickstart/index.md#create_billing_account). + 1. На странице [**{{ ui-key.yacloud_billing.billing.label_service }}**]({{ link-console-billing }}) убедитесь, что у вас подключен [платежный аккаунт](../../billing/concepts/billing-account.md) и он находится в статусе `ACTIVE` или `TRIAL_ACTIVE`. Если платежного аккаунта нет, [создайте его](../../billing/quickstart/index.md#create_billing_account). 1. На странице [{{ ui-key.yacloud.common.resource-acl.label_access-bindings }}]({{ link-console-access-management }}) убедитесь, что у вас следующие _минимальные_ роли: * для создания [сервисного аккаунта](../../iam/concepts/users/service-accounts.md) и получения на него ключей доступа — [iam.serviceAccounts.admin](../../iam/roles-reference.md#iam-serviceAccounts-admin) на [каталог](../../resource-manager/concepts/resources-hierarchy.md#folder). Если вы хотите использовать существующий сервисный аккаунт, достаточно роли `iam.serviceAccounts.admin` на этот сервисный аккаунт. * для назначения сервисному аккаунту нужной роли — [storage.admin](../../storage/security/index.md#storage-admin) на каталог. diff --git a/ru/storage/toc.yaml b/ru/storage/toc.yaml index e1126037a84..c63e34eba78 100644 --- a/ru/storage/toc.yaml +++ b/ru/storage/toc.yaml @@ -211,6 +211,8 @@ items: - name: Блокировка состояний {{ TF }} с помощью {{ ydb-name }} href: tutorials/terraform-state-lock.md - name: Статический веб-сайт в {{ objstorage-full-name }} + - name: Визуализация данных {{ yq-full-name }} + href: tutorials/data-from-yandex-query-visualization.md items: - name: Обзор href: tutorials/static/index.md @@ -238,6 +240,14 @@ items: Резервное копирование кластера {{ managed-k8s-name }} в {{ objstorage-name }} href: tutorials/kubernetes-backup.md + - name: Сокращатель ссылок + href: tutorials/serverless-url-shortener.md + - name: Хранение журналов работы приложения + href: tutorials/log-ingestion.md + - name: Развертывание веб-приложения с использованием Java Servlet API + href: tutorials/java-servlet-todo-list.md + - name: Разработка Telegram-бота + href: tutorials/telegram-bot-serverless.md - name: Концепции items: - name: Обзор diff --git a/ru/storage/tutorials/data-from-yandex-query-visualization.md b/ru/storage/tutorials/data-from-yandex-query-visualization.md new file mode 100644 index 00000000000..a978e38300e --- /dev/null +++ b/ru/storage/tutorials/data-from-yandex-query-visualization.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/datalens/data-from-yandex-query-visualization' +--- + +{% include [data-from-yandex-query-visualization](../../_tutorials/datalens/data-from-yandex-query-visualization.md) %} diff --git a/ru/storage/tutorials/index.md b/ru/storage/tutorials/index.md index 08dc92b1b59..b5a0d4fde7e 100644 --- a/ru/storage/tutorials/index.md +++ b/ru/storage/tutorials/index.md @@ -49,3 +49,8 @@ description: На странице представлен список прак * [{#T}](./static-key-in-lockbox.md) * [{#T}](./terraform-state-storage.md) * [{#T}](./terraform-state-lock.md) +* [{#T}](./serverless-url-shortener.md) +* [{#T}](./log-ingestion.md) +* [{#T}](./java-servlet-todo-list.md) +* [{#T}](./telegram-bot-serverless.md) +* [Визуализация данных {{ yq-full-name }}](data-from-yandex-query-visualization.md) diff --git a/ru/storage/tutorials/java-servlet-todo-list.md b/ru/storage/tutorials/java-servlet-todo-list.md new file mode 100644 index 00000000000..aab8bc2ec8e --- /dev/null +++ b/ru/storage/tutorials/java-servlet-todo-list.md @@ -0,0 +1,9 @@ +--- +title: Развертывание веб-приложения с использованием Java Servlet API +description: Узнайте, как с помощью serverless-технологий и Java Servlet API создать небольшое веб-приложение для управления списком задач. +canonical: '{{ link-docs }}/tutorials/serverless/java-servlet-todo-list' +--- + +# Развертывание веб-приложения с использованием Java Servlet API + +{% include [java-servlet-todo-list](../../_tutorials/serverless/java-servlet-todo-list.md) %} \ No newline at end of file diff --git a/ru/storage/tutorials/log-ingestion.md b/ru/storage/tutorials/log-ingestion.md new file mode 100644 index 00000000000..f0478d6a811 --- /dev/null +++ b/ru/storage/tutorials/log-ingestion.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/serverless/log-ingestion' +--- + +{% include [log-ingestion](../../_tutorials/serverless/log-ingestion.md) %} \ No newline at end of file diff --git a/ru/storage/tutorials/serverless-url-shortener.md b/ru/storage/tutorials/serverless-url-shortener.md new file mode 100644 index 00000000000..08459418247 --- /dev/null +++ b/ru/storage/tutorials/serverless-url-shortener.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/serverless/serverless-url-shortener' +--- + +{% include [serverless-url-shortener](../../_tutorials/serverless/serverless-url-shortener.md) %} \ No newline at end of file diff --git a/ru/storage/tutorials/storage-vpc-access.md b/ru/storage/tutorials/storage-vpc-access.md index 63206542e93..55d0ddd87ec 100644 --- a/ru/storage/tutorials/storage-vpc-access.md +++ b/ru/storage/tutorials/storage-vpc-access.md @@ -1 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/routing/storage-vpc-access' +--- + {% include [storage-vpc-access](../../_tutorials/routing/storage-vpc-access.md) %} \ No newline at end of file diff --git a/ru/storage/tutorials/telegram-bot-serverless.md b/ru/storage/tutorials/telegram-bot-serverless.md new file mode 100644 index 00000000000..37051b548c5 --- /dev/null +++ b/ru/storage/tutorials/telegram-bot-serverless.md @@ -0,0 +1,7 @@ +--- +title: Как создать бота в Телеграм (Telegram) с помощью Serverless +description: В этом сценарии вы узнаете, как с помощью serverless-технологий создать бота в Telegram, который будет отвечать на сообщения в чате. +canonical: '{{ link-docs }}/tutorials/serverless/telegram-bot-serverless' +--- + +{% include [telegram-bot-serverless](../../_tutorials/serverless/telegram-bot-serverless.md) %} \ No newline at end of file diff --git a/ru/support/overview.md b/ru/support/overview.md index 037dea86877..96c115f8c17 100644 --- a/ru/support/overview.md +++ b/ru/support/overview.md @@ -20,7 +20,7 @@ -Создать запрос в центре поддержки может пользователь, который является [членом организации](../organization/concepts/membership.md) {{ yandex-cloud }}. [Убедитесь](./support-center.md#before-you-begin), что вы создаете запрос от имени нужной организации. Если возникла проблема с продакшен-средой вашей инфраструктуры, укажите тип обращения _{{ ui-key.support-center.tickets.common.label_ticket-type-critical }}_. +Создать запрос в центре поддержки может только [пользователь](../overview/roles-and-resources.md#users) {{ yandex-cloud }}. [Убедитесь](./support-center.md#before-you-begin), что вы создаете запрос от имени нужной организации. Если возникла проблема с продакшн-средой вашей инфраструктуры, укажите тип обращения _{{ ui-key.support-center.tickets.common.label_ticket-type-critical }}_. Вне зависимости от тарифного плана вы можете запрашивать у технической поддержки: diff --git a/ru/support/support-center.md b/ru/support/support-center.md index a7dbad9b48c..0dd8f8e304c 100644 --- a/ru/support/support-center.md +++ b/ru/support/support-center.md @@ -7,6 +7,12 @@ description: Эта инструкция поможет начать работ Сервис {{ support-center-name }} поможет вам найти решение возникших в {{ yandex-cloud }} проблем, создать обращения в поддержку и просмотреть их. Также в {{ support-center-name }} вы можете изменить тарифный план. +{% note info %} + +Создать запрос в центре поддержки может только [пользователь](../overview/roles-and-resources.md#users) {{ yandex-cloud }}. Подробнее см. [{#T}](./overview.md). + +{% endnote %} + ## Перед началом работы {#before-you-begin} 1. Перейдите в [консоль управления]({{ link-console-main }}), затем войдите в {{ yandex-cloud }} или зарегистрируйтесь, если вы еще не зарегистрированы. diff --git a/ru/tracker/access.md b/ru/tracker/access.md index 5c4b658d7f8..5671a18f0eb 100644 --- a/ru/tracker/access.md +++ b/ru/tracker/access.md @@ -25,9 +25,9 @@ 1. Откройте [страницу {{ tracker-name }}]({{ link-tracker }}) и [войдите в аккаунт администратора](user/login.md). -1. На панели слева нажмите **Администрирование** → **{{ ui-key.startrek.ui_components_page-admin_PageAdmin.menu-item-users }}**. +1. На панели слева нажмите **Администрирование** → **{{ ui-key.startrek.ui_Common_smart-components_page-admin_PageAdmin.menu-item-users }}**. -1. Для сотрудников, которые будут работать с задачами, в столбце **{{ ui-key.startrek.ui_components_page-admin_OrgUsersPane.title_access }}** выберите **{{ ui-key.startrek.ui_components_page-admin_OrgUsersPane.access-level_full-access }}**. +1. Для сотрудников, которые будут работать с задачами, в столбце **{{ ui-key.startrek.ui_Common_smart-components_page-admin_OrgGroupsPane.title_access }}** выберите **{{ ui-key.startrek.ui_Common_smart-components_page-admin_OrgGroupsPane.access-level_full-access }}**. {% note info %} @@ -49,7 +49,7 @@ 1. Откройте [страницу {{ tracker-name }}]({{ link-tracker }}) и [войдите в аккаунт администратора](user/login.md). -1. На панели слева нажмите **Администрирование** → **{{ ui-key.startrek.ui_components_page-admin_PageAdmin.menu-item-users }}**. +1. На панели слева нажмите **Администрирование** → **{{ ui-key.startrek.ui_Common_smart-components_page-admin_PageAdmin.menu-item-users }}**. 1. В правом верхнем углу страницы выберите опцию **Полный доступ для всех новых пользователей**: @@ -67,7 +67,7 @@ Если вы работаете через организацию {{ yandex-360 }} для бизнеса, вы можете создать группы сотрудников и настраивать доступ на группу. Подробнее о создании группы [в документации Яндекс 360 для бизнеса](https://yandex.ru/support/business/projects.html). Для настройки полного доступа для группы пользователей необходимо [подключить платежный аккаунт](billing-account.md). -Чтобы настроить доступ для группы пользователей, откройте **Администрирование** → **{{ ui-key.startrek.ui_components_page-admin_PageAdmin.menu-item-groups }}** и выберите нужный уровень доступа для каждой группы. +Чтобы настроить доступ для группы пользователей, откройте **Администрирование** → **{{ ui-key.startrek.ui_Common_smart-components_page-admin_PageAdmin.menu-item-groups }}** и выберите нужный уровень доступа для каждой группы. {% note warning %} diff --git a/ru/tracker/add-users.md b/ru/tracker/add-users.md index dffa89d506f..864273d79e5 100644 --- a/ru/tracker/add-users.md +++ b/ru/tracker/add-users.md @@ -73,9 +73,9 @@ 1. Откройте [страницу {{ tracker-name }}]({{ link-tracker }}) и [войдите в аккаунт администратора](user/login.md). - 1. На панели слева нажмите **Администрирование** → **{{ ui-key.startrek.ui_components_page-admin_PageAdmin.menu-item-orgs }}** (если вы не видите данного раздела, нажмите кнопку ![](../_assets/horizontal-ellipsis.svg) **Еще**). + 1. На панели слева нажмите **Администрирование** → **{{ ui-key.startrek.ui_Common_smart-components_page-admin_PageAdmin.menu-item-orgs }}** (если вы не видите данного раздела, нажмите кнопку ![](../_assets/horizontal-ellipsis.svg) **Еще**). - 1. В блоке **{{ ui-key.startrek.ui_components_page-admin_OrgPanes_CloudOrgPane.source-title }}** нажмите **{{ ui-key.startrek.ui_components_page-admin_OrgPanes_CloudOrgPane.federation-task-action }}**. Откроется страница сервиса {{ org-full-name }}. + 1. В блоке **{{ ui-key.startrek.ui_Common_smart-components_page-admin_OrgPanes_CloudOrgPane.source-title }}** нажмите **{{ ui-key.startrek.ui_Common_smart-components_page-admin_OrgPanes_CloudOrgPane.federation-task-action }}**. Откроется страница сервиса {{ org-full-name }}. 2. Задайте настройки федерации и нажмите кнопку **{{ ui-key.yacloud_org.form.federation.create.action.create }}**. @@ -95,9 +95,9 @@ 1. Откройте [страницу {{ tracker-name }}]({{ link-tracker }}) и [войдите в аккаунт администратора](user/login.md). -1. На панели слева нажмите **Администрирование** → **{{ ui-key.startrek.ui_components_page-admin_PageAdmin.menu-item-orgs }}** (если вы не видите данного раздела, нажмите кнопку ![](../_assets/horizontal-ellipsis.svg) **Еще**). +1. На панели слева нажмите **Администрирование** → **{{ ui-key.startrek.ui_Common_smart-components_page-admin_PageAdmin.menu-item-orgs }}** (если вы не видите данного раздела, нажмите кнопку ![](../_assets/horizontal-ellipsis.svg) **Еще**). -1. В блоке **{{ ui-key.startrek.ui_components_page-admin_OrgPanes_DirectoryOrgPane.source-title }}** нажмите **{{ ui-key.startrek.ui_components_page-admin_OrganizationSmallPane.add-org-button }}**. Откроется окно с вашими организациями. Вы можете создать новую организацию или перейти в существующую. +1. В блоке **{{ ui-key.startrek.ui_Common_smart-components_page-admin_OrgPanes_DirectoryOrgPane.source-title }}** нажмите **{{ ui-key.startrek.ui_Common_smart-components_page-admin_OrganizationSmallPane.add-org-button }}**. Откроется окно с вашими организациями. Вы можете создать новую организацию или перейти в существующую. {% note info %} diff --git a/ru/tracker/billing-account.md b/ru/tracker/billing-account.md index 498185747c1..db361f8ae5b 100644 --- a/ru/tracker/billing-account.md +++ b/ru/tracker/billing-account.md @@ -17,7 +17,7 @@ Чтобы привязать платежный аккаунт: 1. Откройте [страницу {{ tracker-name }}]({{ link-tracker }}) и [войдите в аккаунт администратора](user/login.md). 1. Перейдите в раздел **Администрирование** → **Биллинг**. На странице отображаются все ваши платежные аккаунты из {{ yandex-cloud }}. -1. Рядом с нужным аккаунтом нажмите **{{ ui-key.startrek.ui_components_page-admin_BillingAccountList.bind }}**. +1. Рядом с нужным аккаунтом нажмите **Привязать**. {% note warning %} @@ -29,7 +29,7 @@ 1. Откройте [страницу {{ tracker-name }}]({{ link-tracker }}) и [войдите в аккаунт администратора](user/login.md). -1. Перейдите в раздел **Администрирование** → **Биллинг** и нажмите **+ {{ ui-key.startrek.ui_components_page-admin_BillingAccountList.create-account }}**. +1. Перейдите в раздел **Администрирование** → **Биллинг** и нажмите **+ Создать новый аккаунт**. 1. Выберите страну, резидентом которой является плательщик. @@ -61,11 +61,11 @@ {% include [payment-card-validation](../_includes/billing/payment-card-validation.md) %} -1. Нажмите кнопку **{{ ui-key.startrek.ui_components_page-admin_BillingScreen.create-account }}**. +1. Нажмите кнопку **Создать**. {% note info %} - Нажимая кнопку **{{ ui-key.startrek.ui_components_page-admin_BillingScreen.create-account }}**, вы принимаете [оферту {{ yandex-cloud }}]({{ link-cloud-oferta }}). + Нажимая кнопку **Создать**, вы принимаете [оферту {{ yandex-cloud }}]({{ link-cloud-oferta }}). {% endnote %} @@ -103,7 +103,7 @@ Замена платежного аккаунта организации возможна только один раз в месяц. Чтобы заменить платежный аккаунт: 1. Перейдите в раздел **Администрирование** → **Биллинг**. На странице отображается платежный аккаунт, привязанный к {{ tracker-name }}. -2. Перейдите по ссылке **{{ ui-key.startrek.ui_components_page-admin_BillingAccountInfo.rebind-account }}** в верхнем правом углу. Выберите платежный аккаунт, на который хотите заменить текущий, или нажмите **+ {{ ui-key.startrek.ui_components_page-admin_BillingAccountList.create-account }}**. +2. Перейдите по ссылке **Заменить платёжный аккаунт** в верхнем правом углу. Выберите платежный аккаунт, на который хотите заменить текущий, или нажмите **+ Создать новый аккаунт**. Если вы решили создать новый аккаунт, воспользуйтесь [инструкцией](#create). ![](../_assets/tracker/changelogs/change-ba.png =690x) diff --git a/ru/tracker/cloud-vs-360.md b/ru/tracker/cloud-vs-360.md index 9972b68e467..0528b8208ba 100644 --- a/ru/tracker/cloud-vs-360.md +++ b/ru/tracker/cloud-vs-360.md @@ -54,7 +54,7 @@ Администратор организации {{ ya-360 }} может сменить организацию для {{ tracker-name }} и перейти на {{ org-full-name }}. -* Если у вас уже подключена организация {{ org-full-name }}, переход на нее будет выполнен автоматически, никаких дополнительных действий не требуется. Проверить подключение можно на странице ![](../_assets/tracker/svg/admin.svg) **Администрирование** → ![](../_assets/tracker/svg/organizations.svg) [**{{ ui-key.startrek.ui_components_page-admin_PageAdmin.menu-item-orgs }}**]({{ link-tracker }}admin/orgs). +* Если у вас уже подключена организация {{ org-full-name }}, переход на нее будет выполнен автоматически, никаких дополнительных действий не требуется. Проверить подключение можно на странице ![](../_assets/tracker/svg/admin.svg) **Администрирование** → ![](../_assets/tracker/svg/organizations.svg) [**{{ ui-key.startrek.ui_Common_smart-components_page-admin_PageAdmin.menu-item-orgs }}**]({{ link-tracker }}admin/orgs). * Если у вас есть организация {{ org-full-name }}, на которую вы хотите перейти, но которая подключена к другому {{ tracker-name }}, {{ wiki-name }} или {{ forms-name }}, обратитесь в [службу поддержки](troubleshooting.md). Это связано с тем, что все данные при переключении будут удалены. @@ -62,7 +62,7 @@ 1. Если у вас еще нет организации в {{ org-full-name }}, создайте ее по [инструкции](../organization/operations/enable-org.md). Если организация у вас уже есть, пропустите этот шаг. -1. В {{ tracker-name }}, на панели слева, нажмите ![](../_assets/tracker/svg/admin.svg) **Администрирование** → ![](../_assets/tracker/svg/organizations.svg) [**{{ ui-key.startrek.ui_components_page-admin_PageAdmin.menu-item-orgs }}**]({{ link-tracker }}admin/orgs). В блоке организаций {{ org-full-name }} нажмите **{{ ui-key.startrek.ui_components_page-admin_OrgPanes_DirectoryOrgPane.domain-task-action }}** и выберите организацию. Дождитесь синхронизации пользователей и групп из {{ org-full-name }} в {{ tracker-name }} — она занимает до 30 минут. +1. В {{ tracker-name }}, на панели слева, нажмите ![](../_assets/tracker/svg/admin.svg) **Администрирование** → ![](../_assets/tracker/svg/organizations.svg) [**{{ ui-key.startrek.ui_Common_smart-components_page-admin_PageAdmin.menu-item-orgs }}**]({{ link-tracker }}admin/orgs). В блоке организаций {{ org-full-name }} нажмите **{{ ui-key.startrek.ui_Common_smart-components_page-admin_OrgPanes_DirectoryOrgPane.domain-task-action }}** и выберите организацию. Дождитесь синхронизации пользователей и групп из {{ org-full-name }} в {{ tracker-name }} — она занимает до 30 минут. 1. В сервисе {{ org-full-name }} добавьте [пользователей](../organization/operations/manage-users.md) и [группы](../organization/operations/manage-groups.md) — как в {{ ya-360 }}. Название группы в {{ tracker-name }} формируется из поля **Описание**, а если оно не задано, то из поля **Название**. @@ -78,7 +78,7 @@ {% note info %} - В настройках доступа для групп ![](../_assets/tracker/svg/admin.svg) **Администрирование** → [**{{ ui-key.startrek.ui_components_page-admin_PageAdmin.menu-item-groups }}**]({{ link-tracker }}admin/groups) вы увидите 2 группы **Все сотрудники**: одна из них с сотрудниками из организации {{ ya-360 }}, а другая — с сотрудниками из обеих организаций. + В настройках доступа для групп ![](../_assets/tracker/svg/admin.svg) **Администрирование** → [**{{ ui-key.startrek.ui_Common_smart-components_page-admin_PageAdmin.menu-item-groups }}**]({{ link-tracker }}admin/groups) вы увидите 2 группы **Все сотрудники**: одна из них с сотрудниками из организации {{ ya-360 }}, а другая — с сотрудниками из обеих организаций. {% endnote %} diff --git a/ru/tracker/dev-process-templates.md b/ru/tracker/dev-process-templates.md index 846c6766178..c4762e9d167 100644 --- a/ru/tracker/dev-process-templates.md +++ b/ru/tracker/dev-process-templates.md @@ -6,7 +6,7 @@ 1. На панели слева нажмите ![](../_assets/tracker/svg/settings.svg) **Настройки**. Затем выберите ![](../_assets/tracker/svg/interface.svg) **Интерфейс** и нажмите **Управление шаблонами**. Вы также можете перейти по ссылке [{{ link-tracker-templates }}]({{ link-tracker-templates }}). -1. Выберите опцию **Задачи** и нажмите кнопку **{{ ui-key.startrek.ui_components_issue-comments-templates.create-template-item }}**. +1. Выберите опцию **Задачи** и нажмите кнопку **{{ ui-key.startrek.ui_Issues_pure-components_issue-comments-templates.create-template-item }}**. 1. Задайте название и описание шаблона. diff --git a/ru/tracker/disable-tracker.md b/ru/tracker/disable-tracker.md index a9b25b74f99..35b99862867 100644 --- a/ru/tracker/disable-tracker.md +++ b/ru/tracker/disable-tracker.md @@ -15,17 +15,17 @@ {% note info %} -Чтобы не платить за использование {{ tracker-name }}, вы можете отключить платные возможности и оставить сотрудникам только бесплатный доступ в режиме [«{{ ui-key.startrek.ui_components_page-admin_OrgUsersPane.access-level_read_only }}»](access.md#readonly). Полностью отключить {{ tracker-name }} невозможно. +Чтобы не платить за использование {{ tracker-name }}, вы можете отключить платные возможности и оставить сотрудникам только бесплатный доступ в режиме [«{{ ui-key.startrek.ui_Common_smart-components_page-admin_OrgGroupsPane.access-level_read_only }}»](access.md#readonly). Полностью отключить {{ tracker-name }} невозможно. {% endnote %} Чтобы прекратить использование платных возможностей {{ tracker-full-name }}, отзовите у сотрудников организации полный доступ в {{ tracker-name }}. Если полный доступ есть не более чем у 5 пользователей, использование {{ tracker-name }} не тарифицируется. Подробнее читайте в разделе [{#T}](pricing.md). -1. На панели слева {{ tracker-name }} нажмите **Администрирование** → **{{ ui-key.startrek.ui_components_page-admin_PageAdmin.menu-item-users }}**. +1. На панели слева {{ tracker-name }} нажмите **Администрирование** → **{{ ui-key.startrek.ui_Common_smart-components_page-admin_PageAdmin.menu-item-users }}**. 1. Убедитесь, что настройка **Полный доступ для новых пользователей** отключена. -1. Для сотрудников, у которых нужно отозвать доступ, в столбце **{{ ui-key.startrek.ui_components_page-admin_OrgUsersPane.title_access }}** выберите **{{ ui-key.startrek.ui_components_page-admin_OrgUsersPane.access-level_read_only }}**. +1. Для сотрудников, у которых нужно отозвать доступ, в столбце **{{ ui-key.startrek.ui_Common_smart-components_page-admin_OrgGroupsPane.title_access }}** выберите **{{ ui-key.startrek.ui_Common_smart-components_page-admin_OrgGroupsPane.access-level_read_only }}**. После того как у сотрудников будет отозван полный доступ в {{ tracker-name }}, они не смогут создавать и обновлять задачи. Возможность просматривать информацию в {{ tracker-name }} сохранится. \ No newline at end of file diff --git a/ru/tracker/faq.md b/ru/tracker/faq.md index 0f729e5db3d..6f31fcd6e1e 100644 --- a/ru/tracker/faq.md +++ b/ru/tracker/faq.md @@ -65,7 +65,7 @@ 1. Перейдите на вкладку **Основные параметры**. -1. Нажмите кнопку **{{ ui-key.startrek.ui_components_page-queue-admin_QueueActionsMenu.remove-queue-action }}**. +1. Нажмите кнопку **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueActionsMenu.remove-queue-action }}**. 1. Подтвердите удаление. @@ -91,7 +91,7 @@ ## Как узнать владельца очереди {#section_hgc_xyk_nbb} -Владелец указан на вкладке **{{ ui-key.startrek.ui_components_IssueTabs.description-tab }}** на странице очереди. Подробнее читайте в разделе [Список задач очереди](user/queue.md). +Владелец указан на вкладке **Описание** на странице очереди. Подробнее читайте в разделе [Список задач очереди](user/queue.md). ## Почему нельзя использовать виджеты с группировкой по полю «{{ ui-key.startrek-backend.fields.issue.summary-key-value }}» {#section_del_widget} diff --git a/ru/tracker/gantt/list-of-projects.md b/ru/tracker/gantt/list-of-projects.md index 58dd35a095b..f1d1ff5eacf 100644 --- a/ru/tracker/gantt/list-of-projects.md +++ b/ru/tracker/gantt/list-of-projects.md @@ -8,13 +8,13 @@ 1. Перейдите на [страницу проектов]({{ link-tracker }}pages/projects) или на [панели слева]({{ link-tracker }}) выберите ![](../../_assets/tracker/svg/project.svg) **Проекты** и нажмите **Полный список моих проектов**. -1. Выберите вкладку **{{ ui-key.startrek.ui_components_filter-pane_ViewModeSwitch.mode-gantt }}**. +1. Выберите вкладку **Диаграмма Ганта**. * Слева от диаграммы отображается список проектов. Чтобы открыть список задач проекта, нажмите на значок ![](../../_assets/tracker/svg/arrow.svg) рядом с его названием. Задачи отобразятся в виде иерархического списка. * Сроки работы над проектами отображаются на диаграмме в виде полос, направленных вдоль оси времени. Начало каждой полосы соответствует дате начала работы над проектом, а ее конец — дате дедлайна. -1. Чтобы отображать только некоторые задачи внутри проектов, настройте фильтрацию по задачам. В правой части на панели над диаграммой, в разделе **{{ ui-key.startrek.ui_components_portfolios_portfolio-page_ListFilterPane.filter-issues }}**, настройте фильтр, последовательно добавляя нужные параметры и задавая для них значения. +1. Чтобы отображать только некоторые задачи внутри проектов, настройте фильтрацию по задачам. В правой части на панели над диаграммой, в разделе **По задачам**, настройте фильтр, последовательно добавляя нужные параметры и задавая для них значения. -1. Чтобы настроить масштаб временной шкалы, в нижнем правом углу диаграммы выберите **{{ ui-key.startrek.ui_components_Gantt.scale-days }}**, **{{ ui-key.startrek.ui_components_Gantt.scale-month }}** или **{{ ui-key.startrek.ui_components_Gantt.scale-quarters }}**. Настройки масштаба сохранятся после обновления страницы или при повторном переходе в диаграмму. +1. Чтобы настроить масштаб временной шкалы, в нижнем правом углу диаграммы выберите **Неделя**, **Месяц** или **Квартал**. Настройки масштаба сохранятся после обновления страницы или при повторном переходе в диаграмму. ## Изменить сроки проектов {#timing} @@ -34,7 +34,7 @@ {% note info %} -Если кнопка ![](../../_assets/tracker/svg/pick-user.svg) не отображается на полосе проекта, перейдите в ![](../../_assets/tracker/svg/gantt-settings-button.svg) **{{ ui-key.startrek.ui_components_Gantt.timeline-config }}** и в разделе **Полоса задачи** отметьте пункт **{{ ui-key.startrek.ui_components_Gantt.show-issue-assignee }}**. +Если кнопка ![](../../_assets/tracker/svg/pick-user.svg) не отображается на полосе проекта, перейдите в ![](../../_assets/tracker/svg/gantt-settings-button.svg) **Настройки диаграммы** и в разделе **Полоса задачи** отметьте пункт **исполнителя**. {% endnote %} @@ -54,8 +54,8 @@ ## Отображение блока со списком задач {#tasks-view} -* Чтобы найти задачи или проекты в списке, в поле **{{ ui-key.startrek.ui_components_portfolios_portfolio-page_ListFilterPane.search-placeholder }}** введите текст. +* Чтобы найти задачи или проекты в списке, в поле **Поиск** введите текст. -* Чтобы настроить порядок отображения в списке, нажмите ![](../../_assets/tracker/svg/sorting.svg) **{{ ui-key.startrek.ui_components_SortButton.default-title }}**, укажите параметр и нажмите ![](../../_assets/tracker/svg/new-first.svg). В этом случае ручное перемещение задач станет недоступно. +* Чтобы настроить порядок отображения в списке, нажмите ![](../../_assets/tracker/svg/sorting.svg) **{{ ui-key.startrek.ui_Common_smart-components_SortButton.default-title }}**, укажите параметр и нажмите ![](../../_assets/tracker/svg/new-first.svg). В этом случае ручное перемещение задач станет недоступно. -* Чтобы отфильтровать список проектов, используйте конструктор фильтров. Для этого на панели ![](../../_assets/tracker/svg/filter.svg) **Фильтры** в разделе **{{ ui-key.startrek.ui_components_portfolios_portfolio-page_ListFilterPane.filter-projects }}** выберите параметры и укажите значения, по которым будет сформирован список проектов. Кроме того, в разделе **{{ ui-key.startrek.ui_components_portfolios_portfolio-page_ListFilterPane.filter-issues }}** вы можете настроить дополнительный фильтр по задачам внутри проектов. \ No newline at end of file +* Чтобы отфильтровать список проектов, используйте конструктор фильтров. Для этого на панели ![](../../_assets/tracker/svg/filter.svg) **Фильтры** в разделе **По проектам** выберите параметры и укажите значения, по которым будет сформирован список проектов. Кроме того, в разделе **По задачам** вы можете настроить дополнительный фильтр по задачам внутри проектов. \ No newline at end of file diff --git a/ru/tracker/gantt/portfolio.md b/ru/tracker/gantt/portfolio.md index 47174030c68..a7d771702c9 100644 --- a/ru/tracker/gantt/portfolio.md +++ b/ru/tracker/gantt/portfolio.md @@ -8,7 +8,7 @@ 1. На [панели слева]({{ link-tracker }}) выберите ![](../../_assets/tracker/svg/project.svg) **Проекты** или перейдите по [прямой ссылке]({{ link-tracker }}pages/projects) и откройте страницу портфеля. -1. Выберите вкладку **{{ ui-key.startrek.ui_components_filter-pane_ViewModeSwitch.mode-gantt }}**. +1. Выберите вкладку **Диаграмма Ганта**. * Слева от диаграммы отображается список портфелей и проектов. Чтобы открыть список вложенных элементов, нажмите на значок ![](../../_assets/tracker/svg/arrow.svg) рядом с его названием. Задачи отобразятся в виде иерархического списка. * Сроки работы над портфелями, проектами и задачами отображаются на диаграмме в виде полос, направленных вдоль оси времени. Начало каждой полосы соответствует дате начала, а ее конец — дедлайну портфеля, проекта или задачи. @@ -38,7 +38,7 @@ {% note info %} -Если кнопка ![](../../_assets/tracker/svg/pick-user.svg) не отображается на полосе портфеля или проекта, перейдите в ![](../../_assets/tracker/svg/gantt-settings-button.svg) **{{ ui-key.startrek.ui_components_Gantt.timeline-config }}** и в разделе **Полоса задачи** отметьте пункт **{{ ui-key.startrek.ui_components_Gantt.show-issue-assignee }}**. +Если кнопка ![](../../_assets/tracker/svg/pick-user.svg) не отображается на полосе портфеля или проекта, перейдите в ![](../../_assets/tracker/svg/gantt-settings-button.svg) **Настройки диаграммы** и в разделе **Полоса задачи** отметьте пункт **исполнителя**. {% endnote %} @@ -64,7 +64,7 @@ ## Отображение блока со списком проектов и портфелей {#tasks-view} -* Чтобы отфильтровать список проектов и портфелей, используйте конструктор фильтров. Для этого на панели ![](../../_assets/tracker/svg/filter.svg) **{{ ui-key.startrek.ui_components_page-issues_touch_FilterSettingsMenu.item-filters }}** выберите параметры и укажите значения, по которым будет сформирован список. Панель позволяет отдельно фильтровать только портфели или только проекты. +* Чтобы отфильтровать список проектов и портфелей, используйте конструктор фильтров. Для этого на панели ![](../../_assets/tracker/svg/filter.svg) **Фильтры** выберите параметры и укажите значения, по которым будет сформирован список. Панель позволяет отдельно фильтровать только портфели или только проекты. {% note info %} diff --git a/ru/tracker/gantt/project.md b/ru/tracker/gantt/project.md index ddd6c19cd90..7f2688e6feb 100644 --- a/ru/tracker/gantt/project.md +++ b/ru/tracker/gantt/project.md @@ -18,13 +18,13 @@ * Если у задачи есть блокеры, которые не входят в текущий проект, на диаграмме слева от полосы задачи появится значок ![](../../_assets/tracker/svg/blocker.svg) с их количеством. - * Чтобы включить отображение внешних блокеров в списке задач, перейдите в [](../../_assets/tracker/svg/gantt-settings-button.svg) **{{ ui-key.startrek.ui_components_Gantt.timeline-config }}** → **{{ ui-key.startrek.ui_components_Gantt.show-external-blockers }}**. + * Чтобы включить отображение внешних блокеров в списке задач, перейдите в [](../../_assets/tracker/svg/gantt-settings-button.svg) **Настройки диаграммы** → **Показывать внешние блокеры**. * В списке задач внешние блокеры выделены серым цветом и отображаются под зависимой задачей. Если включен [иерархический тип отображения](#trees), блокеры отображаются под веткой задач. Внешние блокеры нельзя перемещать в списке, но их можно открыть и отредактировать. * Сроки начала работ и дедлайн для внешних блокеров можно [изменять](#timing). - * Чтобы удалить связь между внешним блокером и зависимой задачей, нажмите значок ![](../../_assets/tracker/svg/blocker.svg), а затем ![](../../_assets/tracker/svg/del-link.svg) **{{ ui-key.startrek.ui_components_Gantt.delete-link }}**. + * Чтобы удалить связь между внешним блокером и зависимой задачей, нажмите значок ![](../../_assets/tracker/svg/blocker.svg), а затем ![](../../_assets/tracker/svg/del-link.svg) **Удалить связь**. ## Изменить сроки задач {#timing} @@ -96,12 +96,12 @@ ## Действия с задачами {#issue-actions} -Чтобы в блоке со списком задач открыть меню действий с задачей, справа от названия задачи нажмите ![](../../_assets/tracker/svg/actions.svg) **{{ ui-key.startrek.ui_components_Gantt_IssueActionsCell.issue-action-menu-title }}**. +Чтобы в блоке со списком задач открыть меню действий с задачей, справа от названия задачи нажмите ![](../../_assets/tracker/svg/actions.svg) **Меню действий задачи**. В меню доступны действия: -* ![](../../_assets/tracker/text-edit/link.svg) **{{ ui-key.startrek.ui_components_projects_hooks.copy-to-clipboard }}**; -* ![](../../_assets/tracker/svg/move-up.svg) **{{ ui-key.startrek.ui_components_projects_hooks.issue-actions--move-up }}** (только при ручной сортировке); -* ![](../../_assets/tracker/svg/move-down.svg) **{{ ui-key.startrek.ui_components_projects_hooks.issue-actions--move-down }}** (только при ручной сортировке); +* ![](../../_assets/tracker/text-edit/link.svg) **Скопировать ссылку**; +* ![](../../_assets/tracker/svg/move-up.svg) **Перенести наверх списка** (только при ручной сортировке); +* ![](../../_assets/tracker/svg/move-down.svg) **Перенести вниз списка** (только при ручной сортировке); * ![](../../_assets/tracker/svg/convert.svg) **Преобразовать в [веху](../manager/milestones.md) или задачу**. -* ![](../../_assets/tracker/svg/icon-remove.svg) **{{ ui-key.startrek.ui_components_projects_hooks.delete-from-project }}**; -* ![](../../_assets/tracker/svg/gantt-palette.svg) **Выбрать цвет** (только при настройке цвета **{{ ui-key.startrek.ui_components_Gantt.color-type-by-manual }}**). +* ![](../../_assets/tracker/svg/icon-remove.svg) **Удалить из проекта**; +* ![](../../_assets/tracker/svg/gantt-palette.svg) **Выбрать цвет** (только при настройке цвета **назначать вручную**). diff --git a/ru/tracker/hr-process-basic-queue.md b/ru/tracker/hr-process-basic-queue.md index 941c46cf02b..f8c69f5f408 100644 --- a/ru/tracker/hr-process-basic-queue.md +++ b/ru/tracker/hr-process-basic-queue.md @@ -8,7 +8,7 @@ description: Следуя данной инструкции, вы сможете Чтобы сотрудники HR-отдела могли планировать и отслеживать общие задачи по управлению персоналом, создайте очередь и пригласите в нее сотрудников отдела: 1. Создайте очередь: - 1. На панели слева выберите ![](../_assets/tracker/svg/queues-ni.svg) **{{ ui-key.startrek.ui_components_TrackerSearch.queues }}** → **Создать очередь**. + 1. На панели слева выберите ![](../_assets/tracker/svg/queues-ni.svg) **{{ ui-key.startrek.ui_Common_smart-components_TrackerSearch.queues }}** → **Создать очередь**. 1. Выберите базовый шаблон очереди **Начните прямо сейчас**. 1. Задайте имя, например `HR Tasks`. 1. Нажмите кнопку **Создать**. diff --git a/ru/tracker/hr-process-candidate-queue.md b/ru/tracker/hr-process-candidate-queue.md index 0b65a9d049d..9f166d89660 100644 --- a/ru/tracker/hr-process-candidate-queue.md +++ b/ru/tracker/hr-process-candidate-queue.md @@ -15,11 +15,11 @@ ### Создайте форму 1. На панели слева нажмите кнопку ![](../_assets/tracker/svg/icon-add.svg) **Создать задачу**. -1. В блоке **{{ ui-key.startrek.ui_components_PageCreateIssue.try-yandex-forms }}** нажмите кнопку **{{ ui-key.startrek.ui_components_PageCreateIssue.create-new }}**. +1. В блоке **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssue.try-yandex-forms }}** нажмите кнопку **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssue.create-new }}**. 1. Создайте новую форму: * Укажите название `Кандидат`; * Добавьте описание, например `Форма заявки на вакансию`; - * Нажмите кнопку **{{ ui-key.startrek.ui_components_PageCreateIssueForm.continue }}**. + * Нажмите кнопку **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssueForm.continue }}**. 1. Дождитесь загрузки страницы и выберите виджет **Текст**. 1. В поле **Вопрос** введите `ФИО`. 1. Нажмите кнопку ![](../_assets/tracker/svg/icon-add.svg) **Добавить вопрос** и выберите опцию **Текст**. @@ -47,7 +47,7 @@ ### Создайте тестовую задачу -1. На странице создания новой задачи справа вверху в поле **{{ ui-key.startrek.ui_components_QueueAdminTemplateOptions.allow-empty-template }}** выберите опцию **{{ ui-key.startrek.ui_components_QueueAdminTemplateOptions.never }}**. +1. На странице создания новой задачи справа вверху в поле **{{ ui-key.startrek.ui_Queues_smart-components_QueueAdminTemplateOptions.allow-empty-template }}** выберите опцию **{{ ui-key.startrek.ui_Queues_smart-components_QueueAdminTemplateOptions.never }}**. 1. Кликните виджет с названием `Кандидат`. 1. Заполните форму. В качестве адреса почты укажите свой адрес. 1. Нажмите кнопку **Отправить**. diff --git a/ru/tracker/hr-process-employment-queue.md b/ru/tracker/hr-process-employment-queue.md index 81dc77aff87..69d5fb77e1f 100644 --- a/ru/tracker/hr-process-employment-queue.md +++ b/ru/tracker/hr-process-employment-queue.md @@ -14,7 +14,7 @@ Для различных процедур, связанных с оформлением и введением сотрудника в рабочий режим, создайте отдельные типы задач. Например, для выдачи доступов и оборудования создайте тип задачи «Доступы и оборудование»: -1. На странице очереди новых сотрудников `Employment Queue` в правом верхнем углу нажмите ![](../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. На странице очереди новых сотрудников `Employment Queue` в правом верхнем углу нажмите ![](../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. На панели слева выберите **Типы задач**. 1. Дождитесь загрузки страницы и нажмите кнопку **Добавить тип задачи**. 1. В появившейся форме: @@ -37,7 +37,7 @@ Для автоматизации копирования задачи из очереди кандидатов `Candidates Queue` в очередь сотрудников `Employment Queue` создайте триггер, срабатывающий на переход статуса задачи кандидата в состояние "Принят": -1. На странице очереди кандидатов `Candidates Queue` в правом верхнем углу нажмите ![](../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. На странице очереди кандидатов `Candidates Queue` в правом верхнем углу нажмите ![](../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. На панели слева выберите **Автоматизация** → **Триггеры** и нажмите кнопку **Создать триггер**. 1. В поле **Название** введите название триггера, например `employ_candidate`. 1. В блоке **Условия срабатывания** выберите **{{ui-key.startrek-backend.fields.issue.fields.system }}** → **{{ ui-key.startrek-backend.fields.issue.status-key-value }}**. @@ -84,7 +84,7 @@ ### Создайте триггер -1. На странице очереди сотрудников `Employment Queue` в правом верхнем углу нажмите ![](../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. На странице очереди сотрудников `Employment Queue` в правом верхнем углу нажмите ![](../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. На панели слева выберите **Автоматизация** → **Триггеры** и нажмите кнопку **Создать триггер**. 1. В поле **Название** введите название триггера, например `start_employment`. 1. В блоке **Условия срабатывания** выберите **{{ui-key.startrek-backend.fields.issue.fields.system }}** → **{{ ui-key.startrek-backend.fields.issue.status-key-value }}**. diff --git a/ru/tracker/hr-process-probation-queue.md b/ru/tracker/hr-process-probation-queue.md index 890d3b094e0..121f43b779c 100644 --- a/ru/tracker/hr-process-probation-queue.md +++ b/ru/tracker/hr-process-probation-queue.md @@ -6,7 +6,7 @@ Чтобы дата окончания испытательного срока выставлялась автоматически, создайте триггер на событие создания задачи: -1. На странице очереди сотрудников `Employment Queue` в правом верхнем углу нажмите ![](../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. На странице очереди сотрудников `Employment Queue` в правом верхнем углу нажмите ![](../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. На панели слева выберите **Автоматизация** → **Триггеры** и нажмите кнопку **Создать триггер**. 1. В поле **Название** введите название триггера, например `probation_setup`. 1. В блоке **Условия срабатывания** выберите **{{ ui-key.startrek-backend.fields.issue.fields.system }}** → **{{ ui-key.startrek-backend.fields.issue.type-key-value }}**. @@ -23,7 +23,7 @@ Чтобы не упустить из внимания важные моменты в процессе введения нового сотрудника в рабочий режим, добавьте в действия триггера создание чеклиста: 1. В блоке **Действия триггера** в поле **Добавить действие** выберите **Создать чеклист**. -1. В появившейся форме нажмите кнопку **{{ ui-key.startrek.ui_components_entity-page_checklist_Footer.new-item-button-caption }}** и введите описание первого пункта, например `Назначить куратора`. +1. В появившейся форме нажмите кнопку **{{ ui-key.startrek.ui_Common_smart-components_entity-page_checklist_Footer.new-item-button-caption }}** и введите описание первого пункта, например `Назначить куратора`. 1. Аналогично добавьте еще пункты в чеклист. 1. Чтобы сохранить триггер, нажмите кнопку **Создать**. diff --git a/ru/tracker/hr-process-vacancy-queue.md b/ru/tracker/hr-process-vacancy-queue.md index f01a7cfe644..798d5d56498 100644 --- a/ru/tracker/hr-process-vacancy-queue.md +++ b/ru/tracker/hr-process-vacancy-queue.md @@ -15,7 +15,7 @@ ### Настройте предустановленный процесс 1. Откройте страницу очереди. -1. В верхнем правом углу нажмите ![](../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}** и выберите **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. +1. В верхнем правом углу нажмите ![](../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}** и выберите **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. 1. Выберите предустановленный рабочий процесс **Recruiting**. 1. На странице процесса поменяйте название на **Квалифицированные кадры**. 1. Укажите тип задач, к которым применим этот процесс. Для этого нажмите ![](../_assets/tracker/svg/icon-add.svg) справа от названия процесса и введите имя нового типа задачи, например `Специалисты`. @@ -41,11 +41,11 @@ ### Создайте форму для первого процесса 1. На панели слева нажмите кнопку ![](../_assets/tracker/svg/icon-add.svg) **Создать задачу**. -1. В блоке **{{ ui-key.startrek.ui_components_PageCreateIssue.try-yandex-forms }}** нажмите кнопку **{{ ui-key.startrek.ui_components_PageCreateIssue.create-new }}**. +1. В блоке **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssue.try-yandex-forms }}** нажмите кнопку **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssue.create-new }}**. 1. Создайте новую форму: * Укажите название `Специалист`; * Добавьте описание, например `Форма вакансии для квалифицированных сотрудников`; - * Нажмите кнопку **{{ ui-key.startrek.ui_components_PageCreateIssueForm.continue }}**. + * Нажмите кнопку **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssueForm.continue }}**. 1. Дождитесь загрузки страницы и выберите виджет **Текст**. 1. В поле **Вопрос** введите `Название`. 1. Нажмие кнопку ![](../_assets/tracker/svg/icon-add.svg) **Добавить вопрос**. @@ -66,7 +66,7 @@ Если вы хотите ограничить доступ к форме: 1. На странице создания новой задачи наведите курсор на виджет с названием нужной вам формы, например `Специалист`. -1. Кликните ![](../_assets/tracker/svg/actions.svg) и выберите опцию ![](../_assets/tracker/icon-edit.png)**{{ ui-key.startrek.ui_components_PageCreateIssue.change-template }}**. +1. Кликните ![](../_assets/tracker/svg/actions.svg) и выберите опцию ![](../_assets/tracker/icon-edit.png)**{{ ui-key.startrek.ui_Issues_pages_PageCreateIssue.change-template }}**. 1. Внизу на странице перейдите по ссылке **Полная версия {{ forms-full-name }}**. 1. На вкладке **Настройки** в блоке **Кто может заполнять форму** активируйте опцию **Только сотрудники организации**. 1. Нажмите кнопку **Сохранить**. @@ -74,11 +74,11 @@ ### Создайте форму для второго процесса Аналогично создайте и настройте форму для вакансий, не требующих квалификации. -Для этого на странице создания новой задачи нажмите кнопку **{{ ui-key.startrek.ui_components_PageCreateIssue.create-new-template }}** и повторите описанные выше действия с соответствующими второму рабочему процессу значениями. +Для этого на странице создания новой задачи нажмите кнопку **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssue.create-new-template }}** и повторите описанные выше действия с соответствующими второму рабочему процессу значениями. ### Создайте тестовые задачи и сгруппируйте по типу -1. На странице создания новой задачи справа вверху в поле **{{ ui-key.startrek.ui_components_QueueAdminTemplateOptions.allow-empty-template }}** выберите опцию **{{ ui-key.startrek.ui_components_QueueAdminTemplateOptions.never }}**. +1. На странице создания новой задачи справа вверху в поле **{{ ui-key.startrek.ui_Queues_smart-components_QueueAdminTemplateOptions.allow-empty-template }}** выберите опцию **{{ ui-key.startrek.ui_Queues_smart-components_QueueAdminTemplateOptions.never }}**. 1. Кликните виджет с названием нужной вам формы, например `Специалист`. 1. Заполните форму и нажмите кнопку **Отправить**. 1. Аналогично создайте задачу с типом `Неспециалист`. diff --git a/ru/tracker/hr-process-vacations-queue.md b/ru/tracker/hr-process-vacations-queue.md index 8aad382fd63..ef45cf05a66 100644 --- a/ru/tracker/hr-process-vacations-queue.md +++ b/ru/tracker/hr-process-vacations-queue.md @@ -14,11 +14,11 @@ ### Создайте форму 1. На панели слева нажмите кнопку ![](../_assets/tracker/svg/icon-add.svg) **Создать задачу**. -1. В блоке **{{ ui-key.startrek.ui_components_PageCreateIssue.try-yandex-forms }}** нажмите кнопку **{{ ui-key.startrek.ui_components_PageCreateIssue.create-new }}**. +1. В блоке **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssue.try-yandex-forms }}** нажмите кнопку **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssue.create-new }}**. 1. Создайте новую форму: * Укажите название `Заявка на отпуск`; * Добавьте описание, например `Форма заявки на отпуск`; - * Нажмите кнопку **{{ ui-key.startrek.ui_components_PageCreateIssueForm.continue }}**. + * Нажмите кнопку **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssueForm.continue }}**. 1. Дождитесь загрузки страницы и нажмите кнопку **Полная версия {{ forms-full-name }}**. 1. Создайте форму заявки, например со следующими полями: * `ФИО` (короткий текст, обязательное поле); @@ -43,7 +43,7 @@ 1. Сохраните форму, нажав кнопку **Сохранить**. 1. Вернитесь в конструктор формы, нажав вверху страницы кнопку **В конструктор**. 1. Нажмите кнопку **Опубликовать** и в появившемся диалоге скопируйте ссылку на форму. -1. Вернитесь в настройки очереди `Vacations Queue` и нажмите **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-forms }}**. +1. Вернитесь в настройки очереди `Vacations Queue` и нажмите **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-forms }}**. 1. Нажмите **Добавить форму** и заполните появившуюся форму, указав в поле **Ссылка на форму** полученную выше ссылку. 1. Сохраните интеграцию формы, нажав кнопку **Сохранить**. @@ -51,7 +51,7 @@ Для выполнения регулярных действий в очереди, в {{ tracker-name }} предусмотрены [автодействия](user/autoactions.md). Настройте регулярную проверку очереди `Vacations Queue` на наличие не взятых в работу заявок с помощью автодействия. Чтобы не перегружать сотрудников, ответственных за оформление отпусков, частыми напоминаниями, настройте отправку напоминаний раз в сутки и не раньше, чем за две недели до указанного в заявке начала отпуска. -1. Вернитесь в настройки очереди `Vacations Queue` и нажмите **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-autoactions }}**. +1. Вернитесь в настройки очереди `Vacations Queue` и нажмите **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-autoactions }}**. 1. Дождитесь загрузки страницы и нажмите **Создать автодействие**. 1. В поле **Тип автодействия** активируйте **Обновление задач**. 1. В поле **Название** укажите, например, `vacation_warning`. @@ -72,7 +72,7 @@ ## Проверьте работу автодействия -1. На странице создания новой задачи справа вверху в поле **{{ ui-key.startrek.ui_components_QueueAdminTemplateOptions.allow-empty-template }}** выберите опцию **{{ ui-key.startrek.ui_components_QueueAdminTemplateOptions.never }}**. +1. На странице создания новой задачи справа вверху в поле **{{ ui-key.startrek.ui_Queues_smart-components_QueueAdminTemplateOptions.allow-empty-template }}** выберите опцию **{{ ui-key.startrek.ui_Queues_smart-components_QueueAdminTemplateOptions.never }}**. 1. Кликните виджет с названием `Отпуск`. 1. Заполните форму. В поле **Начало** укажите дату через неделю от сегодняшней. 1. Отправьте форму. diff --git a/ru/tracker/local-fields.md b/ru/tracker/local-fields.md index b79bfc6109d..0040439c761 100644 --- a/ru/tracker/local-fields.md +++ b/ru/tracker/local-fields.md @@ -20,7 +20,7 @@ 1. Откройте [страницу очереди](user/queue.md). -1. В правом верхнем углу страницы нажмите ![](../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В правом верхнем углу страницы нажмите ![](../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. Перейдите на вкладку **Локальные поля**. diff --git a/ru/tracker/manager/add-ticket-type.md b/ru/tracker/manager/add-ticket-type.md index d897db54353..2b38da28a78 100644 --- a/ru/tracker/manager/add-ticket-type.md +++ b/ru/tracker/manager/add-ticket-type.md @@ -16,13 +16,13 @@ 1. Перейдите на страницу очереди. -1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Перейдите на вкладку **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. Здесь вы увидите список рабочих процессов в очереди, а также какие типы задач и резолюции определены в каждом из них. +1. Перейдите на вкладку **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. Здесь вы увидите список рабочих процессов в очереди, а также какие типы задач и резолюции определены в каждом из них. 1. Чтобы добавить тип задачи в существующий процесс, в блоке с этим процессом нажмите **Добавить тип задачи** и выберите тип задачи из списка системных типов задач. О том, как добавить тип задачи в новый рабочий процесс, читайте в [инструкции по созданию рабочего процесса](add-workflow.md#create). -Чтобы определить для задачи очереди тип по умолчанию, в поле {{ ui-key.startrek.ui_components_queue-admin-tab-workflows_WorkflowsStateList.default-type-title }} выберите один из вариантов. +Чтобы определить для задачи очереди тип по умолчанию, в поле {{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-workflows_WorkflowsStateList.default-type-title }} выберите один из вариантов. ## Создать тип задачи {#create-ticket-type} @@ -51,9 +51,9 @@ 1. Перейдите на страницу очереди. -1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Перейдите на вкладку **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. Здесь вы увидите список рабочих процессов в очереди. Выберите рабочий процесс, в который хотите добавить новый тип задач и в строке этого рабочего процесса нажмите ![](../../_assets/tracker/svg/arrow.svg). +1. Перейдите на вкладку **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. Здесь вы увидите список рабочих процессов в очереди. Выберите рабочий процесс, в который хотите добавить новый тип задач и в строке этого рабочего процесса нажмите ![](../../_assets/tracker/svg/arrow.svg). 1. Нажмите **Добавить тип задачи**, начните вводить название нового типа задач и нажмите на кнопку создания. @@ -72,8 +72,8 @@ 1. С помощью фильтров [найдите все задачи очереди](quick-filters.md), которые относятся к удаляемому типу и измените его на любой другой, поддержанный в очереди. -1. На странице очереди в верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. На странице очереди в верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Перейдите на вкладку **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. Здесь вы увидите список рабочих процессов в очереди. Выберите рабочий процесс, в котором содержится тип задач, который вы хотите удалить. +1. Перейдите на вкладку **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. Здесь вы увидите список рабочих процессов в очереди. Выберите рабочий процесс, в котором содержится тип задач, который вы хотите удалить. 1. Наведите курсор на строку с удаляемым типом задач, нажмите на тип задач и в строке этого рабочего процесса нажмите ![](../../_assets/tracker/svg/actions.svg) → **Удалить тип задачи из очереди**. diff --git a/ru/tracker/manager/add-workflow.md b/ru/tracker/manager/add-workflow.md index 903686fdecd..a18e0185941 100644 --- a/ru/tracker/manager/add-workflow.md +++ b/ru/tracker/manager/add-workflow.md @@ -26,9 +26,9 @@ 1. Перейдите на страницу очереди. -1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Перейдите на вкладку **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** и нажмите **{{ ui-key.startrek.ui_components_queue-admin-tab-workflows_WorkflowsStateList.action-new-process }}**. Откроется визуальный редактор рабочих процессов. +1. Перейдите на вкладку **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** и нажмите **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-workflows_WorkflowsStateList.action-new-process }}**. Откроется визуальный редактор рабочих процессов. 1. [Добавляйте на схему статусы](./workflow-status-edit.md#add-status) и [настраивайте переходы](./workflow-action-edit.md#add-action) между ними. Придерживайтесь [правил](#rules). @@ -37,13 +37,13 @@ Чтобы скопировать процесс из другой очереди: 1. Перейдите на страницу очереди, в которую нужно скопировать процесс. -1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. -1. На вкладке **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** нажмите ![](../../_assets/tracker/svg/copy-process.svg). +1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. +1. На вкладке **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** нажмите ![](../../_assets/tracker/svg/copy-process.svg). 1. В открывшемся окне заполните поля: - * **{{ ui-key.startrek.ui_components_queue-admin-tab-workflows_CopyWorkflowDialog.label-queue }}**. - * **{{ ui-key.startrek.ui_components_queue-admin-tab-workflows_CopyWorkflowDialog.label-workflow }}**. - * **{{ ui-key.startrek.ui_components_queue-admin-tab-workflows_CopyWorkflowDialog.label-name }}**. -1. Нажмите **{{ ui-key.startrek.ui_components_queue-admin-tab-workflows_CopyWorkflowDialog.action-copy }}**. + * **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-workflows_CopyWorkflowDialog.label-queue }}**. + * **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-workflows_CopyWorkflowDialog.label-workflow }}**. + * **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-workflows_CopyWorkflowDialog.label-name }}**. +1. Нажмите **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-workflows_CopyWorkflowDialog.action-copy }}**. ## Удалить рабочий процесс {#section_s35_xz5_vbb} @@ -57,8 +57,8 @@ 1. Откройте страницу очереди. -1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Перейдите на вкладку **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. +1. Перейдите на вкладку **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. 1. Выберите рабочий процесс и нажмите кнопку ![](../../_assets/tracker/button-delete.png). diff --git a/ru/tracker/manager/agile-new-columns.md b/ru/tracker/manager/agile-new-columns.md index 8cb34bbc234..3c779b27823 100644 --- a/ru/tracker/manager/agile-new-columns.md +++ b/ru/tracker/manager/agile-new-columns.md @@ -6,25 +6,25 @@ ## Колонки по статусам {#status} -Чтобы перейти к колонкам по статусам, на верхней панели доски нажмите **{{ ui-key.startrek.ui_components_agile_common_ViewModeControl.columns }}** → **{{ ui-key.startrek.ui_components_agile_common_ViewModeControl.columnsByStatus }}**. +Чтобы перейти к колонкам по статусам, на верхней панели доски нажмите **Колонки** → **Колонки по статусам**. ### Добавить колонку {#add-status-cols} Чтобы добавить колонку по статусу на доску задач: -1. На странице доски нажмите кнопку **{{ ui-key.startrek.ui_components_agile_backlog_BacklogAddColumnButton.add-column }}**. +1. На странице доски нажмите кнопку **Добавить колонку**. 1. Введите параметры новой колонки: - * Укажите один или несколько статусов в поле **{{ ui-key.startrek.ui_components_agile_common_ColumnForm.create-column-label--statuses }}**. Для этого начните вводить название статуса и выберите значение из списка. + * Укажите один или несколько статусов в поле **Статусы в колонке**. Для этого начните вводить название статуса и выберите значение из списка. * Введите название колонки. * Задайте максимальное число задач, которое может содержаться в колонке. Если их будет больше — колонка станет желтого цвета, но при этом в колонку можно будет добавлять задачи, превышая указанное ограничение. -1. Нажмите **{{ ui-key.startrek.ui_components_agile_common_ColumnForm.create-column-submit-button--create }}**. +1. Нажмите **Добавить**. -1. Чтобы просмотреть список статусов, которые не используются на доске, рядом с крайней правой колонкой нажмите значок ![](../../_assets/tracker/svg/unused-status.svg). Добавьте нужные статусы на доску: на карточке статуса нажмите ![](../../_assets/tracker/svg/actions.svg), затем **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardUnusedStatuses.unused-statuses-create-column }}** или **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardUnusedStatuses.unused-statuses-add-to-column }}**. +1. Чтобы просмотреть список статусов, которые не используются на доске, рядом с крайней правой колонкой нажмите значок ![](../../_assets/tracker/svg/unused-status.svg). Добавьте нужные статусы на доску: на карточке статуса нажмите ![](../../_assets/tracker/svg/actions.svg), затем **Создать колонку** или **Добавить в колонку**. {% note info %} @@ -32,13 +32,13 @@ {% endnote %} -1. Чтобы добавить заметку с текстом, который будет отображаться под названием колонки, наведите указатель на колонку и нажмите ![](../../_assets/tracker/svg/actions.svg) → ![](../../_assets/tracker/svg/icon-note.svg) **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardColumnHeader.column-menu--add-note }}**. +1. Чтобы добавить заметку с текстом, который будет отображаться под названием колонки, наведите указатель на колонку и нажмите ![](../../_assets/tracker/svg/actions.svg) → ![](../../_assets/tracker/svg/icon-note.svg) **Добавить заметку**. ### Изменить колонку {#edit-status-cols} Вы можете изменить параметры колонки и ее расположение на доске. -* Чтобы отредактировать название, максимальное количество задач в колонке или изменить статусы, наведите указатель на колонку и нажмите ![](../../_assets/tracker/svg/actions.svg) → ![](../../_assets/tracker/svg/icon-edit.svg) **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardColumnHeader.column-menu--edit }}**. +* Чтобы отредактировать название, максимальное количество задач в колонке или изменить статусы, наведите указатель на колонку и нажмите ![](../../_assets/tracker/svg/actions.svg) → ![](../../_assets/tracker/svg/icon-edit.svg) **Редактировать**. * Чтобы изменить расположение колонки на доске, перетащите ее в нужное место. @@ -46,21 +46,21 @@ ### Удалить колонку {#delete-status-cols} -Чтобы удалить колонку с доски, наведите указатель на колонку и нажмите ![](../../_assets/tracker/svg/actions.svg) → ![](../../_assets/tracker/svg/icon-remove.svg) **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardColumnHeader.column-menu--delete }}**. +Чтобы удалить колонку с доски, наведите указатель на колонку и нажмите ![](../../_assets/tracker/svg/actions.svg) → ![](../../_assets/tracker/svg/icon-remove.svg) **Удалить**. -Если в удаленной колонке были задачи, они будут перенесены в блок **{{ ui-key.startrek.ui_components_agile_common_UnusedStatusesButton.unused-statuses-button }}**. Чтобы просмотреть такие задачи, рядом с крайней правой колонкой нажмите значок ![](../../_assets/tracker/svg/unused-status.svg), затем нажмите название статуса. +Если в удаленной колонке были задачи, они будут перенесены в блок **Неиспользуемые статусы**. Чтобы просмотреть такие задачи, рядом с крайней правой колонкой нажмите значок ![](../../_assets/tracker/svg/unused-status.svg), затем нажмите название статуса. ## Произвольные колонки {#user-columns} На досках можно создавать, перемещать и удалять произвольные колонки. Это касается всех колонок, кроме первой — колонки с неразобранными задачами. Также внутри произвольных колонок можно создавать задачи, перемещать их как внутри колонки, так и между колонками. -Чтобы перейти к произвольным колонкам, на верхней панели доски нажмите **{{ ui-key.startrek.ui_components_agile_common_ViewModeControl.columns }}** → **{{ ui-key.startrek.ui_components_agile_common_ViewModeControl.customColumns }}**. +Чтобы перейти к произвольным колонкам, на верхней панели доски нажмите **Колонки** → **Произвольные колонки**. ### Добавить колонку {#add-user-cols} Чтобы добавить произвольную колонку на доску задач: -1. На странице доски нажмите кнопку **{{ ui-key.startrek.ui_components_agile_backlog_BacklogAddColumnButton.add-column }}**. +1. На странице доски нажмите кнопку **Добавить колонку**. 1. Введите параметры новой колонки: @@ -68,13 +68,13 @@ * Задайте максимальное число задач, которое может содержаться в колонке. Если их будет больше — колонка станет желтого цвета, но при этом в колонку можно будет добавлять задачи, превышая указанное ограничение. -1. Нажмите **{{ ui-key.startrek.ui_components_agile_common_ColumnForm.create-column-submit-button--create }}**. +1. Нажмите **Добавить**. 1. Добавьте в колонку задачи: рядом с колонкой нажмите ![](../../_assets/tracker/svg/add-task.svg) и добавьте существующую задачу или создайте новую. {% note info %} - Если на карточку задачи добавлено поле **Story Points**, то суммарное количество **Story Points** в колонке отображается в ее заголовке. Чтобы добавить поле **Story Points** в карточку задачи, на странице доски в правом углу панели поиска, сортировки и группировки нажмите кнопку ![](../../_assets/tracker/svg/actions.svg) → **{{ ui-key.startrek.ui_components_agile_common_FieldsSelect.fields-settings }}** и выберите поле **Story Points**. + Если на карточку задачи добавлено поле **Story Points**, то суммарное количество **Story Points** в колонке отображается в ее заголовке. Чтобы добавить поле **Story Points** в карточку задачи, на странице доски в правом углу панели поиска, сортировки и группировки нажмите кнопку ![](../../_assets/tracker/svg/actions.svg) → **Поля карточки** и выберите поле **Story Points**. {% endnote %} @@ -82,7 +82,7 @@ Вы можете изменить параметры колонки и ее расположение на доске. -* Чтобы отредактировать название или максимальное количество задач в колонке, наведите указатель на эту колонку и нажмите ![](../../_assets/tracker/svg/actions.svg) → ![](../../_assets/tracker/svg/icon-edit.svg) **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardColumnHeader.column-menu--edit }}**. +* Чтобы отредактировать название или максимальное количество задач в колонке, наведите указатель на эту колонку и нажмите ![](../../_assets/tracker/svg/actions.svg) → ![](../../_assets/tracker/svg/icon-edit.svg) **Редактировать**. * Чтобы изменить расположение колонки на доске, перетащите ее в нужное место. @@ -90,4 +90,4 @@ ### Удалить колонку {#delete-user-cols} -Чтобы удалить колонку с доски, наведите указатель на колонку и нажмите ![](../../_assets/tracker/svg/actions.svg) → ![](../../_assets/tracker/svg/icon-remove.svg) **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardColumnHeader.column-menu--delete }}**. +Чтобы удалить колонку с доски, наведите указатель на колонку и нажмите ![](../../_assets/tracker/svg/actions.svg) → ![](../../_assets/tracker/svg/icon-remove.svg) **Удалить**. diff --git a/ru/tracker/manager/agile-new-create.md b/ru/tracker/manager/agile-new-create.md index 9c848788685..017e7ed8691 100644 --- a/ru/tracker/manager/agile-new-create.md +++ b/ru/tracker/manager/agile-new-create.md @@ -7,27 +7,27 @@ description: Из статьи вы узнаете, как создать дос ## Создание простой доски {#basic} -**{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardCreateModal.board-type--simple }}** подходит любым командам и позволяет распределять задачи по колонкам в зависимости от их статуса. +**Простая** подходит любым командам и позволяет распределять задачи по колонкам в зависимости от их статуса. Чтобы создать простую доску: 1. На панели слева нажмите **Доски задач** → **Создать доску**. -1. Выберите тип доски **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardCreateModal.board-type--simple }}** и нажмите **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardCreateModal.submit-btn }}**. Будет создана доска с названием «Новая доска». Это поле на доске доступно для редактирования, так что вы сможете его скорректировать и изменить название. +1. Выберите тип доски **Простая** и нажмите **Создать**. Будет создана доска с названием «Новая доска». Это поле на доске доступно для редактирования, так что вы сможете его скорректировать и изменить название. На доске уже добавлены несколько колонок со статусами **Открыт**, **В работе** и **Закрыт**. Можно удалить эти колонки, добавить другие или создать произвольные, не привязанные к статусам задач. -После [добавления на доску задач](agile-new-set-board.md#add-task) вы сможете настроить отображение карточек задач, группировать и фильтровать задачи, а также перемещать их между колонками. На простой доске доступно [подключение бэклога](backlog.md#add-backlog) — доска преобразуется к виду доски **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardCreateModal.board-type--scrum }}**. Обратный переход невозможен. +После [добавления на доску задач](agile-new-set-board.md#add-task) вы сможете настроить отображение карточек задач, группировать и фильтровать задачи, а также перемещать их между колонками. На простой доске доступно [подключение бэклога](backlog.md#add-backlog) — доска преобразуется к виду доски **С бэклогом и спринтами**. Обратный переход невозможен. ## Создание доски с бэклогом и спринтами {#backlog-and-sprints} -Доска **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardCreateModal.board-type--scrum }}** предназначена для Agile-команд и позволяет формировать [бэклог](backlog.md), управлять [спринтами](create-agile-sprint.md), [оценивать сложность задач](poker.md) и анализировать [диаграмму сгорания задач](burndown-diagram.md). +Доска **С бэклогом и спринтами** предназначена для Agile-команд и позволяет формировать [бэклог](backlog.md), управлять [спринтами](create-agile-sprint.md), [оценивать сложность задач](poker.md) и анализировать [диаграмму сгорания задач](burndown-diagram.md). Чтобы создать доску с бэклогом и спринтами: 1. На панели слева нажмите **Доски задач** → **Создать доску**. -1. Выберите тип доски **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardCreateModal.board-type--scrum }}** и нажмите **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardCreateModal.submit-btn }}**. Будет создана доска с названием «Новая доска». Это поле на доске доступно для редактирования, так что вы сможете его скорректировать и изменить название. +1. Выберите тип доски **С бэклогом и спринтами** и нажмите **Создать**. Будет создана доска с названием «Новая доска». Это поле на доске доступно для редактирования, так что вы сможете его скорректировать и изменить название. Доска состоит из трех вкладок: * Бэклог — чтобы сформировать бэклог задач и создавать спринты; diff --git a/ru/tracker/manager/agile-new-issues.md b/ru/tracker/manager/agile-new-issues.md index 616da33470b..bf6fa117f88 100644 --- a/ru/tracker/manager/agile-new-issues.md +++ b/ru/tracker/manager/agile-new-issues.md @@ -10,7 +10,7 @@ По умолчанию на карточке задачи отображаются значения полей ключ, название, исполнитель и некоторых других. Чтобы настроить отображение полей на карточке задачи: -1. На странице доски в правом углу панели поиска, сортировки и группировки нажмите кнопку ![](../../_assets/tracker/svg/actions.svg) → **{{ ui-key.startrek.ui_components_agile_common_FieldsSelect.fields-settings }}**. +1. На странице доски в правом углу панели поиска, сортировки и группировки нажмите кнопку ![](../../_assets/tracker/svg/actions.svg) → **Поля карточки**. 1. Отметьте поля задачи, которые будут отображаться на карточке. Можно добавить любые поля или убрать уже настроенные, кроме названия задачи (поле **Задача**). @@ -36,9 +36,9 @@ {% endnote %} -* Чтобы изменить положение карточки в колонке, наведите на нее курсор и в ее верхнем правом углу нажмите значок ![](../../_assets/tracker/svg/actions.svg) и выберите действие **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardIssue.issue-actions--move-up }}** или **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardIssue.issue-actions--move-down }}**. +* Чтобы изменить положение карточки в колонке, наведите на нее курсор и в ее верхнем правом углу нажмите значок ![](../../_assets/tracker/svg/actions.svg) и выберите действие **Перенести наверх колонки** или **Перенести вниз колонки**. -* Чтобы удалить задачу с доски, в верхнем правом углу карточки нажмите значок ![](../../_assets/tracker/svg/actions.svg) и выберите действие **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardIssue.issue-actions--delete-from-board }}**. +* Чтобы удалить задачу с доски, в верхнем правом углу карточки нажмите значок ![](../../_assets/tracker/svg/actions.svg) и выберите действие **Убрать с доски**. {% note info %} @@ -54,21 +54,21 @@ Чтобы создать фильтр на доске: -1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/filter.svg) **{{ ui-key.startrek.ui_components_page-issues_touch_FilterSettingsMenu.item-filters }}**. Над колонками доски отобразится панель для настройки фильтра. +1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/filter.svg) **Фильтры**. Над колонками доски отобразится панель для настройки фильтра. 1. Нажмите значок ![](../../_assets/tracker/svg/add-filter.svg). Выберите параметр, по которому будут отфильтрованы задачи, и задайте для него значение. Если требуется, добавьте в фильтр несколько параметров. -1. Чтобы отменить фильтр, нажмите ![](../../_assets/tracker/svg/clear-filter.svg) **{{ ui-key.startrek.ui_components_agile_common_AgileFilters.reset-button }}**. +1. Чтобы отменить фильтр, нажмите ![](../../_assets/tracker/svg/clear-filter.svg) **Сбросить**. -1. Чтобы сохранить фильтр, нажмите ![](../../_assets/tracker/svg/save-filter.svg) **{{ ui-key.startrek.ui_components_agile_common_AgileFilters.action-title-save }}**: +1. Чтобы сохранить фильтр, нажмите ![](../../_assets/tracker/svg/save-filter.svg) **Сохранить**: 1. Задайте название фильтра. 1. Выберите, для кого фильтр будет закреплен в верхней части доски для быстрого доступа: только для вас или для всех пользователей. Закрепленные фильтры отображаются в виде кнопок вверху доски. - 1. Нажмите кнопку **{{ ui-key.startrek.ui_components_agile_common_AgileFilters.action-title-save }}**. + 1. Нажмите кнопку **Сохранить**. Сохраненные фильтры будут доступны всем пользователям. @@ -80,11 +80,11 @@ {% endnote %} - 1. На панели с фильтрами нажмите значок ![](../../_assets/tracker/svg/settings.svg) или в правом верхнем углу страницы нажмите ![](../../_assets/horizontal-ellipsis.svg) и выберите **{{ ui-key.startrek.ui_components_agile_common_QuickFilterPopup.filters-manage }}**. + 1. На панели с фильтрами нажмите значок ![](../../_assets/tracker/svg/settings.svg) или в правом верхнем углу страницы нажмите ![](../../_assets/horizontal-ellipsis.svg) и выберите **Управление фильтрами**. 1. Выберите фильтры, которые должны отображаться на доске, и нажмите **Применить**. -1. Чтобы отредактировать или удалить сохраненный фильтр, в правом верхнем углу нажмите ![](../../_assets/horizontal-ellipsis.svg) и выберите **{{ ui-key.startrek.ui_components_agile_common_QuickFilterPopup.filters-manage }}**. Затем рядом с названием фильтра нажмите значок ![](../../_assets/tracker/svg/settings.svg). +1. Чтобы отредактировать или удалить сохраненный фильтр, в правом верхнем углу нажмите ![](../../_assets/horizontal-ellipsis.svg) и выберите **Управление фильтрами**. Затем рядом с названием фильтра нажмите значок ![](../../_assets/tracker/svg/settings.svg). ## Группировать задачи {#group} @@ -110,11 +110,11 @@ ## Сортировка задач на доске {#sorting} -Задачи на доске можно сортировать как вручную, так и по предзаданным параметрам, например, по приоритету, дедлайну или исполнителю. Чтобы сортировать задачи, в верхней части доски нажмите ![](../../_assets/tracker/svg/sorting.svg) **{{ ui-key.startrek.ui_components_dashboard_IssuesStatEditor.editor-sort-by-field-label }}** и выберите из списка нужный параметр. Рядом с кнопкой сортировки есть кнопка, которая позволяет управлять направлением сортировки. +Задачи на доске можно сортировать как вручную, так и по предзаданным параметрам, например, по приоритету, дедлайну или исполнителю. Чтобы сортировать задачи, в верхней части доски нажмите ![](../../_assets/tracker/svg/sorting.svg) **Сортировка** и выберите из списка нужный параметр. Рядом с кнопкой сортировки есть кнопка, которая позволяет управлять направлением сортировки. ## Массовое редактирование задач {#bulk} -На досках работает массовое редактирование задач. Для этого на доске, на карточке одной из задач, нажмите ![](../../_assets/tracker/svg/actions.svg) → **{{ ui-key.startrek.ui_components_agile_common_IssueActionsMenu.select-issue }}** и нажимайте на другие задачи, над которыми требуется совершить однотипное действие. Как только все задачи будут выбраны, на панели внизу доски выберите действие: +На досках работает массовое редактирование задач. Для этого на доске, на карточке одной из задач, нажмите ![](../../_assets/tracker/svg/actions.svg) → **Выделить** и нажимайте на другие задачи, над которыми требуется совершить однотипное действие. Как только все задачи будут выбраны, на панели внизу доски выберите действие: * переместить вверх или вниз колонки; * изменить статус; diff --git a/ru/tracker/manager/agile-new-set-board.md b/ru/tracker/manager/agile-new-set-board.md index 58e25e531c0..37fbc93f497 100644 --- a/ru/tracker/manager/agile-new-set-board.md +++ b/ru/tracker/manager/agile-new-set-board.md @@ -8,7 +8,7 @@ 1. Откройте страницу доски. -1. В крайней левой колонке нажмите значок ![](../../_assets/tracker/svg/add-task.svg) и выберите **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardEmptyScreen.empty-screen--new-issue }}**. +1. В крайней левой колонке нажмите значок ![](../../_assets/tracker/svg/add-task.svg) и выберите **Новая задача**. 1. Введите название задачи. @@ -38,7 +38,7 @@ 1. Откройте страницу задачи. -1. Нажмите на поле **{{ ui-key.startrek-backend.fields.issue.boards }}** на панели справа. Если поля **{{ ui-key.startrek-backend.fields.issue.boards }}** нет, добавьте его с помощью кнопки **{{ ui-key.startrek.ui_components_entity-page_sidebar_SidebarFieldsSelect.add-sidebar-field }}**. +1. Нажмите на поле **{{ ui-key.startrek-backend.fields.issue.boards }}** на панели справа. Если поля **{{ ui-key.startrek-backend.fields.issue.boards }}** нет, добавьте его с помощью кнопки **{{ ui-key.startrek.ui_Common_smart-components_entity-page_sidebar_SidebarFieldsSelect.add-sidebar-field }}**. 1. Начните вводить название доски и выберите подходящий вариант из списка. @@ -48,7 +48,7 @@ 1. Выберите задачи, которые вы хотите добавить на доску. -1. На панели снизу нажмите ![](../../_assets/horizontal-ellipsis.svg) и выберите **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.add-to-board }}**. +1. На панели снизу нажмите ![](../../_assets/horizontal-ellipsis.svg) и выберите **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.add-to-board }}**. 1. Начните вводить название доски и выберите подходящий вариант из списка. @@ -58,8 +58,8 @@ Чтобы автоматически добавлять на доску задачи, например, все задачи очереди с определенным исполнителем, используйте автодобавление: -1. На доске нажмите **{{ ui-key.startrek.ui_components_PageAgileBoard_PageAgileBoardHeader.settings }}** → **{{ ui-key.startrek.ui_components_agile_settings_AgileSettingsLayout.issue-updates }}**. -1. В блоке **{{ ui-key.startrek.ui_components_agile_settings_BoardIssueUpdatesSettings.import-title }}** нажмите **+ {{ ui-key.startrek.ui_components_issues-import_IssuesImportFilters.add-parameters }}**. Выберите из списка параметр и укажите значение. Например, чтобы добавить на доску все задачи, в которых вы являетесь исполнителем, выберите параметр **Исполнитель** и укажите для него значение **Я**. Чтобы добавить дополнительные параметры, повторите этот шаг. +1. На доске нажмите **{{ ui-key.startrek.ui_Boards_pages_PageAgileBoard_PageAgileBoardHeader.settings }}** → **Автоматическое добавление и удаление задач**. +1. В блоке **Добавление задач на доску** нажмите **+ Добавить параметры**. Выберите из списка параметр и укажите значение. Например, чтобы добавить на доску все задачи, в которых вы являетесь исполнителем, выберите параметр **Исполнитель** и укажите для него значение **Я**. Чтобы добавить дополнительные параметры, повторите этот шаг. На странице отобразится количество добавляемых на доску задач. При первой выгрузке будут добавлены задачи, которые удовлетворяют сформулированному условию, за исключением: @@ -74,8 +74,8 @@ Действует ограничение на количество задач на доске: их должно быть не больше 2000. Чтобы доска не переполнялась, можно настроить автоматическое удаление задач с доски и, например, удалять все закрытые задачи или задачи, которые были закрыты несколько месяцев назад. -1. На доске нажмите **{{ ui-key.startrek.ui_components_PageAgileBoard_PageAgileBoardHeader.settings }}** → **{{ ui-key.startrek.ui_components_agile_settings_AgileSettingsLayout.issue-updates }}**. -1. В блоке **{{ ui-key.startrek.ui_components_agile_settings_BoardIssueUpdatesSettings.removal-title }}** добавьте все нужные статусы и время нахождения задачи в этом статусе. +1. На доске нажмите **{{ ui-key.startrek.ui_Boards_pages_PageAgileBoard_PageAgileBoardHeader.settings }}** → **Автоматическое добавление и удаление задач**. +1. В блоке **Удаление задач с доски** добавьте все нужные статусы и время нахождения задачи в этом статусе. Как только условие будет выполнено, задача будет удалена с доски. @@ -115,6 +115,6 @@ 1. Перейдите на доску. -1. В правом верхнем углу нажмите ![](../../_assets/horizontal-ellipsis.svg) и выберите **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardActionsMenu.delete-board-menu-item }}**. +1. В правом верхнем углу нажмите ![](../../_assets/horizontal-ellipsis.svg) и выберите **Удалить доску**. 1. Подтвердите удаление. diff --git a/ru/tracker/manager/agile.md b/ru/tracker/manager/agile.md index 9a9d9db1aab..f1cf7bdc4e1 100644 --- a/ru/tracker/manager/agile.md +++ b/ru/tracker/manager/agile.md @@ -31,7 +31,7 @@ description: В этом разделе описаны инструкции дл - Доска **Скрам**, помимо отображения статусов задач, включает инструменты для управления [спринтами](#dlen_sprint), [оценки сложности задач](planning-poker.md) и [диаграмму сгорания задач](#dlen_burndown). -- Доска **Канбан** — похожа на простую доску, но все задачи в статусе **Открыт** автоматически попадают в колонку [**{{ ui-key.startrek.ui_components_agile_backlog_BacklogIssue.backlog-default-column }}**](#dlen_backlog). +- Доска **Канбан** — похожа на простую доску, но все задачи в статусе **Открыт** автоматически попадают в колонку [**Бэклог**](#dlen_backlog). Подробнее о том, как работать с досками задач: diff --git a/ru/tracker/manager/backlog.md b/ru/tracker/manager/backlog.md index a2a5fdf4ae5..e65bad83475 100644 --- a/ru/tracker/manager/backlog.md +++ b/ru/tracker/manager/backlog.md @@ -2,7 +2,7 @@ [Бэклог](../../glossary/backlog) — это список задач или требований к продукту, которые нужно реализовать. Обычно задачи в бэклоге упорядочены по приоритету. -На вкладке **{{ ui-key.startrek.ui_components_agile_common_AgileTabs.backlog }}** можно собрать список приоритетных задач команды, отсортировать их по важности и распределить по спринтам. Вы сможете создавать задачи или добавлять существующие как в бэклог, так и сразу в спринт. Чтобы взять задачу из бэклога в спринт, достаточно перетащить ее карточку из одного списка в другой. +На вкладке **Бэклог** можно собрать список приоритетных задач команды, отсортировать их по важности и распределить по спринтам. Вы сможете создавать задачи или добавлять существующие как в бэклог, так и сразу в спринт. Чтобы взять задачу из бэклога в спринт, достаточно перетащить ее карточку из одного списка в другой. Следите за [актуальностью](agile-new.md#tips) задач в бэклоге: в нем не должно быть закрытых задач, дубликатов, а также задач, которые не будут взяты в работу в ближайшее время. @@ -10,20 +10,20 @@ ## Как включить бэклог на простых досках {#add-backlog} -Вкладка **{{ ui-key.startrek.ui_components_agile_common_AgileTabs.backlog }}** с бэклогом и спринтами по умолчанию присутствует на досках **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardCreateModal.board-type--scrum }}**. На **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardCreateModal.board-type--simple }}** такой вкладки нет, но ее можно подключить. +Вкладка **Бэклог** с бэклогом и спринтами по умолчанию присутствует на досках **С бэклогом и спринтами**. На **Простая** такой вкладки нет, но ее можно подключить. {% note warning %} -Отключить вкладку **{{ ui-key.startrek.ui_components_agile_common_AgileTabs.backlog }}** и спринты пока нельзя, но в будущем появится такая возможность. +Отключить вкладку **Бэклог** и спринты пока нельзя, но в будущем появится такая возможность. {% endnote %} Чтобы включить бэклог и спринты на **Простых** досках: -1. Нажмите **{{ ui-key.startrek.ui_components_PageAgileBoard_PageAgileBoardHeader_EnableBacklogButton.enable-backlog }}** в верхней части экрана. +1. Нажмите **{{ ui-key.startrek.ui_Boards_pages_PageAgileBoard_PageAgileBoardHeader_EnableBacklogButton.enable-backlog }}** в верхней части экрана. 1. Если на доске уже есть задачи, выберите, куда их перенести: в бэклог или спринт. -Появится вкладка **{{ ui-key.startrek.ui_components_agile_common_AgileTabs.backlog }}** со списком задач бэклога и спринтами. +Появится вкладка **Бэклог** со списком задач бэклога и спринтами. ## Как добавить задачи в бэклог {#add-new-backlog} @@ -36,8 +36,8 @@ Чтобы добавить группу задач, например, все задачи очереди с определенным исполнителем, используйте автодобавление: -1. На доске нажмите **{{ ui-key.startrek.ui_components_PageAgileBoard_PageAgileBoardHeader.settings }}** → **{{ ui-key.startrek.ui_components_agile_settings_AgileSettingsLayout.issue-updates }}**. -1. В блоке **{{ ui-key.startrek.ui_components_agile_settings_BoardIssueUpdatesSettings.import-title }}** нажмите **+ {{ ui-key.startrek.ui_components_issues-import_IssuesImportFilters.add-parameters }}**. Выберите из списка параметр и укажите значение. Например, чтобы добавить на доску все задачи, в которых вы являетесь исполнителем, выберите параметр **Исполнитель** и укажите для него значение **Я**. Чтобы добавить дополнительные параметры, повторите этот шаг. +1. На доске нажмите **{{ ui-key.startrek.ui_Boards_pages_PageAgileBoard_PageAgileBoardHeader.settings }}** → **Автоматическое добавление и удаление задач**. +1. В блоке **Добавление задач на доску** нажмите **+ Добавить параметры**. Выберите из списка параметр и укажите значение. Например, чтобы добавить на доску все задачи, в которых вы являетесь исполнителем, выберите параметр **Исполнитель** и укажите для него значение **Я**. Чтобы добавить дополнительные параметры, повторите этот шаг. Также группу задач можно добавить с помощью операций [массового редактирования](agile-new-issues.md#bulk): 1. На странице [поиска задач]({{ link-tracker }}issues) отметить нужные задачи с помощью чекбоксов слева от задачи. diff --git a/ru/tracker/manager/backward-compatibility.md b/ru/tracker/manager/backward-compatibility.md index 1ad876265c9..cb424669f05 100644 --- a/ru/tracker/manager/backward-compatibility.md +++ b/ru/tracker/manager/backward-compatibility.md @@ -28,9 +28,9 @@ После того как вы поддержали обратную совместимость для типов задач удаляемого рабочего процесса, можно приступать к его удалению: -1. Откройте страницу очереди и перейдите в ее настройки: нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. Откройте страницу очереди и перейдите в ее настройки: нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. На вкладке **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** найдите рабочий процесс, который хотите удалить. +1. На вкладке **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** найдите рабочий процесс, который хотите удалить. 1. Удалите [резолюции](./create-resolution.md#delete-resolution) и [типы задач](./add-ticket-type.md#delete-ticket-type) в этом процессе. diff --git a/ru/tracker/manager/boards-convertor.md b/ru/tracker/manager/boards-convertor.md index b04921773a8..8f8a5de47d1 100644 --- a/ru/tracker/manager/boards-convertor.md +++ b/ru/tracker/manager/boards-convertor.md @@ -28,7 +28,7 @@ description: Следуя данной инструкции, вы сможете * название; * добавленные задачи; * распределение статусов по колонкам; -* фильтры «{{ ui-key.startrek.ui_components_IssuesPresetSelect.preset_author }}» и «{{ ui-key.startrek.ui_components_IssuesPresetSelect.preset_assignee }}»; +* фильтры «{{ ui-key.startrek.ui_Issues_smart-components_IssuesPresetSelect.preset_author }}» и «{{ ui-key.startrek.ui_Issues_smart-components_IssuesPresetSelect.preset_assignee }}»; * фильтр для добавления задач. Тип доски при миграции также сохраняется: **Простая** и **Канбан** (не отличаются по функциональности) преобразуются в простые доски, а **Скрам** — в доски с бэклогом и спринтами. @@ -61,11 +61,11 @@ description: Следуя данной инструкции, вы сможете 1. Изучите окно миграции: * есть ошибки — следуйте инструкциям для их устранения и повторите попытку миграции. - * нет ошибок — нажмите **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardMigrationForm.submit-btn }}**. Миграция может занять несколько минут. + * нет ошибок — нажмите **Начать миграцию**. Миграция может занять несколько минут. ## Возвращение к старой версии доски {#backward} -Если после миграции вы поймете, что новые технологии вам не подходят, то сможете вернуть вашу доску к исходному виду. Для этого на верхней панели доски нажмите ![](../../_assets/tracker/svg/actions.svg) → **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardActionsMenu.migration-rollback }}** и дождитесь завершения миграции. +Если после миграции вы поймете, что новые технологии вам не подходят, то сможете вернуть вашу доску к исходному виду. Для этого на верхней панели доски нажмите ![](../../_assets/tracker/svg/actions.svg) → **Миграция в старую версию** и дождитесь завершения миграции. {% note warning %} diff --git a/ru/tracker/manager/bulk-change.md b/ru/tracker/manager/bulk-change.md index a362ce36bd5..4a018e18080 100644 --- a/ru/tracker/manager/bulk-change.md +++ b/ru/tracker/manager/bulk-change.md @@ -12,7 +12,7 @@ Если вы хотите выбрать сразу все задачи на странице очереди или фильтра, поставьте отметку ![](../../_assets/tracker/svg/check.svg) над списком задач. -1. Нажмите кнопку **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.change-status }}** под списком задач и выберите статус. +1. Нажмите кнопку **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.change-status }}** под списком задач и выберите статус. Доступны только те переходы между статусами, которые разрешены в [воркфлоу](workflow.md). Если вы выберете переход, который доступен только для части задач, статус изменится только у них. @@ -30,7 +30,7 @@ Если вы хотите выбрать сразу все задачи на странице очереди или фильтра, поставьте отметку ![](../../_assets/tracker/svg/check.svg) над списком задач. -1. Нажмите кнопку **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.move }}** под списком задач. +1. Нажмите кнопку **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.move }}** под списком задач. 1. Выберите очередь, в которую будут перемещены задачи. @@ -50,7 +50,7 @@ Если вы хотите выбрать сразу все задачи на странице очереди или фильтра, поставьте отметку ![](../../_assets/tracker/svg/check.svg) над списком задач. -1. Нажмите кнопку **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.add-link }}** под списком задач, выберите [тип связи](../user/links.md) и создайте связь: +1. Нажмите кнопку **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.add-link }}** под списком задач, выберите [тип связи](../user/links.md) и создайте связь: * Чтобы создать новую задачу, выберите вкладку **Новая задача**. Введите название и нажмите клавишу **Enter**. @@ -68,9 +68,9 @@ 1. Нажмите кнопку ![](../../_assets/horizontal-ellipsis.svg) под списком задач. - * Чтобы добавить задачи на доску, выберите **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.add-to-board }}**. Выберите одну или несколько досок и нажмите **{{ ui-key.startrek.ui_components_bulk_BulkChangeParametersDialog.button-submit-text }}**. + * Чтобы добавить задачи на доску, выберите **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.add-to-board }}**. Выберите одну или несколько досок и нажмите **{{ ui-key.startrek.ui_Common_smart-components_bulk_BulkChangeParametersDialog.button-submit-text }}**. - * Чтобы добавить задачу в проект, выберите **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.add-to-projects }}**. Все подзадачи также будут добавлены в проект. + * Чтобы добавить задачу в проект, выберите **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.add-to-projects }}**. Все подзадачи также будут добавлены в проект. ## Изменить параметры {#change-parameters} @@ -82,7 +82,7 @@ Если вы хотите выбрать сразу все задачи на странице очереди или фильтра, поставьте отметку ![](../../_assets/tracker/svg/check.svg) над списком задач. -1. Нажмите кнопку ![](../../_assets/horizontal-ellipsis.svg) под списком задач и выберите **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.edit-parameters }}**. +1. Нажмите кнопку ![](../../_assets/horizontal-ellipsis.svg) под списком задач и выберите **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.edit-parameters }}**. 1. Выберите нужные параметры. Если нужных полей нет в списке, добавьте их с помощью кнопки **Изменить список параметров**. @@ -90,11 +90,11 @@ Некоторые поля могут содержать список значений (например, поля «Наблюдатели», «{{ ui-key.startrek-backend.messages.workflow.field.maillists }}» или «Теги»). По умолчанию новые значения дописываются в конец списка. Чтобы перезаписать поле, включите опцию **Удалить значения**. -1. Нажмите кнопку **{{ ui-key.startrek.ui_components_BulkSuggestPopup.apply }}**. +1. Нажмите кнопку **{{ ui-key.startrek.ui_Common_smart-components_BulkSuggestPopup.apply }}**. ## Стать участником задач {#change-my-tickets} -Чтобы добавить или удалить себя из полей **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.assignee }}** или **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.followers }}** в задачах: +Чтобы добавить или удалить себя из полей **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.assignee }}** или **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.followers }}** в задачах: 1. Откройте список задач. @@ -104,6 +104,6 @@ 1. Нажмите кнопку ![](../../_assets/horizontal-ellipsis.svg) под списком задач и выберите вариант: - * Чтобы стать участником задачи, выберите **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.add-me-to-followers }}** или **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.assignee-me }}**. + * Чтобы стать участником задачи, выберите **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.add-me-to-followers }}** или **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.assignee-me }}**. - * Чтобы отменить свое участие в задаче, выберите **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.remove-me-from }}** и укажите вариант: **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.followers }}**, **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.assignee }}** или **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.remove-from-both-fields }}**. + * Чтобы отменить свое участие в задаче, выберите **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.remove-me-from }}** и укажите вариант: **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.followers }}**, **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.assignee }}** или **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.remove-from-both-fields }}**. diff --git a/ru/tracker/manager/create-agile-board.md b/ru/tracker/manager/create-agile-board.md index 03afa82b8c7..31d739e2bc0 100644 --- a/ru/tracker/manager/create-agile-board.md +++ b/ru/tracker/manager/create-agile-board.md @@ -25,7 +25,7 @@ description: Следуя данной инструкции, вы сможете Выберите эту доску, если работаете по методологии Скрам. - - Доска **Канбан** — похожа на простую доску, но все задачи в статусе **Открыт** автоматически попадают в колонку [**{{ ui-key.startrek.ui_components_agile_backlog_BacklogIssue.backlog-default-column }}**](agile.md#dlen_backlog). + - Доска **Канбан** — похожа на простую доску, но все задачи в статусе **Открыт** автоматически попадают в колонку [**Бэклог**](agile.md#dlen_backlog). Выберите эту доску, если ваша команда работает с большим потоком задач, например в службе поддержки. @@ -51,6 +51,6 @@ description: Следуя данной инструкции, вы сможете 1. Укажите очередь для создания задач. Это позволит быстро создавать задачи в этой очереди прямо на странице доски. -1. Нажмите кнопку **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardCreateModal.submit-btn }}**. Новая доска доступна в меню **Доски** на верхней панели {{ tracker-name }}. +1. Нажмите кнопку **Создать**. Новая доска доступна в меню **Доски** на верхней панели {{ tracker-name }}. 1. Если требуется, [настройте колонки и внешний вид карточки задачи](edit-agile-board.md). diff --git a/ru/tracker/manager/create-agile-sprint.md b/ru/tracker/manager/create-agile-sprint.md index 6478996619c..4eb0ab601a4 100644 --- a/ru/tracker/manager/create-agile-sprint.md +++ b/ru/tracker/manager/create-agile-sprint.md @@ -18,36 +18,36 @@ #### Шаг 2. Создайте новый спринт {#create_sprint} -После создания доски на вкладке **{{ ui-key.startrek.ui_components_agile_common_AgileTabs.backlog }}** у нее уже создан первый спринт. Если вы его еще не спланировали, переходите к следующему шагу. Если первый спринт у вас уже завершен и вы хотите создать новый: +После создания доски на вкладке **Бэклог** у нее уже создан первый спринт. Если вы его еще не спланировали, переходите к следующему шагу. Если первый спринт у вас уже завершен и вы хотите создать новый: -1. На вкладке **{{ ui-key.startrek.ui_components_agile_common_AgileTabs.backlog }}** в правой части доски нажмите **+ {{ ui-key.startrek.ui_components_agile_common_SprintForm.create-sprint }}**. +1. На вкладке **Бэклог** в правой части доски нажмите **+ Создать спринт**. -1. Введите название спринта, выберите длительность и укажите время его начала и окончания. Чтобы сразу взять спринт в работу, оставьте опцию **{{ ui-key.startrek.ui_components_agile_common_SprintFormFields.take-sprint-to-work }}** включенной. +1. Введите название спринта, выберите длительность и укажите время его начала и окончания. Чтобы сразу взять спринт в работу, оставьте опцию **Взять в работу** включенной. -1. Нажмите кнопку **{{ ui-key.startrek.ui_components_agile_common_SprintForm.create-sprint }}**. +1. Нажмите кнопку **Создать спринт**. #### Шаг 3. Добавьте задачи в спринт Добавить задачу в спринт можно несколькими способами: -- На вкладке **{{ ui-key.startrek.ui_components_agile_common_AgileTabs.backlog }}** перетащите задачу из колонки **{{ ui-key.startrek.ui_components_agile_backlog_BacklogIssue.backlog-default-column }}** в колонку спринта. +- На вкладке **Бэклог** перетащите задачу из колонки **Бэклог** в колонку спринта. - На странице задачи, на панели справа, в поле **{{ ui-key.startrek-backend.fields.issue.boards }}**, укажите название или идентификатор доски, а в блоке **{{ ui-key.startrek-backend.fields.issue.fields.agile }}**, в поле **{{ ui-key.startrek-backend.fields.issue.sprint }}**, выберите из списка нужный спринт. -- Чтобы быстро добавить много задач, воспользуйтесь [массовым редактированием](agile-new-issues.md#bulk): на доске, на карточке одной из задач, нажмите ![](../../_assets/tracker/svg/actions.svg) → **{{ ui-key.startrek.ui_components_agile_common_IssueActionsMenu.select-issue }}** и нажимайте на другие задачи, которые требуется добавить в спринт. Как только все задачи будут выбраны, на панели внизу доски нажмите **{{ ui-key.startrek.ui_components_agile_common_BulkActionsPanel.add-to-sprint }}** и выберите нужный. +- Чтобы быстро добавить много задач, воспользуйтесь [массовым редактированием](agile-new-issues.md#bulk): на доске, на карточке одной из задач, нажмите ![](../../_assets/tracker/svg/actions.svg) → **Выделить** и нажимайте на другие задачи, которые требуется добавить в спринт. Как только все задачи будут выбраны, на панели внизу доски нажмите **Добавить в спринт** и выберите нужный. ## Редактировать спринт {#sprint-edit} Для редактирования спринта: -1. Справа от заголовка спринта нажмите ![](../../_assets/horizontal-ellipsis.svg) → ![](../../_assets/tracker/svg/icon-edit.svg) **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardColumnHeader.column-menu--edit }}**. +1. Справа от заголовка спринта нажмите ![](../../_assets/horizontal-ellipsis.svg) → ![](../../_assets/tracker/svg/icon-edit.svg) **Редактировать**. -1. В открывшемся окне вы можете изменить название спринта, длительность, время начала и окончания, а также включить опцию **{{ ui-key.startrek.ui_components_agile_common_SprintFormFields.take-sprint-to-work }}**. +1. В открывшемся окне вы можете изменить название спринта, длительность, время начала и окончания, а также включить опцию **Взять в работу**. -1. Чтобы сохранить изменения, нажмите кнопку **{{ ui-key.startrek.ui_components_agile_common_SprintForm.edit-sprint }}**. +1. Чтобы сохранить изменения, нажмите кнопку **Редактировать спринт**. ## Изменить статус спринта {#sprint-status} -Когда все задачи для спринта спланированы и наступает дата начала спринта, на доске, на вкладке **{{ ui-key.startrek.ui_components_agile_common_AgileTabs.backlog }}**, рядом со спринтом нажмите **{{ ui-key.startrek.ui_components_agile_common_StartSprintButton.start }}**. +Когда все задачи для спринта спланированы и наступает дата начала спринта, на доске, на вкладке **Бэклог**, рядом со спринтом нажмите **Запустить**. -Когда работа над спринтом завершится, нажмите рядом с ним **Завершить**. Если в спринте остались незавершенные задачи, вам будет предложено оставить их в текущем спринте, вернуть в бэклог или перенести в новый спринт, который сразу же можно создать. Как только все задачи будут завершены, спринт будет отображаться в блоке **{{ ui-key.startrek.ui_components_agile_common_FinishedSprintsButton.finished-sprints }}**. +Когда работа над спринтом завершится, нажмите рядом с ним **Завершить**. Если в спринте остались незавершенные задачи, вам будет предложено оставить их в текущем спринте, вернуть в бэклог или перенести в новый спринт, который сразу же можно создать. Как только все задачи будут завершены, спринт будет отображаться в блоке **Завершенные спринты**. diff --git a/ru/tracker/manager/create-macroses.md b/ru/tracker/manager/create-macroses.md index 9b7c27fbc88..e4219351c8f 100644 --- a/ru/tracker/manager/create-macroses.md +++ b/ru/tracker/manager/create-macroses.md @@ -14,7 +14,7 @@ 1. {% include [go to settings](../../_includes/tracker/transition-page.md) %} -1. В правом верхнем углу нажмите ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В правом верхнем углу нажмите ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. На панели слева выберите **Автоматизация** → **Макросы** и нажмите кнопку **Создать макрос**. @@ -37,7 +37,7 @@ 1. {% include [go to settings](../../_includes/tracker/transition-page.md) %} -1. В правом верхнем углу нажмите ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В правом верхнем углу нажмите ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. На панели слева выберите **Автоматизация** → **Макросы** и наведите указатель на нужный макрос. @@ -59,7 +59,7 @@ Вы можете выбрать несколько макросов одновременно. Если макросы изменяют один и тот же параметр, к параметру будет применен макрос, который выбран последним. -1. Чтобы выполнить макрос, нажмите кнопку **{{ ui-key.startrek.ui_components_entity-page_macros_MacrosExecutor.apply-button-label }}**. +1. Чтобы выполнить макрос, нажмите кнопку **Выполнить**. ## Пример макроса {#macro_example} @@ -92,4 +92,4 @@ 1. Нажмите ![](../../_assets/tracker/svg/macros.svg) **Макросы** и выберите макрос из раскрывающегося списка. -1. Нажмите кнопку **{{ ui-key.startrek.ui_components_entity-page_macros_MacrosExecutor.apply-button-label }}**. Задача будет переведена на вторую линию поддержки. \ No newline at end of file +1. Нажмите кнопку **Выполнить**. Задача будет переведена на вторую линию поддержки. \ No newline at end of file diff --git a/ru/tracker/manager/create-portfolio.md b/ru/tracker/manager/create-portfolio.md index 5e8f9bece0b..c77106338e7 100644 --- a/ru/tracker/manager/create-portfolio.md +++ b/ru/tracker/manager/create-portfolio.md @@ -25,7 +25,7 @@ description: В статье описано, как управлять порт 1. Введите название портфеля, установите дату завершения и нажмите **Создать**. -1. На вкладке **{{ ui-key.startrek.ui_components_portfolios_Header.description-tab }}** добавьте информацию: +1. На вкладке **О портфеле** добавьте информацию: * Описание портфеля: над чем вы работаете и каких целей хотите достичь. * Прикрепленные файлы: рабочие материалы портфеля. @@ -153,4 +153,4 @@ description: В статье описано, как управлять порт 1. На панели слева выберите ![](../../_assets/tracker/svg/project.svg) **Проекты** или перейдите по [прямой ссылке]({{ link-tracker }}pages/projects) и откройте страницу портфеля. -1. В правом верхнем углу страницы нажмите ![](../../_assets/horizontal-ellipsis.svg) и выберите **{{ ui-key.startrek.ui_components_portfolios_PortfolioMenu.remove-portfolio }}**. +1. В правом верхнем углу страницы нажмите ![](../../_assets/horizontal-ellipsis.svg) и выберите **Удалить портфель проектов**. diff --git a/ru/tracker/manager/create-project.md b/ru/tracker/manager/create-project.md index 3b08036df4f..cd908b4d17f 100644 --- a/ru/tracker/manager/create-project.md +++ b/ru/tracker/manager/create-project.md @@ -62,7 +62,7 @@ description: Из статьи вы узнаете, как управлять п 1. Откройте страницу задачи. Задача не должна принадлежать другому проекту. Чтобы удалить задачу из проекта, очистите поле **{{ ui-key.startrek-backend.fields.issue.project-key-value }}** на панели справа. -1. В правом верхнем углу выберите **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.convert-to-project }}** и нажмите **Конвертировать**. +1. В правом верхнем углу выберите **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.convert-to-project }}** и нажмите **Конвертировать**. ## Добавить задачи в проект {#add-tickets} @@ -77,7 +77,7 @@ description: Из статьи вы узнаете, как управлять п ### Со страницы проекта {#from-project} -1. Перейдите на вкладку **Список задач** и нажмите **{{ ui-key.startrek.ui_components_projects_Table.add-issue }}**. +1. Перейдите на вкладку **Список задач** и нажмите **Добавить задачу**. 1. Чтобы создать новую задачу: @@ -93,7 +93,7 @@ description: Из статьи вы узнаете, как управлять п 1. Откройте страницу задачи. -1. Нажмите на поле **Проект** на панели справа. Если поля **Проект** нет, добавьте его с помощью кнопки **{{ ui-key.startrek.ui_components_issues-import_IssuesImportFilters.add-parameters }}**. +1. Нажмите на поле **Проект** на панели справа. Если поля **Проект** нет, добавьте его с помощью кнопки **Добавить параметры**. 1. В поле **Основной** или **Дополнительные** начните вводить название проекта и выберите подходящий вариант из списка. Нажмите **Сохранить**. @@ -103,7 +103,7 @@ description: Из статьи вы узнаете, как управлять п 1. Выберите задачи, которые вы хотите добавить в проект. -1. На панели снизу нажмите ![](../../_assets/horizontal-ellipsis.svg) и выберите **{{ ui-key.startrek.ui_components_IssueBulkActionPanel.add-to-projects }}**. +1. На панели снизу нажмите ![](../../_assets/horizontal-ellipsis.svg) и выберите **{{ ui-key.startrek.ui_Issues_smart-components_IssueBulkActionPanel.add-to-projects }}**. 1. Начните вводить название проекта и выберите подходящий вариант из списка. @@ -115,9 +115,9 @@ description: Из статьи вы узнаете, как управлять п 1. В верхнем правом углу нажмите **Импорт задач**. -1. Нажмите ![](../../_assets/tracker/svg/add-task.svg) **{{ ui-key.startrek.ui_components_issues-import_IssuesImportFilters.add-parameters }}** и задайте условие для выбора задач. +1. Нажмите ![](../../_assets/tracker/svg/add-task.svg) **Добавить параметры** и задайте условие для выбора задач. -1. Нажмите **{{ ui-key.startrek.ui_components_issues-import_IssuesImportDialog.import }}** и дождитесь окончания импорта задач. +1. Нажмите **Импортировать** и дождитесь окончания импорта задач. ## Добавить связи для проекта {#links} diff --git a/ru/tracker/manager/create-queue.md b/ru/tracker/manager/create-queue.md index 265d0620f94..1ca49d005c9 100644 --- a/ru/tracker/manager/create-queue.md +++ b/ru/tracker/manager/create-queue.md @@ -13,7 +13,7 @@ Чтобы создать новую очередь: -1. На панели слева выберите ![](../../_assets/tracker/svg/queues.svg) **{{ ui-key.startrek.ui_components_TrackerSearch.queues }}** → **Создать очередь**. +1. На панели слева выберите ![](../../_assets/tracker/svg/queues.svg) **{{ ui-key.startrek.ui_Common_smart-components_TrackerSearch.queues }}** → **Создать очередь**. 1. Выберите шаблон очереди. @@ -54,7 +54,7 @@ Если вы хотите использовать настройки существующей очереди, скопируйте ее: -1. На панели слева выберите ![](../../_assets/tracker/svg/queues.svg) **{{ ui-key.startrek.ui_components_TrackerSearch.queues }}** → **Создать очередь**. +1. На панели слева выберите ![](../../_assets/tracker/svg/queues.svg) **{{ ui-key.startrek.ui_Common_smart-components_TrackerSearch.queues }}** → **Создать очередь**. 1. Нажмите **Копировать настройки очереди**. @@ -80,7 +80,7 @@ Если для ваших задач не подходит ни один из заготовленных шаблонов, вы можете задать все настройки новой очереди самостоятельно: -1. На панели слева выберите ![](../../_assets/tracker/svg/queues.svg) **{{ ui-key.startrek.ui_components_TrackerSearch.queues }}** → **Создать очередь**. +1. На панели слева выберите ![](../../_assets/tracker/svg/queues.svg) **{{ ui-key.startrek.ui_Common_smart-components_TrackerSearch.queues }}** → **Создать очередь**. 1. Нажмите **Создать вручную**. diff --git a/ru/tracker/manager/create-resolution.md b/ru/tracker/manager/create-resolution.md index f82ec47aab5..b8aee13abc4 100644 --- a/ru/tracker/manager/create-resolution.md +++ b/ru/tracker/manager/create-resolution.md @@ -12,9 +12,9 @@ 1. Перейдите на страницу очереди. -1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Перейдите на вкладку **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. Здесь вы увидите список рабочих процессов в очереди. Чтобы посмотреть, какие типы задач и резолюции определены в каждом из них, нажмите ![](../../_assets/tracker/svg/arrow.svg) в строке с нужным рабочим процессом. +1. Перейдите на вкладку **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. Здесь вы увидите список рабочих процессов в очереди. Чтобы посмотреть, какие типы задач и резолюции определены в каждом из них, нажмите ![](../../_assets/tracker/svg/arrow.svg) в строке с нужным рабочим процессом. 1. Чтобы добавить резолюцию в существующий процесс, наведите курсор на часть строки этого процесса с резолюциями. Нажмите на появившийся значок ![](../../_assets/tracker/svg/add-filter.svg) и выберите резолюцию из списка. О том, как добавить резолюцию в новый рабочий процесс, читайте в [инструкции по созданию рабочего процесса](./add-workflow.md#create). @@ -45,9 +45,9 @@ 1. Перейдите на страницу очереди. -1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Перейдите на вкладку **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. Здесь вы увидите список рабочих процессов в очереди. Выберите рабочий процесс, в который хотите добавить новую резолюцию. +1. Перейдите на вкладку **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. Здесь вы увидите список рабочих процессов в очереди. Выберите рабочий процесс, в который хотите добавить новую резолюцию. 1. Наведите курсор на часть строки с резолюциями. Нажмите на появившийся значок ![](../../_assets/tracker/svg/add-filter.svg), начните вводить название новой резолюции и нажмите на кнопку создания. @@ -66,8 +66,8 @@ 1. С помощью фильтров [найдите все задачи очереди](quick-filters.md), которые содержат удаляемую резолюцию. Затем поменяйте для задач резолюцию или измените их статус. -1. На странице очереди в верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. На странице очереди в верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Перейдите на вкладку **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. Здесь вы увидите список рабочих процессов в очереди. Выберите рабочий процесс, в котором содержится резолюция, которую вы хотите удалить. +1. Перейдите на вкладку **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. Здесь вы увидите список рабочих процессов в очереди. Выберите рабочий процесс, в котором содержится резолюция, которую вы хотите удалить. 1. Наведите курсор на строку с удаляемым типом задач и нажмите на крестик рядом с удаляемой резолюцией. diff --git a/ru/tracker/manager/create-work-process.md b/ru/tracker/manager/create-work-process.md index 8843fd657e2..0e07b99e950 100644 --- a/ru/tracker/manager/create-work-process.md +++ b/ru/tracker/manager/create-work-process.md @@ -2,7 +2,7 @@ Шаблон рабочего процесса — набор инструментов {{ tracker-name }}, сгруппированных и настроенных для наиболее распространенных рабочих процессов. -## {{ ui-key.startrek.ui_components_new-process_ProcessTypeStepRedesign.process-type-project }} {#manage-process-template} +## {{ ui-key.startrek.ui_Queues_smart-components_new-process_ProcessTypeStepRedesign.process-type-project }} {#manage-process-template} Подходит для ведения проектов, ограниченных по времени и числу задач. Проект направлен на достижение общего результата одной или несколькими командами. В проекте удобно группировать задачи нескольких команд, работающих над общей целью, выстраивать [иерархию задач](project-list.md) и планировать сроки. @@ -12,7 +12,7 @@ Дополнительные очереди можно будет создать отдельно. -## {{ ui-key.startrek.ui_components_new-process_ProcessTypeStepRedesign.process-type-development }} {#for-developers-template} +## {{ ui-key.startrek.ui_Queues_smart-components_new-process_ProcessTypeStepRedesign.process-type-development }} {#for-developers-template} Подходит для команды разработки, которая управляет проектами по методологии [Скрам]({{ link-wiki-scrum }}). Инструменты {{ tracker-name }} позволяют декомпозировать проекты с помощью [эпиков](epic.md) и [Story](agile.md#sec_basics), планировать спринты и [оценивать задачи](planning-poker.md). @@ -22,7 +22,7 @@ Если вы используете облачные сервисы GitHub, GitLab или Bitbucket, вы можете [подключить](../user/add-repository.md) любое число репозиториев и [привязывать](../user/ticket-links.md#section_commit) коммиты к задачам. -## {{ ui-key.startrek.ui_components_new-process_ProcessTypeStepRedesign.process-type-support }} {#for-support-template} +## {{ ui-key.startrek.ui_Queues_smart-components_new-process_ProcessTypeStepRedesign.process-type-support }} {#for-support-template} Подходит для внутренней и внешней службы поддержки. Задачи можно создавать [из писем](queue-mail.md), отправленных на почту или через [форму обратной связи](forms-integration.md) на сайте, а также из интерфейса {{ tracker-name }} с помощью встроенной формы. Примеры шаблонов ответов, таймеров [SLA](sla.md) и автоответов на обращения уже настроены в этом шаблоне. @@ -31,7 +31,7 @@ * [простая доска задач](boards-project.md); * [очередь](create-queue.md) с базовым набором [типов и статусов](workflow.md) задач. -## {{ ui-key.startrek.ui_components_new-process_ProcessTypeStepRedesign.process-type-standard }} {#basic-template} +## {{ ui-key.startrek.ui_Queues_smart-components_new-process_ProcessTypeStepRedesign.process-type-standard }} {#basic-template} Подходит для знакомства с возможностями {{ tracker-name }}. Если вы выберете этот шаблон, позже его можно будет настроить и дополнить. @@ -41,14 +41,14 @@ ## Создать рабочий процесс из шаблона {#create-from-template} -1. На стартовой [**Моя страница**](https://tracker.yandex.ru/pages/my), на виджете **{{ ui-key.startrek.ui_components_dashboard_InfoPresetsWidget.widget-title }}**, нажмите кнопку **{{ ui-key.startrek.ui_components_dashboard_InfoPresetsWidget.choose-template-button }}**. -1. Выберите шаблон и нажмите кнопку **{{ ui-key.startrek.ui_components_new-process_QueueSetupForm.next-button }}**. +1. На стартовой [**Моя страница**](https://tracker.yandex.ru/pages/my), на виджете **{{ ui-key.startrek.ui_Dashboards_smart-components_InfoPresetsWidget.widget-title }}**, нажмите кнопку **{{ ui-key.startrek.ui_Dashboards_smart-components_InfoPresetsWidget.choose-template-button }}**. +1. Выберите шаблон и нажмите кнопку **{{ ui-key.startrek.ui_Queues_smart-components_new-process_QueueSetupForm.next-button }}**. 1. Укажите параметры очереди: * Название очереди задач; * [Ключ очереди](create-queue.md#key); * Права доступа. -1. Нажмите кнопку **{{ ui-key.startrek.ui_components_new-process_QueueSetupForm.next-button }}**. В зависимости от выбранного шаблона откроется: - * [{{ ui-key.startrek.ui_components_new-process_ProcessTypeStepRedesign.process-type-project }}](create-work-process.md#manage-process-template) — страница нового проекта. - * [{{ ui-key.startrek.ui_components_new-process_ProcessTypeStepRedesign.process-type-development }}](create-work-process.md#for-developers-template) — доска с бэклогом. - * [{{ ui-key.startrek.ui_components_new-process_ProcessTypeStepRedesign.process-type-support }}](create-work-process.md#for-support-template) — очередь задач. - * [{{ ui-key.startrek.ui_components_new-process_ProcessTypeStepRedesign.process-type-standard }}](create-work-process.md#basic-template) — доска задач. \ No newline at end of file +1. Нажмите кнопку **Продолжить**. В зависимости от выбранного шаблона откроется: + * [{{ ui-key.startrek.ui_Queues_smart-components_new-process_ProcessTypeStepRedesign.process-type-project }}](create-work-process.md#manage-process-template) — страница нового проекта. + * [{{ ui-key.startrek.ui_Queues_smart-components_new-process_ProcessTypeStepRedesign.process-type-development }}](create-work-process.md#for-developers-template) — доска с бэклогом. + * [{{ ui-key.startrek.ui_Queues_smart-components_new-process_ProcessTypeStepRedesign.process-type-support }}](create-work-process.md#for-support-template) — очередь задач. + * [{{ ui-key.startrek.ui_Queues_smart-components_new-process_ProcessTypeStepRedesign.process-type-standard }}](create-work-process.md#basic-template) — доска задач. \ No newline at end of file diff --git a/ru/tracker/manager/delete-queue.md b/ru/tracker/manager/delete-queue.md index 46fe155fedc..20427807b71 100644 --- a/ru/tracker/manager/delete-queue.md +++ b/ru/tracker/manager/delete-queue.md @@ -23,9 +23,9 @@ description: Следуя данной инструкции, вы сможете 1. Откройте [страницу очереди](../user/queue.md). -1. В правом верхнем углу страницы нажмите ![](../../_assets/tracker/svg/settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В правом верхнем углу страницы нажмите ![](../../_assets/tracker/svg/settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. В правом верхнем углу страницы нажмите ![](../../_assets/horizontal-ellipsis.svg) → ![](../../_assets/tracker/svg/icon-remove.svg) **{{ ui-key.startrek.ui_components_page-queue-admin_QueueActionsMenu.remove-queue-action }}**. +1. В правом верхнем углу страницы нажмите ![](../../_assets/horizontal-ellipsis.svg) → ![](../../_assets/tracker/svg/icon-remove.svg) **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueActionsMenu.remove-queue-action }}**. 1. Подтвердите удаление. diff --git a/ru/tracker/manager/edit-agile-board.md b/ru/tracker/manager/edit-agile-board.md index 6bb5b6a64dd..9699bb7f752 100644 --- a/ru/tracker/manager/edit-agile-board.md +++ b/ru/tracker/manager/edit-agile-board.md @@ -23,7 +23,7 @@ description: Из статьи вы узнаете, как изменить и 1. Перейдите на вкладку **Колонки** и настройте внешний вид и параметры колонок доски: - - Создать новую колонку — нажмите кнопку **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardAddColumnButton.new-column-button }}** справа от списка всех колонок доски. + - Создать новую колонку — нажмите кнопку **Добавить колонку** справа от списка всех колонок доски. - Переименовать колонку — нажмите кнопку ![](../../_assets/tracker/button-edit.png) справа от названия колонки. Чтобы сохранить изменения, нажмите ![](../../_assets/tracker/approve-checkmark.png). diff --git a/ru/tracker/manager/epic-new.md b/ru/tracker/manager/epic-new.md index c0d9231c057..6d6deec2ba2 100644 --- a/ru/tracker/manager/epic-new.md +++ b/ru/tracker/manager/epic-new.md @@ -17,7 +17,7 @@ 1. На доске нажмите кнопку ![](../../_assets/tracker/svg/icon-add.svg) **Создать задачу**. 1. Перейдите на страницу полной формы создания задачи. Для этого нажмите ![](../../_assets/tracker/svg/open-full.svg) (**Открыть полную форму**). 1. Заполните все необходимые поля задачи. В поле **Тип** укажите `{{ ui-key.startrek-backend.fields.issue.epic }}`. -1. Нажмите кнопку **{{ ui-key.startrek.ui_components_CreateIssueForm.create-issue }}**. +1. Нажмите кнопку **Создать задачу**. ## Добавить задачу в эпик {#add-to-epic} @@ -25,7 +25,7 @@ ### Добавить со страницы эпика {#add-from-epic} -1. На странице эпика в блоке **{{ ui-key.startrek.ui_components_issue-links_InternalLinksCollapse.relations }}** нажмите **Добавить связь**. +1. На странице эпика в блоке **Связанные задачи** нажмите **Добавить связь**. 1. Выберите тип связи **{{ ui-key.startrek-backend.fields.issue.links.relationship.has.epic }}**. @@ -33,7 +33,7 @@ ### Добавить со страницы задачи {#add-from-task} -1. На странице задачи в блоке **{{ ui-key.startrek.ui_components_issue-links_InternalLinksCollapse.relations }}** нажмите **Добавить связь**. +1. На странице задачи в блоке **Связанные задачи** нажмите **Добавить связь**. 1. Выберите тип связи **{{ ui-key.startrek-backend.fields.issue.epic }}**. @@ -57,11 +57,11 @@ ### Удалить задачу на странице задачи {#remove-from-task} -На странице задачи в блоке **{{ ui-key.startrek.ui_components_issue-links_InternalLinksCollapse.relations }}** в секции **{{ ui-key.startrek-backend.fields.issue.epic }}** удалите связь с эпиком. +На странице задачи в блоке **Связанные задачи** в секции **{{ ui-key.startrek-backend.fields.issue.epic }}** удалите связь с эпиком. ### Удалить задачу на доске {#remove-on-board} -На доске [сгруппируйте задачи по эпику](#group-by-epic) и перетащите карточку задачи в раздел **{{ ui-key.startrek.ui_components_IssuesGroupHeader.no-epic }}**. +На доске [сгруппируйте задачи по эпику](#group-by-epic) и перетащите карточку задачи в раздел **Без эпика**. ## Сгруппировать задачи по эпикам {#group-by-epic} @@ -76,7 +76,7 @@ Чтобы отфильтровать задачи по эпику на доске: -1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/filter.svg) **{{ ui-key.startrek.ui_components_page-issues_touch_FilterSettingsMenu.item-filters }}**. Над колонками доски отобразится панель для настройки фильтра. +1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/filter.svg) **Фильтры**. Над колонками доски отобразится панель для настройки фильтра. 1. Нажмите значок ![](../../_assets/tracker/svg/add-filter.svg). Выберите **{{ ui-key.startrek-backend.fields.issue.epic }}**. 1. В диалоговом окне введите ключ эпика, по которому хотите отфильтровать задачи. @@ -84,7 +84,7 @@ Вы также можете отфильтровать задачи в очереди или на странице задач с помощью [языка запросов](../user/query-filter.md): -1. В правом верхнем углу страницы нажмите ![](../../_assets/tracker/svg/query-language.svg) **{{ ui-key.startrek.ui_components_dashboard_FilterEditor.editor-source-radio-query }}**. Все текущие параметры поиска, которые были заданы с помощью быстрых фильтров и условий, отобразятся в строке запроса. +1. В правом верхнем углу страницы нажмите ![](../../_assets/tracker/svg/query-language.svg) **Язык запросов**. Все текущие параметры поиска, которые были заданы с помощью быстрых фильтров и условий, отобразятся в строке запроса. 1. Добавьте в строку условия для фильтрации по эпику. Например: * Отобразить все задачи, у которых есть эпик: diff --git a/ru/tracker/manager/epic.md b/ru/tracker/manager/epic.md index 33f967c48e6..702f5faf859 100644 --- a/ru/tracker/manager/epic.md +++ b/ru/tracker/manager/epic.md @@ -42,7 +42,7 @@ Также вы можете добавить задачу в эпик с помощью [связи](../user/ticket-links.md): -1. На странице задачи нажмите **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.title }}** → **Добавить связь**. +1. На странице задачи нажмите **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.title }}** → **Добавить связь**. 1. Выберите тип связи **{{ ui-key.startrek-backend.fields.issue.links.relationship.has.epic }}**. diff --git a/ru/tracker/manager/history.md b/ru/tracker/manager/history.md index d937206da92..a00257cdb62 100644 --- a/ru/tracker/manager/history.md +++ b/ru/tracker/manager/history.md @@ -15,6 +15,6 @@ По умолчанию записи в истории расположены в хронологическом порядке. -Чтобы изменить порядок записей, справа от блока **{{ ui-key.startrek.ui_components_entity-page_ActivitySection.activity }}** нажмите кнопку ![](../../_assets/tracker/svg/new-first.svg) **{{ ui-key.startrek.ui_components_entity-page_ActivitySection.new-activity-on-top }}**. +Чтобы изменить порядок записей, справа от блока **Активность** нажмите кнопку ![](../../_assets/tracker/svg/new-first.svg) **Сначала новые**. Порядок отображения также изменится и для комментариев к проекту или портфелю. diff --git a/ru/tracker/manager/my-projects.md b/ru/tracker/manager/my-projects.md index 9cadcc539f4..82ccaee1415 100644 --- a/ru/tracker/manager/my-projects.md +++ b/ru/tracker/manager/my-projects.md @@ -34,7 +34,7 @@ description: Следуя данной инструкции, вы сможете * Чтобы найти портфель или проект по названию, введите его в поле **Поиск**. Если вы находитесь во вкладке **Структура**, то вы автоматически перейдете во вкладку **Список**. -* Чтобы выбрать параметр поиска по полю портфеля или проекта, нажмите на его название над списком. Для выбора дополнительных параметров нажмите кнопку ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_components_filter-pane_FieldsSelectButton.add-filter-field-button-title }}** и выберите поле. +* Чтобы выбрать параметр поиска по полю портфеля или проекта, нажмите на его название над списком. Для выбора дополнительных параметров нажмите кнопку ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_Common_smart-components_filter-pane_FieldsSelectButton.add-filter-field-button-title }}** и выберите поле. {% note info %} @@ -42,7 +42,7 @@ description: Следуя данной инструкции, вы сможете {% endnote %} -* Чтобы настроить порядок отображения, нажмите кнопку ![](../../_assets/tracker/svg/sorting.svg) **{{ ui-key.startrek.ui_components_SortButton.default-title }}** и выберите параметр. +* Чтобы настроить порядок отображения, нажмите кнопку ![](../../_assets/tracker/svg/sorting.svg) **{{ ui-key.startrek.ui_Common_smart-components_SortButton.default-title }}** и выберите параметр. {% note info %} diff --git a/ru/tracker/manager/planning-poker.md b/ru/tracker/manager/planning-poker.md index 256f5a009b5..2d6a80d14f2 100644 --- a/ru/tracker/manager/planning-poker.md +++ b/ru/tracker/manager/planning-poker.md @@ -12,7 +12,7 @@ ## Провести оценку задач {#section_estimate} -1. Чтобы перейти на страницу покера, откройте вашу доску и в правом верхнем углу страницы нажмите кнопку **{{ ui-key.startrek.ui_components_agile_poker_PokerButton.poker }}**. +1. Чтобы перейти на страницу покера, откройте вашу доску и в правом верхнем углу страницы нажмите кнопку **Покер**. 1. Попросите других участников планирования перейти на страницу покера. Все пользователи, которые зашли на страницу, будут отображены в блоке **Команда**. @@ -24,11 +24,11 @@ 1. Дождитесь, пока остальные участники планирования выставят свои оценки. В блоке **Команда** под именами участников появятся значки ![](../../_assets/tracker/estimate-done.png). -1. Нажмите кнопку **{{ ui-key.startrek.ui_components_agile_poker_PokerIssueForm.show-estimates }}**. Под именами участников планирования появятся значения оценок, которые они выбрали. +1. Нажмите кнопку **Показать оценки**. Под именами участников планирования появятся значения оценок, которые они выбрали. Итоговая оценка будет [автоматически рассчитана](#section_calc) и сохранена в поле **Оценка**. При необходимости вы можете изменить это значение. -1. Чтобы завершить оценку задачи, нажмите кнопку **{{ ui-key.startrek.ui_components_agile_poker_PokerIssueForm.apply-estimate }}**. Значение из поля **Оценка** будет скопировано в поле задачи **{{ ui-key.startrek-backend.fields.issue.storyPoints }}**, задача будет скрыта со страницы покера. +1. Чтобы завершить оценку задачи, нажмите кнопку **Выставить итоговую**. Значение из поля **Оценка** будет скопировано в поле задачи **{{ ui-key.startrek-backend.fields.issue.storyPoints }}**, задача будет скрыта со страницы покера. ## Настроить шкалу оценки {#section_scale} @@ -52,6 +52,6 @@ 1. Перейдите на вкладку **Покер**. -1. В поле **{{ ui-key.startrek.ui_components_agile_settings_PokerSettings.aggregation-function-field-label }}** выберите функцию расчета. По умолчанию задано **{{ ui-key.startrek-backend.messages.boards.poker.aggregate.function.maximum.double }}**. +1. В поле **Расчёт итоговой оценки** выберите функцию расчета. По умолчанию задано **{{ ui-key.startrek-backend.messages.boards.poker.aggregate.function.maximum.double }}**. 1. Нажмите кнопку **Сохранить**. diff --git a/ru/tracker/manager/poker.md b/ru/tracker/manager/poker.md index 79d31124e75..458d05a426a 100644 --- a/ru/tracker/manager/poker.md +++ b/ru/tracker/manager/poker.md @@ -12,47 +12,47 @@ ## Провести оценку задач {#section_estimate} -1. Чтобы перейти в режим покера, откройте вашу доску и на любой ее вкладке нажмите кнопку **{{ ui-key.startrek.ui_components_agile_common_AgileTabs.poker }}**. +1. Чтобы перейти в режим покера, откройте вашу доску и на любой ее вкладке нажмите кнопку **Покер**. 1. В открывшемся окне скопируйте ссылку на покер и отправьте ее другим участникам команды. Все пользователи, которые перешли по ссылке, отобразятся на странице покера. 1. Добавить задачу в покер можно несколькими способами: * перетащить задачу в блок покера из спринта или бэклога; - * на карточке задачи нажать ![](../../_assets/tracker/svg/actions.svg) → **{{ ui-key.startrek.ui_components_agile_poker_hooks.add-issue-to-poker }}**. + * на карточке задачи нажать ![](../../_assets/tracker/svg/actions.svg) → **Добавить в покер**. 1. Выберите подходящую оценку для задачи и дождитесь, когда остальные участники планирования выставят свои оценки — на карточке каждого участника должна отобразиться зеленая галочка. -1. Нажмите кнопку **{{ ui-key.startrek.ui_components_agile_poker_PokerIssueForm.show-estimates }}**. Под именами участников планирования появятся значения оценок, которые они выбрали. +1. Нажмите кнопку **Показать оценки**. Под именами участников планирования появятся значения оценок, которые они выбрали. Итоговая оценка будет [автоматически рассчитана](#section_calc) и сохранена в поле **Оценка**. При необходимости вы можете изменить это значение. -1. Чтобы завершить оценку задачи, нажмите **{{ ui-key.startrek.ui_components_agile_poker_PokerIssueForm.apply-estimate }}**. Значение из поля **Оценка** будет скопировано в поле задачи **Story Points**, задача будет скрыта со страницы покера. +1. Чтобы завершить оценку задачи, нажмите **Выставить итоговую**. Значение из поля **Оценка** будет скопировано в поле задачи **Story Points**, задача будет скрыта со страницы покера. ## Настроить шкалу оценки {#section_scale} Обычно шкала оценки для покера планирования включает числа Фибоначчи или подобную числовую последовательность. Чтобы изменить шкалу оценки: -1. Откройте вашу доску и в правом верхнем углу нажмите **{{ ui-key.startrek.ui_components_PageAgileBoard_PageAgileBoardHeader.settings }}** → **{{ ui-key.startrek.ui_components_agile_settings_AgileSettingsLayout.poker }}**. +1. Откройте вашу доску и в правом верхнем углу нажмите **{{ ui-key.startrek.ui_Boards_pages_PageAgileBoard_PageAgileBoardHeader.settings }}** → **Покер**. -1. Чтобы добавить число в шкалу оценки, введите его в поле **{{ ui-key.startrek.ui_components_agile_settings_PokerSettings.deck-field-label }}**. +1. Чтобы добавить число в шкалу оценки, введите его в поле **Колода оценок**. 1. Чтобы удалить число из шкалы оценки, рядом с числом нажмите значок ![](../../_assets/tracker/delete-agile-status.png). -1. Нажмите кнопку **{{ ui-key.startrek.ui_components_agile_settings_PokerSettings.save }}**. +1. Нажмите кнопку **Сохранить**. ## Настроить расчет итоговой оценки {#section_calc} Вы можете выбрать, как будет определяться итоговая оценка трудоемкости задачи на основе оценок участников планирования. Для этого: -1. Откройте вашу доску и в правом верхнем углу нажмите **{{ ui-key.startrek.ui_components_PageAgileBoard_PageAgileBoardHeader.settings }}** → **{{ ui-key.startrek.ui_components_agile_settings_AgileSettingsLayout.poker }}**. +1. Откройте вашу доску и в правом верхнем углу нажмите **{{ ui-key.startrek.ui_Boards_pages_PageAgileBoard_PageAgileBoardHeader.settings }}** → **Покер**. -1. В поле **{{ ui-key.startrek.ui_components_agile_settings_PokerSettings.aggregation-function-field-label }}** выберите функцию расчета. По умолчанию задано **Максимальное значение**. +1. В поле **Расчёт итоговой оценки** выберите функцию расчета. По умолчанию задано **Максимальное значение**. -1. Нажмите кнопку **{{ ui-key.startrek.ui_components_agile_settings_PokerSettings.save }}**. +1. Нажмите кнопку **Сохранить**. ## Скрывать задачи с выставленными Story Points {#hide-estimated} При включении покера планирования автоматически скрываются задачи с заполненным полем **Story Points**. Если вы хотите продолжать видеть эти задачи при включенном режиме покера, отключите эту опцию в настройках: -1. Откройте вашу доску и в правом верхнем углу нажмите **{{ ui-key.startrek.ui_components_PageAgileBoard_PageAgileBoardHeader.settings }}** → **{{ ui-key.startrek.ui_components_agile_settings_AgileSettingsLayout.poker }}**. -1. Активируйте опцию **{{ ui-key.startrek.ui_components_agile_settings_PokerSettings.display-estimated-field-label }}**. \ No newline at end of file +1. Откройте вашу доску и в правом верхнем углу нажмите **{{ ui-key.startrek.ui_Boards_pages_PageAgileBoard_PageAgileBoardHeader.settings }}** → **Покер**. +1. Активируйте опцию **Отображать оценённые задачи**. \ No newline at end of file diff --git a/ru/tracker/manager/portfolio.md b/ru/tracker/manager/portfolio.md index 3f7c68c9d4a..c9cc3a7f588 100644 --- a/ru/tracker/manager/portfolio.md +++ b/ru/tracker/manager/portfolio.md @@ -16,9 +16,9 @@ На странице портфеля проектов собраны сведения о команде, отражено текущее состояние портфеля и указаны проекты, которые входят в портфель: -* Вкладка **{{ ui-key.startrek.ui_components_portfolios_Header.description-tab }}**. Описание портфеля, статус, сроки работы над портфелем, автор и ответственный за портфель, список участников команды, комментарии, заказчики, [связи](./create-portfolio.md#links) с другими портфелями и проектами, а также теги. +* Вкладка **О портфеле**. Описание портфеля, статус, сроки работы над портфелем, автор и ответственный за портфель, список участников команды, комментарии, заказчики, [связи](./create-portfolio.md#links) с другими портфелями и проектами, а также теги. -* Вкладка **{{ ui-key.startrek.ui_components_portfolios_Header.projects-tab }}**. В списке отображаются как открытые портфели и проекты, так и закрытые. Их можно переставлять местами, переносить из одного портфеля в другой и фильтровать по заданным параметрам. +* Вкладка **Проекты**. В списке отображаются как открытые портфели и проекты, так и закрытые. Их можно переставлять местами, переносить из одного портфеля в другой и фильтровать по заданным параметрам. * Вкладка **Диаграмма Ганта**. Дорожная карта проектов портфеля и задач, которые входят в эти проекты. На диаграмме Ганта обозначены сроки портфелей, проектов и задач, а также зависимости между ними. Подробнее читайте в разделе [{#T}](../gantt/portfolio.md). diff --git a/ru/tracker/manager/project-list.md b/ru/tracker/manager/project-list.md index 07723045955..03052b7e9fd 100644 --- a/ru/tracker/manager/project-list.md +++ b/ru/tracker/manager/project-list.md @@ -12,9 +12,9 @@ * Чтобы выбрать поля, которые вы хотите видеть в таблице списка задач слева от диаграммы, нажмите значок ![](../../_assets/tracker/svg/settings-old.svg). Отметьте нужные пункты и нажмите **Применить**. - * Чтобы найти задачи в списке, в поле **{{ ui-key.startrek.ui_components_filter-pane.search-placeholder }}** введите текст. + * Чтобы найти задачи в списке, в поле **{{ ui-key.startrek.ui_Common_smart-components_filter-pane.search-placeholder }}** введите текст. - * Чтобы настроить порядок отображения в списке, нажмите ![](../../_assets/tracker/svg/sorting.svg) **{{ ui-key.startrek.ui_components_SortButton.default-title }}**, укажите параметр и нажмите ![](../../_assets/tracker/svg/new-first.svg). В этом случае ручное перемещение задач станет недоступно. + * Чтобы настроить порядок отображения в списке, нажмите ![](../../_assets/tracker/svg/sorting.svg) **{{ ui-key.startrek.ui_Common_smart-components_SortButton.default-title }}**, укажите параметр и нажмите ![](../../_assets/tracker/svg/new-first.svg). В этом случае ручное перемещение задач станет недоступно. * Чтобы сгруппировать задачи по статусу, исполнителю или другим параметрам, нажмите кнопку ![](../../_assets/tracker/svg/group.svg) **Без группировки** и выберите подходящий вариант из списка. @@ -22,7 +22,7 @@ * Чтобы поменять местами столбцы списка, над списком нажмите значок ![](../../_assets/tracker/svg/settings-old.svg). Затем в блоке **Добавленные** зажмите параметр и перетащите его внутри блока. Нажмите **Применить**. - * Чтобы изменить вид списка задач, выберите ![](../../_assets/tracker/svg/flat-list.svg) **{{ ui-key.startrek.ui_components_filter-pane.list-mode-flat }}** или ![](../../_assets/tracker/svg/tree-list.svg) **{{ ui-key.startrek.ui_components_filter-pane.list-mode-tree }}**.{#trees} + * Чтобы изменить вид списка задач, выберите ![](../../_assets/tracker/svg/flat-list.svg) **{{ ui-key.startrek.ui_Common_smart-components_filter-pane.list-mode-flat }}** или ![](../../_assets/tracker/svg/tree-list.svg) **{{ ui-key.startrek.ui_Common_smart-components_filter-pane.list-mode-tree }}**.{#trees} {% note info %} @@ -34,7 +34,7 @@ В режиме древовидного списка можно создавать новые подзадачи или изменять связи для подзадач: - * Чтобы создать подзадачу, напротив задачи нажмите кнопку ![](../../_assets/tracker/svg/icon-add.svg) **{{ ui-key.startrek.ui_components_projects_Table.add-sub-issue }}**: + * Чтобы создать подзадачу, напротив задачи нажмите кнопку ![](../../_assets/tracker/svg/icon-add.svg) **Добавить подзадачу**: * Чтобы создать новую задачу, перейдите на вкладку **Новая задача**. Введите название и нажмите клавишу **Enter**. * Если задача уже существует, перейдите на вкладку **Существующая задача** и укажите ее ключ или название, затем выберите задачу из списка. Найти ключ можно на странице задачи над ее названием (например, `TEST-1234`). @@ -45,7 +45,7 @@ {% note info %} - Ручное перемещение задач доступно, если в поле **{{ ui-key.startrek.ui_components_SortButton.default-title }}** не выбран параметр сортировки. По умолчанию для списка задач выбран ручной режим сортировки: вы можете перетаскивать задачи в списке. + Ручное перемещение задач доступно, если в поле **{{ ui-key.startrek.ui_Common_smart-components_SortButton.default-title }}** не выбран параметр сортировки. По умолчанию для списка задач выбран ручной режим сортировки: вы можете перетаскивать задачи в списке. {% endnote %} @@ -54,8 +54,8 @@ Чтобы в списке задач проекта открыть меню действий с задачей, в конце строки с описанием задачи нажмите ![](../../_assets/tracker/svg/actions.svg) **Действия**. В меню доступны действия: -* ![](../../_assets/tracker/text-edit/link.svg) **{{ ui-key.startrek.ui_components_projects_hooks.copy-to-clipboard }}**; -* ![](../../_assets/tracker/svg/move-up.svg) **{{ ui-key.startrek.ui_components_projects_hooks.issue-actions--move-up }}** (только при ручной сортировке); -* ![](../../_assets/tracker/svg/move-down.svg) **{{ ui-key.startrek.ui_components_projects_hooks.issue-actions--move-down }}** (только при ручной сортировке); +* ![](../../_assets/tracker/text-edit/link.svg) **Скопировать ссылку**; +* ![](../../_assets/tracker/svg/move-up.svg) **Перенести наверх списка** (только при ручной сортировке); +* ![](../../_assets/tracker/svg/move-down.svg) **Перенести вниз списка** (только при ручной сортировке); * ![](../../_assets/tracker/svg/convert.svg) **Преобразовать в [веху](milestones.md) или задачу**. -* ![](../../_assets/tracker/svg/icon-remove.svg) **{{ ui-key.startrek.ui_components_projects_hooks.delete-from-project }}**. +* ![](../../_assets/tracker/svg/icon-remove.svg) **Удалить из проекта**. diff --git a/ru/tracker/manager/queue-access-types.md b/ru/tracker/manager/queue-access-types.md index 34ff4081ed5..fe13a480d1d 100644 --- a/ru/tracker/manager/queue-access-types.md +++ b/ru/tracker/manager/queue-access-types.md @@ -10,7 +10,7 @@ 1. На панели слева нажмите **Очереди** и выберите из списка нужную очередь. -1. Нажмите **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}** → **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-permissions }}**. Если вы не видите кнопку **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**, значит у вас нет прав для настройки очереди. Если права вам необходимы, обратитесь к владельцу очереди. +1. Нажмите **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}** → **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-permissions }}**. Если вы не видите кнопку **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**, значит у вас нет прав для настройки очереди. Если права вам необходимы, обратитесь к владельцу очереди. Доступы в очереди настраиваются с помощью следующих прав: diff --git a/ru/tracker/manager/queue-access.md b/ru/tracker/manager/queue-access.md index 77d6838186a..bc544d4890c 100644 --- a/ru/tracker/manager/queue-access.md +++ b/ru/tracker/manager/queue-access.md @@ -19,7 +19,7 @@ description: Следуя данной инструкции, вы сможете 1. На панели слева нажмите **Очереди** и выберите из списка нужную очередь. -1. Нажмите **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}** → **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-permissions }}**. Если вы не видите кнопку **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**, значит у вас нет прав для настройки очереди. Если права вам необходимы, обратитесь к владельцу очереди. +1. Нажмите **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}** → **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-permissions }}**. Если вы не видите кнопку **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**, значит у вас нет прав для настройки очереди. Если права вам необходимы, обратитесь к владельцу очереди. Откроется страница настройки прав доступа в очереди. Чтобы посмотреть все [права доступа](queue-access-types.md) для пользователя или группы, воспользуйтесь поиском в верхней части экрана или нажмите на пользователя или группу. diff --git a/ru/tracker/manager/queue-history.md b/ru/tracker/manager/queue-history.md index 6cb075ed481..d0494a81835 100644 --- a/ru/tracker/manager/queue-history.md +++ b/ru/tracker/manager/queue-history.md @@ -17,7 +17,7 @@ description: Следуя данной инструкции, вы сможете 1. Откройте страницу очереди. -1. В правом верхнем углу страницы нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В правом верхнем углу страницы нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. Перейдите на вкладку **Журнал изменений**. diff --git a/ru/tracker/manager/queue-spent-time.md b/ru/tracker/manager/queue-spent-time.md index f21df31490e..4236a4161e2 100644 --- a/ru/tracker/manager/queue-spent-time.md +++ b/ru/tracker/manager/queue-spent-time.md @@ -4,26 +4,26 @@ Чтобы сделать это: -1. В настройках очереди перейдите на вкладку **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}**. -1. Включите опцию **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-track-time-in-issues }}**. -1. В поле **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-working-calendar }}** выберите один из доступных вариантов. -1. Нажмите **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.save }}**. +1. В настройках очереди перейдите на вкладку **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}**. +1. Включите опцию **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-track-time-in-issues }}**. +1. В поле **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-working-calendar }}** выберите один из доступных вариантов. +1. Нажмите **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.save }}**. -После этого в задачах очереди появится новый раздел **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}**. В него будут перенесены все данные полей задачи из категории **Учёт времени**. +После этого в задачах очереди появится новый раздел **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}**. В него будут перенесены все данные полей задачи из категории **Учёт времени**. -Если вы отключите опцию **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-track-time-in-issues }}**, данные из раздела **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** будут перенесены обратно в поля категории **Учёт времени**. +Если вы отключите опцию **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-track-time-in-issues }}**, данные из раздела **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** будут перенесены обратно в поля категории **Учёт времени**. ## Разрешить исполнителю редактировать время {#assignee-edit} По умолчанию редактировать [историю записей по учету времени](../user/time-spent.md#records-history) можно только через [запрос к API](../concepts/issues/patch-worklog.md). -Чтобы автор записи мог отредактировать или удалить ее прямо в окне истории записей, включите опцию **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-can-assignee-update-time }}**. +Чтобы автор записи мог отредактировать или удалить ее прямо в окне истории записей, включите опцию **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-can-assignee-update-time }}**. ## Автоматически рассчитывать затраченное время при закрытии задачи {#calculate-time} -Вы можете сделать так, чтобы затраченное на задачу время рассчитывалось автоматически. При закрытии задачи, если в ней не учтено никакое время, на [экране перехода](workflow-action-edit.md) появится поле **{{ ui-key.startrek.ui_components_FormField_TimeTrackingBlock.field-spent-title }}** с уже заполненным значением. +Вы можете сделать так, чтобы затраченное на задачу время рассчитывалось автоматически. При закрытии задачи, если в ней не учтено никакое время, на [экране перехода](workflow-action-edit.md) появится поле **{{ ui-key.startrek.ui_Common_smart-components_FormField_TimeTrackingBlock.field-spent-title }}** с уже заполненным значением. -Чтобы сделать это, включите опцию **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-show-time-field-on-close }}** и [настройте экран перехода](workflow-action-edit.md) в финальный статус задачи. +Чтобы сделать это, включите опцию **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-show-time-field-on-close }}** и [настройте экран перехода](workflow-action-edit.md) в финальный статус задачи. {% cut "Как рассчитывается время" %} @@ -41,25 +41,25 @@ ## Учитывать оставшееся и общее время выполнения задачи {#overall-time} -Вы можете добавить в раздел **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** дополнительные поля: +Вы можете добавить в раздел **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** дополнительные поля: -* В поле **{{ ui-key.startrek.ui_components_FormField_TimeTrackingBlock.field-remain-title }}** можно указывать, сколько еще времени вы рассчитываете работать над этой задачей. Чтобы добавить его, включите опцию **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-show-time-field-on-close }}**. -* В поле **{{ ui-key.startrek.ui_components_FormField_TimeTrackingBlock.field-estimation-title }}** можно указывать, сколько всего времени вы рассчитываете работать над этой задачей. Чтобы добавить его, включите опцию **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-use-remaining-time }}**. +* В поле **{{ ui-key.startrek.ui_Common_smart-components_FormField_TimeTrackingBlock.field-remain-title }}** можно указывать, сколько еще времени вы рассчитываете работать над этой задачей. Чтобы добавить его, включите опцию **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-show-time-field-on-close }}**. +* В поле **{{ ui-key.startrek.ui_Common_smart-components_FormField_TimeTrackingBlock.field-estimation-title }}** можно указывать, сколько всего времени вы рассчитываете работать над этой задачей. Чтобы добавить его, включите опцию **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-use-remaining-time }}**. -Если используется хотя бы одно из этих полей, то на странице задачи в поле **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** появится полоса прогресса задачи. +Если используется хотя бы одно из этих полей, то на странице задачи в поле **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** появится полоса прогресса задачи. {% note info %} -Поля **{{ ui-key.startrek.ui_components_FormField_TimeTrackingBlock.field-remain-title }}** и **{{ ui-key.startrek.ui_components_FormField_TimeTrackingBlock.field-estimation-title }}** связаны друг с другом следующим образом: +Поля **{{ ui-key.startrek.ui_Common_smart-components_FormField_TimeTrackingBlock.field-remain-title }}** и **{{ ui-key.startrek.ui_Common_smart-components_FormField_TimeTrackingBlock.field-estimation-title }}** связаны друг с другом следующим образом: -**{{ ui-key.startrek.ui_components_FormField_TimeTrackingBlock.field-spent-title }}** + **{{ ui-key.startrek.ui_components_FormField_TimeTrackingBlock.field-remain-title }}** = **{{ ui-key.startrek.ui_components_FormField_TimeTrackingBlock.field-estimation-title }}** +**{{ ui-key.startrek.ui_Common_smart-components_FormField_TimeTrackingBlock.field-spent-title }}** + **{{ ui-key.startrek.ui_Common_smart-components_FormField_TimeTrackingBlock.field-remain-title }}** = **{{ ui-key.startrek.ui_Common_smart-components_FormField_TimeTrackingBlock.field-estimation-title }}** Если используются оба поля, то при изменении значения одного из них будет автоматически установлено значение для другого. {% endnote %} ## Настроить график работы {#work-schedule} -Вы можете настроить график, по которому работают исполнители задач этой очереди. Эти данные используются при [автоматическом расчете затраченного времени](#calculate-time). Чтобы установить его, в поле **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-working-calendar }}** выберите подходящий вариант. +Вы можете настроить график, по которому работают исполнители задач этой очереди. Эти данные используются при [автоматическом расчете затраченного времени](#calculate-time). Чтобы установить его, в поле **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-working-calendar }}** выберите подходящий вариант. Если ни один из вариантов графика работы вам не подходит, вы можете [создать свой](schedule.md). @@ -71,4 +71,4 @@ В базовом учете времени вы не можете указать время просто числом и всегда должны уточнить, что именно записываете: недели, дни, часы, минуты или секунды. -В расширенном учете времени вы можете выбрать предпочитаемую единицу времени и вводить ее числом без необходимости добавлять букву. Чтобы сделать это, в поле **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-use-summary-time }}** выберите один из вариантов. \ No newline at end of file +В расширенном учете времени вы можете выбрать предпочитаемую единицу времени и вводить ее числом без необходимости добавлять букву. Чтобы сделать это, в поле **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-use-summary-time }}** выберите один из вариантов. \ No newline at end of file diff --git a/ru/tracker/manager/queue-team.md b/ru/tracker/manager/queue-team.md index 5f448219e38..4af14f2f631 100644 --- a/ru/tracker/manager/queue-team.md +++ b/ru/tracker/manager/queue-team.md @@ -30,19 +30,19 @@ description: Следуя данной инструкции, вы сможете 1. Откройте [страницу очереди](../user/queue.md). -1. В правом верхнем углу страницы нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В правом верхнем углу страницы нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. Перейдите на вкладку **Права доступа**. 1. Нажмите на аватар возле имени владельца. Откроется окно смены владельца очереди. -1. Нажмите **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminTabPermissions_ChangeOwnerForm.change-owner }}**. +1. Нажмите **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminTabPermissions_ChangeOwnerForm.change-owner }}**. 1. Введите имя или логин нового владельца. 1. Нажмите кнопку **Сохранить**. -1. Если требуется, чтобы все новые задачи автоматически назначались на владельца, включите опцию **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminTabPermissions_ChangeOwnerForm.set-as-default }}**. +1. Если требуется, чтобы все новые задачи автоматически назначались на владельца, включите опцию **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminTabPermissions_ChangeOwnerForm.set-as-default }}**. 1. Нажмите **Сохранить**. @@ -54,7 +54,7 @@ description: Следуя данной инструкции, вы сможете 1. Откройте [страницу очереди](../user/queue.md). -1. В правом верхнем углу страницы нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В правом верхнем углу страницы нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. Перейдите на вкладку **Команда очереди**. diff --git a/ru/tracker/manager/quick-filters.md b/ru/tracker/manager/quick-filters.md index c7b6044784d..65c42d2f42f 100644 --- a/ru/tracker/manager/quick-filters.md +++ b/ru/tracker/manager/quick-filters.md @@ -17,7 +17,7 @@ 1. Перейдите на страницу очереди. -1. Над списком задач нажмите кнопку ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_components_filter-pane_FieldsSelectButton.add-filter-field-button-title }}** и выберите поле. +1. Над списком задач нажмите кнопку ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_Common_smart-components_filter-pane_FieldsSelectButton.add-filter-field-button-title }}** и выберите поле. 1. Задайте значение для параметра. @@ -27,7 +27,7 @@ 1. Перейдите на страницу очереди. -1. Нажмите кнопку ![](../../_assets/tracker/svg/list-settings.svg) **{{ ui-key.startrek.ui_components_PageAgileBoardSettings_Header.settings }}** над списком задач справа. +1. Нажмите кнопку ![](../../_assets/tracker/svg/list-settings.svg) **Настройки** над списком задач справа. 1. Выберите параметры, которые вы хотите видеть в списке задач. @@ -50,7 +50,7 @@ 1. В правом верхнем углу нажмите кнопку ![](../../_assets/tracker/svg/actions.svg) **Действия над очередью**. -1. Затем нажмите кнопку ![](../../_assets/tracker/svg/icon-export-tasks.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.export }}**. +1. Затем нажмите кнопку ![](../../_assets/tracker/svg/icon-export-tasks.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.export }}**. 1. Выберите формат, в котором вы хотите сохранить список задач. diff --git a/ru/tracker/manager/schedule.md b/ru/tracker/manager/schedule.md index 220d196d9f2..036ef037516 100644 --- a/ru/tracker/manager/schedule.md +++ b/ru/tracker/manager/schedule.md @@ -24,7 +24,7 @@ description: Следуя данной инструкции, вы сможете 1. {% include [go to settings](../../_includes/tracker/transition-page.md) %} -1. В правом верхнем углу нажмите ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В правом верхнем углу нажмите ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. Выберите **Правила SLA**. @@ -50,7 +50,7 @@ description: Следуя данной инструкции, вы сможете 1. {% include [go to settings](../../_includes/tracker/transition-page.md) %} -1. В правом верхнем углу нажмите ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В правом верхнем углу нажмите ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. Выберите **Правила SLA**. diff --git a/ru/tracker/manager/sla.md b/ru/tracker/manager/sla.md index 31226ed3f6d..02fce1a5840 100644 --- a/ru/tracker/manager/sla.md +++ b/ru/tracker/manager/sla.md @@ -19,7 +19,7 @@ description: Следуя данной инструкции, вы сможете 1. {% include [go to settings](../../_includes/tracker/transition-page.md) %} -1. В правом верхнем углу нажмите ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В правом верхнем углу нажмите ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. Перейдите на вкладку **Правила SLA**. @@ -112,7 +112,7 @@ description: Следуя данной инструкции, вы сможете 1. {% include [go to settings](../../_includes/tracker/transition-page.md) %} -1. В правом верхнем углу нажмите ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В правом верхнем углу нажмите ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. Перейдите на вкладку **Правила SLA**. @@ -156,7 +156,7 @@ description: Следуя данной инструкции, вы сможете 1. {% include [go to settings](../../_includes/tracker/transition-page.md) %} -1. В правом верхнем углу нажмите ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В правом верхнем углу нажмите ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. Перейдите на вкладку **Правила SLA**. diff --git a/ru/tracker/manager/subscriptions.md b/ru/tracker/manager/subscriptions.md index 4d1c2bb2d7e..2cfd5ef8e0a 100644 --- a/ru/tracker/manager/subscriptions.md +++ b/ru/tracker/manager/subscriptions.md @@ -12,7 +12,7 @@ 1. Откройте [страницу очереди](../user/queue.md). -1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. Перейдите на вкладку **{{ ui-key.yacloud.component.navigation-menu.label_notifications }}**. diff --git a/ru/tracker/manager/workflow-action-edit.md b/ru/tracker/manager/workflow-action-edit.md index d3fdbd33530..c6fc32ef890 100644 --- a/ru/tracker/manager/workflow-action-edit.md +++ b/ru/tracker/manager/workflow-action-edit.md @@ -10,9 +10,9 @@ 1. Перейдите на страницу очереди. -1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Перейдите на вкладку **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** и нажмите на название рабочего процесса, переходы которого вы хотите редактировать. +1. Перейдите на вкладку **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** и нажмите на название рабочего процесса, переходы которого вы хотите редактировать. Откроется визуальный редактор рабочих процессов. Здесь можно редактировать уже добавленные переходы — для этого достаточно нажать на переход на схеме, и откроется страница с его настройками. Кроме того, на схему можно [добавлять новые переходы](#add-action). @@ -22,21 +22,21 @@ Чтобы добавить автоматическое действие: -1. В настройках перехода откройте раздел **Автоматизация** и нажмите **{{ ui-key.startrek.ui_components_workflow-functions_WorkflowFunctionMenu.menu-title }}**. +1. В настройках перехода откройте раздел **Автоматизация** и нажмите **{{ ui-key.startrek.ui_Queues_smart-components_workflow-functions_WorkflowFunctionMenu.menu-title }}**. 1. Выберите из списка необходимые автоматизации и настройте их. Если подходящей автоматизации не нашлось, настройте [триггер](../user/trigger.md). Доступные автоматизации при смене статуса задачи: -* **{{ ui-key.startrek.ui_components_workflow-functions.type-SendEmailFunction }}** — отправлять письма конкретным сотрудникам или пользователям, выполняющим роли в задаче (например, автору или исполнителю задачи). -* **{{ ui-key.startrek.ui_components_workflow-functions.type-AddCommentFunction }}** — оставлять в задаче комментарий от отпределенного пользователя (сотрудника или робота). -* **{{ ui-key.startrek.ui_components_workflow-functions.type-SetActiveSprintFunction }}** — добавить задачу в активный спринт на выбранной доске. -* **{{ ui-key.startrek.ui_components_workflow-functions.type-SetCurrentTimeFunction }}** — записать время выполнения перехода в выбранное поле. -* **{{ ui-key.startrek.ui_components_workflow-functions.type-CalculateFieldFunction }}** — просуммировать содержимое нескольких полей и записать результат в другое поле. -* **{{ ui-key.startrek.ui_components_workflow-functions.type-MoveUsersFunction }}** — переместить или скопировать пользователей из одного поля в другое. -* **{{ ui-key.startrek.ui_components_workflow-functions.type-RemoveUsersFromCcFunction }}** — убрать пользователя из наблюдателей задачи, например, если от него была получена нужная информация и дальнейшее участие в задаче не требуется.  -* **{{ ui-key.startrek.ui_components_workflow-functions.type-AddTextToFieldFunction }}** — заполнить поле в задаче. При настройке этого вида автоматизации вам поможет фильтр по типу заполняемого в поле значения. -* **{{ ui-key.startrek.ui_components_workflow-functions.type-RemoveFieldValueFunction }}** — убрать содержимое любого поля в задаче. -* **{{ ui-key.startrek.ui_components_workflow-functions.type-UnsetResolutionFunction }}** — если задача была завершена с некоторой резолюцией, эта резолюция будет отменена. +* **{{ ui-key.startrek.ui_Queues_smart-components_workflow-functions.type-SendEmailFunction }}** — отправлять письма конкретным сотрудникам или пользователям, выполняющим роли в задаче (например, автору или исполнителю задачи). +* **{{ ui-key.startrek.ui_Queues_smart-components_workflow-functions.type-AddCommentFunction }}** — оставлять в задаче комментарий от отпределенного пользователя (сотрудника или робота). +* **{{ ui-key.startrek.ui_Queues_smart-components_workflow-functions.type-SetActiveSprintFunction }}** — добавить задачу в активный спринт на выбранной доске. +* **{{ ui-key.startrek.ui_Queues_smart-components_workflow-functions.type-SetCurrentTimeFunction }}** — записать время выполнения перехода в выбранное поле. +* **{{ ui-key.startrek.ui_Queues_smart-components_workflow-functions.type-CalculateFieldFunction }}** — просуммировать содержимое нескольких полей и записать результат в другое поле. +* **{{ ui-key.startrek.ui_Queues_smart-components_workflow-functions.type-MoveUsersFunction }}** — переместить или скопировать пользователей из одного поля в другое. +* **{{ ui-key.startrek.ui_Queues_smart-components_workflow-functions.type-RemoveUsersFromCcFunction }}** — убрать пользователя из наблюдателей задачи, например, если от него была получена нужная информация и дальнейшее участие в задаче не требуется.  +* **{{ ui-key.startrek.ui_Queues_smart-components_workflow-functions.type-AddTextToFieldFunction }}** — заполнить поле в задаче. При настройке этого вида автоматизации вам поможет фильтр по типу заполняемого в поле значения. +* **{{ ui-key.startrek.ui_Queues_smart-components_workflow-functions.type-RemoveFieldValueFunction }}** — убрать содержимое любого поля в задаче. +* **{{ ui-key.startrek.ui_Queues_smart-components_workflow-functions.type-UnsetResolutionFunction }}** — если задача была завершена с некоторой резолюцией, эта резолюция будет отменена. ### Условия перехода {#conditions} @@ -55,9 +55,9 @@ Чтобы добавить условия перехода: -1. В настройках перехода откройте раздел **Условия перехода** и нажмите **{{ ui-key.startrek.ui_components_workflow-conditions_ConditionsMenu.add-condition }}**. +1. В настройках перехода откройте раздел **Условия перехода** и нажмите **{{ ui-key.startrek.ui_Queues_smart-components_workflow-conditions_ConditionsMenu.add-condition }}**. -1. Выберите из списка подходящие условия и настройте их. Чтобы настроить группу условий с помощью операций **И** и **ИЛИ**, нажмите **{{ ui-key.startrek.ui_components_workflow-conditions_WorkflowGroupCondition.add-conditions-group }}**. +1. Выберите из списка подходящие условия и настройте их. Чтобы настроить группу условий с помощью операций **И** и **ИЛИ**, нажмите **{{ ui-key.startrek.ui_Queues_smart-components_workflow-conditions_WorkflowGroupCondition.add-conditions-group }}**. ### Экран перехода {#screen} @@ -89,9 +89,9 @@ 1. Перейдите на страницу очереди. -1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Перейдите на вкладку **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** и нажмите на название рабочего процесса. Откроется визуальный редактор рабочих процессов. +1. Перейдите на вкладку **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** и нажмите на название рабочего процесса. Откроется визуальный редактор рабочих процессов. 1. На верхней панели визуального редактора процессов нажмите **Добавить переход**. Заполните поля **Исходный статус** и **Новый статус** значениями из списков. Если вы хотите добавить переход для статусов, которых еще нет в рабочем процессе, сначала [добавьте их](./workflow-status-edit.md#add-status). diff --git a/ru/tracker/manager/workflow-status-edit.md b/ru/tracker/manager/workflow-status-edit.md index f9bb457c0d8..dbd00465426 100644 --- a/ru/tracker/manager/workflow-status-edit.md +++ b/ru/tracker/manager/workflow-status-edit.md @@ -12,9 +12,9 @@ 1. Перейдите на страницу очереди. -1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Перейдите на вкладку **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** и нажмите на название рабочего процесса, статусы которого вы хотите редактировать. +1. Перейдите на вкладку **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** и нажмите на название рабочего процесса, статусы которого вы хотите редактировать. Откроется визуальный редактор рабочих процессов. Здесь можно редактировать уже добавленные статусы — для этого достаточно нажать на статус на схеме, и откроется страница с его настройками. Кроме того, на схему можно [добавлять новые статусы](#add-status). @@ -116,9 +116,9 @@ 1. Перейдите на страницу очереди. -1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Перейдите на вкладку **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. Здесь вы увидите список рабочих процессов в очереди. Выберите рабочий процесс, в который хотите добавить новый статус, и нажмите на его название. Откроется визуальный редактор рабочих процессов. +1. Перейдите на вкладку **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. Здесь вы увидите список рабочих процессов в очереди. Выберите рабочий процесс, в который хотите добавить новый статус, и нажмите на его название. Откроется визуальный редактор рабочих процессов. 1. На верхней панели визуального редактора процессов нажмите **Добавить статус**. Начните вводить название нового статуса и нажмите на кнопку создания. @@ -137,9 +137,9 @@ 1. Перейдите на страницу очереди. -1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Перейдите на вкладку **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** и нажмите на название рабочего процесса. Откроется визуальный редактор рабочих процессов. +1. Перейдите на вкладку **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}** и нажмите на название рабочего процесса. Откроется визуальный редактор рабочих процессов. 1. На верхней панели визуального редактора процессов нажмите **Добавить статус**. Начните вводить название нового статуса и нажмите на кнопку создания. @@ -161,8 +161,8 @@ Чтобы удалить статус из рабочего процесса: -1. На странице очереди в верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. На странице очереди в верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Перейдите на вкладку **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. Откройте в редакторе рабочий процесс, из которого хотите удалить статус. +1. Перейдите на вкладку **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. Откройте в редакторе рабочий процесс, из которого хотите удалить статус. 1. Нажмите на удаляемый статус и нажмите на клавиатуре **Delete** или перейдите в настройки статуса и нажмите ![](../../_assets/tracker/svg/actions.svg) → **Убрать из процесса**. diff --git a/ru/tracker/manager/workflow.md b/ru/tracker/manager/workflow.md index ab5abf54eac..ceab7a1f383 100644 --- a/ru/tracker/manager/workflow.md +++ b/ru/tracker/manager/workflow.md @@ -28,9 +28,9 @@ 1. На панели {{ tracker-name }} слева нажмите Очереди и перейдите на страницу очереди. -1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. -1. Перейдите на вкладку **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. +1. Перейдите на вкладку **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. На вкладке содержится список всех рабочих процессов очереди. diff --git a/ru/tracker/mobile/attach-file.md b/ru/tracker/mobile/attach-file.md index 66a187730d1..6ac3a24f89b 100644 --- a/ru/tracker/mobile/attach-file.md +++ b/ru/tracker/mobile/attach-file.md @@ -11,9 +11,9 @@ * Чтобы добавить фото или видео с камеры телефона, нажмите на иконку **Камера**. Когда все будет готово, нажмите **ОК**. Чтобы переснять фото или видео, нажмите **Повтор**. - * Чтобы добавить приложения из памяти телефона, нажмите на иконку **{{ ui-key.startrek.ui_components_attachments-manager.attachments-section-title }}** и выберите файлы. + * Чтобы добавить приложения из памяти телефона, нажмите на иконку **{{ ui-key.startrek.ui_Common_smart-components_attachments-manager.attachments-section-title }}** и выберите файлы. -1. Нажмите кнопку **{{ ui-key.startrek.ui_components_ModalTextEditor.save }}**. +1. Нажмите кнопку **Сохранить**. Таким же образом можно прикрепить файл к комментарию. diff --git a/ru/tracker/mobile/checklist.md b/ru/tracker/mobile/checklist.md index aec389e4d93..d744ee7f800 100644 --- a/ru/tracker/mobile/checklist.md +++ b/ru/tracker/mobile/checklist.md @@ -12,7 +12,7 @@ 1. Чтобы указать исполнителя и дедлайн для этого пункта, справа от него нажмите значок ![](../../_assets/horizontal-ellipsis.svg) и выберите нужное действие. -1. Чтобы добавить очередной пункт, введите описание нового пункта и намите клавишу ввода на клавиатуре телефона. Если вы добавляете новый пункт в готовый чеклист, сначала нажмите кнопку **{{ ui-key.startrek.ui_components_entity-page_checklist_Footer.new-item-button-caption }}** внизу списка. +1. Чтобы добавить очередной пункт, введите описание нового пункта и намите клавишу ввода на клавиатуре телефона. Если вы добавляете новый пункт в готовый чеклист, сначала нажмите кнопку **{{ ui-key.startrek.ui_Common_smart-components_entity-page_checklist_Footer.new-item-button-caption }}** внизу списка. ## Работать с чеклистом {#checklist-operations} @@ -24,9 +24,9 @@ * Чтобы снять отметку о выполнении пункта, нажмите отметку ![](../../_assets/tracker/checklist-checkmark.png). -* Чтобы добавить пункт в чеклист, нажмите **{{ ui-key.startrek.ui_components_entity-page_checklist_Footer.new-item-button-caption }}** внизу списка. +* Чтобы добавить пункт в чеклист, нажмите **{{ ui-key.startrek.ui_Common_smart-components_entity-page_checklist_Footer.new-item-button-caption }}** внизу списка. -* Чтобы удалить пункт чеклиста, справа от пункта нажмите значок ![](../../_assets/horizontal-ellipsis.svg) и выберите **{{ ui-key.startrek.ui_components_entity-page_checklist_ChecklistItem.remove-item-title }}**. +* Чтобы удалить пункт чеклиста, справа от пункта нажмите значок ![](../../_assets/horizontal-ellipsis.svg) и выберите **Удалить пункт**. * Чтобы удалить чеклист, нажмите значок ![](../../_assets/tracker/delete-checklist-mobile.png) вверху списка. diff --git a/ru/tracker/mobile/comments.md b/ru/tracker/mobile/comments.md index 4c251cc1521..d36f4ccd0df 100644 --- a/ru/tracker/mobile/comments.md +++ b/ru/tracker/mobile/comments.md @@ -10,7 +10,7 @@ ## Оставить комментарий {#leave-comment} -Чтобы прокомментировать задачу, введите текст в поле **{{ ui-key.startrek.ui_components_entity-page_comments_CommentEditor_mobile.write-comment }}** в нижней части экрана и нажмите кнопку ![](../../_assets/tracker/send.png). В комментариях вы можете использовать [разметку текста](../user/markup.md), а также [прикреплять к ним изображения и файлы](#sec_file). Чтобы развернуть поле с комментарием на весь экран, нажмите на значок ![](../../_assets/tracker/open-text.png). +Чтобы прокомментировать задачу, введите текст в поле **Написать комментарий** в нижней части экрана и нажмите кнопку ![](../../_assets/tracker/send.png). В комментариях вы можете использовать [разметку текста](../user/markup.md), а также [прикреплять к ним изображения и файлы](#sec_file). Чтобы развернуть поле с комментарием на весь экран, нажмите на значок ![](../../_assets/tracker/open-text.png). В комментарии к задаче можно указать ключ любой другой задачи — тогда {{ tracker-name }} автоматически их [свяжет](ticket-links.md#add-link). @@ -32,9 +32,9 @@ Чтобы пригласить других пользователей к обсуждению задачи: -1. Выберите поле **{{ ui-key.startrek.ui_components_entity-page_comments_CommentEditor_mobile.write-comment }}** в нижней части экрана и нажмите ![](../../_assets/tracker/at.png). +1. Выберите поле **Написать комментарий** в нижней части экрана и нажмите ![](../../_assets/tracker/at.png). -1. Введите логин или имя пользователя, которого вы хотите призвать в комментарии, и нажмите кнопку **{{ ui-key.startrek.ui_components_ModalTextEditor.save }}**. Вы можете призвать несколько пользователей одновременно. +1. Введите логин или имя пользователя, которого вы хотите призвать в комментарии, и нажмите кнопку **Сохранить**. Вы можете призвать несколько пользователей одновременно. 1. Введите текст комментария и нажмите кнопку ![](../../_assets/tracker/send.png). @@ -50,11 +50,11 @@ Чтобы прикрепить файл к комментарию: -1. Выберите поле **{{ ui-key.startrek.ui_components_entity-page_comments_CommentEditor_mobile.write-comment }}** в нижней части экрана и нажмите ![](../../_assets/tracker/pin.png). +1. Выберите поле **Написать комментарий** в нижней части экрана и нажмите ![](../../_assets/tracker/pin.png). * Чтобы добавить фото или видео с камеры телефона, нажмите на иконку **Камера**. Когда все будет готово, нажмите **ОК**. Чтобы переснять фото или видео, нажмите **Повтор**. - * Чтобы добавить приложения из памяти телефона, нажмите на иконку **{{ ui-key.startrek.ui_components_attachments-manager.attachments-section-title }}** и выберите файлы. + * Чтобы добавить приложения из памяти телефона, нажмите на иконку **{{ ui-key.startrek.ui_Common_smart-components_attachments-manager.attachments-section-title }}** и выберите файлы. {% note info %} diff --git a/ru/tracker/mobile/create-filter.md b/ru/tracker/mobile/create-filter.md index 87a2d594f12..7bf246f9939 100644 --- a/ru/tracker/mobile/create-filter.md +++ b/ru/tracker/mobile/create-filter.md @@ -16,6 +16,6 @@ {% note info %} -Чтобы сохранить фильтр, используйте веб-версию {{ tracker-name }}. Ваши сохраненные фильтры доступны в поле выбора **{{ ui-key.startrek.ui_components_agile_common_AgileFilters.all-issues-filter-title }}** в разделе **{{ ui-key.startrek-backend.messages.user.named.request.folder.my }}**. +Чтобы сохранить фильтр, используйте веб-версию {{ tracker-name }}. Ваши сохраненные фильтры доступны в поле выбора **Все задачи** в разделе **{{ ui-key.startrek-backend.messages.user.named.request.folder.my }}**. {% endnote %} \ No newline at end of file diff --git a/ru/tracker/mobile/create-ticket.md b/ru/tracker/mobile/create-ticket.md index e76a63cb834..935619820c4 100644 --- a/ru/tracker/mobile/create-ticket.md +++ b/ru/tracker/mobile/create-ticket.md @@ -24,11 +24,11 @@ 1. [Отредактируйте](edit-ticket.md) информацию о задаче: - * На вкладке **{{ ui-key.startrek.ui_components_IssueTabs.description-tab }}** укажите основные параметры: добавьте описание, выберите тип и приоритет задачи, укажите исполнителя и установите дедлайн. Для форматирования текста используйте [разметку YFM](../user/markup.md). + * На вкладке **Описание** укажите основные параметры: добавьте описание, выберите тип и приоритет задачи, укажите исполнителя и установите дедлайн. Для форматирования текста используйте [разметку YFM](../user/markup.md). - * На вкладке **{{ ui-key.startrek.ui_components_IssueTabs.fields-tab }}** укажите [дополнительные параметры](../user/create-param.md#default-fields) задачи. + * На вкладке **Параметры** укажите [дополнительные параметры](../user/create-param.md#default-fields) задачи. - * Если ваша задача будет связана с другими задачами, на вкладке **{{ ui-key.startrek.ui_components_IssueTabs.links-tab }}** [создайте подзадачи](#subtask). Чтобы изменить [тип связи](../user/links.md), нажмите ![](../../_assets/tracker/dots.png) напротив названия позадачи и выберите новый тип. + * Если ваша задача будет связана с другими задачами, на вкладке **Связи** [создайте подзадачи](#subtask). Чтобы изменить [тип связи](../user/links.md), нажмите ![](../../_assets/tracker/dots.png) напротив названия позадачи и выберите новый тип. 1. Чтобы [прикрепить к задаче файлы или изображения](attach-file.md), перейдите к редактированию описания задачи ![](../../_assets/tracker/icon-edit.png). Затем нажмите кнопку ![](../../_assets/tracker/pin.png) и выберите приложения. @@ -50,11 +50,11 @@ 1. Откройте задачу, к которой вы хотите создать подзадачу. -1. В правом верхнем углу экрана нажмите ![](../../_assets/tracker/dots.png) и выберите **{{ ui-key.startrek.ui_components_IssueActionsButton.menu-item-create-subticket }}**. +1. В правом верхнем углу экрана нажмите ![](../../_assets/tracker/dots.png) и выберите **Создать подзадачу**. 1. Заполните поля так же, как при [создании новой задачи](#create-task). -1. Нажмите кнопку **{{ ui-key.startrek.ui_components_IssueActionsButton.menu-item-create-subticket }}**. +1. Нажмите кнопку **Создать подзадачу**. diff --git a/ru/tracker/mobile/default-filters.md b/ru/tracker/mobile/default-filters.md index 8df281fd8e4..105e2d6b151 100644 --- a/ru/tracker/mobile/default-filters.md +++ b/ru/tracker/mobile/default-filters.md @@ -6,7 +6,7 @@ Найдите ваши задачи с помощью предустановленных системных фильтров. -1. В левом верхнем углу экрана нажмите **{{ ui-key.startrek.ui_components_agile_common_AgileFilters.all-issues-filter-title }}** и выберите один из вариантов: +1. В левом верхнем углу экрана нажмите **Все задачи** и выберите один из вариантов: * **Избранные задачи** – задачи, которые вы [добавили в избранное](../user/favourites.md#task-fav). @@ -20,7 +20,7 @@ * **Ждут ответа** – задачи, в которых вас [призвали в комментарии](comments.md#call-comment). - * **{{ ui-key.startrek.ui_components_IssuesPresetSelect.preset_deadline }}** – задачи, для которых вы являетесь автором, исполнителем или наблюдателем и в которых: + * **{{ ui-key.startrek.ui_Issues_smart-components_IssuesPresetSelect.preset_deadline }}** – задачи, для которых вы являетесь автором, исполнителем или наблюдателем и в которых: * дедлайн уже наступил за последние две недели ![](../../_assets/tracker/deadline-red.png); diff --git a/ru/tracker/mobile/edit-ticket.md b/ru/tracker/mobile/edit-ticket.md index 63fef469360..f8d643ec0ae 100644 --- a/ru/tracker/mobile/edit-ticket.md +++ b/ru/tracker/mobile/edit-ticket.md @@ -10,20 +10,20 @@ ## Изменить название задачи {#edit-name} -Нажмите на название задачи. Отредактируйте текст и нажмите кнопку **{{ ui-key.startrek.ui_components_settings_IssueUpdatesSettings.save }}**. +Нажмите на название задачи. Отредактируйте текст и нажмите кнопку **Сохранить**. ## Изменить описание задачи {#edit-description} -Справа от описания задачи нажмите значок ![](../../_assets/tracker/icon-edit.png) и отредактируйте текст. Для форматирования текста используйте [разметку YFM](../user/markup.md). Чтобы сохранить изменения, нажмите кнопку **{{ ui-key.startrek.ui_components_settings_IssueUpdatesSettings.save }}**. +Справа от описания задачи нажмите значок ![](../../_assets/tracker/icon-edit.png) и отредактируйте текст. Для форматирования текста используйте [разметку YFM](../user/markup.md). Чтобы сохранить изменения, нажмите кнопку **Сохранить**. -В описании задачи можно указать ключ любой другой задачи — тогда {{ tracker-name }} автоматически их свяжет. Связанная задача отобразится на вкладке **{{ ui-key.startrek.ui_components_IssueTabs.links-tab }}**. +В описании задачи можно указать ключ любой другой задачи — тогда {{ tracker-name }} автоматически их свяжет. Связанная задача отобразится на вкладке **Связи**. В описании задачи также можно [прикрепить изображение или файл](attach-file.md). ## Изменить параметры задачи {#edit-fields} -[Параметры задачи](../user/create-param.md#default-fields) отображаются на вкладке **{{ ui-key.startrek.ui_components_IssueTabs.fields-tab }}**. Чтобы изменить значение параметра, нажмите на значок ![](../../_assets/tracker/mobile-params-open.png). Введите значение и нажмите кнопку **{{ ui-key.startrek.ui_components_settings_IssueUpdatesSettings.save }}**. +[Параметры задачи](../user/create-param.md#default-fields) отображаются на вкладке **Параметры**. Чтобы изменить значение параметра, нажмите на значок ![](../../_assets/tracker/mobile-params-open.png). Введите значение и нажмите кнопку **Сохранить**. {% note info %} @@ -31,7 +31,7 @@ {% endnote %} -Параметры **{{ ui-key.startrek-backend.fields.issue.priority-key-value }}**, **{{ ui-key.startrek-backend.fields.issue.type-key-value }}**, **{{ ui-key.startrek-backend.fields.issue.assignee-key-value }}** и **{{ ui-key.startrek-backend.fields.issue.dueDate-key-value }}** также расположены на вкладке **{{ ui-key.startrek.ui_components_IssueTabs.description-tab }}**. Чтобы отредактировать их значения, нажмите на название параметра, укажите значение и нажмите кнопку **{{ ui-key.startrek.ui_components_settings_IssueUpdatesSettings.save }}**. +Параметры **{{ ui-key.startrek-backend.fields.issue.priority-key-value }}**, **{{ ui-key.startrek-backend.fields.issue.type-key-value }}**, **{{ ui-key.startrek-backend.fields.issue.assignee-key-value }}** и **{{ ui-key.startrek-backend.fields.issue.dueDate-key-value }}** также расположены на вкладке **Описание**. Чтобы отредактировать их значения, нажмите на название параметра, укажите значение и нажмите кнопку **Сохранить**. ## Изменить статус задачи {#edit-status} diff --git a/ru/tracker/mobile/enable-tracker.md b/ru/tracker/mobile/enable-tracker.md index f2722271890..c57582696a1 100644 --- a/ru/tracker/mobile/enable-tracker.md +++ b/ru/tracker/mobile/enable-tracker.md @@ -18,7 +18,7 @@ 1. Войдите в ваш [аккаунт на Яндексе]({{ link-passport }}). Если у вас еще нет аккаунта, [создайте]({{ support-passport-create }}) его. - * Если у вас нет организации {{ yandex-cloud }}, откроется окно подключения {{ tracker-full-name }}. Примите условия использования {{ yandex-cloud }} и нажмите **{{ ui-key.startrek.ui_components_PageHiThere.wrong-user-btn }}**. Для вас будет автоматически создана организация и подключен {{ tracker-full-name }}. + * Если у вас нет организации {{ yandex-cloud }}, откроется окно подключения {{ tracker-full-name }}. Примите условия использования {{ yandex-cloud }} и нажмите **Войти**. Для вас будет автоматически создана организация и подключен {{ tracker-full-name }}. * Если в вашей организации еще не подключен {{ tracker-name }}, при первом входе в мобильное приложение сервис будет подключен автоматически. diff --git a/ru/tracker/mobile/login.md b/ru/tracker/mobile/login.md index 4fbd37acfb9..f55c28be92e 100644 --- a/ru/tracker/mobile/login.md +++ b/ru/tracker/mobile/login.md @@ -26,7 +26,7 @@ 1. При первом запуске войдите в аккаунт, который вы используете для работы в {{ tracker-name }}: - * Чтобы войти с помощью почтового адреса на Яндексе или на домене вашей организации, нажмите кнопку **{{ ui-key.startrek.ui_components_PageHiThere.wrong-user-btn }}** и укажите ваш логин вида `{{ example-account }}` или `login@example.com`. Если у вас еще нет организации, она будет создана автоматически при [первом входе](enable-tracker.md) в приложение. + * Чтобы войти с помощью почтового адреса на Яндексе или на домене вашей организации, нажмите кнопку **Войти** и укажите ваш логин вида `{{ example-account }}` или `login@example.com`. Если у вас еще нет организации, она будет создана автоматически при [первом входе](enable-tracker.md) в приложение. * Если в вашей организации настроена система единого входа (Single Sign-On) через [федерацию удостоверений](../add-users.md#federation), нажмите кнопку **Войти через SSO**, укажите идентификатор федерации и войдите в ваш рабочий аккаунт. diff --git a/ru/tracker/mobile/my-tickets.md b/ru/tracker/mobile/my-tickets.md index ef8a4a99460..a44fbff8a40 100644 --- a/ru/tracker/mobile/my-tickets.md +++ b/ru/tracker/mobile/my-tickets.md @@ -22,7 +22,7 @@ description: Из статьи вы узнаете, как можно посмо * **Я исполнитель**. * **Я наблюдатель**. * **Ждут ответа**. - * **{{ ui-key.startrek.ui_components_IssuesPresetSelect.preset-deadline }}**. + * **{{ ui-key.startrek.ui_Issues_smart-components_IssuesPresetSelect.preset-deadline }}**. * Чтобы отфильтровать задачи по [резолюции](../manager/create-resolution.md), нажмите кнопку **{{ ui-key.startrek-backend.fields.issue.resolution-key-value }}** и выберите нужные значения из списка. diff --git a/ru/tracker/mobile/search-task.md b/ru/tracker/mobile/search-task.md index 29cbd22f2a4..5ccdbaeee4a 100644 --- a/ru/tracker/mobile/search-task.md +++ b/ru/tracker/mobile/search-task.md @@ -2,4 +2,4 @@ Если вы знаете название задачи или ее ключ, вы можете найти задачу с помощью строки поиска или языка запросов. -В верхней части экрана в поле **{{ ui-key.startrek.ui_components_PageIssues.search-title }}** введите название или ключ задачи. В результате появится список задач, которые удовлетворяют запросу. В списке отображаются первые 20 записей. Если вы не нашли нужную задачу, уточните запрос. +В верхней части экрана в поле **Поиск по всем задачам** введите название или ключ задачи. В результате появится список задач, которые удовлетворяют запросу. В списке отображаются первые 20 записей. Если вы не нашли нужную задачу, уточните запрос. diff --git a/ru/tracker/mobile/sort-and-group.md b/ru/tracker/mobile/sort-and-group.md index 51a0b5a785b..ee159d8db3f 100644 --- a/ru/tracker/mobile/sort-and-group.md +++ b/ru/tracker/mobile/sort-and-group.md @@ -6,7 +6,7 @@ 1. Откройте список задач. -1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/gantt-settings-button.svg) → ![](../../_assets/tracker/svg/sorting.svg) **{{ ui-key.startrek.ui_components_dashboard_IssuesStatEditor.editor-sort-by-field-label }}**. +1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/gantt-settings-button.svg) → ![](../../_assets/tracker/svg/sorting.svg) **Сортировка**. 1. Выберите параметр сортировки и направление: по убыванию или по возрастанию. @@ -16,7 +16,7 @@ 1. Откройте список задач. -1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/gantt-settings-button.svg) → ![](../../_assets/tracker/svg/group.svg) **{{ ui-key.startrek.ui_components_page-issues_touch_FilterSettingsMenu.item-group }}**. +1. В верхнем правом углу нажмите ![](../../_assets/tracker/svg/gantt-settings-button.svg) → ![](../../_assets/tracker/svg/group.svg) **Группировка**. 1. Выберите параметр для группировки задач. diff --git a/ru/tracker/mobile/ticket-links.md b/ru/tracker/mobile/ticket-links.md index 0aaf7717801..7f75e0fb26e 100644 --- a/ru/tracker/mobile/ticket-links.md +++ b/ru/tracker/mobile/ticket-links.md @@ -16,7 +16,7 @@ Чтобы создать связь с другой задачей: -1. Вставьте ключ задачи в комментарий или описание. Связанная задача отобразится на вкладке **{{ ui-key.startrek.ui_components_IssueTabs.links-tab }}**. +1. Вставьте ключ задачи в комментарий или описание. Связанная задача отобразится на вкладке **Связи**. 1. При необходимости [измените тип связи](#change-link-type) на любой из доступных. @@ -32,7 +32,7 @@ 1. Заполните поля так же, как при [создании новой задачи](./create-ticket.md). -1. Нажмите кнопку **{{ ui-key.startrek.ui_components_CreateIssueForm.create-issue }}**. Рядом с названием подзадачи отобразится ссылка на родительскую задачу. +1. Нажмите кнопку **Создать задачу**. Рядом с названием подзадачи отобразится ссылка на родительскую задачу. ## Изменить тип связи {#change-link-type} @@ -40,7 +40,7 @@ 1. Откройте одну из двух связанных задач. -1. Перейдите на вкладку **{{ ui-key.startrek.ui_components_IssueTabs.links-tab }}**. +1. Перейдите на вкладку **Связи**. 1. Напротив связанной задачи нажмите кнопку ![](../../_assets/horizontal-ellipsis.svg) → **Изменить тип связи** и выберите новый тип. @@ -50,6 +50,6 @@ 1. Откройте одну из двух связанных задач. -1. Перейдите на вкладку **{{ ui-key.startrek.ui_components_IssueTabs.links-tab }}**. +1. Перейдите на вкладку **Связи**. 1. Напротив связанной задачи нажмите кнопку ![](../../_assets/horizontal-ellipsis.svg) и выберите **Удалить связь**. diff --git a/ru/tracker/mobile/time-spent.md b/ru/tracker/mobile/time-spent.md index 742c8b8e035..c255ea51d07 100644 --- a/ru/tracker/mobile/time-spent.md +++ b/ru/tracker/mobile/time-spent.md @@ -1,11 +1,11 @@ # Просмотреть затраченное время -Чтобы просмотреть количество времени, которое вы затратили на задачу, на странице задачи перейдите на вкладку **{{ ui-key.startrek.ui_components_IssueTabs.fields-tab }}**. Затраченное время отображается в блоке **{{ ui-key.startrek.ui_components_new-process_ProcessTypeStepRedesign.information-time-tracking-title }}**. +Чтобы просмотреть количество времени, которое вы затратили на задачу, на странице задачи перейдите на вкладку **Параметры**. Затраченное время отображается в блоке **{{ ui-key.startrek.ui_Queues_smart-components_new-process_ProcessTypeStepRedesign.information-time-tracking-title }}**. -Чтобы отредактировать оценку задачи, справа от параметра **{{ ui-key.startrek-backend.fields.issue.estimation-key-value }}** нажмите на значок ![](../../_assets/tracker/mobile-edit-param.png). Введите значение и нажмите кнопку **{{ ui-key.startrek.ui_components_settings_IssueUpdatesSettings.save }}**. +Чтобы отредактировать оценку задачи, справа от параметра **{{ ui-key.startrek-backend.fields.issue.estimation-key-value }}** нажмите на значок ![](../../_assets/tracker/mobile-edit-param.png). Введите значение и нажмите кнопку **Сохранить**. {% note info %} -Если вы не видите блок **{{ ui-key.startrek.ui_components_new-process_ProcessTypeStepRedesign.information-time-tracking-title }}**, перейдите в веб-интерфейс и на панели справа добавьте поля **{{ ui-key.startrek-backend.fields.issue.spent-key-value }}** и **{{ ui-key.startrek-backend.fields.issue.estimation-key-value }}** с помощью кнопки ![](../../_assets/tracker/task-params-btn.png) **Выбрать поля**. +Если вы не видите блок **{{ ui-key.startrek.ui_Queues_smart-components_new-process_ProcessTypeStepRedesign.information-time-tracking-title }}**, перейдите в веб-интерфейс и на панели справа добавьте поля **{{ ui-key.startrek-backend.fields.issue.spent-key-value }}** и **{{ ui-key.startrek-backend.fields.issue.estimation-key-value }}** с помощью кнопки ![](../../_assets/tracker/task-params-btn.png) **Выбрать поля**. {% endnote %} diff --git a/ru/tracker/organizations.md b/ru/tracker/organizations.md index 201a4857b1f..8573fdf5fcb 100644 --- a/ru/tracker/organizations.md +++ b/ru/tracker/organizations.md @@ -6,7 +6,7 @@ [Изменения]({{ link-ya-360-notfree }}) затронут всех пользователей {{ tracker-name }} с бесплатной организацией в {{ ya-360 }}. -Чтобы посмотреть, к каким организациям подключен ваш {{ tracker-name }}, на панели слева нажмите ![](../_assets/tracker/svg/admin.svg) **Администрирование** → ![](../_assets/tracker/svg/organizations.svg) [**{{ ui-key.startrek.ui_components_page-admin_PageAdmin.menu-item-orgs }}**]({{ link-tracker }}admin/orgs). Чтобы проверить, платите ли вы за организацию в {{ ya-360 }}, в блоке с ней нажмите **{{ ui-key.startrek.ui_components_page-admin_OrgMainInfoPane.org-manage-button }}** и перейдите в раздел **Оплата и тариф**. +Чтобы посмотреть, к каким организациям подключен ваш {{ tracker-name }}, на панели слева нажмите ![](../_assets/tracker/svg/admin.svg) **Администрирование** → ![](../_assets/tracker/svg/organizations.svg) [**{{ ui-key.startrek.ui_Common_smart-components_page-admin_PageAdmin.menu-item-orgs }}**]({{ link-tracker }}admin/orgs). Чтобы проверить, платите ли вы за организацию в {{ ya-360 }}, в блоке с ней нажмите **Управление организацией** и перейдите в раздел **Оплата и тариф**. {% cut "Откуда у меня организация {{ ya-360 }}, настраивали же только {{ org-full-name }}?" %} diff --git a/ru/tracker/pay-the-bill.md b/ru/tracker/pay-the-bill.md index e3009fc3c8c..ab256de63a6 100644 --- a/ru/tracker/pay-the-bill.md +++ b/ru/tracker/pay-the-bill.md @@ -60,9 +60,9 @@ 1. На странице **{{ ui-key.yacloud_billing.billing.switch_accounts }}** выберите ваш платежный аккаунт. -1. В блоке с названием аккаунта нажмите кнопку **{{ ui-key.startrek.ui_components_page-admin_BillingAccountInfo.refill-balance }}**. +1. В блоке с названием аккаунта нажмите кнопку **Пополнить баланс**. -1. Введите сумму платежа и снова нажмите кнопку **{{ ui-key.startrek.ui_components_page-admin_BillingAccountInfo.refill-balance }}**. +1. Введите сумму платежа и снова нажмите кнопку **Пополнить баланс**. ## Пополнить счет банковским переводом {#transfer} @@ -70,9 +70,9 @@ 1. На странице **{{ ui-key.yacloud_billing.billing.accounts.label_title }}** выберите ваш платежный аккаунт. -1. В блоке с названием аккаунта нажмите кнопку **{{ ui-key.startrek.ui_components_page-admin_BillingAccountInfo.refill-balance }}**. +1. В блоке с названием аккаунта нажмите кнопку **Пополнить баланс**. -1. Введите сумму платежа и нажмите кнопку **{{ ui-key.startrek.ui_components_page-admin_BillingAccountInfo.refill-dialog-ok-issue }}**. Система сформирует счет для оплаты. +1. Введите сумму платежа и нажмите кнопку **Выписать счёт**. Система сформирует счет для оплаты. 1. Распечатайте счет и используйте его для оплаты в отделении банка или через систему клиент-банк. diff --git a/ru/tracker/quick-start.md b/ru/tracker/quick-start.md index efeee217d7a..e6503cef32e 100644 --- a/ru/tracker/quick-start.md +++ b/ru/tracker/quick-start.md @@ -9,13 +9,13 @@ В {{ tracker-name }} вы можете [создать](manager/create-queue.md) и [настроить](manager/edit-queue-general.md) очередь вручную или же воспользоваться средствами [автоматизации](automation.md). Для создания очереди, преднастроенной на конкретную специфику рабочего процесса, рекомендуем воспользоваться [шаблонами рабочих процессов](manager/create-work-process.md): -1. На стартовой странице [**Моя страница**](https://tracker.yandex.ru/pages/my), на виджете **{{ ui-key.startrek.ui_components_dashboard_InfoPresetsWidget.widget-title }}**, нажмите кнопку **{{ ui-key.startrek.ui_components_dashboard_InfoPresetsWidget.choose-template-button }}**. -1. Выберите **{{ ui-key.startrek.ui_components_new-process_ProcessTypeStepRedesign.process-type-standard }}** и нажмите кнопку **{{ ui-key.startrek.ui_components_new-process_QueueSetupForm.next-button }}**. +1. На стартовой странице [**Моя страница**](https://tracker.yandex.ru/pages/my), на виджете **{{ ui-key.startrek.ui_Dashboards_smart-components_InfoPresetsWidget.widget-title }}**, нажмите кнопку **{{ ui-key.startrek.ui_Dashboards_smart-components_InfoPresetsWidget.choose-template-button }}**. +1. Выберите **{{ ui-key.startrek.ui_Queues_smart-components_new-process_ProcessTypeStepRedesign.process-type-standard }}** и нажмите кнопку **{{ ui-key.startrek.ui_Queues_smart-components_new-process_QueueSetupForm.next-button }}**. 1. Укажите параметры очереди: * Название очереди задач; * [Ключ очереди](manager/create-queue.md#key); * Права доступа. -1. Нажмите кнопку **{{ ui-key.startrek.ui_components_new-process_QueueSetupForm.next-button }}**. +1. Нажмите кнопку **{{ ui-key.startrek.ui_Queues_smart-components_new-process_QueueSetupForm.next-button }}**. Будет создана очередь с базовым набором [типов и статусов](manager/workflow.md) задач и [простая доска задач](manager/agile.md#sec_boards). @@ -56,17 +56,17 @@ 1. В поле **Название задачи** введите название задачи. Лучше, если название будет емким, чтобы задачу легко можно было найти в списке, например: «Найти ответ на главный вопрос жизни, вселенной и всего остального». - 1. При желании дайте описание задачи. Для этого кликните по плейсхолдеру `{{ ui-key.startrek.ui_components_PageCreateIssue.description-placeholder }}` и опишите задачу в открывшемся текстовом редакторе. + 1. При желании дайте описание задачи. Для этого кликните по плейсхолдеру `{{ ui-key.startrek.ui_Issues_pages_PageCreateIssue.description-placeholder }}` и опишите задачу в открывшемся текстовом редакторе. - 1. Если нужно, загрузите файлы, кликнув на кнопку **{{ ui-key.startrek.ui_components_attachments-manager.attach }}**. + 1. Если нужно, загрузите файлы, кликнув на кнопку **{{ ui-key.startrek.ui_Common_smart-components_attachments-manager.attach }}**. - 1. Также вы можете добавить чекпоинты в **Чеклист**, кликнув на кнопку **{{ ui-key.startrek.ui_components_entity-page_checklist_Footer.new-item-button-caption }}** и заполнив открывшуюся форму. + 1. Также вы можете добавить чекпоинты в **Чеклист**, кликнув на кнопку **{{ ui-key.startrek.ui_Common_smart-components_entity-page_checklist_Footer.new-item-button-caption }}** и заполнив открывшуюся форму. 1. На панели справа внесите необходимые данные по задаче, например: * в поле **{{ ui-key.startrek-backend.fields.issue.assignee-key-value }}** укажите себя как исполнителя, нажав кнопку **Назначить меня**; * в поле **{{ ui-key.startrek-backend.fields.issue.dueDate-key-value }}** задайте произвольный дедлайн. - 1. При необходимости, измените список отображаемых полей задачи. Для этого кликните на кнопку **{{ ui-key.startrek.ui_components_entity-page_sidebar_SidebarFieldsSelect.add-sidebar-field }}** и выберите нужные параметры. + 1. При необходимости, измените список отображаемых полей задачи. Для этого кликните на кнопку **{{ ui-key.startrek.ui_Common_smart-components_entity-page_sidebar_SidebarFieldsSelect.add-sidebar-field }}** и выберите нужные параметры. 1. Нажмите кнопку **{{ ui-key.startrek-backend.types.types.trigger.action.create.issue }}**. diff --git a/ru/tracker/release-notes/2308.md b/ru/tracker/release-notes/2308.md index 6b069128922..b102876bb5c 100644 --- a/ru/tracker/release-notes/2308.md +++ b/ru/tracker/release-notes/2308.md @@ -23,8 +23,8 @@ description: Ознакомьтесь с историей изменений в Теперь на странице организаций можно сменить организацию, подключенную к {{ tracker-name }}: 1. Перейдите на [страницу организаций]({{ link-tracker }}admin/orgs). -1. Нажмите **{{ ui-key.startrek.ui_components_page-admin_ChangeOrganizationModal.add-button }}**. -1. В открывшемся окне выберите доступную организацию и нажмите **{{ ui-key.startrek.ui_components_page-admin_ChangeOrganizationModal.add-button }}**. +1. Нажмите **Сменить организацию**. +1. В открывшемся окне выберите доступную организацию и нажмите **Сменить организацию**. Вы можете сменить как организацию {{ yandex-cloud }}, так и {{ ya-360 }}. @@ -40,10 +40,10 @@ description: Ознакомьтесь с историей изменений в Чтобы подключить собственный репозиторий: 1. Перейдите на [страницу подключения репозиториев]({{ link-tracker }}admin/repositories). -1. В правом верхнем углу нажмите **{{ ui-key.startrek.ui_components_admin-repositories_ConnectRepositoryDialog.connect }}**. +1. В правом верхнем углу нажмите **{{ ui-key.startrek.ui_Common_smart-components_admin-repositories_ConnectRepositoryDialog.connect }}**. 1. В поле **Платформа** выберите платформу, к которой подключен ваш сервер. -1. В поле **{{ ui-key.startrek.ui_components_admin-repositories_ConnectRepositoryDialog_fields_UrlField.server-url-label }}** укажите адрес вашего сервера до любого доступного по токену репозитория. -1. В поле **{{ ui-key.startrek.ui_components_admin-repositories_ConnectRepositoryDialog.token-label }}** укажите токен для подключения к вашему серверу. +1. В поле **Ссылка на репозиторий** укажите адрес вашего сервера до любого доступного по токену репозитория. +1. В поле **{{ ui-key.startrek.ui_Common_smart-components_admin-repositories_ConnectRepositoryDialog.token-label }}** укажите токен для подключения к вашему серверу. 1. Нажмите кнопку **Подключить**. 1. Убедитесь, что статус репозиториев отображается в {{ tracker-name }} как **Подключен**. diff --git a/ru/tracker/release-notes/2309.md b/ru/tracker/release-notes/2309.md index 22a9e294958..7df682aea62 100644 --- a/ru/tracker/release-notes/2309.md +++ b/ru/tracker/release-notes/2309.md @@ -11,7 +11,7 @@ Сохранились возможности переопределять доступы в задачах с помощью компонентов и назначать права в зависимости от роли в задаче. Теперь эти настройки доступны в новом интерфейсе и стали удобнее. -Для управления доступами перейдите в настройки очереди, на вкладку **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-permissions }}**. На этой странице также можно просматривать права доступа к очереди у любого пользователя или группы пользователей. +Для управления доступами перейдите в настройки очереди, на вкладку **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-permissions }}**. На этой странице также можно просматривать права доступа к очереди у любого пользователя или группы пользователей. Подробнее о настройке прав доступа см. в разделе [{#T}](../manager/queue-access.md). @@ -33,9 +33,9 @@ 1. В настройках очереди, для которой хотите создать или интегрировать форму, выберите вкладку **Интеграции (beta)**. -1. В разделе **{{ ui-key.startrek.ui_components_queue-admin-tab-integrations_IntegrationForms.title }}** нажмите **Настроить формы**. На этой странице вы можете работать с формами: +1. В разделе **Формы** нажмите **Настроить формы**. На этой странице вы можете работать с формами: - * Создавать новые формы и подключать уже существующие. Для этого в правом верхнем углу нажмите **{{ ui-key.startrek.ui_components_page-queue-admin_queue-admin-tab-integrations-forms_components_FormsMenu.add-form }}** и выберите **{{ ui-key.startrek.ui_components_page-queue-admin_queue-admin-tab-integrations-forms_components_FormsMenu.add-form }}** или **{{ ui-key.startrek.ui_components_page-queue-admin_queue-admin-tab-integrations-forms_components_FormsMenu.create-new }}**. + * Создавать новые формы и подключать уже существующие. Для этого в правом верхнем углу нажмите **Добавить форму** и выберите **Добавить форму** или **Создать новую**. * Редактировать и удалять подключенные формы. Для этого в списке форм справа от нужной записи нажмите ![](../../_assets/tracker/svg/actions.svg) и выберите действие. @@ -49,7 +49,7 @@ ### Вехи в проектах {#milestones} -Добавлен новый [тип задач](../manager/add-ticket-type.md) — ![](../../_assets/tracker/svg/milestone.svg) **{{ ui-key.startrek.ui_components_issues_create-issue-popup_NewIssueForm.milestone-type }}**. С его помощью вы можете отслеживать важные этапы разработки проекта. Особенность вех в том, что у них нет полей **Дата начала** и **Дата завершения** — только **Дедлайн**. +Добавлен новый [тип задач](../manager/add-ticket-type.md) — ![](../../_assets/tracker/svg/milestone.svg) **Веха**. С его помощью вы можете отслеживать важные этапы разработки проекта. Особенность вех в том, что у них нет полей **Дата начала** и **Дата завершения** — только **Дедлайн**. Вехи проекта в {{ tracker-name }} отображаются на вкладке **О проекте**, под описанием проекта. На [диаграмме Ганта для проекта](../gantt/project.md) вехи отображаются в виде ромба. На этих страницах теперь можно добавлять вехи в проект. @@ -62,17 +62,17 @@ Новый редактор [рабочих процессов очереди](../manager/add-workflow.md) вышел из бета-версии и теперь доступен по умолчанию. В связи в этим из настроек очереди убрали раздел **Типы задач** — все его опции теперь доступны в разделе **Рабочие процессы**. Чтобы открыть рабочие процессы: 1. Перейдите в настройки нужной очереди. -1. Выберите вкладку **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. +1. Выберите вкладку **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. ### Копирование рабочих процессов из других очередей {#copy-workflow} Теперь в редакторе рабочих процессов можно копировать рабочие процессы из одних очередей и использовать их в других очередях. Чтобы сделать это: 1. Перейдите в настройки очереди, для которой хотите настроить рабочий процесс. -1. Выберите вкладку **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. +1. Выберите вкладку **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-workflows }}**. 1. В правом верхнем углу нажмите ![](../../_assets/tracker/svg/copy-workflow.svg). 1. Во всплывающем окне выберите очередь и ее рабочий процесс, который хотите скопировать, и введите название нового рабочего процесса. -1. Нажмите **{{ ui-key.startrek.ui_components_queue-admin-tab-workflows_CopyWorkflowDialog.action-copy }}**. +1. Нажмите **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-workflows_CopyWorkflowDialog.action-copy }}**. ## Исправления и улучшения {#fixes} diff --git a/ru/tracker/user/agile.md b/ru/tracker/user/agile.md index f89e34b5dde..2a85e3cd894 100644 --- a/ru/tracker/user/agile.md +++ b/ru/tracker/user/agile.md @@ -32,7 +32,7 @@ 1. Откройте доску задач. -1. В правом нижнем углу доски нажмите на кнопку **{{ ui-key.startrek.ui_components_agile_common_AddIssueButton.add-issue-button }}**. +1. В правом нижнем углу доски нажмите на кнопку **Добавить задачу**. 1. Введите название задачи и выберите ее тип. @@ -100,13 +100,13 @@ 1. Выберите задачи, которые вы хотите добавить на доску, и внизу страницы нажмите кнопку **Изменить параметры**. -1. Чтобы добавить задачи в бэклог, начните вводить название доски в поле **{{ ui-key.startrek.ui_components_agile_common_AgileTabs.board }}** и выберите подходящий вариант из списка. Если поля **{{ ui-key.startrek.ui_components_agile_common_AgileTabs.board }}** нет, добавьте его с помощью кнопки **Выбрать поля**. +1. Чтобы добавить задачи в бэклог, начните вводить название доски в поле **Доска** и выберите подходящий вариант из списка. Если поля **Доска** нет, добавьте его с помощью кнопки **Выбрать поля**. 1. Чтобы добавить задачи в спринт, начните вводить название спринта в поле **{{ ui-key.startrek-backend.fields.issue.sprint }}** и выберите подходящий вариант из списка. Поле доски при этом заполнится автоматически. Если поля **{{ ui-key.startrek-backend.fields.issue.sprint }}** нет, добавьте его с помощью кнопки **Выбрать поля**. -1. Нажмите кнопку **{{ ui-key.startrek.ui_components_TransitionScreen.screen-next-button }}** и дождитесь окончания обработки задач. +1. Нажмите кнопку **Продолжить** и дождитесь окончания обработки задач. ## Убрать задачи с доски {#remove-tasks} @@ -153,7 +153,7 @@ * Ключ или название задачи. Начните вводить текст в поле на панели сверху. На доске останутся только те задачи, ключ или название которых содержит этот текст. -* Быстрые фильтры. По умолчанию на доске есть только два быстрых фильтра: **{{ ui-key.startrek.ui_components_agile_common_QuickFiltersItem.quick-filter--assignee-me }}** и **{{ ui-key.startrek.ui_components_agile_common_QuickFiltersItem.quick-filter--author-me }}**. Чтобы добавить новые фильтры, на панели с фильтрами нажмите кнопку ![](../../_assets/tracker/edit-agile.png). +* Быстрые фильтры. По умолчанию на доске есть только два быстрых фильтра: **Я исполнитель** и **Я автор**. Чтобы добавить новые фильтры, на панели с фильтрами нажмите кнопку ![](../../_assets/tracker/edit-agile.png). ## Полноэкранный режим {#fullscreen} diff --git a/ru/tracker/user/attach-file.md b/ru/tracker/user/attach-file.md index 6c391741c46..da5e3b51f49 100644 --- a/ru/tracker/user/attach-file.md +++ b/ru/tracker/user/attach-file.md @@ -5,7 +5,7 @@ Вы можете прикрепить файл к описанию задачи одним из способов: -* Нажмите кнопку ![](../../_assets/tracker/svg/icon-file.svg) **{{ ui-key.startrek.ui_components_attachments-manager.attach }}** под описанием задачи. +* Нажмите кнопку ![](../../_assets/tracker/svg/icon-file.svg) **{{ ui-key.startrek.ui_Common_smart-components_attachments-manager.attach }}** под описанием задачи. * Перетащите файлы в описание задачи. diff --git a/ru/tracker/user/checklist.md b/ru/tracker/user/checklist.md index 1b2c79504c6..e6aa22dd1f4 100644 --- a/ru/tracker/user/checklist.md +++ b/ru/tracker/user/checklist.md @@ -12,9 +12,9 @@ 1. Если необходимо, укажите исполнителя и дедлайн для этого пункта чеклиста. -1. Чтобы добавит пункт, нажмите **{{ ui-key.startrek.ui_components_entity-page_checklist_ChecklistItem.button-submit }}**. Если вы хотите отменить добавление пункта, нажмите **{{ ui-key.startrek.ui_components_entity-page_checklist_ChecklistItem.button-cancel }}**. +1. Чтобы добавит пункт, нажмите **Сохранить**. Если вы хотите отменить добавление пункта, нажмите **Отменить**. -1. Чтобы добавить очередной пункт, нажмите **{{ ui-key.startrek.ui_components_entity-page_checklist_Footer.new-item-button-caption }}**. +1. Чтобы добавить очередной пункт, нажмите **{{ ui-key.startrek.ui_Common_smart-components_entity-page_checklist_Footer.new-item-button-caption }}**. ## Работать с чеклистом {#checklist-operations} @@ -32,8 +32,8 @@ * Чтобы переместить пункт выше или ниже, нажмите значок ![](../../_assets/tracker/svg/range.svg) и перетащите пункт в нужное место списка. -* Чтобы скрыть или показать все пункты, нажмите на **{{ ui-key.startrek.ui_components_entity-page_checklist_Header.header-title }}** вверху списка. +* Чтобы скрыть или показать все пункты, нажмите на **{{ ui-key.startrek.ui_Common_smart-components_entity-page_checklist_Header.header-title }}** вверху списка. -* Чтобы добавить пункт в чеклист, нажмите **{{ ui-key.startrek.ui_components_entity-page_checklist_Footer.new-item-button-caption }}** внизу списка. +* Чтобы добавить пункт в чеклист, нажмите **{{ ui-key.startrek.ui_Common_smart-components_entity-page_checklist_Footer.new-item-button-caption }}** внизу списка. -* Чтобы удалить чеклист, нажмите значок ![](../../_assets/horizontal-ellipsis.svg) и выберите ![](../../_assets/tracker/svg/icon-remove.svg) **{{ ui-key.startrek.ui_components_entity-page_checklist_ChecklistActionsMenu.remove-title }}** вверху списка. +* Чтобы удалить чеклист, нажмите значок ![](../../_assets/horizontal-ellipsis.svg) и выберите ![](../../_assets/tracker/svg/icon-remove.svg) **{{ ui-key.startrek.ui_Common_smart-components_entity-page_checklist_ChecklistActionsMenu.remove-title }}** вверху списка. diff --git a/ru/tracker/user/clone.md b/ru/tracker/user/clone.md index b3fda5c0706..33249e8d9e2 100644 --- a/ru/tracker/user/clone.md +++ b/ru/tracker/user/clone.md @@ -12,7 +12,7 @@ 1. Откройте страницу задачи. -1. В правом верхнем углу выберите **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.clone-issue-action-title }}**. +1. В правом верхнем углу выберите **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.clone-issue-action-title }}**. 1. Выберите очередь, в которой вы хотите создать задачу-клон. diff --git a/ru/tracker/user/create-autoaction.md b/ru/tracker/user/create-autoaction.md index 6f9f2ef9ca5..fbeded83d3f 100644 --- a/ru/tracker/user/create-autoaction.md +++ b/ru/tracker/user/create-autoaction.md @@ -12,7 +12,7 @@ 1. {% include [go to settings](../../_includes/tracker/transition-page.md) %} -1. В правом верхнем углу нажмите ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В правом верхнем углу нажмите ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. На панели слева выберите **Автоматизация** → **Автодействия** и нажмите кнопку **Создать автодействие**. diff --git a/ru/tracker/user/create-filter.md b/ru/tracker/user/create-filter.md index b2b19b13d77..83b395c3363 100644 --- a/ru/tracker/user/create-filter.md +++ b/ru/tracker/user/create-filter.md @@ -26,7 +26,7 @@ Добавьте параметры задачи и укажите их возможные значения: - 1. Над списком задач нажмите кнопку ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_components_filter-pane_FieldsSelectButton.add-filter-field-button-title }}**. + 1. Над списком задач нажмите кнопку ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_Common_smart-components_filter-pane_FieldsSelectButton.add-filter-field-button-title }}**. 1. Выберите параметр задачи, затем задайте его значение. @@ -46,11 +46,11 @@ {% endnote %} -- **{{ ui-key.startrek.ui_components_dashboard_FilterEditor.editor-source-radio-query }}** +- **Язык запросов** Язык запросов позволяет задать условия, которые невозможно настроить с помощью параметров. Например, найти задачи, которые были открыты в течение последней недели. Подробнее о языке запросов читайте в разделе [{#T}](query-filter.md). - 1. В правом верхнем углу страницы нажмите ![](../../_assets/tracker/svg/query-language.svg) **{{ ui-key.startrek.ui_components_dashboard_FilterEditor.editor-source-radio-query }}**. Все параметры поиска, которые вы задали с помощью быстрых фильтров и условий, отобразятся в строке запроса. + 1. В правом верхнем углу страницы нажмите ![](../../_assets/tracker/svg/query-language.svg) **Язык запросов**. Все параметры поиска, которые вы задали с помощью быстрых фильтров и условий, отобразятся в строке запроса. 1. Добавьте в строку условия с помощью [языка запросов](query-filter.md). @@ -58,7 +58,7 @@ ### Шаг 3. Настройте внешний вид списка задач -- Чтобы отобразить или скрыть параметры задач, справа над списком нажмите ![](../../_assets/tracker/svg/list-settings.svg) **{{ ui-key.startrek.ui_components_PageAgileBoard_PageAgileBoardHeader.settings }}**, выберите параметры и нажмите кнопку **Применить**. +- Чтобы отобразить или скрыть параметры задач, справа над списком нажмите ![](../../_assets/tracker/svg/list-settings.svg) **{{ ui-key.startrek.ui_Boards_pages_PageAgileBoard_PageAgileBoardHeader.settings }}**, выберите параметры и нажмите кнопку **Применить**. - Чтобы сгруппировать задачи по определенному параметру, над списком нажмите ![](../../_assets/tracker/svg/group.svg) **Без группировки** и выберите параметр. @@ -66,7 +66,7 @@ ### Шаг 4. Сохраните фильтр -Если вам часто приходится пользоваться одним и тем же фильтром, сохраните его. Ваши сохраненные фильтры доступны в поле выбора **{{ ui-key.startrek.ui_components_filter-pane.all-issues-filter-title }}** в разделе **{{ ui-key.startrek-backend.messages.user.named.request.folder.my }}**. +Если вам часто приходится пользоваться одним и тем же фильтром, сохраните его. Ваши сохраненные фильтры доступны в поле выбора **{{ ui-key.startrek.ui_Common_smart-components_filter-pane.all-issues-filter-title }}** в разделе **{{ ui-key.startrek-backend.messages.user.named.request.folder.my }}**. 1. Над списком задач нажмите кнопку **Сохранить**. @@ -74,29 +74,29 @@ 1. Нажмите кнопку **Сохранить**. -Чтобы сохранить список задач, найденных с помощью фильтра, в правом верхнем углу нажмите кнопку ![](../../_assets/tracker/svg/icon-export-tasks.svg) **{{ ui-key.startrek.ui_components_FilterExportMenu.menu-item-export }}** и выберите формат файла для загрузки или скопируйте список в буфер обмена. +Чтобы сохранить список задач, найденных с помощью фильтра, в правом верхнем углу нажмите кнопку ![](../../_assets/tracker/svg/icon-export-tasks.svg) **Выгрузить** и выберите формат файла для загрузки или скопируйте список в буфер обмена. ## Редактировать фильтр {#edit} #### Изменить условия фильтра -1. В верхней части окна в поле **{{ ui-key.startrek.ui_components_page-issues_touch.all-issues-filter-title }}** выберите ваш фильтр. +1. В верхней части окна в поле **{{ ui-key.startrek.ui_Issues_pages_page-issues_touch.all-issues-filter-title }}** выберите ваш фильтр. 1. [Измените условия поиска задач](#set-conditions) с помощью быстрых фильтров, параметров или языка запросов. 1. Над списком задач нажмите кнопку **Сохранить**: - * Чтобы сохранить фильтр под текущим именем, нажмите кнопку **{{ ui-key.startrek.ui_components_filter-pane.action-title-save }}**. + * Чтобы сохранить фильтр под текущим именем, нажмите кнопку **{{ ui-key.startrek.ui_Common_smart-components_filter-pane.action-title-save }}**. - * Чтобы сохранить фильтр под другим именем, нажмите кнопку **{{ ui-key.startrek.ui_components_filter-pane.action-title-save-as }}**. Затем задайте имя фильтра, выберите категорю и нажмите кнопку **Сохранить**. + * Чтобы сохранить фильтр под другим именем, нажмите кнопку **{{ ui-key.startrek.ui_Common_smart-components_filter-pane.action-title-save-as }}**. Затем задайте имя фильтра, выберите категорю и нажмите кнопку **Сохранить**. #### Удалить фильтр -1. В верхней части окна в поле **{{ ui-key.startrek.ui_components_page-issues_touch.all-issues-filter-title }}** выберите ваш фильтр. +1. В верхней части окна в поле **{{ ui-key.startrek.ui_Issues_pages_page-issues_touch.all-issues-filter-title }}** выберите ваш фильтр. 1. Удалите фильтр одним из спообов: * Справа от названия фильтра нажмите значок ![](../../_assets/tracker/svg/icon-filter-delete.svg) **Удалить**. - * В верхнем правом углу страницы нажмите значок ![](../../_assets/tracker/svg/actions.svg) **{{ ui-key.startrek.ui_components_FilterExportMenu.title }}** и выберите ![](../../_assets/tracker/svg/icon-filter-delete.svg) **Удалить**. \ No newline at end of file + * В верхнем правом углу страницы нажмите значок ![](../../_assets/tracker/svg/actions.svg) **Действия над фильтром** и выберите ![](../../_assets/tracker/svg/icon-filter-delete.svg) **Удалить**. \ No newline at end of file diff --git a/ru/tracker/user/create-ticket-with-forms.md b/ru/tracker/user/create-ticket-with-forms.md index 26cd3e1104d..517056cfd2e 100644 --- a/ru/tracker/user/create-ticket-with-forms.md +++ b/ru/tracker/user/create-ticket-with-forms.md @@ -12,6 +12,6 @@ - Форма [подключена к очереди в {{ tracker-name }}](../manager/attach-form.md) в качестве шаблона для быстрого создания типовых задач. - При таком способе размещения формы перейдите на страницу очереди и нажмите кнопку **{{ ui-key.startrek.ui_components_CreateIssueForm.create-issue }}**, затем выберите форму и заполните поля. На основе введенных данных будет создана задача. + При таком способе размещения формы перейдите на страницу очереди и нажмите кнопку **Создать задачу**, затем выберите форму и заполните поля. На основе введенных данных будет создана задача. Подробнее об интеграции с {{ forms-full-name }} читайте в разделе [{#T}](../manager/forms-integration.md). diff --git a/ru/tracker/user/create-ticket.md b/ru/tracker/user/create-ticket.md index ea3b874ce39..69377efa8f2 100644 --- a/ru/tracker/user/create-ticket.md +++ b/ru/tracker/user/create-ticket.md @@ -15,7 +15,7 @@ 1. Добавьте описание задачи. Для форматирования текста используйте [разметку YFM](markup.md). -1. Чтобы добавить в задачу файлы или изображения, нажмите **{{ ui-key.startrek.ui_components_attachments-manager.attach }}**. +1. Чтобы добавить в задачу файлы или изображения, нажмите **{{ ui-key.startrek.ui_Common_smart-components_attachments-manager.attach }}**. 1. Чтобы добавить список этапов выполнения задачи, нажмите кнопку **Добавить чеклист**. @@ -27,7 +27,7 @@ Вы также можете оставить значения по умолчанию, чтобы настроить их позже. -1. При необходимости задайте [дополнительные параметры](create-param.md#default-fields). Для этого добавьте поля с помощью кнопки ![](../../_assets/tracker/task-params-btn.png) **{{ ui-key.startrek.ui_components_entity-page_sidebar_SidebarFieldsSelect.add-sidebar-field }}** и заполните их. +1. При необходимости задайте [дополнительные параметры](create-param.md#default-fields). Для этого добавьте поля с помощью кнопки ![](../../_assets/tracker/task-params-btn.png) **{{ ui-key.startrek.ui_Common_smart-components_entity-page_sidebar_SidebarFieldsSelect.add-sidebar-field }}** и заполните их. {% note info %} @@ -35,7 +35,7 @@ {% endnote %} -1. Нажмите кнопку **{{ ui-key.startrek.ui_components_CreateIssueForm.create-issue }}**. +1. Нажмите кнопку **Создать задачу**. ## Возможности автоматизации {#avto} @@ -49,7 +49,7 @@ Если вам приходится создавать много похожих задач, создайте для них [шаблон](ticket-template.md). -Чтобы создать задачу с помощью шаблона, в правом верхнем углу нажмите кнопку ![](../../_assets/tracker/svg/icon-note.svg) **{{ ui-key.startrek.ui_components_issue-templates_Select.select-template }}**. Выберите подходящий шаблон или нажмите `{{ ui-key.startrek.ui_components_issue-templates_Select.manage-templates }}`, чтобы создать новый. +Чтобы создать задачу с помощью шаблона, в правом верхнем углу нажмите кнопку ![](../../_assets/tracker/svg/icon-note.svg) **{{ ui-key.startrek.ui_Issues_smart-components_issue-templates_Select.select-template }}**. Выберите подходящий шаблон или нажмите `{{ ui-key.startrek.ui_Issues_smart-components_issue-templates_Select.manage-templates }}`, чтобы создать новый. Если вы примените шаблон, поля задачи получат значения из шаблона и останутся доступными для редактирования. @@ -71,11 +71,11 @@ 1. Откройте страницу задачи, к которой вы хотите создать подзадачу. -1. В правом верхнем углу выберите **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.create-subissue }}**. +1. В правом верхнем углу выберите **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.create-subissue }}**. 1. Заполните поля так же, как при [создании новой задачи](#create-task). -1. Нажмите кнопку **{{ ui-key.startrek.ui_components_CreateIssueForm.create-issue }}**. +1. Нажмите кнопку **Создать задачу**. #### Следующий шаг diff --git a/ru/tracker/user/create-trigger.md b/ru/tracker/user/create-trigger.md index 20a8ddafb0f..f356faef2a2 100644 --- a/ru/tracker/user/create-trigger.md +++ b/ru/tracker/user/create-trigger.md @@ -13,7 +13,7 @@ description: Следуя данной инструкции, вы сможете 1. {% include [go to settings](../../_includes/tracker/transition-page.md) %} -1. В правом верхнем углу нажмите ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В правом верхнем углу нажмите ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. На панели слева выберите **Автоматизация** → **Триггеры** и нажмите кнопку **Создать триггер**. diff --git a/ru/tracker/user/default-filters.md b/ru/tracker/user/default-filters.md index 73592bfb41b..1db97399972 100644 --- a/ru/tracker/user/default-filters.md +++ b/ru/tracker/user/default-filters.md @@ -22,7 +22,7 @@ * **Ждут ответа** – задачи, в которых вас [призвали в комментарии](comments.md#call-comment). - * **{{ ui-key.startrek.ui_components_IssuesPresetSelect.preset_deadline }}** – задачи, для которых вы являетесь автором, исполнителем или наблюдателем и в которых: + * **{{ ui-key.startrek.ui_Issues_smart-components_IssuesPresetSelect.preset_deadline }}** – задачи, для которых вы являетесь автором, исполнителем или наблюдателем и в которых: * дедлайн уже наступил за последние две недели; @@ -36,7 +36,7 @@ * Чтобы сгруппировать задачи по определенному параметру, справа от строки поиска нажмите ![](../../_assets/tracker/svg/group.svg) **Без группировки** и выберите параметр. - * Чтобы сохранить список задач, в верхнем правом углу нажмите ![](../../_assets/tracker/svg/icon-export-tasks.svg) **{{ ui-key.startrek.ui_components_FilterExportMenu.menu-item-export }}** и выберите формат файла для загрузки или скопируйте список в буфер обмена. + * Чтобы сохранить список задач, в верхнем правом углу нажмите ![](../../_assets/tracker/svg/icon-export-tasks.svg) **Выгрузить** и выберите формат файла для загрузки или скопируйте список в буфер обмена. * Чтобы свернуть панель со списком фильтров, в верхнем правом углу страницы нажмите ![](../../_assets/tracker/svg/icon-parameters.svg) **Параметры**. @@ -52,7 +52,7 @@ * Чтобы отфильтровать задачи по [резолюции](../manager/create-resolution.md), нажмите кнопку **{{ ui-key.startrek-backend.fields.issue.resolution-key-value }}** и выберите нужные значения из списка. - * Чтобы использовать [дополнительные параметры поиска](#add-condition), нажмите кнопку ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_components_filter-pane_FieldsSelectButton.add-filter-field-button-title }}** и выберите поле. + * Чтобы использовать [дополнительные параметры поиска](#add-condition), нажмите кнопку ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_Common_smart-components_filter-pane_FieldsSelectButton.add-filter-field-button-title }}** и выберите поле. В результате в списке останутся только те задачи, которые удовлетворяют выбранным фильтрам. @@ -62,18 +62,18 @@ Чтобы найти в списке задачи по параметрам, которые нельзя задать с помощью системных фильтров, добавьте условия поиска. -1. В верхнем правом углу страницы нажмите ![](../../_assets/tracker/svg/icon-parameters.svg) **{{ ui-key.startrek.ui_components_dashboard_IssuesStatEditor.editor-source-radio-parameters }}**. Под строкой поиска отобразится панель с установленными параметрами фильтрации. +1. В верхнем правом углу страницы нажмите ![](../../_assets/tracker/svg/icon-parameters.svg) **Параметры**. Под строкой поиска отобразится панель с установленными параметрами фильтрации. -1. Нажмите значок ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_components_filter-pane_FieldsSelectButton.add-filter-field-button-title }}**. +1. Нажмите значок ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_Common_smart-components_filter-pane_FieldsSelectButton.add-filter-field-button-title }}**. -1. Выберите параметр задачи, затем задайте его значение нажмите кнопку **{{ ui-key.startrek.ui_components_filter-field.save-button }}**. +1. Выберите параметр задачи, затем задайте его значение нажмите кнопку **Сохранить**. В списке останутся только задачи, параметры которых удовлетворяют заданному условию. 1. Если нужно уточнить условия поиска, добавьте еще несколько параметров. -1. Чтобы отменить заданные условия поиска, над списком задач нажмите кнопку **{{ ui-key.startrek.ui_components_filter-pane.reset-button }}**. +1. Чтобы отменить заданные условия поиска, над списком задач нажмите кнопку **{{ ui-key.startrek.ui_Common_smart-components_filter-pane.reset-button }}**. Например, вы можете искать задачи по названию или описанию: @@ -92,7 +92,7 @@ Если условия поиска не удается задать с помощью параметров задачи, используйте запрос: -1. В правом верхнем углу страницы нажмите кнопку ![](../../_assets/tracker/svg/query-language.svg) **{{ ui-key.startrek.ui_components_dashboard_FilterEditor.editor-source-radio-query }}**. Все параметры поиска, которые вы задали с помощью системных фильтров и условий, отобразятся в строке запроса. +1. В правом верхнем углу страницы нажмите кнопку ![](../../_assets/tracker/svg/query-language.svg) **Язык запросов**. Все параметры поиска, которые вы задали с помощью системных фильтров и условий, отобразятся в строке запроса. 1. Добавьте в строку условия с помощью [языка запросов](query-filter.md). diff --git a/ru/tracker/user/edit-ticket.md b/ru/tracker/user/edit-ticket.md index a9324fca137..d39167afca4 100644 --- a/ru/tracker/user/edit-ticket.md +++ b/ru/tracker/user/edit-ticket.md @@ -26,7 +26,7 @@ [Параметры задачи](create-param.md##default-fields) отображаются на панели справа. Чтобы изменить значение параметра, нажмите на его название и выберите новое значение. -Если вы не видите на панели справа нужных параметров, добавьте их с помощью кнопки **{{ ui-key.startrek.ui_components_entity-page_sidebar_SidebarFieldsSelect.add-sidebar-field }}**. +Если вы не видите на панели справа нужных параметров, добавьте их с помощью кнопки **{{ ui-key.startrek.ui_Common_smart-components_entity-page_sidebar_SidebarFieldsSelect.add-sidebar-field }}**. Чтобы изменить параметры сразу нескольких задач, используйте [массовые операции](../manager/bulk-change.md#change-parameters). diff --git a/ru/tracker/user/forms-template.md b/ru/tracker/user/forms-template.md index e7021bf71e6..ce21ff8bd66 100644 --- a/ru/tracker/user/forms-template.md +++ b/ru/tracker/user/forms-template.md @@ -36,7 +36,7 @@ {% endnote %} -1. Введите название и описание для формы и нажмите **{{ ui-key.startrek.ui_components_PageCreateIssueForm.continue }}**. +1. Введите название и описание для формы и нажмите **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssueForm.continue }}**. 1. Добавьте поля на форму. @@ -91,10 +91,10 @@ 1. Чтобы изменить порядок расположения форм на странице создания задачи, нажмите на значок ![](../../_assets/tracker/svg/range.svg) и перетащите форму. -1. Чтобы настроить возможность создавать задачи без формы или только с помощью формы, в правом верхнем углу выберите опцию **{{ ui-key.startrek.ui_components_QueueAdminTemplateOptions.allow-empty-template }}**: - * **{{ ui-key.startrek.ui_components_QueueAdminTemplateOptions.always }}** — все пользователи смогут создавать задачи без формы; - * **{{ ui-key.startrek.ui_components_QueueAdminTemplateOptions.never }}** — создание задач будет доступно только через форму; - * **{{ ui-key.startrek.ui_components_QueueAdminTemplateOptions.team }}** — только участники [команды очереди](../manager/queue-team.md) смогут создавать задачи без формы. +1. Чтобы настроить возможность создавать задачи без формы или только с помощью формы, в правом верхнем углу выберите опцию **{{ ui-key.startrek.ui_Queues_smart-components_QueueAdminTemplateOptions.allow-empty-template }}**: + * **{{ ui-key.startrek.ui_Queues_smart-components_QueueAdminTemplateOptions.always }}** — все пользователи смогут создавать задачи без формы; + * **{{ ui-key.startrek.ui_Queues_smart-components_QueueAdminTemplateOptions.never }}** — создание задач будет доступно только через форму; + * **{{ ui-key.startrek.ui_Queues_smart-components_QueueAdminTemplateOptions.team }}** — только участники [команды очереди](../manager/queue-team.md) смогут создавать задачи без формы. ## Управлять формами {#manage-template} @@ -124,15 +124,15 @@ 1. Выберите форму и нажмите кнопку ![](../../_assets/horizontal-ellipsis.svg). -1. Выберите **{{ ui-key.startrek.ui_components_PageCreateIssue.change-title-and-description }}**. +1. Выберите **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssue.change-title-and-description }}**. -1. Введите новые название и описание формы и нажмите **{{ ui-key.startrek.ui_components_queue-admin-tab-main_QueueAdminTabMain.save }}**. +1. Введите новые название и описание формы и нажмите **Сохранить**. ### Изменить форму {#edit-template} 1. Выберите форму и нажмите кнопку ![](../../_assets/horizontal-ellipsis.svg). -1. Выберите **{{ ui-key.startrek.ui_components_PageCreateIssue.change-template }}**. +1. Выберите **{{ ui-key.startrek.ui_Issues_pages_PageCreateIssue.change-template }}**. 1. Отредактируйте вопросы формы во встроенном конструкторе {{ forms-full-name }} и настройте интеграции с {{ tracker-name }}, как при [создании формы](#create-template). diff --git a/ru/tracker/user/gitlab.md b/ru/tracker/user/gitlab.md index 9c7ef77e18d..63d8324e043 100644 --- a/ru/tracker/user/gitlab.md +++ b/ru/tracker/user/gitlab.md @@ -8,7 +8,7 @@ description: Из статьи вы узнаете, как работает св ## Настроить связь {#relation} -В [задачах {{ tracker-name }}](../about-tracker.md#zadacha) можно автоматически добавлять ссылки на [мерж-реквесты]({{ gl.docs }}/ee/user/project/merge_requests/) из {{ GL }}, указывая [ключ](../glossary.md#key) нужной задачи в названии или описании нового мерж-реквеста. Ссылки будут размещаться в разделе [{{ ui-key.startrek.ui_components_issue-links_ExternalLinksCollapse.external-relations}}](../external-links.md). +В [задачах {{ tracker-name }}](../about-tracker.md#zadacha) можно автоматически добавлять ссылки на [мерж-реквесты]({{ gl.docs }}/ee/user/project/merge_requests/) из {{ GL }}, указывая [ключ](../glossary.md#key) нужной задачи в названии или описании нового мерж-реквеста. Ссылки будут размещаться в разделе [{{ ui-key.startrek.ui_Issues_smart-components_issue-links_ExternalLinksCollapse.external-relations}}](../external-links.md). Дополнительно можно включить автоматическое создание комментариев в задаче с информацией о мерж-реквестах. Автоматическое комментирование доступно только для [{{ mgl-name }}](../../managed-gitlab/). diff --git a/ru/tracker/user/issues-stat.md b/ru/tracker/user/issues-stat.md index f9e56ee350d..222f80a2961 100644 --- a/ru/tracker/user/issues-stat.md +++ b/ru/tracker/user/issues-stat.md @@ -16,7 +16,7 @@ - **Источник задач** — фильтр, на основе которого формируется список задач. Вы можете выбрать [системный](default-filters.md) или [созданный ранее](create-filter.md) фильтр из списка или задать фильтр с помощью [языка запросов](query-filter.md) или параметров. -- **Количество строк на странице** — максимальное количество строк диаграммы, которые отображаются в виджете. Если строк окажется больше, вы сможете воспользоваться кнопкой **{{ ui-key.startrek.ui_components_dashboard_TableWidget.show-all }}** в нижней части виджета. +- **Количество строк на странице** — максимальное количество строк диаграммы, которые отображаются в виджете. Если строк окажется больше, вы сможете воспользоваться кнопкой **Показать все** в нижней части виджета. - **Ключевой параметр** — параметр задач, по которому собирается статистика. diff --git a/ru/tracker/user/login.md b/ru/tracker/user/login.md index 21fb08c8d61..90eca3bf2db 100644 --- a/ru/tracker/user/login.md +++ b/ru/tracker/user/login.md @@ -22,7 +22,7 @@ Чтобы войти в {{ tracker-full-name }}: -1. Перейдите в [{{ tracker-name }}]({{ link-tracker }}). Нажмите кнопку **{{ ui-key.startrek.ui_components_promo_Page.login-button-label }}**. +1. Перейдите в [{{ tracker-name }}]({{ link-tracker }}). Нажмите кнопку **{{ ui-key.startrek.ui_Common_pages_promo_Page.login-button-label }}**. 1. Выберите аккаунт, который вы используете для работы в {{ tracker-name }}: diff --git a/ru/tracker/user/manage-autoaction.md b/ru/tracker/user/manage-autoaction.md index 1535ce96645..920bb3bfc6f 100644 --- a/ru/tracker/user/manage-autoaction.md +++ b/ru/tracker/user/manage-autoaction.md @@ -2,7 +2,7 @@ 1. {% include [go to settings](../../_includes/tracker/transition-page.md) %} -1. В правом верхнем углу нажмите ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В правом верхнем углу нажмите ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. На панели слева выберите **Автоматизация** → **Автодействия**. diff --git a/ru/tracker/user/manage-trigger.md b/ru/tracker/user/manage-trigger.md index 7f6a4130eae..726762f700b 100644 --- a/ru/tracker/user/manage-trigger.md +++ b/ru/tracker/user/manage-trigger.md @@ -13,7 +13,7 @@ description: Следуя данной инструкции, вы сможете 1. {% include [go to settings](../../_includes/tracker/transition-page.md) %} -1. В правом верхнем углу нажмите ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В правом верхнем углу нажмите ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. На панели слева выберите **Автоматизация** → **Триггеры**. diff --git a/ru/tracker/user/move-ticket.md b/ru/tracker/user/move-ticket.md index 6657902eaf5..833c0c13735 100644 --- a/ru/tracker/user/move-ticket.md +++ b/ru/tracker/user/move-ticket.md @@ -17,7 +17,7 @@ description: Следуя данной инструкции, вы сможете 1. Откройте задачу, которую хотите перенести. -1. В правом верхнем углу выберите **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.move-issue }}**. +1. В правом верхнем углу выберите **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.move-issue }}**. 1. Укажите очередь, в которую вы хотите перенести задачу и нажмите кнопку **Сохранить**. diff --git a/ru/tracker/user/my-tickets.md b/ru/tracker/user/my-tickets.md index 49bf5148e54..65aa41baf08 100644 --- a/ru/tracker/user/my-tickets.md +++ b/ru/tracker/user/my-tickets.md @@ -30,11 +30,11 @@ description: Из статьи вы узнаете, как можно посмо * **Я исполнитель**. * **Я наблюдатель**. * **Ждут ответа**. - * **{{ ui-key.startrek.ui_components_IssuesPresetSelect.preset-deadline }}**. + * **{{ ui-key.startrek.ui_Issues_smart-components_IssuesPresetSelect.preset-deadline }}**. * Чтобы отфильтровать задачи по [резолюции](../manager/create-resolution.md), нажмите кнопку **Резолюция** и выберите нужные значения из списка. -* Чтобы использовать [дополнительные параметры поиска](./default-filters.md#add-condition), нажмите кнопку ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_components_filter-pane_FieldsSelectButton.add-filter-field-button-title }}** и выберите поле. +* Чтобы использовать [дополнительные параметры поиска](./default-filters.md#add-condition), нажмите кнопку ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_Common_smart-components_filter-pane_FieldsSelectButton.add-filter-field-button-title }}** и выберите поле. ## Найти задачи по названию {#search-name} @@ -42,7 +42,7 @@ description: Из статьи вы узнаете, как можно посмо 1. На панели слева откройте ![](../../_assets/tracker/svg/tasks.svg) **Задачи** или перейдите по [ссылке]({{ link-tracker }}issues/). -1. В поле **{{ ui-key.startrek.ui_components_filter-pane.search-placeholder }}** введите текст для поиска. +1. В поле **{{ ui-key.startrek.ui_Common_smart-components_filter-pane.search-placeholder }}** введите текст для поиска. Поиск задачи осуществляется с учетом указанных фильтров. diff --git a/ru/tracker/user/notifications-projects-portfolios.md b/ru/tracker/user/notifications-projects-portfolios.md index ab5752e0851..5648d5d561e 100644 --- a/ru/tracker/user/notifications-projects-portfolios.md +++ b/ru/tracker/user/notifications-projects-portfolios.md @@ -39,7 +39,7 @@ * Вы назначены заказчиком. * Изменено описание. -* Изменены следующие поля: **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--startDate }}**, **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--endDate }}**, **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--lead }}**, **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--teamUsers }}**. +* Изменены следующие поля: **Дата начала**, **Дедлайн**, **Ответственный**, **Участники**. * После изменения даты начала или даты завершения изменились кварталы, на которые поставлен проект. * Добавлен комментарий. * Добавлена реакция на комментарий. @@ -51,7 +51,7 @@ Если вы заказчик в портфеле, то будете получать уведомления о следующих изменениях в нем: * Вы назначены заказчиком. -* Изменены следующие поля: **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--startDate }}**, **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--endDate }}**, **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--status }}**, **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--lead }}**, **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--teamUsers }}**. +* Изменены следующие поля: **Дата начала**, **Дедлайн**, **Статус**, **Ответственный**, **Участники**. * После изменения даты начала или даты завершения изменились кварталы, на которые поставлен портфель. * Добавлен комментарий. * Добавлена реакция на комментарий. @@ -62,9 +62,9 @@ Если вы участник в портфеле или проекте, то будете получать уведомления о следующих изменениях в нем: * Вы назначены участником. -* Изменены следующие поля: **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--startDate }}**, **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--endDate }}**, **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--lead }}**, **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--teamUsers }}**. +* Изменены следующие поля: **Дата начала**, **Дедлайн**, **Ответственный**, **Участники**. * После изменения даты начала или даты завершения изменились кварталы, на которые поставлен проект или портфель. * Изменено описание. * Добавлен комментарий. * Добавлена реакция на комментарий. -* Для портфелей: изменено поле **{{ ui-key.startrek.ui_components_projects_Sidebar.sidebar-param-title--status }}**. \ No newline at end of file +* Для портфелей: изменено поле **Статус**. \ No newline at end of file diff --git a/ru/tracker/user/personal.md b/ru/tracker/user/personal.md index 9ecbe00f831..8779103a830 100644 --- a/ru/tracker/user/personal.md +++ b/ru/tracker/user/personal.md @@ -6,7 +6,7 @@ Вы можете настроить вашу [стартовую страницу](startpage.md) в старом интерфейсе так, чтобы на ней отображался любой из предложенных вариантов: -* [**{{ ui-key.startrek.ui_components_page-my_PageMy.page-title }}**](startpage.md#my-page); +* [**{{ ui-key.startrek.ui_Common_pages_page-my_PageMy.page-title }}**](startpage.md#my-page); * [фильтр](create-filter.md); * [дашборд](dashboard.md); * [доска задач](../manager/create-agile-board.md). diff --git a/ru/tracker/user/query-filter.md b/ru/tracker/user/query-filter.md index 119ad563221..1fcece8fbaf 100644 --- a/ru/tracker/user/query-filter.md +++ b/ru/tracker/user/query-filter.md @@ -25,7 +25,7 @@ description: В этом разделе описан язык запросов { 1. Откройте страницу [**Задачи**]({{ link-tracker }}issues). -1. В правом верхнем углу страницы нажмите кнопку ![](../../_assets/tracker/svg/query-language.svg) **{{ ui-key.startrek.ui_components_dashboard_FilterEditor.editor-source-radio-query }}**. +1. В правом верхнем углу страницы нажмите кнопку ![](../../_assets/tracker/svg/query-language.svg) **Язык запросов**. 1. Введите запрос и нажмите кнопку **Применить**. diff --git a/ru/tracker/user/queue.md b/ru/tracker/user/queue.md index 8cba98faaac..c8d6ab4dccc 100644 --- a/ru/tracker/user/queue.md +++ b/ru/tracker/user/queue.md @@ -4,7 +4,7 @@ Чтобы просмотреть все задачи очереди, откройте ее страницу: -1. На панели слева выберите ![](../../_assets/tracker/svg/queues.svg) **{{ ui-key.startrek.ui_components_TrackerSearch.queues }}**. +1. На панели слева выберите ![](../../_assets/tracker/svg/queues.svg) **{{ ui-key.startrek.ui_Common_smart-components_TrackerSearch.queues }}**. 1. Выберите фильтр для отображения списка очередей: * **Мои очереди**. @@ -20,7 +20,7 @@ 1. Нажмите на название нужной очереди. -По умолчанию на странице очереди отображаются только активные задачи (опция **{{ ui-key.startrek.ui_components_projects_utils.field-name-resolution }}: {{ ui-key.startrek.ui_components_projects_utils.filter-macro-empty_ }}**). Вы можете настроить отображение задач с помощью кнопок [фильтров по параметрам](../manager/quick-filters.md) над списком задач. +По умолчанию на странице очереди отображаются только активные задачи (опция **{{ ui-key.startrek.ui_Portfolios_smart-components_project-list_utils.field-name-resolution }}: {{ ui-key.startrek.ui_Portfolios_smart-components_project-list_utils.filter-macro-empty_ }}**). Вы можете настроить отображение задач с помощью кнопок [фильтров по параметрам](../manager/quick-filters.md) над списком задач. ## Добавить очередь в избранное {#queue-fav} @@ -28,11 +28,11 @@ 1. Откройте страницу очереди. -1. Вверху страницы над названием очереди нажмите на значок ![](../../_assets/tracker/svg/favourites.svg) **{{ ui-key.startrek.ui_components_entity-page_macros_FavoriteButton.button-tooltip-add }}**. +1. Вверху страницы над названием очереди нажмите на значок ![](../../_assets/tracker/svg/favourites.svg) **{{ ui-key.startrek.ui_Common_smart-components_entity-page_macros_FavoriteButton.button-tooltip-add }}**. Чтобы открыть список избранных очередей: -1. На панели слева выберите ![](../../_assets/tracker/svg/queues.svg) **{{ ui-key.startrek.ui_components_TrackerSearch.queues }}**. +1. На панели слева выберите ![](../../_assets/tracker/svg/queues.svg) **{{ ui-key.startrek.ui_Common_smart-components_TrackerSearch.queues }}**. 1. В списке справа выберите фильтр **Избранные**. @@ -49,7 +49,7 @@ Чтобы сохранить список задач в файл: -1. В правом верхнем углу страницы нажмите ![](../../_assets/horizontal-ellipsis.svg) → ![](../../_assets/tracker/svg/export.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.export }}**. +1. В правом верхнем углу страницы нажмите ![](../../_assets/horizontal-ellipsis.svg) → ![](../../_assets/tracker/svg/export.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.export }}**. 1. Выберите формат, в котором вы хотите сохранить список задач. diff --git a/ru/tracker/user/reminder.md b/ru/tracker/user/reminder.md index bced7b4f65b..b0a11c7921b 100644 --- a/ru/tracker/user/reminder.md +++ b/ru/tracker/user/reminder.md @@ -14,7 +14,7 @@ {% endnote %} -1. В правом верхнем углу выберите **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.add-notification }}**. +1. В правом верхнем углу выберите **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.add-notification }}**. 1. Укажите дату и время напоминания. @@ -46,6 +46,6 @@ 1. Откройте страницу задачи. -1. В правом верхнем углу выберите **{{ ui-key.startrek.ui_components_actions-panel_ActionsPanel.action-menu-title }}** → **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.create-calendar-event }}** → **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.calendar-event-me }}**. +1. В правом верхнем углу выберите **{{ ui-key.startrek.ui_Common_smart-components_actions-panel_ActionsPanel.action-menu-title }}** → **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.create-calendar-event }}** → **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.calendar-event-me }}**. 1. Введите информацию о событии в календаре, при необходимости добавьте участников встречи и нажмите **Создать**. diff --git a/ru/tracker/user/startpage-dashboard.md b/ru/tracker/user/startpage-dashboard.md index 1f0d4d47bb7..24d4ab63287 100644 --- a/ru/tracker/user/startpage-dashboard.md +++ b/ru/tracker/user/startpage-dashboard.md @@ -1,3 +1,3 @@ # Как сделать дашборд стартовой страницей -Вы можете сделать [стартовой страницей](startpage.md) любой из дашбордов, к которому у вас есть доступ. Для этого на странице с дашбордом, в правом верхнем углу, нажмите ![](../../_assets/tracker/svg/actions.svg) → **{{ ui-key.startrek.ui_components_dashboard_DashboardActionsMenu.set-start-page-action }}**. +Вы можете сделать [стартовой страницей](startpage.md) любой из дашбордов, к которому у вас есть доступ. Для этого на странице с дашбордом, в правом верхнем углу, нажмите ![](../../_assets/tracker/svg/actions.svg) → **Сделать стартовой**. diff --git a/ru/tracker/user/startpage.md b/ru/tracker/user/startpage.md index 75ed2c1c403..4123de86564 100644 --- a/ru/tracker/user/startpage.md +++ b/ru/tracker/user/startpage.md @@ -6,7 +6,7 @@ description: Узнайте, как настроить стартовую стр # Стартовая страница -Стартовая страница открывается при нажатии на логотип {{ tracker-name }}. Вы можете [выбрать](#change-start-page), какую страницу использовать в качестве стартовой. По умолчанию выбрана [**{{ ui-key.startrek.ui_components_page-my_PageMy.page-title }}**](https://tracker.yandex.ru/pages/my) — персональная для каждого пользователя страница с несколькими виджетами: +Стартовая страница открывается при нажатии на логотип {{ tracker-name }}. Вы можете [выбрать](#change-start-page), какую страницу использовать в качестве стартовой. По умолчанию выбрана [**{{ ui-key.startrek.ui_Common_pages_page-my_PageMy.page-title }}**](https://tracker.yandex.ru/pages/my) — персональная для каждого пользователя страница с несколькими виджетами: * [информация для сотрудников](#staff-widget) — настраивается администратором для всех сотрудников организации; * [полезная информация о {{ tracker-name }}](#tracker-info); @@ -31,8 +31,8 @@ description: Узнайте, как настроить стартовую стр Виджет с информацией для сотрудников публикует администратор организации, и только администратор может редактировать его или удалить. Чтобы опубликовать виджет: -1. На странице **{{ ui-key.startrek.ui_components_page-my_PageMy.page-title }}** нажмите **{{ ui-key.startrek.ui_components_dashboard_DashboardHeader.dashboard-header-settings-button }}** → **{{ ui-key.startrek.ui_components_dashboard_DashboardHeader.dashboard-header-add-button }}** → **{{ ui-key.startrek.ui_components_dashboard_DashboardHeader.dashboard-header-add-orgAdmin }}**. -1. Включите опцию **{{ ui-key.startrek.ui_components_dashboard_OrgAdminEditor.editor-published-field-label }}**. +1. На странице **{{ ui-key.startrek.ui_Common_pages_page-my_PageMy.page-title }}** нажмите **{{ ui-key.startrek.ui_Dashboards_smart-components_DashboardHeader.dashboard-header-settings-button }}** → **{{ ui-key.startrek.ui_Dashboards_smart-components_DashboardHeader.dashboard-header-add-button }}** → **{{ ui-key.startrek.ui_Dashboards_smart-components_DashboardHeader.dashboard-header-add-orgAdmin }}**. +1. Включите опцию **{{ ui-key.startrek.ui_Dashboards_smart-components_OrgAdminEditor.editor-published-field-label }}**. {% note tip %} @@ -41,7 +41,7 @@ description: Узнайте, как настроить стартовую стр {% endnote %} 1. Заполните содержимое виджета. -1. Нажмите **{{ ui-key.startrek.ui_components_dashboard_OrgAdminEditor.editor-save-button }}**. +1. Нажмите **{{ ui-key.startrek.ui_Dashboards_smart-components_OrgAdminEditor.editor-save-button }}**. ### Виджет с полезной информацией о {{ tracker-name }} {#tracker-info} @@ -76,7 +76,7 @@ description: Узнайте, как настроить стартовую стр -В качестве стартовой страницы вы можете использовать любой [фильтр](create-filter.md), [дашборд](dashboard.md) или [доску задач](../manager/create-agile-board.md). При этом **{{ ui-key.startrek.ui_components_page-my_PageMy.page-title }}** останется доступной по прямой ссылке: [https://tracker.yandex.ru/pages/my](https://tracker.yandex.ru/pages/my) или по нажатию на домик в шапке {{ tracker-name }}. +В качестве стартовой страницы вы можете использовать любой [фильтр](create-filter.md), [дашборд](dashboard.md) или [доску задач](../manager/create-agile-board.md). При этом **{{ ui-key.startrek.ui_Common_pages_page-my_PageMy.page-title }}** останется доступной по прямой ссылке: [https://tracker.yandex.ru/pages/my](https://tracker.yandex.ru/pages/my) или по нажатию на домик в шапке {{ tracker-name }}. Пока сменить стартовую страницу можно только в старом интерфейсе: 1. {% include [open-personal-settings](../../_includes/tracker/open-personal-settings.md) %} diff --git a/ru/tracker/user/subscribe.md b/ru/tracker/user/subscribe.md index 022aafbd1d3..b805e4a820e 100644 --- a/ru/tracker/user/subscribe.md +++ b/ru/tracker/user/subscribe.md @@ -18,7 +18,7 @@ 1. Откройте страницу задачи. -1. На правой панели в поле **{{ ui-key.startrek-backend.fields.issue.followers }}** нажмите **Добавить меня**. Если поля **{{ ui-key.startrek-backend.fields.issue.followers }}** нет, добавьте его с помощью кнопки ![](../../_assets/tracker/svg/add-task.svg) **{{ ui-key.startrek.ui_components_entity-page_sidebar_SidebarFieldsSelect.add-sidebar-field }}**. +1. На правой панели в поле **{{ ui-key.startrek-backend.fields.issue.followers }}** нажмите **Добавить меня**. Если поля **{{ ui-key.startrek-backend.fields.issue.followers }}** нет, добавьте его с помощью кнопки ![](../../_assets/tracker/svg/add-task.svg) **{{ ui-key.startrek.ui_Common_smart-components_entity-page_sidebar_SidebarFieldsSelect.add-sidebar-field }}**. Если вы все сделали правильно, в поле наблюдатели появится ваше имя. Теперь вы будете получать письма с уведомлениями о любых изменениях этой задачи. @@ -35,9 +35,9 @@ 1. Откройте [страницу очереди](queue.md). -1. В правом верхнем углу нажмите значок ![](../../_assets/tracker/svg/actions.svg). Затем нажмите ![](../../_assets/tracker/svg/subscribe.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.subscribe }}** и выберите значение: - - **{{ ui-key.startrek.ui_components_PageQueue_header.subscribe-new-tickets }}**, чтобы получать уведомления о создании новых задач в очереди. Вы также будете подписаны на все события, которые указаны в [настройках уведомлений](user-notifications.md#sec_add_role) для роли **{{ ui-key.startrek-backend.roles.role.name.queue-follower-key-value }}**. - - **{{ ui-key.startrek.ui_components_PageQueue_header.subscribe-all }}**, чтобы получать уведомления о любых изменениях задач очереди. +1. В правом верхнем углу нажмите значок ![](../../_assets/tracker/svg/actions.svg). Затем нажмите ![](../../_assets/tracker/svg/subscribe.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.subscribe }}** и выберите значение: + - **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.subscribe-new-tickets }}**, чтобы получать уведомления о создании новых задач в очереди. Вы также будете подписаны на все события, которые указаны в [настройках уведомлений](user-notifications.md#sec_add_role) для роли **{{ ui-key.startrek-backend.roles.role.name.queue-follower-key-value }}**. + - **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.subscribe-all }}**, чтобы получать уведомления о любых изменениях задач очереди. Вы также можете [выбрать события](user-subscriptions.md), уведомления о которых хотите получать. diff --git a/ru/tracker/user/summary-table-with-totals.md b/ru/tracker/user/summary-table-with-totals.md index 6a1b9416564..5e9d272ad41 100644 --- a/ru/tracker/user/summary-table-with-totals.md +++ b/ru/tracker/user/summary-table-with-totals.md @@ -16,7 +16,7 @@ - **Ячейки** — параметр, сумма значений которого приводится на пересечениях. -- **Количество строк на странице** — максимальное количество строк таблицы, которые отображаются в виджете. Если строк окажется больше, вы сможете воспользоваться кнопкой **{{ ui-key.startrek.ui_components_dashboard_TableWidget.show-all }}** в нижней части виджета. +- **Количество строк на странице** — максимальное количество строк таблицы, которые отображаются в виджете. Если строк окажется больше, вы сможете воспользоваться кнопкой **Показать все** в нижней части виджета. - **Сортировка в строках** — порядок сортировки строк таблицы. diff --git a/ru/tracker/user/summary-table.md b/ru/tracker/user/summary-table.md index 876c56bccde..271d3a2f7bc 100644 --- a/ru/tracker/user/summary-table.md +++ b/ru/tracker/user/summary-table.md @@ -14,7 +14,7 @@ - **Строки** — параметр, по которому строятся строки таблицы. -- **Количество строк на странице** — максимальное количество строк таблицы, которые отображаются в виджете. Если строк окажется больше, вы сможете воспользоваться кнопкой **{{ ui-key.startrek.ui_components_dashboard_TableWidget.show-all }}** в нижней части виджета. +- **Количество строк на странице** — максимальное количество строк таблицы, которые отображаются в виджете. Если строк окажется больше, вы сможете воспользоваться кнопкой **Показать все** в нижней части виджета. - **Сортировка** — порядок сортировки строк таблицы. diff --git a/ru/tracker/user/ticket-links.md b/ru/tracker/user/ticket-links.md index d9739d0ac0f..9cce702aa11 100644 --- a/ru/tracker/user/ticket-links.md +++ b/ru/tracker/user/ticket-links.md @@ -34,11 +34,11 @@ 1. Откройте страницу задачи, к которой вы хотите создать подзадачу. -1. В правом верхнем углу выберите **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.create-subissue }}**. +1. В правом верхнем углу выберите **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.create-subissue }}**. 1. Заполните поля так же, как при [создании новой задачи](./create-ticket.md). -1. Нажмите кнопку **{{ ui-key.startrek.ui_components_CreateIssueForm.create-issue }}**. Вверху страницы над названием подзадачи отобразится ссылка на родительскую задачу. +1. Нажмите кнопку **Создать задачу**. Вверху страницы над названием подзадачи отобразится ссылка на родительскую задачу. ## Изменить тип связи {#change-link-type} @@ -64,7 +64,7 @@ Задачу можно сделать частью более крупной (родительской) задачи: -1. В правом верхнем углу выберите **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.to-subissue }}**. +1. В правом верхнем углу выберите **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.to-subissue }}**. 1. Укажите ключ или название родительской задачи, затем выберите ее из списка. Найти ключ можно на странице задачи над ее названием (например, `TEST-1234`). @@ -74,7 +74,7 @@ 1. Откройте страницу подзадачи. -1. В правом верхнем углу выберите **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.to-subissue }}**. +1. В правом верхнем углу выберите **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.title }}** → **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.to-subissue }}**. 1. Укажите ключ или название новой родительской задачи, затем выберите ее из списка. Найти ключ можно на странице задачи над ее названием (например, `TEST-1234`). diff --git a/ru/tracker/user/ticket-schedule.md b/ru/tracker/user/ticket-schedule.md index 23af755c566..a53da76d5c1 100644 --- a/ru/tracker/user/ticket-schedule.md +++ b/ru/tracker/user/ticket-schedule.md @@ -14,7 +14,7 @@ 1. {% include [go to settings](../../_includes/tracker/transition-page.md) %} -1. В правом верхнем углу нажмите ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. +1. В правом верхнем углу нажмите ![](../../_assets/tracker/svg/queue-settings.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. 1. На панели слева выберите **Автодействия**. @@ -46,7 +46,7 @@ 1. В блоке **Действие** нажмите кнопку **Создать задачу**. -1. В окне **Создание задачи** заполните поля шаблона для автоматического создания задач и нажмите кнопку **{{ ui-key.startrek.ui_components_FieldEdit.form-submit }}**. +1. В окне **Создание задачи** заполните поля шаблона для автоматического создания задач и нажмите кнопку **Сохранить**. 1. Если вы хотите создавать несколько задач в одном автодействии, снова нажмите кнопку **Создать задачу** и заполните поля новой задачи. diff --git a/ru/tracker/user/time-spent.md b/ru/tracker/user/time-spent.md index 4fe5255e62b..ddfee5e8fff 100644 --- a/ru/tracker/user/time-spent.md +++ b/ru/tracker/user/time-spent.md @@ -9,7 +9,7 @@ Управлять учетом времени можно двумя способами: * [Базовый способ](#limited-spent-time) — использовать действие **Указать затраченное время** в списке действий. -* [Расширенный способ](#extended-spent-time) — использовать раздел **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** на панели справа. +* [Расширенный способ](#extended-spent-time) — использовать раздел **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** на панели справа. Рекомендуем использовать расширенный способ учета времени: он более гибкий в настройке и простой в использовании. @@ -36,15 +36,15 @@ 1. Откройте страницу задачи. -1. В правом верхнем углу выберите **{{ ui-key.startrek.ui_components_actions-panel_ActionsPanel.action-menu-title }}** → **{{ ui-key.startrek.ui_components_issue-actions_IssueMenu.add-worklog }}**. +1. В правом верхнем углу выберите **{{ ui-key.startrek.ui_Common_smart-components_actions-panel_ActionsPanel.action-menu-title }}** → **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_IssueMenu.add-worklog }}**. -1. Заполните поле **{{ ui-key.startrek.ui_components_issue-actions_worklog_AddWorklogDialog.duration-label }}**. +1. Заполните поле **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_worklog_AddWorklogDialog.duration-label }}**. Например: * 1 неделя и 3 дня — `1н 3д`, `1w 3d`. * 3 часа 20 минут 30 секунд — `3ч 20м 30с`, `3h 20m 30s`. -1. Заполните поле **{{ ui-key.startrek.ui_components_issue-actions_worklog_AddWorklogDialog.date-label }}**, указав дату и время в текущем часовом поясе. +1. Заполните поле **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_worklog_AddWorklogDialog.date-label }}**, указав дату и время в текущем часовом поясе. {% note info %} @@ -56,7 +56,7 @@ 1. При необходимости оставьте комментарий. Комментарий не будет виден в задаче, но сохранится в [Отчете по затратам времени](../manager/statistics.md#section_uxt_3ft_xz) и в [Истории изменений задачи](#records-history). -1. Нажмите кнопку **{{ ui-key.startrek.ui_components_issue-actions_worklog_AddWorklogDialog.apply-button }}**. +1. Нажмите кнопку **{{ ui-key.startrek.ui_Issues_smart-components_issue-actions_worklog_AddWorklogDialog.apply-button }}**. {% note info %} @@ -74,7 +74,7 @@ Если в задаче не отображается блок **Учёт времени**, добавьте его: -1. Нажмите кнопку ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_components_entity-page_sidebar_SidebarFieldsSelect.add-sidebar-field }}** на панели справа. +1. Нажмите кнопку ![](../../_assets/tracker/svg/add-filter.svg) **{{ ui-key.startrek.ui_Common_smart-components_entity-page_sidebar_SidebarFieldsSelect.add-sidebar-field }}** на панели справа. 1. В группе **{{ ui-key.startrek-backend.fields.issue.fields.timetracking }}** включите опции **{{ ui-key.startrek-backend.fields.issue.spent-key-value }}** и **{{ ui-key.startrek-backend.fields.issue.estimation-key-value }}**. @@ -92,24 +92,24 @@ Чтобы включить расширенный учет времени для задач очереди: 1. Откройте [страницу очереди](queue.md). -1. В правом верхнем углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_components_PageQueue_header.settings }}**. -1. Перейдите на вкладку **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}**. -1. Включите опцию **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-track-time-in-issues }}**. -1. В поле **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-working-calendar }}** выберите один из доступных вариантов. -1. Нажмите **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.save }}**. +1. В правом верхнем углу нажмите ![](../../_assets/tracker/svg/settings-old.svg) **{{ ui-key.startrek.ui_Queues_pages_PageQueue_header.settings }}**. +1. Перейдите на вкладку **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}**. +1. Включите опцию **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-track-time-in-issues }}**. +1. В поле **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-working-calendar }}** выберите один из доступных вариантов. +1. Нажмите **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.save }}**. -После этого в задачах очереди появится новый раздел **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}**. В него будут перенесены все данные полей задачи из категории **Учёт времени**. +После этого в задачах очереди появится новый раздел **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}**. В него будут перенесены все данные полей задачи из категории **Учёт времени**. -Чтобы перейти обратно на базовый учет времени, в настройках очереди отключите опцию **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-track-time-in-issues }}**. Данные из раздела **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** будут перенесены в поля категории **Учёт времени**. +Чтобы перейти обратно на базовый учет времени, в настройках очереди отключите опцию **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-track-time-in-issues }}**. Данные из раздела **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** будут перенесены в поля категории **Учёт времени**. ### Указать затраченное время {#add-extended-time-spent} Чтобы зарегистрировать затраченное время: -1. Убедитесь, что в настройках очереди включена опция **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-track-time-in-issues }}**. +1. Убедитесь, что в настройках очереди включена опция **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-track-time-in-issues }}**. 1. Откройте страницу задачи. -1. На панели справа нажмите **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}**. -1. Заполните поле **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.save }}**. +1. На панели справа нажмите **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}**. +1. Заполните поле **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.save }}**. Например: @@ -117,24 +117,24 @@ * 3 часа 20 минут 30 секунд — `3ч 20м 30с`, `3h 20m 30s`. * Четыре [предпочтительных единицы времени](../manager/queue-spent-time.md#displayed-time) — `4`. -1. В поле **{{ ui-key.startrek.ui_components_FormField_TimeTrackingBlock.field-datetime-title }}** укажите дату и время, которые будут отображаться в записи по учету времени. -1. При желании в поле **{{ ui-key.startrek.ui_components_FormField_TimeTrackingBlock.field-comment-title }}** добавьте комментарий к записи. -1. Нажмите **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.save }}**. +1. В поле **{{ ui-key.startrek.ui_Common_smart-components_FormField_TimeTrackingBlock.field-datetime-title }}** укажите дату и время, которые будут отображаться в записи по учету времени. +1. При желании в поле **{{ ui-key.startrek.ui_Common_smart-components_FormField_TimeTrackingBlock.field-comment-title }}** добавьте комментарий к записи. +1. Нажмите **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.save }}**. Вы также можете указывать затраченное время [способом из базового учета времени](#add-limited-time-spent). ### Смотреть и редактировать историю записей {#records-history} -Чтобы открыть историю всех записей об учтенном для задачи времени, на панели справа в правой части поля **{{ ui-key.startrek.ui_components_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** нажмите ![](../../_assets/tracker/svg/history.svg). Откроется окно **{{ ui-key.startrek.ui_components_FormField_TimeTrackingBlock.field-comment-title }}**. +Чтобы открыть историю всех записей об учтенном для задачи времени, на панели справа в правой части поля **{{ ui-key.startrek.ui_Queues_pages_page-queue-admin_QueueAdminPageContent.menu-item-timetracking }}** нажмите ![](../../_assets/tracker/svg/history.svg). Откроется окно **{{ ui-key.startrek.ui_Common_smart-components_FormField_TimeTrackingBlock.field-comment-title }}**. {% note alert %} -Редактировать историю записей можно, только если в [настройках учета времени](../manager/queue-spent-time.md) включена опция **{{ ui-key.startrek.ui_components_timetracking-history-dialog_TimeTrackingHistoryDialog.title }}**. +Редактировать историю записей можно, только если в [настройках учета времени](../manager/queue-spent-time.md) включена опция **{{ ui-key.startrek.ui_Common_smart-components_timetracking-history-dialog_TimeTrackingHistoryDialog.title }}**. {% endnote %} -Автор записи может изменить у записей поля **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-can-assignee-update-time }}** и **{{ ui-key.startrek.ui_components_timetracking-history-dialog_TimeTrackingDialogBody.column-date }}**. Чтобы сделать это, справа от значения нужного поля нажмите ![](../../_assets/tracker/svg/icon-edit2.svg) и введите новое значение. Поле **{{ ui-key.startrek.ui_components_timetracking-history-dialog_TimeTrackingDialogBody.column-spent }}** изменить нельзя. +Автор записи может изменить у записей поля **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-can-assignee-update-time }}** и **{{ ui-key.startrek.ui_Common_smart-components_timetracking-history-dialog_TimeTrackingDialogBody.column-date }}**. Чтобы сделать это, справа от значения нужного поля нажмите ![](../../_assets/tracker/svg/icon-edit2.svg) и введите новое значение. Поле **{{ ui-key.startrek.ui_Common_smart-components_timetracking-history-dialog_TimeTrackingDialogBody.column-spent }}** изменить нельзя. -Если запись была отредактирована, то справа от значения поля **{{ ui-key.startrek.ui_components_queue-admin-tab-timetracking_TimetackingForm.field-can-assignee-update-time }}** появится значок ![](../../_assets/tracker/svg/history.svg). Если навести на него указатель, появится всплывающее окно с историей изменений записи. +Если запись была отредактирована, то справа от значения поля **{{ ui-key.startrek.ui_Queues_pages_queue-admin-tab-timetracking_TimetackingForm.field-can-assignee-update-time }}** появится значок ![](../../_assets/tracker/svg/history.svg). Если навести на него указатель, появится всплывающее окно с историей изменений записи. -Также автор записи может удалить ее. Чтобы сделать это, в правой части записи нажмите ![](../../_assets/tracker/svg/actions.svg) → **{{ ui-key.startrek.ui_components_timetracking-history-dialog_TimeTrackingDialogBody.column-comment }}**. \ No newline at end of file +Также автор записи может удалить ее. Чтобы сделать это, в правой части записи нажмите ![](../../_assets/tracker/svg/actions.svg) → **{{ ui-key.startrek.ui_Common_smart-components_timetracking-history-dialog_TimeTrackingDialogBody.column-comment }}**. \ No newline at end of file diff --git a/ru/tracker/user/votes.md b/ru/tracker/user/votes.md index b526de59b07..ed4dca8def8 100644 --- a/ru/tracker/user/votes.md +++ b/ru/tracker/user/votes.md @@ -19,9 +19,9 @@ description: Следуя данной инструкции, вы сможете Чтобы найти задачи, за которые вы голосовали, воспользуйтесь [языком запросов](query-filter.md): -1. На панели слева выберите ![](../../_assets/tracker/svg/tasks.svg) **Задачи** и в нижней части окна нажмите **{{ ui-key.startrek.ui_components_page-issues_touch.all-issues-filter-title }}**. +1. На панели слева выберите ![](../../_assets/tracker/svg/tasks.svg) **Задачи** и в нижней части окна нажмите **{{ ui-key.startrek.ui_Issues_pages_page-issues_touch.all-issues-filter-title }}**. -1. В правом верхнем углу страницы нажмите кнопку **{{ ui-key.startrek.ui_components_page-issues_touch.query-language }}**. +1. В правом верхнем углу страницы нажмите кнопку **{{ ui-key.startrek.ui_Issues_pages_page-issues_touch.query-language }}**. 1. Введите в строку запрос: diff --git a/ru/tracker/user/wiki.md b/ru/tracker/user/wiki.md index 22fbd11258f..9b024eaedb9 100644 --- a/ru/tracker/user/wiki.md +++ b/ru/tracker/user/wiki.md @@ -34,7 +34,7 @@ 1. Откройте [список доступных задач]({{ link-tracker }}issues) и [настройте фильтрацию](create-filter.md#set-conditions). - 1. В правом верхнем углу страницы нажмите кнопку ![](../../_assets/tracker/svg/icon-export-tasks.svg) **{{ ui-key.startrek.ui_components_FilterExportMenu.menu-item-export }}** → **Копировать список задач**. + 1. В правом верхнем углу страницы нажмите кнопку ![](../../_assets/tracker/svg/icon-export-tasks.svg) **Выгрузить** → **Копировать список задач**. 1. Вставьте список на страницу. diff --git a/ru/troubleshooting/billing/how-to/edi-system-connection.md b/ru/troubleshooting/billing/how-to/edi-system-connection.md index 7b2409163f6..b74fef387d9 100644 --- a/ru/troubleshooting/billing/how-to/edi-system-connection.md +++ b/ru/troubleshooting/billing/how-to/edi-system-connection.md @@ -28,7 +28,7 @@ Через ЭДО можно получить только те документы, которые оформлены после даты подключения ЭДО. -Документы, сформированные ранее потребуется самостоятельно загрузить из [Консоли управления]({{ link-console-main }}) в разделе [**{{ ui-key.yacloud.billing.label_service }}**]({{ link-console-billing }}). +Документы, сформированные ранее потребуется самостоятельно загрузить из [Консоли управления]({{ link-console-main }}) в разделе [**{{ ui-key.yacloud_billing.billing.label_service }}**]({{ link-console-billing }}). {% endnote %} diff --git a/ru/troubleshooting/billing/how-to/edit-invoice-template-or-content.md b/ru/troubleshooting/billing/how-to/edit-invoice-template-or-content.md index 03956474f79..633894e4a22 100644 --- a/ru/troubleshooting/billing/how-to/edit-invoice-template-or-content.md +++ b/ru/troubleshooting/billing/how-to/edit-invoice-template-or-content.md @@ -13,7 +13,7 @@ Корректное начисление услуг в бухгалтерском учете происходит по акту и счету-фактуре. Сейчас нет законодательных актов с указанием того, что составление счета на оплату является обязательным мероприятием при проведении расчетов с контрагентами. -Согласно п. 6.10 [Оферты на заключение договора на использование Сервисов Платформы «Яндекс.Облако»]({{ billing-oferta-url }}?lang=ru), акцептируемой при создании платежного аккаунта, Клиент производит оплату без выставления Яндексом счета. +Согласно п. 6.10 [Оферты на заключение договора на использование Сервисов Платформы «Яндекс.Облако»]({{ billing-oferta-url }}), акцептируемой при создании платежного аккаунта, Клиент производит оплату без выставления Яндексом счета. Это означает, что вы можете отправить перевод и без использования автоматически сформированного счета на оплату. Оплату услуг можно производить на основании Договора и Акта об оказанных услугах. К Акту прилагается расшифровка, которая содержит все необходимые реквизиты лицевого счета и может использоваться для оплаты, главное – правильно указать реквизиты получателя и ЛСО-счет в назначении платежа. diff --git a/ru/troubleshooting/billing/how-to/generating-invoice.md b/ru/troubleshooting/billing/how-to/generating-invoice.md index 03ddd344b2d..33f39e0928d 100644 --- a/ru/troubleshooting/billing/how-to/generating-invoice.md +++ b/ru/troubleshooting/billing/how-to/generating-invoice.md @@ -9,7 +9,7 @@ Счет автоматически отправляется в конце месяца на адрес электронной почты владельца платёжного аккаунта, указанный у этого пользователя [в параметрах Консоли управления]({{ link-console-settings }}). -Также имеется возможность сформировать счёт на оплату самостоятельно [в разделе **{{ ui-key.yacloud.billing.label_service }}**]({{ link-console-billing }}). Чтобы пополнить лицевой счет, воспользуйтесь [этой инструкцией](../../../billing/operations/pay-the-bill#legal-entities.md). +Также имеется возможность сформировать счёт на оплату самостоятельно [в разделе **{{ ui-key.yacloud_billing.billing.label_service }}**]({{ link-console-billing }}). Чтобы пополнить лицевой счет, воспользуйтесь [этой инструкцией](../../../billing/operations/pay-the-bill#legal-entities.md). {% note info %} diff --git a/ru/troubleshooting/billing/how-to/getting-reconcillation-report.md b/ru/troubleshooting/billing/how-to/getting-reconcillation-report.md index 12b868eb8da..3bd64bb08f8 100644 --- a/ru/troubleshooting/billing/how-to/getting-reconcillation-report.md +++ b/ru/troubleshooting/billing/how-to/getting-reconcillation-report.md @@ -59,5 +59,5 @@ Если вышеописанные рекомендации не помогли решить задачу, [создайте запрос в техническую поддержку]({{ link-console-support }}). При создании запроса укажите следующую информацию: -1. Номер договора с ООО «Яндекс.Облако» (имеет вид `XXXXXX/XX`) либо идентификатор платежного аккаунта. Он имеет вид `d2nXXXXXXXXXXXXXXXXX`. Этот идентификатор можно найти [на странице с данными по платежному аккаунту]({{ link-console-billing }}). +1. Номер договора с ООО «Яндекс.Облако» (имеет вид `XXXXXX/XX`) либо идентификатор платежного аккаунта. Он имеет вид `dn2XXXXXXXXXXXXXXXXX`. Этот идентификатор можно найти [на странице с данными по платежному аккаунту]({{ link-console-billing }}). 1. ИНН или КПП вашей организации. diff --git a/ru/troubleshooting/billing/known-issues/billing-account-is-charged-by-unused-resources.md b/ru/troubleshooting/billing/known-issues/billing-account-is-charged-by-unused-resources.md index 41ffe5873d9..924a8588a0e 100644 --- a/ru/troubleshooting/billing/known-issues/billing-account-is-charged-by-unused-resources.md +++ b/ru/troubleshooting/billing/known-issues/billing-account-is-charged-by-unused-resources.md @@ -10,7 +10,7 @@ Проверьте, есть ли в вашем облаке активные или тарифицируемые ресурсы. Например, если вы остановите виртуальную машину в сервисе {{ compute-name }}, тарифицироваться перестанут только вычислительные ресурсы ВМ — ядра vCPU и оперативная память (*RAM*). При этом связанные с ВМ диски, образы и снимки, а также зарезервированные публичные IP-адреса продолжают тарифицироваться. -Чтобы понять, какие продукты продолжают потреблять ресурсы и баланс, ознакомьтесь с детализацией потребления услуг {{ yandex-cloud }}, переключившись на вкладку **{{ ui-key.yacloud.billing.account.detail.tab_product }}** в разделе **{{ ui-key.yacloud.billing.account.detail.label_title }}** на [странице вашего платежного аккаунта]({{ link-console-billing }}). +Чтобы понять, какие продукты продолжают потреблять ресурсы и баланс, ознакомьтесь с детализацией потребления услуг {{ yandex-cloud }}, переключившись на вкладку **{{ ui-key.yacloud_billing.billing.account.detail.tab_product }}** в разделе **{{ ui-key.yacloud_billing.billing.account.detail.label_title }}** на [странице вашего платежного аккаунта]({{ link-console-billing }}). Изучив данные детализации, вы сможете понять, какие именно ресурсы остались активны и продолжают тарифицироваться, и удалить неиспользуемые. diff --git a/ru/troubleshooting/datalens/how-to/marketplace-connector-support.md b/ru/troubleshooting/datalens/how-to/marketplace-connector-support.md index c78f7dcc708..e4d12ea1b04 100644 --- a/ru/troubleshooting/datalens/how-to/marketplace-connector-support.md +++ b/ru/troubleshooting/datalens/how-to/marketplace-connector-support.md @@ -11,5 +11,5 @@ ## Если ничего не получилось {#if-nothing-worked} -Если вышеописанные действия не помогли решить задачу, свяжитесь со службой технической поддержки коннектора МойСклад, отправив обращение с описанием проблемы на адрес их [электронной почты](datalens@htmls.ru). +Если вышеописанные действия не помогли решить задачу, свяжитесь со службой технической поддержки коннектора МойСклад, отправив обращение с описанием проблемы на адрес их [электронной почты](mailto:datalens@htmls.ru). diff --git a/ru/troubleshooting/legal/how-to/data-centers-physical-addresses.md b/ru/troubleshooting/legal/how-to/data-centers-physical-addresses.md index faa29139091..26d3f4e8722 100644 --- a/ru/troubleshooting/legal/how-to/data-centers-physical-addresses.md +++ b/ru/troubleshooting/legal/how-to/data-centers-physical-addresses.md @@ -7,16 +7,15 @@ ## Решение {#case-resolution} -Платформа {{ yandex-cloud }} размещается в четырех дата-центрах Яндекса, расположенных во Владимирской, Рязанской, Калужской и Московской областях. +Платформа {{ yandex-cloud }} размещается в трех дата-центрах Яндекса, расположенных во Владимирской, Рязанской и Калужской областях. Ресурсы в {{ yandex-cloud }} делятся на зональные, то есть привязанные к зоне доступности, и глобальные — не привязанные к зоне. Зональными ресурсами являются, например, виртуальная машина и диск. Адреса наших дата-центров: -* В городе Мытищи — г. Мытищи, ул. Силикатная 19; * Владимирская область — г. Владимир, мкр. Энергетик, ул. Поисковая 1 к. 2; * Рязанская область — г. Сасово, ул. Пушкина 21; * Калужская область — г. Калуга, 1-й Автомобильный пр-д 8. -Рекомендуем указывать все четыре адреса. Опыт других клиентов показывает, что к такому подходу нет нареканий со стороны регулятора. \ No newline at end of file +Рекомендуем указывать все три адреса. Опыт других клиентов показывает, что к такому подходу нет нареканий со стороны регулятора. \ No newline at end of file diff --git a/ru/troubleshooting/smartcaptcha/how-to/learning-about-monitoring-and-tarification.md b/ru/troubleshooting/smartcaptcha/how-to/learning-about-monitoring-and-tarification.md index 5ada3036d1c..cc08219e323 100644 --- a/ru/troubleshooting/smartcaptcha/how-to/learning-about-monitoring-and-tarification.md +++ b/ru/troubleshooting/smartcaptcha/how-to/learning-about-monitoring-and-tarification.md @@ -21,4 +21,4 @@ Точное количество запросов узнать через мониторинг не получится, но можно посмотреть его в детализации {{ billing-name }}, если включить разбивку по продуктам – там показаны все обращения к {{ captcha-name }} без разделения на успешные и неуспешные. -Выгрузить детализацию в формате CSV можно нажав на кнопку **{{ ui-key.yacloud.billing.account.detail.button_export }}** — в полученном файле будут данные по запросам {{ captcha-name }} за каждый день с точностью до единиц. \ No newline at end of file +Выгрузить детализацию в формате CSV можно нажав на кнопку **{{ ui-key.yacloud_billing.billing.account.detail.button_export }}** — в полученном файле будут данные по запросам {{ captcha-name }} за каждый день с точностью до единиц. \ No newline at end of file diff --git a/ru/troubleshooting/tracker/how-to/logging-into-tracker.md b/ru/troubleshooting/tracker/how-to/logging-into-tracker.md index bf22aad3022..bfa06c50196 100644 --- a/ru/troubleshooting/tracker/how-to/logging-into-tracker.md +++ b/ru/troubleshooting/tracker/how-to/logging-into-tracker.md @@ -23,7 +23,7 @@ 1. Перейдите на главную страницу Яндекса. 1. Нажмите на свой аватар справа вверху. - 1. Выберите **{{ ui-key.startrek.ui_components_navigation.invite-user }}**. + 1. Выберите **Добавить пользователя**. 1. В открывшемся окне введите ваш логин и пароль. 1. Перейдите на [страницу {{ tracker-name }}]({{ link-tracker }}). @@ -31,7 +31,7 @@ 1. Перейдите по этой [ссылке](https://tracker.yandex.ru/connect/clear_organization?retpath=https://tracker.yandex.ru/hi-there). 1. Нажмите на свой аватар справа вверху. - 1. Нажмите на кнопку **{{ ui-key.startrek.ui_components_Gantt.exit }}**. + 1. Нажмите на кнопку **Выйти**. 1. Перейдите на [страницу {{ tracker-name }}](https://yandex.cloud/ru/services/tracker). 1. Выберите **Открыть сервис**. 1. Авторизуйтесь заново. diff --git a/ru/troubleshooting/tracker/how-to/using-new-task-boards.md b/ru/troubleshooting/tracker/how-to/using-new-task-boards.md index 0abbd50c16c..1279b1d9135 100644 --- a/ru/troubleshooting/tracker/how-to/using-new-task-boards.md +++ b/ru/troubleshooting/tracker/how-to/using-new-task-boards.md @@ -34,7 +34,7 @@ Чтобы начать работу с доской задач: -1. Создайте простую доску задач или доску типа **{{ ui-key.startrek.ui_components_agile_agile-board_AgileBoardCreateModal.board-type--scrum }}**. +1. Создайте простую доску задач или доску типа **С бэклогом и спринтами**. 1. Создайте проект в новом интерфейсе. Тогда доска для проекта будет создана автоматически. 1. Начните группировать и фильтровать задачи, перемещать их между колонками, или настроить поля карточек. diff --git a/ru/troubleshooting/tracker/known-issues/illegal-parameter-while-creating-queue.md b/ru/troubleshooting/tracker/known-issues/illegal-parameter-while-creating-queue.md index 46dd321ecfe..dba4d8aa512 100644 --- a/ru/troubleshooting/tracker/known-issues/illegal-parameter-while-creating-queue.md +++ b/ru/troubleshooting/tracker/known-issues/illegal-parameter-while-creating-queue.md @@ -9,7 +9,7 @@ При создании задачи всегда необходимо указывать очередь, без этого задача не создастся. -Если очередь в вашей организации не создана, то ее нужно создать. Для этого перейдите во вкладку **{{ ui-key.startrek.ui_components_App.title-queues }}** и нажмите на кнопку **{{ ui-key.startrek.ui_components_PageQueues.new-queue }}**. Если очередь уже создана, то нужно начать вводить ее название при создании задачи, и она появится в списке. +Если очередь в вашей организации не создана, то ее нужно создать. Для этого перейдите во вкладку **Очереди** и нажмите на кнопку **Создать очередь**. Если очередь уже создана, то нужно начать вводить ее название при создании задачи, и она появится в списке. Окно выбора очереди может быть пустым, если задача в сервисе создается впервые и очередь ни разу не была выбрана. Если начать вводить название уже созданной в организации очереди, то она появится в результате поиска и затем всегда будет отображаться для выбора. diff --git a/ru/troubleshooting/tracker/known-issues/unable-to-modify-workflow.md b/ru/troubleshooting/tracker/known-issues/unable-to-modify-workflow.md index d17d46d800b..88f6b2b553e 100644 --- a/ru/troubleshooting/tracker/known-issues/unable-to-modify-workflow.md +++ b/ru/troubleshooting/tracker/known-issues/unable-to-modify-workflow.md @@ -7,8 +7,8 @@ ## Решение {#issue-resolution} -Такое может произойти, если у вас выбран предустановленный шаблон воркфлоу — их редактировать нельзя. Необходимо скопировать его, нажав кнопку **{{ ui-key.startrek.ui_components_dashboard_CollapseHeader.copy-menu-item }}**, и тогда новый воркфлоу будет доступен для редактирования. +Такое может произойти, если у вас выбран предустановленный шаблон воркфлоу — их редактировать нельзя. Необходимо скопировать его, нажав кнопку **Копировать**, и тогда новый воркфлоу будет доступен для редактирования. -После этого нужно указать новый воркфлоу для типов задач на вкладке **{{ ui-key.startrek.ui_components_admin-tab-types_AdminTabTypes.title }}** в настройках очереди вместо стандартного шаблона. +После этого нужно указать новый воркфлоу для типов задач на вкладке **Типы задач** в настройках очереди вместо стандартного шаблона. Подробности о работе с воркфлоу есть в нашей [документации](../../../tracker/manager/add-workflow.md). \ No newline at end of file diff --git a/ru/tutorials/infrastructure/gta-v-server.md b/ru/tutorials/infrastructure/gta-v-server.md index 488ef552546..3f8d0ade775 100644 --- a/ru/tutorials/infrastructure/gta-v-server.md +++ b/ru/tutorials/infrastructure/gta-v-server.md @@ -1 +1,25 @@ +--- +title: Игровой сервер GTA V в облаке {{ yandex-cloud }} +description: Игровой сервер в облаке — это мощное решение для эффективной игры в GTA V. Следуйте этому руководству, чтобы настроить и развернуть свой собственный сервер на платформе {{ yandex-cloud }}. +keywords: + - gta + - гта + - gta 5 + - гта 5 + - gta v + - гта v + - gta server + - сервер gta + - сервер гта + - игровой сервер gta + - игровой сервер гта + - игровой сервер + - игровой сервер в облаке + - игровой сервер {{ yandex-cloud }} + - развертывание игрового сервера + - настройка игрового сервера + - gta в {{ yandex-cloud }} + - гта в {{ yandex-cloud }} +--- + {% include [gta-v-server](../../_tutorials/infrastructure/gta-v-server.md) %} \ No newline at end of file diff --git a/ru/tutorials/routing/high-accessible-dmz.md b/ru/tutorials/routing/high-accessible-dmz.md index 0895b518db3..6a6a5ce7ea5 100644 --- a/ru/tutorials/routing/high-accessible-dmz.md +++ b/ru/tutorials/routing/high-accessible-dmz.md @@ -3,4 +3,4 @@ title: Реализация защищенной высокодоступной description: Из данной инструкции вы узнаете, как можно развернуть защищенную высокодоступную сетевую инфраструктуру с выделением DMZ на основе Check Point NGFW. --- -{% include [high-accessible-dmz-usergate](../../_tutorials/routing/high-accessible-dmz.md) %} \ No newline at end of file +{% include [high-accessible-dmz-usergate](../../_tutorials/routing/high-accessible-dmz.md) %} diff --git a/ru/tutorials/toc.yaml b/ru/tutorials/toc.yaml index f52aacca47c..d30af3f0696 100644 --- a/ru/tutorials/toc.yaml +++ b/ru/tutorials/toc.yaml @@ -690,6 +690,8 @@ items: items: - name: Все руководства href: windows/index.md + - name: Безопасная передача пароля в скрипт инициализации + href: windows/secure-password-script.md - name: Развертывание Active Directory href: windows/active-directory.md - name: Развертывание Microsoft Exchange diff --git a/ru/tutorials/windows/index.md b/ru/tutorials/windows/index.md index 9daa2c66e5b..0eb4b35fdf9 100644 --- a/ru/tutorials/windows/index.md +++ b/ru/tutorials/windows/index.md @@ -5,6 +5,7 @@ description: Различные сценарии использования Wind # Руководства по работе с Windows в {{ yandex-cloud }} +* [Безопасная передача пароля в скрипт инициализации](secure-password-script.md) * [Развертывание Active Directory](active-directory.md) * [Развертывание Microsoft Exchange](exchange.md) * [Развертывание Microsoft Remote Desktop Services](rds.md) diff --git a/ru/tutorials/windows/secure-password-script.md b/ru/tutorials/windows/secure-password-script.md new file mode 100644 index 00000000000..60921ff2788 --- /dev/null +++ b/ru/tutorials/windows/secure-password-script.md @@ -0,0 +1,7 @@ +--- +title: Безопасная передача пароля в скрипт инициализации +description: В этом сценарии вы узнаете как безопасно передать пароль в скрипт инициализации. +canonical: '{{ link-docs }}/tutorials/windows/secure-password-script' +--- + +{% include [secure-password-script](../../_tutorials/windows/secure-password-script.md) %} \ No newline at end of file diff --git a/ru/video/iframe-sdk.md b/ru/video/iframe-sdk.md index 076da32fe9e..e442681bef1 100644 --- a/ru/video/iframe-sdk.md +++ b/ru/video/iframe-sdk.md @@ -1,4 +1,4 @@ -# Справочник SDK видеоплеера для IFrame +# SDK видеоплеера для IFrame Вы можете разместить [видеоплеер](./concepts/player.md) с контентом из {{ video-name }} на HTML-странице с помощью SDK видеоплеера для IFrame. diff --git a/ru/video/release-notes.md b/ru/video/release-notes.md index f41c0ba357d..b3ca9394ecb 100644 --- a/ru/video/release-notes.md +++ b/ru/video/release-notes.md @@ -5,10 +5,14 @@ description: В разделе представлена история изме # История изменений в {{ video-full-name }} +## Октябрь 2024 {#oct-2024} + +* Опубликованы SDK видеоплеера для [iOS](./sdk/ios-sdk.md). + ## Сентябрь 2024 {#sep-2024} * Поддержана загрузка [субтитров](./concepts/videos.md#subtitles) для [видео](./concepts/videos.md). -* Опубликован [SDK видеоплеера для JavaScript](./sdk/javascript/index.md). +* Опубликованы SDK видеоплеера для [JavaScript](./sdk/javascript/index.md). * Реализована поддержка [методов REST API](https://github.com/yandex-cloud/cloudapi/tree/master/yandex/cloud/video) для взаимодействия с сервисом, опубликован [справочник](./api-ref/). ## Август 2024 {#aug-2024} @@ -27,7 +31,7 @@ description: В разделе представлена история изме ## Март 2024 {#mar-2024} * Добавлена возможность получения [статистики просмотров](./operations/video/get-statistics.md) видео. -* Опубликован [справочник Cloud Video Player SDK для IFrame](iframe-sdk.md). +* Опубликован [справочник Cloud Video Player SDK для IFrame](./iframe-sdk.md). * Добавлена возможность [настройки публичного доступа](./operations/video/publish.md) к видео. ## Ноябрь 2023 {#nov-2023} diff --git a/ru/video/sdk/index.md b/ru/video/sdk/index.md index cd3a33d4b7f..0d1e8aeb1bd 100644 --- a/ru/video/sdk/index.md +++ b/ru/video/sdk/index.md @@ -2,9 +2,10 @@ Для встраивания [видеоплеера](../concepts/player.md) с контентом из {{ video-name }} на сайт или в приложение предусмотрены следующие SDK: * [SDK видеоплеера для IFrame](../iframe-sdk.md) +* [SDK видеоплеера для iOS](./ios-sdk.md) * [SDK видеоплеера для JavaScript](./javascript/index.md) -В будущем также будут добавлены SDK для iOS и Android. +В будущем также будут добавлен SDK для Android. См. также: * [Справочник API {{ video-name }}](../api-ref/authentication.md) \ No newline at end of file diff --git a/ru/video/sdk/ios-sdk.md b/ru/video/sdk/ios-sdk.md new file mode 100644 index 00000000000..b51dbecd643 --- /dev/null +++ b/ru/video/sdk/ios-sdk.md @@ -0,0 +1,196 @@ +--- +title: Как добавить Cloud Video Player в приложение iOS +description: Следуя данной инструкции, вы сможете интегрировать Cloud Video Player в ваше мобильное приложение для iOS. +--- + +# SDK видеоплеера для iOS + +Вы можете добавить [видеоплеер](../concepts/player.md) с контентом из {{ video-name }} в ваше мобильное приложение для iOS. Для этого воспользуйтесь SDK видеоплеера для iOS. + +Чтобы использовать SDK, вам понадобится установленная и настроенная среда разработки [Xcode](https://developer.apple.com/xcode/) версии 15.3 или выше с языком программирования [Swift](https://www.swift.org/install/macos/) версии 5.8 или выше. + +## Подключение библиотеки SDK видеоплеера {#add-library} + +{% list tabs group=programming_language %} + +- Xcode SPM {#xcode-spm} + + 1. В окне Xcode навигатора проектов (**Project Navigator**) выберите свой проект. + 1. На верхней панели нажмите **File** и выберите **Add Package Dependencies...** + 1. В строке поиска ![image](../../_assets/console-icons/magnifier.svg) введите `https://github.com/yandex-cloud/cloud-video-player-ios-sdk/` и выберите пакет `cloud-video-player-ios-sdk`. + 1. В поле **Dependency Rule** выберите **Up to Next Major Version** и укажите версию `0.1.0-beta`. + 1. В поле **Add to Project** выберите проект, к которому вы хотите подключить библиотеки, и нажмите **Add Package**. + 1. Во всплывающем окне укажите, к какому таргету в проекте подключить библиотеки, и нажмите **Add Package**. + + Пакет содержит следующие библиотеки: + * `CloudVideoPlayer` — основная библиотека SDK видеоплеера для iOS. + * `CloudVideoPlayerUI` — дополнительная библиотека с набором интерфейсных элементов (оболочка видеоплеера). + +- Package.swift {#package-swift} + + 1. В окне Xcode навигатора проектов (**Project Navigator**) выберите свой проект. + 1. Откройте `Package.swift`. + 1. Добавьте в массив `dependencies` следующую зависимость: + + ```swift + dependencies: [ + .package( + url: "https://github.com/yandex-cloud/cloud-video-player-ios-sdk/", + from: "0.1.0-beta" + ) + ], + ``` + + 1. Добавьте библиотеки в массив `dependencies` конкретного таргета: + + ```swift + .target( + name: "MyTargetName", + dependencies: [ + .product(name: "CloudVideoPlayer", package: "cloud-video-player-ios-sdk"), + .product(name: "CloudVideoPlayerUI", package: "cloud-video-player-ios-sdk") + ] + ), + ``` + + Где: + * `CloudVideoPlayer` — основная библиотека SDK видеоплеера для iOS. + * `CloudVideoPlayerUI` — дополнительная библиотека с набором интерфейсных элементов (оболочка видеоплеера). + + 1. Сохраните изменения. + +{% endlist %} + + +## Импорт библиотек {#import-library} + +Чтобы импортировать библиотеки, добавьте в файл с кодом следующие строки: + +```swift +import CloudVideoPlayer +import CloudVideoPlayerUI +``` + +## Использование SDK {#usage} + +### Настройте запуск воспроизведения {#player-setup} + +1. Импортируйте библиотеку в файле: + + ```swift + import CloudVideoPlayer + ``` + +1. Создайте объекты `Environment` и `YaPlayer`: + + ```swift + let environment = Environment(from: From(raw: "you-app-bundle")) + + class ViewController: UIViewController { + let player = environment.player() + } + ``` + +1. Создайте UIView-компонент `VideoSurface`, добавьте его в иерархию и подключите к экземпляру плеера: + + ```swift + let surface = VideoSurface() + + override func loadView() { + super.loadView() + self.view.addSubview(surface) + surface.frame = UIScreen.main.bounds + } + + override func viewDidLoad() { + super.viewDidLoad() + surface.attach(player: player) + } + ``` + +1. Запустите воспроизведение: + + ```swift + player.set(source: ContentId(rawValue: "https://runtime.video.cloud.yandex.net/player/...")) + player.play() + ``` + +{% include [video-content-id-desc](../../_includes/video/video-content-id-desc.md) %} + +{% cut "Полный код настройки запуска воспроизведения" %} + +```swift +import CloudVideoPlayer + +let environment = Environment(from: From(raw: "you-app-bundle")) + +class ViewController: UIViewController { + + let player = environment.player() + let surface = VideoSurface() + + override func loadView() { + super.loadView() + self.view.addSubview(surface) + surface.frame = UIScreen.main.bounds + } + + override func viewDidLoad() { + super.viewDidLoad() + surface.attach(player: player) + + player.set(source: ContentId(rawValue: "https://runtime.video.cloud.yandex.net/player/...")) + player.play() + } +} +``` + +{% include [video-content-id-desc](../../_includes/video/video-content-id-desc.md) %} + +{% endcut %} + +### Подключение оболочки видеоплеера {#use-skin} + +1. Импортируйте библиотеку в файле: + + ```swift + import CloudVideoPlayerUI + ``` + +1. Создайте UIView-компонент `VideoView`, добавьте его в иерархию и подключите к экземпляру плеера: + + ```swift + let videoView = VideoView() + + override func loadView() { + super.loadView() + self.view.addSubview(surface) + videoView.frame = UIScreen.main.bounds + } + + override func viewDidLoad() { + super.viewDidLoad() + videoView.attach(player: player) + } + ``` + +{% cut "Полный код подключения оболочки видеоплеера" %} + +```swift +import CloudVideoPlayerUI + +let videoView = VideoView() + +override func loadView() { + super.loadView() + self.view.addSubview(surface) + videoView.frame = UIScreen.main.bounds +} + +override func viewDidLoad() { + super.viewDidLoad() + videoView.attach(player: player) +} +``` + +{% endcut %} \ No newline at end of file diff --git a/ru/video/sdk/javascript/index.md b/ru/video/sdk/javascript/index.md index 2387bc2255f..b0e6b6ddc1b 100644 --- a/ru/video/sdk/javascript/index.md +++ b/ru/video/sdk/javascript/index.md @@ -12,7 +12,7 @@ description: На странице приведены основные элем Чтобы подключить плеер на страницу, добавьте на нее код: ```html - + ``` ## Инициализация плеера {#initialize-player} @@ -57,4 +57,4 @@ var player = Ya.playerSdk.init({ Информацию о событиях плеера см. в разделах: * [События плеера](./player-events.md) -* [Interface: PlayerSdkEventHandlers](../../api-ref/javascript/interfaces/PlayerSdkEventHandlers.md) в справочнике API \ No newline at end of file +* [Interface: PlayerSdkEventHandlers](../../api-ref/javascript/interfaces/PlayerSdkEventHandlers.md) в справочнике API diff --git a/ru/video/toc.yaml b/ru/video/toc.yaml index d91e49a2798..181ba9d2698 100644 --- a/ru/video/toc.yaml +++ b/ru/video/toc.yaml @@ -107,6 +107,8 @@ items: href: sdk/index.md - name: IFrame href: iframe-sdk.md + - name: iOS + href: sdk/ios-sdk.md - name: JavaScript items: - name: Начало работы diff --git a/ru/vpc/api-ref/SecurityGroup/delete.md b/ru/vpc/api-ref/SecurityGroup/delete.md index 845f809de1a..49debf68b06 100644 --- a/ru/vpc/api-ref/SecurityGroup/delete.md +++ b/ru/vpc/api-ref/SecurityGroup/delete.md @@ -21,7 +21,7 @@ DELETE https://vpc.{{ api-host }}/vpc/v1/securityGroups/{securityGroupId} Required field. ID of the security group to delete. -To get a address ID make a [SecurityGroup.List](/docs/vpc/api-ref/Address/list#List) request. || +To get a address ID make a [SecurityGroup.List] request. || |# ## Response {#yandex.cloud.operation.Operation} diff --git a/ru/vpc/api-ref/SecurityGroup/get.md b/ru/vpc/api-ref/SecurityGroup/get.md index b7e09c248a5..130af54e1b8 100644 --- a/ru/vpc/api-ref/SecurityGroup/get.md +++ b/ru/vpc/api-ref/SecurityGroup/get.md @@ -22,7 +22,7 @@ GET https://vpc.{{ api-host }}/vpc/v1/securityGroups/{securityGroupId} || securityGroupId | **string** Required field. ID of the Security Group resource to return. -To get the security group ID, use a [SecurityGroup.List](/docs/vpc/api-ref/Address/list#List) request. || +To get the security group ID, use a [SecurityGroup.List] request. || |# ## Response {#yandex.cloud.vpc.v1.SecurityGroup} diff --git a/ru/vpc/api-ref/SecurityGroup/listOperations.md b/ru/vpc/api-ref/SecurityGroup/listOperations.md index 704b44548e6..43df0eb7898 100644 --- a/ru/vpc/api-ref/SecurityGroup/listOperations.md +++ b/ru/vpc/api-ref/SecurityGroup/listOperations.md @@ -21,7 +21,7 @@ GET https://vpc.{{ api-host }}/vpc/v1/securityGroups/{securityGroupId}/operation Required field. ID of the address to list operations for. -To get a address ID make a [SecurityGroup.List](/docs/vpc/api-ref/Address/list#List) request. || +To get a address ID make a [SecurityGroup.List] request. || |# ## Query parameters {#yandex.cloud.vpc.v1.ListSecurityGroupOperationsRequest} diff --git a/ru/vpc/api-ref/grpc/SecurityGroup/delete.md b/ru/vpc/api-ref/grpc/SecurityGroup/delete.md index 364dbb1ab07..2400fc58248 100644 --- a/ru/vpc/api-ref/grpc/SecurityGroup/delete.md +++ b/ru/vpc/api-ref/grpc/SecurityGroup/delete.md @@ -25,7 +25,7 @@ Deletes the specified security group. Required field. ID of the security group to delete. -To get a address ID make a [SecurityGroup.List](/docs/vpc/api-ref/grpc/Address/list#List) request. || +To get a address ID make a [SecurityGroup.List] request. || |# ## operation.Operation {#yandex.cloud.operation.Operation} diff --git a/ru/vpc/api-ref/grpc/SecurityGroup/get.md b/ru/vpc/api-ref/grpc/SecurityGroup/get.md index d21f9d84e7d..41c5d5c1f9f 100644 --- a/ru/vpc/api-ref/grpc/SecurityGroup/get.md +++ b/ru/vpc/api-ref/grpc/SecurityGroup/get.md @@ -26,7 +26,7 @@ To get the list of all available SecurityGroup resources, make a [List](/docs/vp || securityGroupId | **string** Required field. ID of the Security Group resource to return. -To get the security group ID, use a [SecurityGroup.List](/docs/vpc/api-ref/grpc/Address/list#List) request. || +To get the security group ID, use a [SecurityGroup.List] request. || |# ## SecurityGroup {#yandex.cloud.vpc.v1.SecurityGroup} diff --git a/ru/vpc/api-ref/grpc/SecurityGroup/listOperations.md b/ru/vpc/api-ref/grpc/SecurityGroup/listOperations.md index 6cc1eab6673..3871f9249d5 100644 --- a/ru/vpc/api-ref/grpc/SecurityGroup/listOperations.md +++ b/ru/vpc/api-ref/grpc/SecurityGroup/listOperations.md @@ -27,7 +27,7 @@ Lists operations for the specified security groups. Required field. ID of the address to list operations for. -To get a address ID make a [SecurityGroup.List](/docs/vpc/api-ref/grpc/Address/list#List) request. || +To get a address ID make a [SecurityGroup.List] request. || || pageSize | **int64** The maximum number of results per page to return. If the number of available diff --git a/ru/vpc/release-notes.md b/ru/vpc/release-notes.md index 4c3fb9fc60c..b4cb809b249 100644 --- a/ru/vpc/release-notes.md +++ b/ru/vpc/release-notes.md @@ -5,6 +5,11 @@ description: В разделе представлена история изме # История изменений в {{ vpc-full-name }} +## III квартал 2024 {#q3-2024} + +* Добавлена возможность создавать [сервисные подключения](./concepts/private-endpoint.md). Возможность на стадии Preview, чтобы запросить доступ, [обратитесь в поддержку](../support/overview.md). +* Реализована интеграция с {{ dns-name }} для указания DNS-записей в спецификациях публичных адресов. + ## II квартал 2024 {#q2-2024} * Увеличены [лимиты](../compute/concepts/limits.md) сетевых соединений. diff --git a/ru/vpc/toc.yaml b/ru/vpc/toc.yaml index 04d924aec4d..a85bcc020ff 100644 --- a/ru/vpc/toc.yaml +++ b/ru/vpc/toc.yaml @@ -150,6 +150,16 @@ items: href: tutorials/remote-wireguard-vpn.md - name: Создание и настройка шлюза UserGate в режиме прокси-сервера href: tutorials/usergate-proxy.md + - name: Создание и настройка шлюза UserGate в режиме межсетевого экрана + href: tutorials/usergate-firewall.md + - name: Реализация отказоустойчивых сценариев для сетевых виртуальных машин + href: tutorials/route-switcher.md + - name: >- + Создание туннеля между двумя подсетями при помощи OpenVPN Access + Server + href: tutorials/site-to-site-openvpn.md + - name: Создание бастионного хоста + href: tutorials/bastion.md - name: >- Миграция кластера {{ dataproc-full-name }} с файловой системой HDFS в другую зону доступности @@ -160,8 +170,24 @@ items: href: tutorials/multi-folder-vpc.md - name: Настройка PT Application Firewall href: tutorials/pt-application-firewall.md + - name: >- + Реализация защищенной высокодоступной сетевой инфраструктуры с + выделением DMZ на основе Check Point NGFW + href: tutorials/high-accessible-dmz.md + - name: >- + Сегментация облачной инфраструктуры с помощью решения Check Point + Next-Generation Firewall + href: tutorials/network-segmentation-checkpoint.md + - name: Подключение к {{ objstorage-name }} из {{ vpc-name }} + href: tutorials/storage-vpc-access.md + - name: Подключение к {{ container-registry-name }} из {{ vpc-name }} + href: tutorials/vpc-cr-access.md - name: Использование модулей {{ yandex-cloud }} в {{ TF }} href: tutorials/terraform-modules.md + - name: >- + Развертывание группы доступности Always On с внутренним сетевым + балансировщиком + href: tutorials/mssql-alwayson-lb.md - name: Концепции items: - name: Взаимосвязь ресурсов сервиса diff --git a/ru/vpc/tutorials/bastion.md b/ru/vpc/tutorials/bastion.md new file mode 100644 index 00000000000..0d0f3409194 --- /dev/null +++ b/ru/vpc/tutorials/bastion.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/routing/bastion' +--- + +{% include [bastion](../../_tutorials/routing/bastion.md) %} \ No newline at end of file diff --git a/ru/vpc/tutorials/high-accessible-dmz.md b/ru/vpc/tutorials/high-accessible-dmz.md new file mode 100644 index 00000000000..79b30015022 --- /dev/null +++ b/ru/vpc/tutorials/high-accessible-dmz.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/routing/high-accessible-dmz' +--- + +{% include [high-accessible-dmz](../../_tutorials/routing/high-accessible-dmz.md) %} \ No newline at end of file diff --git a/ru/vpc/tutorials/index.md b/ru/vpc/tutorials/index.md index 4d251536b1c..e17e6f2c36f 100644 --- a/ru/vpc/tutorials/index.md +++ b/ru/vpc/tutorials/index.md @@ -15,8 +15,18 @@ description: Различные сценарии использования {{ v * [{#T}](clickhouse-dns-peering.md) * [Защищенный доступ пользователей к облачным ресурсам на основе WireGuard VPN](remote-wireguard-vpn.md) * [Создание и настройка шлюза UserGate в режиме прокси-сервера](usergate-proxy.md) +* [Создание и настройка шлюза UserGate в режиме межсетевого экрана](usergate-firewall.md) +* [Реализация отказоустойчивых сценариев для сетевых виртуальных машин](route-switcher.md) +* [Создание туннеля между двумя подсетями при помощи OpenVPN Access Server](site-to-site-openvpn.md) +* [Создание бастионного хоста](bastion.md) * [Миграция кластера {{ dataproc-full-name }} с файловой системой HDFS в другую зону доступности](hdfs-cluster-migration.md) +* [Сеть между каталогами (Multi-folder-VPC)](multi-folder-vpc.md) * [Настройка сети для {{ dataproc-full-name }}](dataproc-nat-instance.md) * [Сеть между каталогами (Multi-folder-VPC)](multi-folder-vpc.md) +* [Реализация защищенной высокодоступной сетевой инфраструктуры с выделением DMZ на основе Check Point NGFW](high-accessible-dmz.md) +* [Сегментация облачной инфраструктуры с помощью решения Check Point Next-Generation Firewall](network-segmentation-checkpoint.md) +* [Подключение к {{ objstorage-name }} из {{ vpc-name }}](storage-vpc-access.md) +* [Подключение к {{ container-registry-name }} из {{ vpc-name }}](vpc-cr-access.md) * [Настройка PT Application Firewall](pt-application-firewall.md) -* [Использование модулей {{ yandex-cloud }} в {{ TF }}](terraform-modules.md) \ No newline at end of file +* [Использование модулей {{ yandex-cloud }} в {{ TF }}](terraform-modules.md) +* [Развертывание группы доступности Always On с внутренним сетевым балансировщиком](mssql-alwayson-lb.md) \ No newline at end of file diff --git a/ru/vpc/tutorials/mssql-alwayson-lb.md b/ru/vpc/tutorials/mssql-alwayson-lb.md new file mode 100644 index 00000000000..1f61e62b817 --- /dev/null +++ b/ru/vpc/tutorials/mssql-alwayson-lb.md @@ -0,0 +1,7 @@ +--- +title: Развертывание группы доступности Always On с внутренним сетевым балансировщиком +description: В этом сценарии вы создадите в {{ yandex-cloud }} группы доступности Always On с балансировкой нагрузки между узлами с помощью внутреннего сетевого балансировщика. +canonical: '{{ link-docs }}/tutorials/windows/mssql-alwayson-lb' +--- + +{% include [mssql-alwayson-lb](../../_tutorials/windows/mssql-alwayson-lb.md) %} \ No newline at end of file diff --git a/ru/vpc/tutorials/multi-folder-vpc.md b/ru/vpc/tutorials/multi-folder-vpc.md index 3cf3e5c33af..0cb83243e3f 100644 --- a/ru/vpc/tutorials/multi-folder-vpc.md +++ b/ru/vpc/tutorials/multi-folder-vpc.md @@ -1 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/routing/multi-folder-vpc' +--- + {% include [multi-folder-vpc](../../_tutorials/routing/multi-folder-vpc.md) %} diff --git a/ru/vpc/tutorials/network-segmentation-checkpoint.md b/ru/vpc/tutorials/network-segmentation-checkpoint.md new file mode 100644 index 00000000000..984b088ba9d --- /dev/null +++ b/ru/vpc/tutorials/network-segmentation-checkpoint.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/routing/network-segmentation-checkpoint' +--- + +{% include [network-segmentation-checkpoint](../../_tutorials/routing/network-segmentation-checkpoint.md) %} \ No newline at end of file diff --git a/ru/vpc/tutorials/route-switcher.md b/ru/vpc/tutorials/route-switcher.md new file mode 100644 index 00000000000..c99a393b9a3 --- /dev/null +++ b/ru/vpc/tutorials/route-switcher.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/routing/route-switcher' +--- + +{% include [route-switcher](../../_tutorials/routing/route-switcher.md) %} \ No newline at end of file diff --git a/ru/vpc/tutorials/site-to-site-openvpn.md b/ru/vpc/tutorials/site-to-site-openvpn.md new file mode 100644 index 00000000000..490fe85db7b --- /dev/null +++ b/ru/vpc/tutorials/site-to-site-openvpn.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/routing/site-to-site-openvpn' +--- + +{% include [openvpn](../../_tutorials/routing/site-to-site-openvpn.md) %} \ No newline at end of file diff --git a/ru/vpc/tutorials/storage-vpc-access.md b/ru/vpc/tutorials/storage-vpc-access.md new file mode 100644 index 00000000000..55d0ddd87ec --- /dev/null +++ b/ru/vpc/tutorials/storage-vpc-access.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/routing/storage-vpc-access' +--- + +{% include [storage-vpc-access](../../_tutorials/routing/storage-vpc-access.md) %} \ No newline at end of file diff --git a/ru/vpc/tutorials/usergate-firewall.md b/ru/vpc/tutorials/usergate-firewall.md new file mode 100644 index 00000000000..605051a0900 --- /dev/null +++ b/ru/vpc/tutorials/usergate-firewall.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/routing/usergate-firewall' +--- + +{% include [usergate-setup](../../_tutorials/routing/usergate-firewall.md) %} diff --git a/ru/vpc/tutorials/vpc-cr-access.md b/ru/vpc/tutorials/vpc-cr-access.md new file mode 100644 index 00000000000..e684154f946 --- /dev/null +++ b/ru/vpc/tutorials/vpc-cr-access.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/routing/vpc-cr-access' +--- + +{% include [vpc-cr-access](../../_tutorials/routing/vpc-cr-access.md) %} \ No newline at end of file diff --git a/ru/websql/concepts/index.md b/ru/websql/concepts/index.md index d9ec8fdf3e6..a42598c334e 100644 --- a/ru/websql/concepts/index.md +++ b/ru/websql/concepts/index.md @@ -8,10 +8,10 @@ {{ websql-full-name }} поддерживает работу со следующими версиями БД: -* {{ PG }}: 12, 13, 14, 15, 16. -* {{ MY }}: 5, 8. -* {{ CH }}: 23, 24. -* {{ RD }} (только нешардированные кластеры): 6.2, 7. +* {{ PG }}: 12 и выше. +* {{ MY }}: 5 и выше. +* {{ CH }}: 23 и выше. +* {{ RD }} (только нешардированные кластеры): 6 и выше. ## Пользовательский интерфейс {#user-interface} diff --git a/ru/websql/index.yaml b/ru/websql/index.yaml index 06e7cdb2a59..4c2189b30c8 100644 --- a/ru/websql/index.yaml +++ b/ru/websql/index.yaml @@ -11,9 +11,9 @@ description: появляются в Connection Manager сервиса MetaData Hub и наоборот. - >- Yandex WebSQL поддерживает работу со следующими версиями БД:
      -
    • PostgreSQL: 12, 13, 14, 15, 16.
    • MySQL: 5, 8.
      • -
    • ClickHouse®: 23, 24.
    • Redis (только нешардированные кластеры): - 6.2, 7.
    +
  • PostgreSQL: 12 и выше.
  • MySQL: 5 и выше.
  • ClickHouse®: + 23 и выше.
  • Redis (только нешардированные кластеры): 6 и выше.
    • + meta: title: Yandex WebSQL links: diff --git a/ru/websql/quickstart.md b/ru/websql/quickstart.md index 039b9aa810c..f12e9ad3141 100644 --- a/ru/websql/quickstart.md +++ b/ru/websql/quickstart.md @@ -6,10 +6,10 @@ {{ websql-full-name }} поддерживает работу со следующими версиями БД: -* {{ PG }}: 12, 13, 14, 15, 16. -* {{ MY }}: 5, 8. -* {{ CH }}: 23, 24. -* {{ RD }} (только нешардированные кластеры): 6.2, 7. +* {{ PG }}: 12 и выше. +* {{ MY }}: 5 и выше. +* {{ CH }}: 23 и выше. +* {{ RD }} (только нешардированные кластеры): 6 и выше. В этом разделе вы научитесь подключаться: diff --git a/ru/websql/release-notes/index.md b/ru/websql/release-notes/index.md index e8fc83b529a..03861e4e1ff 100644 --- a/ru/websql/release-notes/index.md +++ b/ru/websql/release-notes/index.md @@ -5,6 +5,12 @@ description: В разделе представлена история изме # История изменений {{ websql-full-name }} в 2024 году +## Октябрь {#october} + +1. Добавлена возможность делиться результатом запроса сразу после его выполнения. + +1. Уменьшено время обработки быстрых запросов. + ## Сентябрь {#september} ### Новые возможности {#new-features-september} diff --git a/ru/yandexgpt/text-generation/api-ref/TextGeneration/completion.md b/ru/yandexgpt/text-generation/api-ref/TextGeneration/completion.md index 1719f3b1d5b..ae0b2d5b77e 100644 --- a/ru/yandexgpt/text-generation/api-ref/TextGeneration/completion.md +++ b/ru/yandexgpt/text-generation/api-ref/TextGeneration/completion.md @@ -26,8 +26,45 @@ POST https://llm.{{ api-host }}/foundationModels/v1/completion "messages": [ { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "object" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } + // end of the list of possible fields + } + ], + "tools": [ + { + // Includes only one of the fields `function` + "function": { + "name": "string", + "description": "string", + "parameters": "object" + } // end of the list of possible fields } ] @@ -47,6 +84,10 @@ Configuration options for completion generation. || || messages[] | **[Message](#yandex.cloud.ai.foundation_models.v1.Message)** A list of messages representing the context for the completion model. || +|| tools[] | **[Tool](#yandex.cloud.ai.foundation_models.v1.Tool)** + +List of tools that are available for the model to invoke during the completion generation. +Note: This parameter is not yet supported and will be ignored if provided. || |# ## CompletionOptions {#yandex.cloud.ai.foundation_models.v1.CompletionOptions} @@ -85,9 +126,134 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **object** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + +## Tool {#yandex.cloud.ai.foundation_models.v1.Tool} + +Represents a tool that can be invoked during completion generation. + +#| +||Field | Description || +|| function | **[FunctionTool](#yandex.cloud.ai.foundation_models.v1.FunctionTool)** + +Represents a function that can be called. + +Includes only one of the fields `function`. || +|# + +## FunctionTool {#yandex.cloud.ai.foundation_models.v1.FunctionTool} + +Represents a function tool that can be invoked during completion generation. + +#| +||Field | Description || +|| name | **string** + +The name of the function. || +|| description | **string** + +A description of the function's purpose or behavior. || +|| parameters | **object** + +A JSON Schema that defines the expected parameters for the function. +The schema should describe the required fields, their types, and any constraints or default values. || |# ## Response {#yandex.cloud.ai.foundation_models.v1.CompletionResponse} @@ -100,8 +266,34 @@ Message content. || { "message": { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "object" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } // end of the list of possible fields }, "status": "string" @@ -149,7 +341,8 @@ The generation status of the alternative - `ALTERNATIVE_STATUS_TRUNCATED_FINAL`: Incomplete final alternative resulting from reaching the maximum allowed number of tokens. - `ALTERNATIVE_STATUS_FINAL`: Final alternative generated without running into any limits. - `ALTERNATIVE_STATUS_CONTENT_FILTER`: Generation was stopped due to the discovery of potentially sensitive content in the prompt or generated response. -To fix, modify the prompt and restart generation. || +To fix, modify the prompt and restart generation. +- `ALTERNATIVE_STATUS_TOOL_CALLS`: Tools were invoked during the completion generation. || |# ## Message {#yandex.cloud.ai.foundation_models.v1.Message2} @@ -168,9 +361,103 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList2)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList2)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList2} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall2)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall2} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall2)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall2} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **object** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList2} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult2)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult2} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult2)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult2} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || |# ## ContentUsage {#yandex.cloud.ai.foundation_models.v1.ContentUsage} diff --git a/ru/yandexgpt/text-generation/api-ref/TextGenerationAsync/completion.md b/ru/yandexgpt/text-generation/api-ref/TextGenerationAsync/completion.md index 88c5d34ebec..f6f4fa61b0e 100644 --- a/ru/yandexgpt/text-generation/api-ref/TextGenerationAsync/completion.md +++ b/ru/yandexgpt/text-generation/api-ref/TextGenerationAsync/completion.md @@ -26,8 +26,45 @@ POST https://llm.{{ api-host }}/foundationModels/v1/completionAsync "messages": [ { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "object" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } + // end of the list of possible fields + } + ], + "tools": [ + { + // Includes only one of the fields `function` + "function": { + "name": "string", + "description": "string", + "parameters": "object" + } // end of the list of possible fields } ] @@ -47,6 +84,10 @@ Configuration options for completion generation. || || messages[] | **[Message](#yandex.cloud.ai.foundation_models.v1.Message)** A list of messages representing the context for the completion model. || +|| tools[] | **[Tool](#yandex.cloud.ai.foundation_models.v1.Tool)** + +List of tools that are available for the model to invoke during the completion generation. +Note: This parameter is not yet supported and will be ignored if provided. || |# ## CompletionOptions {#yandex.cloud.ai.foundation_models.v1.CompletionOptions} @@ -85,9 +126,134 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **object** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + +## Tool {#yandex.cloud.ai.foundation_models.v1.Tool} + +Represents a tool that can be invoked during completion generation. + +#| +||Field | Description || +|| function | **[FunctionTool](#yandex.cloud.ai.foundation_models.v1.FunctionTool)** + +Represents a function that can be called. + +Includes only one of the fields `function`. || +|# + +## FunctionTool {#yandex.cloud.ai.foundation_models.v1.FunctionTool} + +Represents a function tool that can be invoked during completion generation. + +#| +||Field | Description || +|| name | **string** + +The name of the function. || +|| description | **string** + +A description of the function's purpose or behavior. || +|| parameters | **object** + +A JSON Schema that defines the expected parameters for the function. +The schema should describe the required fields, their types, and any constraints or default values. || |# ## Response {#yandex.cloud.operation.Operation} @@ -116,8 +282,34 @@ Message content. || { "message": { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "object" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } // end of the list of possible fields }, "status": "string" @@ -255,7 +447,8 @@ The generation status of the alternative - `ALTERNATIVE_STATUS_TRUNCATED_FINAL`: Incomplete final alternative resulting from reaching the maximum allowed number of tokens. - `ALTERNATIVE_STATUS_FINAL`: Final alternative generated without running into any limits. - `ALTERNATIVE_STATUS_CONTENT_FILTER`: Generation was stopped due to the discovery of potentially sensitive content in the prompt or generated response. -To fix, modify the prompt and restart generation. || +To fix, modify the prompt and restart generation. +- `ALTERNATIVE_STATUS_TOOL_CALLS`: Tools were invoked during the completion generation. || |# ## Message {#yandex.cloud.ai.foundation_models.v1.Message2} @@ -274,11 +467,105 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList2)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList2)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || |# +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList2} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall2)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall2} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall2)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall2} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **object** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList2} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult2)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult2} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult2)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult2} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + ## ContentUsage {#yandex.cloud.ai.foundation_models.v1.ContentUsage} An object representing the number of content [tokens](/docs/foundation-models/concepts/yandexgpt/tokens) used by the completion model. diff --git a/ru/yandexgpt/text-generation/api-ref/Tokenizer/tokenizeCompletion.md b/ru/yandexgpt/text-generation/api-ref/Tokenizer/tokenizeCompletion.md index a1e1261d98f..73a37220d12 100644 --- a/ru/yandexgpt/text-generation/api-ref/Tokenizer/tokenizeCompletion.md +++ b/ru/yandexgpt/text-generation/api-ref/Tokenizer/tokenizeCompletion.md @@ -26,8 +26,45 @@ POST https://llm.{{ api-host }}/foundationModels/v1/tokenizeCompletion "messages": [ { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "object" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } + // end of the list of possible fields + } + ], + "tools": [ + { + // Includes only one of the fields `function` + "function": { + "name": "string", + "description": "string", + "parameters": "object" + } // end of the list of possible fields } ] @@ -47,6 +84,10 @@ Configuration options for completion generation. || || messages[] | **[Message](#yandex.cloud.ai.foundation_models.v1.Message)** A list of messages representing the context for the completion model. || +|| tools[] | **[Tool](#yandex.cloud.ai.foundation_models.v1.Tool)** + +List of tools that are available for the model to invoke during the completion generation. +Note: This parameter is not yet supported and will be ignored if provided. || |# ## CompletionOptions {#yandex.cloud.ai.foundation_models.v1.CompletionOptions} @@ -85,9 +126,134 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **object** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + +## Tool {#yandex.cloud.ai.foundation_models.v1.Tool} + +Represents a tool that can be invoked during completion generation. + +#| +||Field | Description || +|| function | **[FunctionTool](#yandex.cloud.ai.foundation_models.v1.FunctionTool)** + +Represents a function that can be called. + +Includes only one of the fields `function`. || +|# + +## FunctionTool {#yandex.cloud.ai.foundation_models.v1.FunctionTool} + +Represents a function tool that can be invoked during completion generation. + +#| +||Field | Description || +|| name | **string** + +The name of the function. || +|| description | **string** + +A description of the function's purpose or behavior. || +|| parameters | **object** + +A JSON Schema that defines the expected parameters for the function. +The schema should describe the required fields, their types, and any constraints or default values. || |# ## Response {#yandex.cloud.ai.foundation_models.v1.TokenizeResponse} diff --git a/ru/yandexgpt/text-generation/api-ref/grpc/TextGeneration/completion.md b/ru/yandexgpt/text-generation/api-ref/grpc/TextGeneration/completion.md index d75fb715107..028f8fdfa46 100644 --- a/ru/yandexgpt/text-generation/api-ref/grpc/TextGeneration/completion.md +++ b/ru/yandexgpt/text-generation/api-ref/grpc/TextGeneration/completion.md @@ -24,8 +24,45 @@ A method for generating text completions in [synchronous mode](/docs/foundation- "messages": [ { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "google.protobuf.Struct" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } + // end of the list of possible fields + } + ], + "tools": [ + { + // Includes only one of the fields `function` + "function": { + "name": "string", + "description": "string", + "parameters": "google.protobuf.Struct" + } // end of the list of possible fields } ] @@ -45,6 +82,10 @@ Configuration options for completion generation. || || messages[] | **[Message](#yandex.cloud.ai.foundation_models.v1.Message)** A list of messages representing the context for the completion model. || +|| tools[] | **[Tool](#yandex.cloud.ai.foundation_models.v1.Tool)** + +List of tools that are available for the model to invoke during the completion generation. +Note: This parameter is not yet supported and will be ignored if provided. || |# ## CompletionOptions {#yandex.cloud.ai.foundation_models.v1.CompletionOptions} @@ -83,9 +124,134 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + +## Tool {#yandex.cloud.ai.foundation_models.v1.Tool} + +Represents a tool that can be invoked during completion generation. + +#| +||Field | Description || +|| function | **[FunctionTool](#yandex.cloud.ai.foundation_models.v1.FunctionTool)** + +Represents a function that can be called. + +Includes only one of the fields `function`. || +|# + +## FunctionTool {#yandex.cloud.ai.foundation_models.v1.FunctionTool} + +Represents a function tool that can be invoked during completion generation. + +#| +||Field | Description || +|| name | **string** + +The name of the function. || +|| description | **string** + +A description of the function's purpose or behavior. || +|| parameters | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +A JSON Schema that defines the expected parameters for the function. +The schema should describe the required fields, their types, and any constraints or default values. || |# ## CompletionResponse {#yandex.cloud.ai.foundation_models.v1.CompletionResponse} @@ -96,8 +262,34 @@ Message content. || { "message": { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "google.protobuf.Struct" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } // end of the list of possible fields }, "status": "AlternativeStatus" @@ -145,7 +337,8 @@ The generation status of the alternative - `ALTERNATIVE_STATUS_TRUNCATED_FINAL`: Incomplete final alternative resulting from reaching the maximum allowed number of tokens. - `ALTERNATIVE_STATUS_FINAL`: Final alternative generated without running into any limits. - `ALTERNATIVE_STATUS_CONTENT_FILTER`: Generation was stopped due to the discovery of potentially sensitive content in the prompt or generated response. -To fix, modify the prompt and restart generation. || +To fix, modify the prompt and restart generation. +- `ALTERNATIVE_STATUS_TOOL_CALLS`: Tools were invoked during the completion generation. || |# ## Message {#yandex.cloud.ai.foundation_models.v1.Message2} @@ -164,9 +357,103 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList2)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList2)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList2} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall2)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall2} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall2)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall2} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList2} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult2)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult2} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult2)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult2} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || |# ## ContentUsage {#yandex.cloud.ai.foundation_models.v1.ContentUsage} diff --git a/ru/yandexgpt/text-generation/api-ref/grpc/TextGenerationAsync/completion.md b/ru/yandexgpt/text-generation/api-ref/grpc/TextGenerationAsync/completion.md index 5c0b9687bfd..37d669b9f21 100644 --- a/ru/yandexgpt/text-generation/api-ref/grpc/TextGenerationAsync/completion.md +++ b/ru/yandexgpt/text-generation/api-ref/grpc/TextGenerationAsync/completion.md @@ -24,8 +24,45 @@ A method for generating text completions in [asynchronous mode](/docs/foundation "messages": [ { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "google.protobuf.Struct" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } + // end of the list of possible fields + } + ], + "tools": [ + { + // Includes only one of the fields `function` + "function": { + "name": "string", + "description": "string", + "parameters": "google.protobuf.Struct" + } // end of the list of possible fields } ] @@ -45,6 +82,10 @@ Configuration options for completion generation. || || messages[] | **[Message](#yandex.cloud.ai.foundation_models.v1.Message)** A list of messages representing the context for the completion model. || +|| tools[] | **[Tool](#yandex.cloud.ai.foundation_models.v1.Tool)** + +List of tools that are available for the model to invoke during the completion generation. +Note: This parameter is not yet supported and will be ignored if provided. || |# ## CompletionOptions {#yandex.cloud.ai.foundation_models.v1.CompletionOptions} @@ -83,9 +124,134 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + +## Tool {#yandex.cloud.ai.foundation_models.v1.Tool} + +Represents a tool that can be invoked during completion generation. + +#| +||Field | Description || +|| function | **[FunctionTool](#yandex.cloud.ai.foundation_models.v1.FunctionTool)** + +Represents a function that can be called. + +Includes only one of the fields `function`. || +|# + +## FunctionTool {#yandex.cloud.ai.foundation_models.v1.FunctionTool} + +Represents a function tool that can be invoked during completion generation. + +#| +||Field | Description || +|| name | **string** + +The name of the function. || +|| description | **string** + +A description of the function's purpose or behavior. || +|| parameters | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +A JSON Schema that defines the expected parameters for the function. +The schema should describe the required fields, their types, and any constraints or default values. || |# ## operation.Operation {#yandex.cloud.operation.Operation} @@ -106,8 +272,34 @@ Message content. || { "message": { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "google.protobuf.Struct" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } // end of the list of possible fields }, "status": "AlternativeStatus" @@ -214,7 +406,8 @@ The generation status of the alternative - `ALTERNATIVE_STATUS_TRUNCATED_FINAL`: Incomplete final alternative resulting from reaching the maximum allowed number of tokens. - `ALTERNATIVE_STATUS_FINAL`: Final alternative generated without running into any limits. - `ALTERNATIVE_STATUS_CONTENT_FILTER`: Generation was stopped due to the discovery of potentially sensitive content in the prompt or generated response. -To fix, modify the prompt and restart generation. || +To fix, modify the prompt and restart generation. +- `ALTERNATIVE_STATUS_TOOL_CALLS`: Tools were invoked during the completion generation. || |# ## Message {#yandex.cloud.ai.foundation_models.v1.Message2} @@ -233,11 +426,105 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList2)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList2)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || |# +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList2} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall2)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall2} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall2)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall2} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList2} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult2)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult2} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult2)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult2} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + ## ContentUsage {#yandex.cloud.ai.foundation_models.v1.ContentUsage} An object representing the number of content [tokens](/docs/foundation-models/concepts/yandexgpt/tokens) used by the completion model. diff --git a/ru/yandexgpt/text-generation/api-ref/grpc/Tokenizer/tokenizeCompletion.md b/ru/yandexgpt/text-generation/api-ref/grpc/Tokenizer/tokenizeCompletion.md index f7155869ab0..d72df7fd1c9 100644 --- a/ru/yandexgpt/text-generation/api-ref/grpc/Tokenizer/tokenizeCompletion.md +++ b/ru/yandexgpt/text-generation/api-ref/grpc/Tokenizer/tokenizeCompletion.md @@ -24,8 +24,45 @@ RPC method for tokenizing content of CompletionRequest "messages": [ { "role": "string", - // Includes only one of the fields `text` - "text": "string" + // Includes only one of the fields `text`, `toolCallList`, `toolResultList` + "text": "string", + "toolCallList": { + "toolCalls": [ + { + // Includes only one of the fields `functionCall` + "functionCall": { + "name": "string", + "arguments": "google.protobuf.Struct" + } + // end of the list of possible fields + } + ] + }, + "toolResultList": { + "toolResults": [ + { + // Includes only one of the fields `functionResult` + "functionResult": { + "name": "string", + // Includes only one of the fields `content` + "content": "string" + // end of the list of possible fields + } + // end of the list of possible fields + } + ] + } + // end of the list of possible fields + } + ], + "tools": [ + { + // Includes only one of the fields `function` + "function": { + "name": "string", + "description": "string", + "parameters": "google.protobuf.Struct" + } // end of the list of possible fields } ] @@ -45,6 +82,10 @@ Configuration options for completion generation. || || messages[] | **[Message](#yandex.cloud.ai.foundation_models.v1.Message)** A list of messages representing the context for the completion model. || +|| tools[] | **[Tool](#yandex.cloud.ai.foundation_models.v1.Tool)** + +List of tools that are available for the model to invoke during the completion generation. +Note: This parameter is not yet supported and will be ignored if provided. || |# ## CompletionOptions {#yandex.cloud.ai.foundation_models.v1.CompletionOptions} @@ -83,9 +124,134 @@ The ID of the message sender. Supported roles: Textual content of the message. -Includes only one of the fields `text`. +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|| toolCallList | **[ToolCallList](#yandex.cloud.ai.foundation_models.v1.ToolCallList)** + +List of tool calls made by the model as part of the response generation. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. Message content. || +|| toolResultList | **[ToolResultList](#yandex.cloud.ai.foundation_models.v1.ToolResultList)** + +List of tool results returned from external tools that were invoked by the model. + +Includes only one of the fields `text`, `toolCallList`, `toolResultList`. + +Message content. || +|# + +## ToolCallList {#yandex.cloud.ai.foundation_models.v1.ToolCallList} + +Represents a list of tool calls. + +#| +||Field | Description || +|| toolCalls[] | **[ToolCall](#yandex.cloud.ai.foundation_models.v1.ToolCall)** + +A list of tool calls to be executed. || +|# + +## ToolCall {#yandex.cloud.ai.foundation_models.v1.ToolCall} + +Represents a call to a tool. + +#| +||Field | Description || +|| functionCall | **[FunctionCall](#yandex.cloud.ai.foundation_models.v1.FunctionCall)** + +Represents a call to a function. + +Includes only one of the fields `functionCall`. || +|# + +## FunctionCall {#yandex.cloud.ai.foundation_models.v1.FunctionCall} + +Represents the invocation of a function with specific arguments. + +#| +||Field | Description || +|| name | **string** + +The name of the function being called. || +|| arguments | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +The structured arguments passed to the function. +These arguments must adhere to the JSON Schema defined in the corresponding function's parameters. || +|# + +## ToolResultList {#yandex.cloud.ai.foundation_models.v1.ToolResultList} + +Represents a list of tool results. + +#| +||Field | Description || +|| toolResults[] | **[ToolResult](#yandex.cloud.ai.foundation_models.v1.ToolResult)** + +A list of tool results. || +|# + +## ToolResult {#yandex.cloud.ai.foundation_models.v1.ToolResult} + +Represents the result of a tool call. + +#| +||Field | Description || +|| functionResult | **[FunctionResult](#yandex.cloud.ai.foundation_models.v1.FunctionResult)** + +Represents the result of a function call. + +Includes only one of the fields `functionResult`. || +|# + +## FunctionResult {#yandex.cloud.ai.foundation_models.v1.FunctionResult} + +Represents the result of a function call. + +#| +||Field | Description || +|| name | **string** + +The name of the function that was executed. || +|| content | **string** + +The result of the function call, represented as a string. +This field can be used to store the output of the function. + +Includes only one of the fields `content`. || +|# + +## Tool {#yandex.cloud.ai.foundation_models.v1.Tool} + +Represents a tool that can be invoked during completion generation. + +#| +||Field | Description || +|| function | **[FunctionTool](#yandex.cloud.ai.foundation_models.v1.FunctionTool)** + +Represents a function that can be called. + +Includes only one of the fields `function`. || +|# + +## FunctionTool {#yandex.cloud.ai.foundation_models.v1.FunctionTool} + +Represents a function tool that can be invoked during completion generation. + +#| +||Field | Description || +|| name | **string** + +The name of the function. || +|| description | **string** + +A description of the function's purpose or behavior. || +|| parameters | **[google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/struct)** + +A JSON Schema that defines the expected parameters for the function. +The schema should describe the required fields, their types, and any constraints or default values. || |# ## TokenizeResponse {#yandex.cloud.ai.foundation_models.v1.TokenizeResponse} diff --git a/ru/ydb/toc.yaml b/ru/ydb/toc.yaml index e42f9bf31bc..a26a4e1b8b3 100644 --- a/ru/ydb/toc.yaml +++ b/ru/ydb/toc.yaml @@ -89,6 +89,8 @@ items: href: tutorials/mkf-ydb-stream.md - name: Блокировка состояний {{ TF }} с помощью {{ ydb-name }} href: tutorials/terraform-state-lock.md + - name: Сокращатель ссылок + href: tutorials/serverless-url-shortener.md - name: Концепции items: - name: Обзор diff --git a/ru/ydb/tutorials/index.md b/ru/ydb/tutorials/index.md index f81b1802e06..59ea026592a 100644 --- a/ru/ydb/tutorials/index.md +++ b/ru/ydb/tutorials/index.md @@ -24,3 +24,4 @@ description: Различные сценарии использования {{ y * [{#T}](mkf-yds-stream.md) * [{#T}](mkf-ydb-stream.md) * [{#T}](terraform-state-lock.md) +* [{#T}](serverless-url-shortener.md) diff --git a/ru/ydb/tutorials/java-servlet-todo-list.md b/ru/ydb/tutorials/java-servlet-todo-list.md index 949ac946063..464da2422b5 100644 --- a/ru/ydb/tutorials/java-servlet-todo-list.md +++ b/ru/ydb/tutorials/java-servlet-todo-list.md @@ -1,7 +1,7 @@ --- title: Java Servlet API. Развертывание веб-приложения description: В этом сценарии вы узнаете, как с помощью Java Servlet API и serverless-технологий создать небольшое веб-приложение для управления списком задач. -sourcePath: overlay/tutorials/java-servlet-todo-list.md +canonical: '{{ link-docs }}/tutorials/serverless/java-servlet-todo-list' --- # Развертывание веб-приложения с использованием Java Servlet API и {{ ydb-short-name }} diff --git a/ru/ydb/tutorials/serverless-url-shortener.md b/ru/ydb/tutorials/serverless-url-shortener.md new file mode 100644 index 00000000000..08459418247 --- /dev/null +++ b/ru/ydb/tutorials/serverless-url-shortener.md @@ -0,0 +1,5 @@ +--- +canonical: '{{ link-docs }}/tutorials/serverless/serverless-url-shortener' +--- + +{% include [serverless-url-shortener](../../_tutorials/serverless/serverless-url-shortener.md) %} \ No newline at end of file